ビジネス コンポーネント操作用のメッセージ スキーマ

  • [アーティクル]

Siebel ビジネス コンポーネント操作のメッセージ スキーマ

次の表に、Siebel ビジネス コンポーネントで Siebel アダプターによって公開される操作のメッセージ スキーマを示します。

操作 XML 構造体 説明
挿入 メッセージの挿入:

<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] = メッセージのバージョン文字列。たとえば、 "http://Microsoft.LobServices.Siebel/2007/03"です。

[BO] = ビジネス オブジェクトの名前。たとえば、Account です。

[BC] = ビジネス コンポーネントの名前。たとえば、Account です。

[FIELD1_NAME] = ビジネス コンポーネント のフィールド名。たとえば、Account_x0020_Status。

応答メッセージの挿入:

<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] = メッセージのバージョン文字列。例えば "http://Microsoft.LobServices.Siebel/2007/03"

[BO] = ビジネス オブジェクトの名前。たとえば、Account です。

[BC] = ビジネス コンポーネントの名前。たとえば、Account です。

[ID] = レコード ID;たとえば、42 から 6ODBL です。		 ビジネス コンポーネントに 1 つ以上のレコードを挿入します。

応答には、挿入されたすべてのレコードのレコード ID が含まれます。

少なくとも 1 つの挿入が成功した場合、例外はスローされません。応答には、正常に挿入されたレコードの ID が含まれます。 ただし、すべての挿入が失敗すると、例外がスローされます (XmlReaderParsingException または TargetSystemException)。
クエリ クエリ メッセージ:

<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] = メッセージのバージョン文字列。たとえば、 "http://Microsoft.LobServices.Siebel/2007/03"です。

[View_mode] = 適用する表示モード。 これは省略可能なパラメーターです。 使用可能な値の説明については、Siebel のドキュメントを参照してください。

[Search_expr] = Siebel 検索式;たとえば、[名前] LIKE "3Com*" などです。

[Sort_spec] = Siebel sort 仕様;たとえば、Name (DESC)、Location などです。

[FIELD1_NAME] = ビジネス コンポーネント のフィールド名。たとえば、アカウントの状態です。

クエリ応答メッセージ:

<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] = メッセージのバージョン文字列。たとえば、 "http://Microsoft.LobServices.Siebel/2007/03"です。

[BO] = ビジネス オブジェクトの名前。たとえば、Account です。

[BC] = ビジネス コンポーネントの名前。たとえば、Account です。

[FIELD1_NAME] = ビジネス コンポーネント のフィールド名。たとえば、Account_x0020_Status。		 ターゲット ビジネス コンポーネントから 1 つ以上のレコードを照会します。 Query 操作は、次のパラメーターを受け取ります。

<SearchExpr> 対象のビジネス コンポーネントの下にあるすべてのレコードが検索式と比較され、一致するレコードが返されます。

<SortSpec> 並べ替えの指定は、検索式に一致するレコードが返される順序を決定します。 このパラメーターは省略可能です。

<QueryFields> クエリ操作で取得する必要があるターゲット ビジネス コンポーネント内のフィールドを指定するフィールド名の一覧。 各レコードには、このリスト内のフィールドのみが返されます。 各フィールドは、XML でエンコードされた名前ではなく、ビジネス コンポーネントのフィールドの元の名前を使用して指定する必要があります。たとえば、"First_x0032_Name" ではなく "First Name" などです。 このパラメーターは省略可能です。 クエリ フィールドが指定されていない場合は、すべてのフィールドが返されます。
更新 更新メッセージ:

<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] = メッセージのバージョン文字列。たとえば、 "http://Microsoft.LobServices.Siebel/2007/03"です。

[BO] = ビジネス オブジェクトの名前。たとえば、Account です。

[BC] = ビジネス コンポーネントの名前。たとえば、Account です。

[View_mode] = 更新する必要があるレコードに対してクエリを実行するときに適用する表示モード。 これは省略可能なパラメーターです。 使用可能な値の説明については、Siebel のドキュメントを参照してください。

[FIELD1_NAME] = ビジネス コンポーネント のフィールド名。たとえば、Account_x0020_Status。

[Record_ID] = 更新するレコードのレコード ID。たとえば、42 から 60DBL です。

更新応答メッセージ:

<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] = メッセージのバージョン文字列。たとえば、 "http://Microsoft.LobServices.Siebel/2007/03"です。

[BO] = ビジネス オブジェクトの名前。たとえば、Account です。

[BC] = ビジネス コンポーネントの名前。たとえば、Account です。

[ID] = レコード ID;たとえば、42 から 6ODBL です。		 更新レコードのリストで指定された 1 つ以上のレコードを更新します。

各更新レコードには、更新するフィールドの一覧と、更新するレコードを識別する 1 つの必須 <Id> 要素が含まれています。

応答には、更新されたすべてのレコードのレコード ID の一覧が含まれます。

少なくとも 1 つの更新が成功した場合、例外はスローされません。応答には、正常に更新されたレコードの ID が含まれます。 ただし、すべての更新が失敗すると、例外がスローされます (XmlReaderParsingException または TargetSystemException)。
削除 メッセージの削除:

<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] = メッセージのバージョン文字列。たとえば、 "http://Microsoft.LobServices.Siebel/2007/03"です。

[BO] = ビジネス オブジェクトの名前。たとえば、Account です。

[BC] = ビジネス コンポーネントの名前。たとえば、Account です。

[View_mode] = 削除する必要があるレコードに対してクエリを実行するときに適用する表示モード。 これは省略可能なパラメーターです。 使用可能な値の説明については、Siebel のドキュメントを参照してください。

[ID] = レコード ID;たとえば、42 から 6ODBL です。

Search_expr = Siebel 検索式;たとえば、[名前] LIKE "3Com*" などです。

応答メッセージを削除する

<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] = メッセージのバージョン文字列。たとえば、 "http://Microsoft.LobServices.Siebel/2007/03"です。

[BO] = ビジネス オブジェクトの名前。たとえば、Account です。

[BC] = ビジネス コンポーネントの名前。たとえば、Account です。

[ID] = レコード ID;たとえば、42 から 6ODBL です。		 レコード ID のセットまたは検索式に一致する 1 つ以上のレコードを削除します。

大事な： Delete 操作は、検索式またはレコード ID のセットを受け取ります。 同じ Delete 操作で両方のパラメーターを指定することはできません。

応答には、削除されたすべての行のレコード ID の一覧が含まれます。

少なくとも 1 つの削除が成功した場合、例外はスローされません。応答には、正常に削除されたレコードの ID が含まれます。 ただし、すべての削除が失敗すると、例外がスローされます (XmlReaderParsingException または TargetSystemException)。
Associate 関連付けメッセージ:

<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] = メッセージのバージョン文字列。たとえば、 "http://Microsoft.LobServices.Siebel/2007/03"です。

[BO] = ビジネス オブジェクトの名前。たとえば、Account です。

[BC] = ビジネス コンポーネントの名前。たとえば、Account です。

[View_mode] = 親および子ビジネス コンポーネント レコードのクエリに適用する表示モード。 値が指定されている場合、その値は親検索と子検索の両方に適用されます。 これは省略可能な引数です。 使用可能な値の詳細については、Siebel のドキュメントを参照してください。

[Par_search] = 1 つの親ビジネス コンポーネント レコードに一致する検索式。たとえば、[Id] LIKE AB-12345 などです。

[Chld_search] = 親ビジネス コンポーネント レコードに関連付けられる 1 つの子ビジネス コンポーネント レコードに一致する検索式。たとえば、[Id] LIKE CD-12345 などです。

[Field_name] = 親ビジネス コンポーネントの複数値グループ フィールド名。たとえば、アカウント ビジネス コンポーネントの "名に請求" などです。

関連付け応答メッセージ:

<AssociateResponse xmlns="[VERSION]/BusinessObjects/[BO]/[BC]/Operation"> <AssociateResult> <ChildID>[CHILD_ID]</ChildID> <ParentID>[PARENT_ID]</ParentID> </AssociateResult> </AssociateResponse>

[VERSION] = メッセージのバージョン文字列。たとえば、 "http://Microsoft.LobServices.Siebel/2007/03"です。

[BO] = ビジネス オブジェクトの名前。たとえば、Account です。

[BC] = ビジネス コンポーネントの名前。たとえば、Account です。

[CHILD_ID] = 子レコード ID;たとえば、42 から 6ODBL です。

[PARENT_ID] = 親レコード ID;たとえば、42 から 6ODBL です。		 関連付け操作は、複数値グループ (MVG) フィールドを持つビジネス コンポーネントに対してのみ表示されます。 親レコードと子レコードの検索式を指定してレコードを関連付けます。

関連付け操作:

- 選択した親ビジネス コンポーネント レコードを、選択した 1 つの子ビジネス コンポーネント レコードに関連付けます

- 1 対 1 の関連付けを確立します。 1 つの親レコードが 1 つの子レコードに関連付けられます

- 1:N 関連付けに対して複数の 1:1 関連付けを作成し、M:N 関連付けに対して複数の 1:N 関連付けを作成する必要がある

注意:

親検索式は、親テーブル内の一意のレコードと一致する必要があります。

子検索式は、子テーブル内の一意のレコードと一致する必要があります。

戻り値には、関連付けられた子行のレコード ID と、関連付けられた親行のレコード ID が含まれます。 親検索式または子検索式が複数の一致するレコードを返す場合は、例外がスローされます。
分離 メッセージの関連付けを解除する:

<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] = メッセージのバージョン文字列。たとえば、 "http://Microsoft.LobServices.Siebel/2007/03"です。

[BO] = ビジネス オブジェクトの名前。たとえば、Account です。

[BC] = ビジネス コンポーネントの名前。たとえば、Account です。

[View_mode] = 親および子ビジネス コンポーネント レコードのクエリに適用する表示モード。 値が指定されている場合、その値は親検索と子検索の両方に適用されます。 これは省略可能な引数です。 許容値の詳細については、Siebel のドキュメントを参照してください。

[Par_search] = 1 つの親ビジネス コンポーネント レコードに一致する検索式。たとえば、[Id] LIKE AB-12345 などです。

[Chld_search] = 親ビジネス コンポーネント レコードと関連付け解除される 1 つの子ビジネス コンポーネント レコードと正確に一致する検索式。たとえば、[Id] LIKE CD-12345 などです。

[Field_name] = 親ビジネス コンポーネントの複数値グループ フィールド名。たとえば、アカウント ビジネス コンポーネントの "名に請求" などです。

応答メッセージの関連付けを解除する:

<DissociateResponse xmlns="[VERSION]/BusinessObjects/[BO]/[BC]/Operation"> <DissociateResult> <ChildID>[CHILD_ID]</ChildID> <ParentID>[PARENT_ID]</ParentID> </DissociateResult> </DisocciateResponse>

[VERSION] = メッセージのバージョン文字列。たとえば、 "http://Microsoft.LobServices.Siebel/2007/03"です。

[BO] = ビジネス オブジェクトの名前。たとえば、Account です。

[BC] = ビジネス コンポーネントの名前。たとえば、Account です。

[CHILD_ID] = 子レコード ID;たとえば、42 から 6ODBL です。

[PARENT_ID] = 親レコード ID;たとえば、42 から 6ODBL です。		 関連付け解除操作は、複数値グループ (MVG) フィールドを持つビジネス コンポーネントに対してのみ表示されます。 親レコードと子レコードの検索式を指定することで、レコードの関連付けを解除します。

関連付け解除操作:

選択した親ビジネス コンポーネント レコードと、選択した 1 つの子ビジネス コンポーネント レコードとの関連付けを解除します

1 対 1 の関連付けを確立します。 1 つの親レコードが 1 つの子レコードと関連付け解除されます

1:1 の 1:N の関連付けに対して複数の 1:1 の関連付けを行い、M:N の関連付けに対して複数の 1:N の関連付けを行う必要があります

子検索式は、親検索式と一致する親レコードに関連付けられているレコードの中で一意のレコードと一致する必要があることに注意してください。

大事な： ASSOCIATE 操作と DISSOCIATE 操作の子検索式には違いがあります。 ASSOCIATE 操作では、子検索式は子ビジネス コンポーネント内のすべてのレコードを検索します。 DISSOCIATE 操作では、子検索式は、親ビジネス コンポーネント内のレコードに関連付けられている子ビジネス コンポーネント内のレコードのみを検索します。親レコードは親検索式と一致します。

戻り値には、関連付け解除された子レコードのレコード ID と、関連付け解除された親レコードのレコード ID が含まれます。 親検索式または子検索式が複数の一致するレコードを返す場合は、例外がスローされます。
Query_[MVG_Child_Business_Comp] Query_[MVG_Child_Business_Comp] メッセージ:

<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] = メッセージのバージョン文字列。たとえば、 "http://Microsoft.LobServices.Siebel/2007/03"です。

[BO] = ビジネス オブジェクトの名前。たとえば、Account です。

[BC] = ビジネス コンポーネントの名前。たとえば、Account です。

[View_mode] = 適用する表示モード。0 ~ 9 を指定できます。 これは省略可能なパラメーターです。 これらの可能な値の説明については、Siebel のドキュメントを参照してください。

[CHILD_BC] = 親ビジネス コンポーネントの MVG フィールドに関連付けられている子ビジネス コンポーネントの名前。たとえば、Contact (取引先企業の親ビジネス コンポーネントの場合)。

[Par_search] = 1 つの親ビジネス コンポーネント レコードに一致する検索式。たとえば、[Id] LIKE AB-12345 などです。

[Field_name] = 親ビジネス コンポーネントの複数値グループ フィールド名。たとえば、アカウント ビジネス コンポーネントの "名に請求" などです。

[Chld_search] = 1 つ以上の子ビジネス コンポーネント レコードに一致する検索式。たとえば、[Id] LIKE CD-12345 などです。

[field1]、[field2]など = 子ビジネス コンポーネントのクエリ フィールド。 操作で取得する必要がある子ビジネス コンポーネント内のフィールドを指定するフィールド名の一覧。 各レコードには、このリスト内のフィールドのみが返されます。 各フィールドは、XML でエンコードされた名前ではなく、子ビジネス コンポーネントのフィールドの元の名前を使用して指定する必要があります。たとえば、"First_x0032_Name" ではなく "First Name" などです。 このパラメーターは省略可能です。

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] = メッセージのバージョン文字列。たとえば、 "http://Microsoft.LobServices.Siebel/2007/03"です。

[BO] = ビジネス オブジェクトの名前。たとえば、Account です。

[BC] = ビジネス コンポーネントの名前。たとえば、Account です。

[FIELD1_NAME] = ビジネス コンポーネント フィールド名。たとえば、Account_x0020_Status。

[CHILD_BC] = 親ビジネス コンポーネントの MVG フィールドに関連付けられている子ビジネス コンポーネントの名前。たとえば、Contact (取引先企業の親ビジネス コンポーネントの場合)。		 この操作は、MVG フィールドを持つビジネス コンポーネントに対して公開されます。

親ビジネス コンポーネントの MVG フィールドに関連付けられている親レコードに関連付けられている子レコードに対してクエリを実行します。

Siebel ビジネス コンポーネント操作のメッセージ アクション

次の表は、Siebel の各ビジネス コンポーネント操作の SOAP アクションを示しています。 要求メッセージのアクションのみが表示されます。応答メッセージのアクションは、要求メッセージ アクションに "/response" を追加することによって形成されます。たとえば、 "http://Microsoft.LobServices.Siebel/2007/03/BusinessObjects/Account/Account/Insert/response"です。

Operation アクション 例
挿入 [VERSION]/BusinessObjects/[BO]/[BC]/Insert http://Microsoft.LobServices.Siebel/2007/03/BusinessObjects/Account/Account/Insert
クエリ [VERSION]/BusinessObjects/[BO]/[BC]/Query http://Microsoft.LobServices.Siebel/2007/03/BusinessObjects/Account/Account/Query
更新 [VERSION]/BusinessObjects/[BO]/[BC]/Update http://Microsoft.LobServices.Siebel/2007/03/BusinessObjects/Account/Account/Update
削除 [VERSION]/BusinessObjects/[BO]/[BC]/Delete http://Microsoft.LobServices.Siebel/2007/03/BusinessObjects/Account/Account/Delete
Associate [VERSION]/BusinessObjects/[BO]/[BC]/Associate http://Microsoft.LobServices.Siebel/2007/03/BusinessObjects/Account/Account/Associate
分離 [VERSION]/BusinessObjects/[BO]/[BC]/関連付け解除 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] = メッセージのバージョン文字列。たとえば、 "http://Microsoft.LobServices.Siebel/2007/03"です。

[BO] = ビジネス オブジェクト名。たとえば、Account です。

[BC] = ビジネス コンポーネント名。たとえば、Account です。

親ビジネス コンポーネントの MVG フィールドに関連付けられている子ビジネス コンポーネントの名前。たとえば、Contact (取引先企業の親ビジネス コンポーネントの場合)。

BizTalk Server ソリューションで Siebel アダプターを使用する場合、または Windows Communication Foundation (WCF) チャネル モデルを使用する場合は、メッセージ アクションを明示的に指定する必要があります。 詳細については、「 Siebel アプリケーションの開発」を参照してください。

Siebel Business Component WCF クライアント メソッド

次の表は、Siebel ビジネス コンポーネント用のアダプター サービス参照 Visual Studio プラグインの追加によって生成される WCF サービス モデル メソッドシグネチャを示しています。

操作 WCF サービス モデル メソッド
挿入 string[] client.Insert([BC]InsertRecord[] ArrayOf[BC]InsertRecord);

[BC] = ビジネス コンポーネントの名前。たとえば、Account です。
クエリ [BC]QueryRecord[] client.Query(System.Nullable<short> ViewMode, [BC]QueryInputRecord [BC]QueryInputRecord);

[BC] = 取引先企業などのビジネス コンポーネントの名前。
更新 string[] client.Update(System.Nullable<short> ViewMode, [BC]UpdateRecord[] ArrayOf[BC]UpdateRecord);

[BC] = ビジネス コンポーネントの名前。たとえば、Account です。
削除 string[] client.Delete(System.Nullable<short> ViewMode, string[] Id, string SearchExpr);
Associate ParentChildRecord client.Associate(System.Nullable<short> ViewMode, string ParentSearchExpr, string ParentMVGField, string ChildSearchExpr);
分離 ParentChildRecord client.Dissociate(System.Nullable<short> ViewMode, string ParentSearchExpr, string ParentMVGField, string ChildSearchExpr);
Query_[MVG子どもビジネスコンプ] [CHILD_BC]QueryRecord[] client.Query_[CHILD_BC](../../core/system.md ViewModeshort ViewMode, string ParentSearchExpr, string ParentMVGField, [CHILD_BC]QueryInputRecord [CHILD_BC]QueryInputRecord);

[CHILD_BC] = 親ビジネス コンポーネントの MVG フィールドに関連付けられている子ビジネス コンポーネントの名前。たとえば、Contact (取引先企業の親ビジネス コンポーネントの場合)。

参照

BizTalk Adapter for Siebel eBusiness アプリケーションのメッセージとメッセージ スキーマ