Schémas de message pour les opérations des composants métier
Schémas de message pour les opérations de composant métier Siebel
Le tableau suivant répertorie les schémas de message pour les opérations exposées par l’adaptateur Siebel sur les composants métier Siebel.
| Opération | XML Structure | Description |
|---|---|---|
| Insérer | Insérer un message :<Insert xmlns="[VERSION]/BusinessObjects/[BO]/[BC]/Operation"> <ArrayOf[BC]InsertRecord> <[BC]InsertRecord> <[FIELD1_NAME]>value1</[FIELD1_NAME]> <[FIELD2_NAME]>value2</[FIELD2_NAME]> … </[BC]InsertRecord> … </ArrayOf[BC]InsertRecord> </Insert>[VERSION] = Chaîne de version du message ; par exemple, "http://Microsoft.LobServices.Siebel/2007/03".[BO] = Nom de l’objet métier ; par exemple, Compte. [BC] = nom du composant métier ; par exemple, Compte. [FIELD1_NAME] = nom du champ du composant métier ; par exemple, Account_x0020_Status. Insérer un message de réponse : <InsertResponset xmlns="[VERSION]/BusinessObjects/[BO]/[BC]/Operation"> <InsertResult> <string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">[ID1]</string> <string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">[ID2]</string> … </InsertResult> </InsertResponse>[VERSION] = Chaîne de version du message ; par exemple, "http://Microsoft.LobServices.Siebel/2007/03"[BO] = Nom de l’objet métier ; par exemple, Compte. [BC] = nom du composant métier ; par exemple, Compte. [ID] = ID d’enregistrement ; par exemple, 42-6ODBL. |
Insère un ou plusieurs enregistrements dans un composant métier. La réponse contient les ID d’enregistrement de tous les enregistrements insérés. Si au moins une insertion réussit, aucune exception n’est levée et la réponse contient les ID des enregistrements correctement insérés. Toutefois, si toutes les insertions échouent, une exception est levée (XmlReaderParsingException ou TargetSystemException). |
| Requête | Message de requête :<Query xmlns="[VERSION]/BusinessObjects/[BO]/[BC]/Operation"> <ViewMode>[View_mode]</ViewMode> <[BC]QueryInputRecord> <SearchExpr>[Search_expr]</SearchExpr> <SortSpec>Sort_spec</SortSpec> <QueryFields> <string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">[Field1_name]</string> <string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">[Field2_name]</string> … </QueryFields> </[BC]QueryInputRecord> </Query>[VERSION] = Chaîne de version du message ; par exemple, "http://Microsoft.LobServices.Siebel/2007/03".[View_mode] = Mode Affichage à appliquer. Il s'agit d'un paramètre facultatif. Consultez la documentation de Siebel pour obtenir une explication des valeurs possibles. [Search_expr] = expression de recherche Siebel ; par exemple, [Name] LIKE « 3Com* ». [Sort_spec] = spécification de tri Siebel ; par exemple, Nom (DESC), Emplacement. [FIELD1_NAME] = nom du champ du composant métier ; par exemple, État du compte. Message de réponse de requête : <QueryResponse xmlns=" [VERSION]/BusinessObjects/[BO]/[BC]/Operation"> <QueryResult> <[BC]QueryRecord> <[FIELD1_NAME]>value1</[FIELD1_NAME]> <[FIELD2_NAME]>value2</[FIELD2_NAME]> … </[BC]QueryRecord > </QueryResult> </QueryResponse>[VERSION] = Chaîne de version du message ; par exemple, "http://Microsoft.LobServices.Siebel/2007/03".[BO] = Nom de l’objet métier ; par exemple, Compte. [BC] = nom du composant métier ; par exemple, Compte. [FIELD1_NAME] = nom du champ du composant métier ; par exemple, Account_x0020_Status. |
Interroge un ou plusieurs enregistrements du composant métier cible. L’opération Query prend les paramètres suivants : <SearchExpr> Tous les enregistrements sous le composant métier cible sont comparés à l’expression de recherche et les enregistrements correspondants sont retournés. <SortSpec> La spécification de tri détermine l’ordre dans lequel les enregistrements qui correspondent à l’expression de recherche sont retournés. Ce paramètre est facultatif. <QueryFields> Liste des noms de champs qui spécifient les champs du composant métier cible qui doivent être récupérés par l’opération de requête. Seuls les champs de cette liste sont retournés dans chaque enregistrement. Chaque champ doit être spécifié à l’aide du nom d’origine du champ dans le composant métier, et non du nom encodé en XML ; par exemple, « Prénom » au lieu de « First_x0032_Name ». Ce paramètre est facultatif. Si les champs de requête ne sont pas spécifiés, tous les champs sont retournés. |
| Update | Message de mise à jour :<Update xmlns="[VERSION]/BusinessObjects/[BO]/[BC]/Operation"> <ViewMode>[View_mode]</ViewMode> <ArrayOf[BC]UpdateRecord> <[BC]UpdateRecord> <[FIELD1_NAME]>value1</[FIELD1_NAME]> <[FIELD2_NAME]>value2</[FIELD2_NAME]> … <Id>[Record_ID]</Id> </[BC]UpdateRecord> … </ArrayOf[BC]UpdateRecord> </Update>[VERSION] = Chaîne de version du message ; par exemple, "http://Microsoft.LobServices.Siebel/2007/03".[BO] = Nom de l’objet métier ; par exemple, Compte. [BC] = nom du composant métier ; par exemple, Compte. [View_mode] = mode Affichage à appliquer lors de l’interrogation des enregistrements qui doivent être mis à jour. Il s'agit d'un paramètre facultatif. Consultez la documentation de Siebel pour obtenir une explication des valeurs possibles. [FIELD1_NAME] = nom du champ du composant métier ; par exemple, Account_x0020_Status. [Record_ID] = ID d’enregistrement d’un enregistrement à mettre à jour ; par exemple, 42-60DBL. Mettre à jour le message de réponse : <UpdateResponse xmlns="[VERSION]/BusinessObjects/[BO]/[BC]/Operation"> <UpdateResult> <string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">[ID1]</string> <string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">[ID2]</string> … </UpdateResult> </UpdateResponse>[VERSION] = Chaîne de version du message ; par exemple, "http://Microsoft.LobServices.Siebel/2007/03".[BO] = Nom de l’objet métier ; par exemple, Compte. [BC] = nom du composant métier ; par exemple, Compte. [ID] = ID d’enregistrement ; par exemple, 42-6ODBL. |
Mettez à jour un ou plusieurs enregistrements spécifiés par une liste d’enregistrements de mise à jour. Chaque enregistrement de mise à jour contient une liste des champs à mettre à jour et un seul élément Id> obligatoire <qui identifie l’enregistrement à mettre à jour. La réponse contient une liste des ID d’enregistrement de tous les enregistrements mis à jour. Si au moins une mise à jour réussit, aucune exception n’est levée et la réponse contient les ID des enregistrements correctement mis à jour. Toutefois, si toutes les mises à jour échouent, une exception est levée (XmlReaderParsingException ou TargetSystemException). |
| Supprimer | Supprimer le message :<Delete xmlns="[VERSION]/BusinessObjects/[BO]/[BC]/Operation"> <ViewMode>[View_mode]</ViewMode> <Id> <string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">[ID1]</string> <string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">[ID2]</string> … </Id> <SearchExpr>Search_expr</SearchExpr> </Delete>[VERSION] = Chaîne de version du message ; par exemple, "http://Microsoft.LobServices.Siebel/2007/03".[BO] = Nom de l’objet métier ; par exemple, Compte. [BC] = nom du composant métier ; par exemple, Compte. [View_mode] = mode Affichage à appliquer lors de l’interrogation des enregistrements qui doivent être supprimés. Il s'agit d'un paramètre facultatif. Consultez la documentation de Siebel pour obtenir une explication des valeurs possibles. [ID] = ID d’enregistrement ; par exemple, 42-6ODBL. Search_expr = expression de recherche Siebel ; par exemple, [Name] LIKE « 3Com* ». Supprimer le message de réponse <DeleteResponse xmlns="[VERSION]/BusinessObjects/[BO]/[BC]/Operation"> <DeleteResult> <string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">[ID1]</string> <string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">[ID2]</string> … </DeleteResult> </DeleteResponse>[VERSION] = Chaîne de version du message ; par exemple, "http://Microsoft.LobServices.Siebel/2007/03".[BO] = Nom de l’objet métier ; par exemple, Compte. [BC] = nom du composant métier ; par exemple, Compte. [ID] = ID d’enregistrement ; par exemple, 42-6ODBL. |
Supprimez un ou plusieurs enregistrements correspondant à un jeu d’ID d’enregistrement ou à une expression de recherche. Important: L’opération Delete accepte une expression de recherche ou un ensemble d’ID d’enregistrement. Vous ne pouvez pas spécifier les deux paramètres dans la même opération Delete. La réponse contient une liste des ID d’enregistrement de toutes les lignes supprimées. Si au moins une suppression réussit, aucune exception n’est levée et la réponse contient les ID des enregistrements supprimés. Toutefois, si toutes les suppressions échouent, une exception est levée (XmlReaderParsingException ou TargetSystemException). |
| Associé | Associer le message :<Associate xmlns="[VERSION]/BusinessObjects/[BO]/[BC]/Operation"> <ViewMode>[View_mode]</ViewMode> <ParentSearchExpr>Par_search</ParentSearchExpr> <ParentMVGField>Field_name</ParentMVGField> <ChildSearchExpr>Chld_search</ChildSearchExpr> </Associate>[VERSION] = Chaîne de version du message ; par exemple, "http://Microsoft.LobServices.Siebel/2007/03".[BO] = Nom de l’objet métier ; par exemple, Compte. [BC] = nom du composant métier ; par exemple, Compte. [View_mode] = Mode d’affichage à appliquer à la requête pour les enregistrements de composant d’entreprise parent et enfant. Si une valeur est spécifiée, cette valeur est appliquée à la recherche parente et à la recherche enfant. Il s'agit d'un argument facultatif. Pour une explication des valeurs possibles, consultez la documentation de Siebel. [Par_search] = expression de recherche correspondant exactement à un enregistrement de composant métier parent ; par exemple, [Id] LIKE AB-12345. [Chld_search] = Expression de recherche correspondant exactement à un enregistrement de composant métier enfant qui sera associé à l’enregistrement de composant métier parent ; par exemple, [Id] LIKE CD-12345. [Field_name] = Nom de champ de groupe à valeurs multiples du composant métier parent ; par exemple, « Bill To First Name » dans le composant métier Compte. Associer le message de réponse : <AssociateResponse xmlns="[VERSION]/BusinessObjects/[BO]/[BC]/Operation"> <AssociateResult> <ChildID>[CHILD_ID]</ChildID> <ParentID>[PARENT_ID]</ParentID> </AssociateResult> </AssociateResponse>[VERSION] = Chaîne de version du message ; par exemple, "http://Microsoft.LobServices.Siebel/2007/03".[BO] = Nom de l’objet métier ; par exemple, Compte. [BC] = nom du composant métier ; par exemple, Compte. [CHILD_ID] = ID d’enregistrement enfant ; par exemple, 42-6ODBL. [PARENT_ID] = ID d’enregistrement parent ; par exemple, 42-6ODBL. |
L’opération Associer est exposée uniquement pour les composants métier avec des champs de groupe à valeurs multiples (MVG). Il associe des enregistrements en spécifiant des expressions de recherche pour les enregistrements parents et enfants. L’opération Associate : - Associe un enregistrement de composant métier parent sélectionné à un enregistrement de composant d’entreprise enfant sélectionné - Établit une association 1 :1. un enregistrement parent sera associé à un enregistrement enfant - Plusieurs associations 1 :1 doivent être créées pour une association 1 :N et plusieurs associations 1 :N doivent être faites pour une association M :N Notez ce qui suit : L’expression de recherche parente doit correspondre à un enregistrement unique dans la table parente. L’expression de recherche enfant doit correspondre à un enregistrement unique dans la table enfant. La valeur de retour contient l’ID d’enregistrement de la ligne enfant associée et l’ID d’enregistrement de la ligne parente associée. Si l’expression de recherche parente ou l’expression de recherche enfant retourne plusieurs enregistrements correspondants, une exception est levée. |
| Dissocier | Dissocier le message :<Dissociate xmlns="[VERSION]/BusinessObjects/[BO]/[BC]/Operation"> <ViewMode>[View_mode]</ViewMode> <ParentSearchExpr>Par_search</ParentSearchExpr> <ParentMVGField>Field_name</ParentMVGField> <ChildSearchExpr>Chld_search</ChildSearchExpr> </Dissociate>[VERSION] = Chaîne de version du message ; par exemple, "http://Microsoft.LobServices.Siebel/2007/03".[BO] = Nom de l’objet métier ; par exemple, Compte. [BC] = nom du composant métier ; par exemple, Compte. [View_mode] = Mode d’affichage à appliquer à la requête pour les enregistrements de composant d’entreprise parent et enfant. Si une valeur est spécifiée, cette valeur est appliquée à la recherche parente et à la recherche enfant. Il s'agit d'un argument facultatif. Pour obtenir une explication des valeurs autorisées, consultez la documentation de Siebel. [Par_search] = expression de recherche correspondant exactement à un enregistrement de composant métier parent ; par exemple, [Id] LIKE AB-12345. [Chld_search] = Expression de recherche correspondant exactement à un enregistrement de composant métier enfant qui sera dissocié de l’enregistrement du composant métier parent ; par exemple, [Id] LIKE CD-12345. [Field_name] = Nom de champ de groupe à valeurs multiples du composant métier parent ; par exemple, « Bill To First Name » dans le composant métier Compte. Dissocier le message de réponse : <DissociateResponse xmlns="[VERSION]/BusinessObjects/[BO]/[BC]/Operation"> <DissociateResult> <ChildID>[CHILD_ID]</ChildID> <ParentID>[PARENT_ID]</ParentID> </DissociateResult> </DisocciateResponse>[VERSION] = Chaîne de version du message ; par exemple, "http://Microsoft.LobServices.Siebel/2007/03".[BO] = Nom de l’objet métier ; par exemple, Compte. [BC] = nom du composant métier ; par exemple, Compte. [CHILD_ID] = ID d’enregistrement enfant ; par exemple, 42-6ODBL. [PARENT_ID] = ID d’enregistrement parent ; par exemple, 42-6ODBL. |
L’opération Dissocier est exposée uniquement pour les composants métier avec des champs de groupe à valeurs multiples (MVG). Il dissocie les enregistrements en spécifiant des expressions de recherche pour les enregistrements parents et enfants. L’opération Dissocier : Dissocie un enregistrement de composant métier parent sélectionné avec un enregistrement de composant métier enfant sélectionné Établit une dissociation 1 :1. un enregistrement parent sera dissocié d’un enregistrement enfant Plusieurs dissociations 1 :1 doivent être effectuées pour une dissociation 1 :N et plusieurs dissociations 1 :N doivent être effectuées pour une dissociation M :N Notez que l’expression de recherche enfant doit correspondre à un enregistrement unique parmi les enregistrements associés avec des enregistrements parents qui correspondent à l’expression de recherche parente. Important: Il existe une différence dans l’expression de recherche enfant pour les opérations ASSOCIATE et DISSOCIATE. Dans une opération ASSOCIATE, l’expression de recherche enfant recherche tous les enregistrements dans le composant métier enfant. Dans une opération DISSOCIATE, l’expression de recherche enfant recherche uniquement les enregistrements du composant métier enfant qui sont associés aux enregistrements du composant métier parent, où les enregistrements parents correspondent à l’expression de recherche parente. La valeur de retour contient l’ID d’enregistrement de l’enregistrement enfant dissocié et l’ID d’enregistrement de l’enregistrement parent dissocié. Si l’expression de recherche parente ou l’expression de recherche enfant retourne plusieurs enregistrements correspondants, une exception est levée. |
| Query_[MVG_Child_Business_Comp] | Query_[MVG_Child_Business_Comp] message :<Query_[CHILD_BC] xmlns="BusinessObjects/[BO]/[BC]/Operation"> <ViewMode>View_mode</ViewMode> <ParentSearchExpr>Par_search</ParentSearchExpr> <ParentMVGField>Field_name</ParentMVGField> <[CHILD_BC]QueryInputRecord> <SearchExpr>Chld_search </SearchExpr> <QueryFields> <string>field1</string> <string>field2</string> … </QueryFields> </[CHILD_BC]QueryInputRecord> </Query_[CHILD_BC]>[VERSION] = Chaîne de version du message ; par exemple, "http://Microsoft.LobServices.Siebel/2007/03".[BO] = Nom de l’objet métier ; par exemple, Compte. [BC] = nom du composant métier ; par exemple, Compte. [View_mode] = Mode d’affichage à appliquer ; peut être comprise entre 0 et 9. Il s'agit d'un paramètre facultatif. Consultez la documentation de Siebel pour une explication de ces valeurs possibles. [CHILD_BC] = Nom du composant métier enfant associé au champ MVG du composant métier parent ; par exemple, Contact (pour le composant métier parent de compte). [Par_search] = expression de recherche correspondant à 1 enregistrement de composant métier parent ; par exemple, [Id] LIKE AB-12345. [Field_name] = Nom de champ de groupe à valeurs multiples du composant métier parent ; par exemple, « Bill To First Name » dans le composant métier Account ». [Chld_search] = Expression de recherche correspondant à 1 ou plusieurs enregistrements de composants métier enfants ; par exemple, [Id] LIKE CD-12345. [champ1], [champ2], et ainsi de suite = Champs de requête dans le composant métier enfant. Liste des noms de champs qui spécifient les champs du composant métier enfant qui doivent être récupérés par l’opération. Seuls les champs de cette liste sont retournés dans chaque enregistrement. Chaque champ doit être spécifié en utilisant le nom d’origine du champ dans le composant d’entreprise enfant, et non le nom encodé xml ; par exemple, « Prénom » au lieu de « First_x0032_Name ». Ce paramètre est facultatif. message de réponse Query_[MVG_Child_Business_Comp] : <Query_[CHILD_BC]Response xmlns="[VERSION]/BusinessObjects/[BO]/[BC]/Operation"> <Query_[CHILD_BC]Result> <[CHILD_BC]QueryRecord> <[FIELD1_NAME]>value1</[FIELD1_NAME]> <[FIELD2_NAME]>value2</[FIELD2_NAME]> … </[CHILD_BC]QueryRecord > </QueryResult> </QueryResponse>[VERSION] = Chaîne de version du message ; par exemple, "http://Microsoft.LobServices.Siebel/2007/03".[BO] = Nom de l’objet métier ; par exemple, Compte. [BC] = nom du composant métier ; par exemple, Compte. [FIELD1_NAME] = nom du champ du composant métier ; par exemple, Account_x0020_Status. [CHILD_BC] = Nom du composant métier enfant associé au champ MVG du composant métier parent ; par exemple, Contact (pour le composant métier parent de compte). |
Cette opération est exposée pour les composants métier avec des champs MVG. Il interroge les enregistrements enfants associés à un enregistrement parent associé à un champ MVG dans le composant métier parent. |
Actions de message pour les opérations de composant métier Siebel
Le tableau suivant montre l’action SOAP pour chacune des opérations de composant métier Siebel. Seules les actions pour les messages de demande sont affichées, l’action du message de réponse est formée en ajoutant « /response » à l’action de message de demande ; par exemple, "http://Microsoft.LobServices.Siebel/2007/03/BusinessObjects/Account/Account/Insert/response".
| Opération | Action | Exemple |
|---|---|---|
| Insérer | [VERSION]/BusinessObjects/[BO]/[BC]/Insert | http://Microsoft.LobServices.Siebel/2007/03/BusinessObjects/Account/Account/Insert |
| Requête | [VERSION]/BusinessObjects/[BO]/[BC]/Query | http://Microsoft.LobServices.Siebel/2007/03/BusinessObjects/Account/Account/Query |
| Update | [VERSION]/BusinessObjects/[BO]/[BC]/Update | http://Microsoft.LobServices.Siebel/2007/03/BusinessObjects/Account/Account/Update |
| Supprimer | [VERSION]/BusinessObjects/[BO]/[BC]/Delete | http://Microsoft.LobServices.Siebel/2007/03/BusinessObjects/Account/Account/Delete |
| Associé | [VERSION]/BusinessObjects/[BO]/[BC]/Associate | http://Microsoft.LobServices.Siebel/2007/03/BusinessObjects/Account/Account/Associate |
| Dissocier | [VERSION]/BusinessObjects/[BO]/[BC]/Dissocier | http://Microsoft.LobServices.Siebel/2007/03/BusinessObjects/Account/Account/Dissociate |
| Query_[CHILD_BC] | [VERSION]/BusinessObjects/[BO]/[BC]/Query_[CHILD_BC] | http://Microsoft.LobServices.Siebel/2007/03/BusinessObjects/Account/Account/Query_Contact |
[VERSION] = Chaîne de version du message ; par exemple, "http://Microsoft.LobServices.Siebel/2007/03".
[BO] = nom de l’objet métier ; par exemple, Compte.
[BC] = nom du composant métier ; par exemple, Compte.
Nom du composant métier enfant associé au champ MVG du composant métier parent ; par exemple, Contact (pour le composant métier parent de compte).
Vous devez spécifier explicitement l’action de message lorsque vous utilisez l’adaptateur Siebel dans une solution BizTalk Server ou à l’aide du modèle de canal Windows Communication Foundation (WCF). Pour plus d’informations, consultez Développer vos applications Siebel.
Méthodes clientes WCF du composant métier Siebel
Le tableau suivant montre les signatures de méthode de modèle de service WCF qui sont générées par le plug-in Add Adapter Service Reference Visual Studio pour les composants métier Siebel.
| Opération | Méthode de modèle de service WCF |
|---|---|
| Insérer | string[] client.Insert([BC]InsertRecord[] ArrayOf[BC]InsertRecord);[BC] = Nom du composant d’entreprise ; par exemple, Compte. |
| Requête | [BC]QueryRecord[] client.Query(System.Nullable<short> ViewMode, [BC]QueryInputRecord [BC]QueryInputRecord);[BC] = Nom du composant d’entreprise, par exemple Compte. |
| Update | string[] client.Update(System.Nullable<short> ViewMode, [BC]UpdateRecord[] ArrayOf[BC]UpdateRecord);[BC] = Nom du composant d’entreprise ; par exemple, Compte. |
| Supprimer | string[] client.Delete(System.Nullable<short> ViewMode, string[] Id, string SearchExpr); |
| Associé | ParentChildRecord client.Associate(System.Nullable<short> ViewMode, string ParentSearchExpr, string ParentMVGField, string ChildSearchExpr); |
| Dissocier | ParentChildRecord client.Dissociate(System.Nullable<short> ViewMode, string ParentSearchExpr, string ParentMVGField, string ChildSearchExpr); |
| Query_[MVG Child Business Comp] | [CHILD_BC]QueryRecord[] client.Query_[CHILD_BC](../../core/system.md ViewModeshort ViewMode, string ParentSearchExpr, string ParentMVGField, [CHILD_BC]QueryInputRecord [CHILD_BC]QueryInputRecord);[CHILD_BC] = Nom du composant d’entreprise enfant associé au champ MVG du composant d’entreprise parent ; par exemple, Contact (pour le composant d’entreprise parente compte). |
Voir aussi
Messages et schémas de message pour l’adaptateur BizTalk pour Siebel eBusiness Applications