ContractSync コラボレーション・テンプレート

契約情報は通常、Order Entry、Planning、Finance、および Support など多様な業務の機能または業務を支援する複数のシステム間で複写されます。Contract 情報は複数のシステム間でやり取りされるので、整合性を維持し、すべてのシステムを確実に同期することが業務において重要な課題です。

ContractSync コラボレーション・テンプレートは、ほかのオブジェクトおよびコラボレーションと連携し、Contract 情報を使用するすべてのシステムでこの情報を更新および同期する共通のプロセスを指定します。同期化により、組織全体で共通の Contract 情報を利用できます。

Contract Manager コラボレーション・オブジェクト・グループは、カスタマー・インタラクション・マネジメント (CIM) アプリケーションとエンタープライズ・リソース・プランニング (ERP) アプリケーションとの間で Contract 情報を同期します。これらのアプリケーションのどちらも、同期される情報のソースまたは宛先となることができます。

このようにデータを複製することで、データが企業内で追加、変更、または削除された際に、別個のアプリケーションが情報を整合的に利用できます。コラボレーションは、重複した入力を必要とせずに、宛先アプリケーションでの複製情報の正確性を保証します。

関連するビジネス・オブジェクトの同期

ContractSync が同期するのは Contract のみですが、適切なコラボレーションを呼び出して次の関連ビジネス・オブジェクトを検証または同期するよう構成できます。

ビジネス・オブジェクト 関連するコラボレーション・プロパティー 呼び出し先コラボレーション
Contact FAIL_ON_CONTACT_ERROR VERIFY_SYNC_CONTACT

ContactSync

Contact Wrapper

Customer

VERIFY_SYNC_CUSTOMERS CustomerSync

CustomerWrapper

Item

Item Basic

ItemOrder

ItemPlanning

ITEM_TYPE VERIFY_SYNC_ITEM

ItemSync

ItemWrapper

コラボレーション・オブジェクトのセットアップ

この節では、ポート・バインディングについて説明し、ContractSync に基づくコラボレーション・オブジェクトをセットアップするために必要なステップを説明します。コラボレーション・テンプレートの標準の機能、ポート、および構成プロパティーについて、およびコラボレーション・オブジェクト作成に関する一般情報については、『Required Documents for Creating Collaboration Objects』にリストされている文書を参照してください。

ポート情報

図 1 に、ContractSync のソース・ポートおよび宛先ポートとの関係を示します。

図 1. ContractSync コラボレーションのポート

注: コラボレーション・オブジェクトでポートを使用しないようにするには、そのポートをポート・コネクターにバインドしてください。これにより、コラボレーション・オブジェクトが追加機能を提供せずに、そのポートは未使用として示されます。

ポート名: DestinationAppRetrieve
ビジネス・オブジェクト バインド先 機能 使用される動詞
Contract 宛先アプリケーションのコネクター 参照値のビジネス・オブジェクトを送信して、完全な値のビジネス・オブジェクトを検索します。この結果、Contract を同期するときに使用される動詞が決まります。

Retrieve


ポート名: From
ビジネス・オブジェクト バインド先 機能 使用される動詞
Contract ソース・アプリケーションのコネクター、または呼び出し側コラボレーション トリガー・ビジネス・オブジェクトを受け取ります。コラボレーションが正常に終了した場合、このポートは、同期呼び出しの最後に、トリガー・ビジネス・オブジェクトをソース・アプリケーションに戻します。

Create Retrieve Update Delete


ポート名: To
ビジネス・オブジェクト バインド先 機能 使用される動詞
Contract 宛先アプリケーションのコネクター

トリガー・ビジネス・オブジェクトをコラボレーションから送信します。

Create Update Delete


ポート名: ToContactWrapper
ビジネス・オブジェクト バインド先 機能 使用される動詞
Contact
  • ContactWrapper の From ポート (検証または同期の場合)
  • 宛先アプリケーションのコネクターまたはポート・コネクター (Contact の検証または同期以外の場合)
検証または同期のために Contact ビジネス・オブジェクトを送信します。

Sync Exists


ポート名: ToCustomerWrapper
ビジネス・オブジェクト バインド先 機能 使用される動詞
Customer
  • CustomerWrapper の From ポート (検証または同期の場合)
  • 宛先アプリケーションのコネクターまたはポート・コネクター (Customer の検証または同期以外の場合)
検証または同期のために Customer ビジネス・オブジェクトを送信します。

Sync Exists


ポート名: ToItemWrapper
ビジネス・オブジェクト バインド先 機能 使用される動詞
任意の汎用 item ビジネス・オブジェクト (Item、ItemBasic、ItemPlanning など)
  • ItemWrapper の From ポート (VERIFY_SYNC_ITEM = "verify" または "sync" の場合)
  • 宛先アプリケーションのコネクターまたはポート・コネクター (検証または同期以外の場合)

検証または同期のために参照値 Item ビジネス・オブジェクトを送信します。

Sync Exists

コラボレーション・オブジェクトのセットアップ

ContractSync のスタンドアロンとしての使用

ContractSync をスタンドアロン・コラボレーション・オブジェクトとしてセットアップするには、次の手順を実行します。

  1. ContractSync コラボレーション・オブジェクトを作成します。
  2. コラボレーション・オブジェクトの各 ToBusObjWrapper ポートをポート・コネクターにバインドします。
  3. ポート情報』の説明に従って、残りのポートをバインドします。
  4. ContractSync コラボレーション・オブジェクトの VERIFY_SYNC_BusObj 構成プロパティーのデフォルト値「neither」は変更しません。
  5. コラボレーションの残りのプロパティーを設定します。詳しくは、『構成プロパティー』を参照してください。  

ContractSync のコラボレーション・オブジェクト・グループでの使用

ContractSync プロセスの一部として関連の Customer、Contact、または Item を検証または同期するには、以下のコラボレーション・オブジェクト・グループのいずれかの組み合わせを作成します。


検証 同期 必要なコラボレーション
Contact   ContractSync、ContactWrapper
  Contact ContractSync、ContactWrapper、ContactSync
Customer   ContractSync、CustomerWrapper
  Customer ContractSync、CustomerWrapper、CustomerSync
Item   ContractSync、ItemWrapper
  Item ContractSync、ItemWrapper、ItemSync

ContractSync のコラボレーション・オブジェクト・グループでの使用

コラボレーション・オブジェクト・グループの一部として ContractSync をセットアップする手順は、以下のとおりです。以下の手順では、Contract とその参照 Item のみを同期するものとします。

  1. ContractSync および必要な各ラッパーおよび同期コラボレーションについて、テンプレートからコラボレーション・オブジェクトを作成します。この例では、ContractSync、ItemWrapper、および ItemSync の各コラボレーション・オブジェクトを作成します。
  2. ContractSync コラボレーション・オブジェクトを編集し、ToBusObjWrapper ポートを適切な Wrapper コラボレーション・オブジェクトまたはポート・コネクターにバインドします。この例では、ToItemWrapper ポートを ItemWrapper コラボレーションの From ポートにバインドします。該当する宛先の『ポート情報』節を参照してください。
  3. ContractSync コラボレーション・オブジェクトの残りのポートをこの文書の『ポート情報』節の説明にしたがってバインドします。
  4. ContractSync コラボレーション・オブジェクトの VERIFY_SYNC_BusObj プロパティーを設定します。この例では、以下のプロパティーに次の推奨値を設定または保持します。
  5. ContractSync コラボレーション・オブジェクトの ITEM_TYPE を適切な品目タイプに設定します。
  6. ItemWrapper コラボレーション・オブジェクトを構成して、To ポートを ItemSync の From ポートにバインドします。
  7. ItemWrapper コラボレーション・オブジェクトの残りのポートをバインドします。詳しくは、Wrapper コラボレーションの参照ページの『ポート情報』を参照してください。注: ItemWrapper コラボレーション・オブジェクトの From ポートは、System Manager によってすでに ContractSync の To ポートへバインドされていることがあります。
  8. ItemSync コラボレーション・オブジェクトを編集して、そのポートをバインドします。詳しくは、ItemSync コラボレーションの参照ページの『ポート情報』を参照してください。
  9. 各コラボレーション・オブジェクトの構成プロパティーを設定します。詳しくは、以下を参照してください。

Contact または Customer を同期する場合、それらに関連するコラボレーションを上記に示した手順と同様に構成します。

コラボレーション・テンプレートのプロセス

この節では、このコラボレーション・テンプレートのプロセス・ロジックについて説明します。

プロセス・ロジックの概要

図 2 に、ContractSync のプロセス・ロジックを示します。

図 2. ContractSync コラボレーション: プロセス・ロジック

注: アプリケーションによっては、レコードが物理的に削除されません。ソース・アプリケーションは、連絡先のステータスを削除する代わりに非アクティブにすることもあります。この場合、コラボレーションは Contact ビジネス・オブジェクトを動詞 Update とともに受信します。特定のアプリケーション・プロセスによる削除方法については、コネクター文書を参照してください。

継承されたプロセス・ロジック

このコラボレーション・テンプレートでは、以下の標準コラボレーション・ビジネス・プロセスが使用されます。

これらのビジネス・プロセスについては、『Required Documents for Creating Collaboration Objects』を参照してください。

Customer と CustomerPartner の検証または同期

図 3 は、Customer、Header Contact、および Line Item Contactの検証および同期に関する ContractSync のプロセスを示します。

ContractSync は次の順番で Wrapper コラボレーションを呼び出します。Customer、Contact (Header Contact)、Item、Contact (Line Item Contact)。

図 3. Customer、Header Contact、および Line Item Contact の検証または同期

Item の検証または同期

図 4 に、関連 Item の検証および同期に関する ContractSync のプロセスを示します。

図 4. Item の検証または同期

注: コラボレーションが ItemBasic、ItemOrder、および ItemPlanning を正常に処理するには、インストールのリポジトリーに Utility ビジネス・オブジェクトが含まれている必要があります。このビジネス・オブジェクトはコラボレーション・コード内で参照され、これによって一時的イテレーター変数がインスタンス化されます。このオブジェクトがリポジトリーに存在しない場合、コラボレーションは失敗します。

差し戻し処理

InterChange Server は、トランザクション・コラボレーションのいずれかのステップで失敗が発生した場合、トランザクションをロールバックできます。例えば、ContractSync がトランザクションのコラボレーションに参加するコラボレーション・オブジェクト・グループのメンバーである場合、ContractSync のアクションは、より大きなトランザクションの 1 つのサブトランザクション・ステップとなります。コラボレーション・オブジェクト・グループのビジネス・プロセスでいずれかのステップが失敗すると、トランザクション・コラボレーションは InterChange Server がグループ内のコラボレーションの処理をどのようにロールバックすればよいか明示します。

ContractSync コラボレーション・オブジェクトをほかのコラボレーション・オブジェクトと無関係に使用する場合、または From ポートを別のコラボレーションではなくソース・アプリケーションにバインドする場合、そのプロセスを構成するトランザクション・ステップは 1 つのみになります。このような場合には、ロールバックを実行する必要はありません。

1 つのコラボレーション・オブジェクト、またはコラボレーション・オブジェクト・グループにロールバックを実行させるには、コラボレーション・テンプレートを変更する必要があります。WebSphere Business Integration システムにおけるトランザクション処理を理解するためには、「テクニカル入門 (IBM WebSphere InterChange Server)」を参照してください。コラボレーション・テンプレートへのトランザクション処理の追加については、『Required Documents for Creating Collaboration Objects』を参照してください。

トランザクション処理を実行できるようにコラボレーション・オブジェクトを拡張するには、以下の手順を完了します。

  1. この機能を、そのコラボレーション・テンプレートと、コラボレーション・オブジェクト・グループ内の他のすべてのコラボレーション・テンプレートに追加します。
  2. コラボレーション・オブジェクト、およびコラボレーション・オブジェクト・グループのすべてのメンバーの最小トランザクション・レベルを、None より大きい値に設定します。「最小限の努力」以上に設定した場合、いずれかのサブトランザクション・ステップで失敗が発生すると、このコラボレーション・オブジェクトおよびグループ内のほかのコラボレーション・オブジェクトは、すべてのビジネス・オブジェクトに対して実行された Create、Update、および Delete 操作に対して差し戻しを実行します。
  3. コラボレーション・オブジェクト、およびコラボレーション・オブジェクト・グループの他のすべてのメンバーの USE_RETRIEVE プロパティーを「true」に設定します。コラボレーション・オブジェクトに対して、値を変更する前に検索するように強制すると、コラボレーション・オブジェクトは Update または Delete プロセスの際に元の値を復元できるようになります。

構成プロパティー設定のチェックリスト

Contract Manager コラボレーション・オブジェクト・グループは 4 つのコラボレーションで構成されているため、要件に沿った動作を実現するにはすべてのコラボレーションを構成することが重要です。以下のチェックリストは、4 つすべてのコラボレーションに関する構成プロパティーを指定します。


ゴール プロパティー 設定
同期前に Contract を宛先アプリケーションから検索します。 USE_RETRIEVE 「true」
トリガーとなる Contract に関連する Item、Contact、または Customer を検証します。 VERIFY_SYNC_ITEM VERIFY_SYNC_CONTACT VERIFY_SYNC_CUSTOMERS 「verify」
トリガーとなる Contract に関連する Item、Contact、または Customer を同期します。 VERIFY_SYNC_ITEM VERIFY_SYNC_CONTACT VERIFY_SYNC_CUSTOMERS 「sync」
ContractSync のトリガー・ビジネス・オブジェクトが宛先に存在する場合に、Create 要求を Update 要求に変換します。 CONVERT_CREATE 「true」
無効な契約が見つかった場合に、コラボレーションの処理を中止します。 FAIL_ON_CONTACT_ERROR 「true」
ContractSync のトリガー・ビジネス・オブジェクトが宛先に存在しない場合に、Update 要求を Create 要求に変換する CONVERT_UPDATE 「true」

ContractWrapperのプロパティー設定方法


ゴール プロパティー 設定
Contract データの検証または同期が失敗した場合に、ContractWrapper コラボレーションが警告を記録し、成功ステータスを呼び出しコラボレーションに戻すよう指定します。 CONTINUE_WITH_WARNING 「true」

構成プロパティー

この節では、このコラボレーション・テンプレートの標準プロパティーおよび固有のプロパティーについて説明します。

標準プロパティー

このコラボレーション・テンプレートでは、以下のコラボレーション・テンプレートの標準構成プロパティーを使用します。

これらの構成プロパティーについては、『Required Documents for Creating Collaboration Objects』を参照してください。

このコラボレーション・テンプレート固有のプロパティー

このコラボレーション・テンプレートには、標準構成プロパティーに加えて、以下に示す構成プロパティーがあります。

ContractSync コラボレーション・テンプレート固有の構成プロパティー

プロパティー名とその説明 可能な値 デフォルト値

FAIL_ON_CONTACT_ERROR 「false」に設定すると、コラボレーションは無効な連絡先を削除し、処理を続行します。

「true」に設定値すると、処理を中止します。

false、true true

ITEM_TYPE ラッパーに送信される Item ビジネス・オブジェクトの一種。

Item、ItemBasic、ItemOrder、または ItemPlanning

Item

VERIFY_SYNC_CONTACT

「sync」に設定すると、ContractSync が宛先アプリケーション内の関連する Contact を同期します。ContractSync は、各 Contact ビジネス・オブジェクトを Sync 動詞とともに ContactWrapper に送信します。これを受けて、ContactWrapper がすべての属性に対する値をソース・アプリケーションから検索し、ビジネス・オブジェクトを Create 動詞とともに宛先に送信します。ContactWrapper が Contact ビジネス・オブジェクトの作成に失敗した場合、ContractSync はエラー・メッセージ番号 5010 をログに書き込み、終了します。ContactWrapper がすべての Contact ビジネス・オブジェクトの作成に成功し、トレース・レベルが 3 以上に設定されている場合、情報メッセージ番号 5020 がトレース宛先に表示されます。「verify」を設定すると、宛先アプリケーションの Contact が検証されます。ContractSync は、各 Contact ビジネス・オブジェクトを Exists 動詞とともに HYPERLINK "..\\Wrapper/Wrapper.pdf"ContactWrapper に送信します。次に、ContactWrapper は宛先アプリケーションからビジネス・オブジェクトを検索します。ContactWrapper が Contact ビジネス・オブジェクトの検索に失敗した場合、ContractSync はエラー・メッセージ番号 5010 をログに書き込み、終了します。ContactWrapper がすべての Contact ビジネス・オブジェクトの検証に成功し、トレース・レベルが 3 以上に設定されている場合、情報メッセージ番号 5020 がトレース宛先に表示されます。

「neither」に設定すると、ContractSync は最初に関連の Contact を同期または検証せずにトリガー Contract ビジネス・オブジェクトを同期します。

注: メッセージ番号に対応するメッセージの内容については、以下のコラボレーション・メッセージ・ファイル (\collaborations\messages\ContractSync.txt) を参照してください。

neither、sync、verify sync

VERIFY_SYNC_CUSTOMERS

「sync」に設定すると、宛先アプリケーション内の関連する Customer を同期します。ContractSync は、そのビジネス・オブジェクトを Sync 動詞とともに CustomerWrapper に送信します。これを受けて、CustomerWrapper がすべての属性に対する値をソース・アプリケーションから検索し、ビジネス・オブジェクトを Create 動詞とともに宛先に送信します。この同期コラボレーションが Customer の作成に失敗した場合、ContractSync はエラー・メッセージ番号 5010 をログに書き込み、終了します。CustomerWrapper がすべての Customer ビジネス・オブジェクトの作成に成功し、トレース・レベルが 3 以上に設定されている場合、情報メッセージ番号 5020 がトレース宛先に表示されます。「verify」を設定すると、宛先アプリケーションの Customer が検証されます。ContractSync は、そのビジネス・オブジェクトを Exists 動詞とともに CustomerWrapper に送信します。次に、CustomerWrapper は宛先アプリケーションからビジネス・オブジェクトを検索します。CustomerWrapper が Customer ビジネス・オブジェクトの検索に失敗した場合、ContractSync はエラー・メッセージ番号 5010 をログに書き込み、終了します。CustomerWrapper がすべての Customer ビジネス・オブジェクトの検証に成功し、トレース・レベルが 3 以上に設定されている場合、情報メッセージ番号 5020 がトレース宛先に表示されます。

「neither」に設定すると、ContractSync は最初に宛先アプリケーションのCustomer を同期または検証せずに、Contract ビジネス・オブジェクトを作成します。

注: メッセージ番号に対応するメッセージの内容については、以下のコラボレーション・メッセージ・ファイル (\collaborations\messages\ContractSync.txt) を参照してください。

neither、sync、verify sync

VERIFY_SYNC_ITEM

「sync」に設定すると、ContractSync が宛先アプリケーション内の関連する Item を同期します。ContractSync は、そのビジネス・オブジェクトを動詞 Sync (キー・フィールドの値のみ) とともに ItemWrapper に送信します。次に、ItemWrapper はすべての属性の値をソース・アプリケーションから検索し、汎用ビジネス・オブジェクトを Create 動詞とともに ItemSync に送信します。ItemWrapper が関連する Item の作成に失敗した場合、ContractSync はエラー・メッセージ番号 5010 をログに書き込み、終了します。ItemWrapper がすべての関連する Item の作成に成功し、トレース・レベルが 3 以上に設定されている場合、情報メッセージ番号 5020 がトレース宛先に表示されます。

「verify」に設定すると、ContractSync は、宛先アプリケーションのアイテムを検証します。ContractSync は、そのビジネス・オブジェクトを Exists 動詞とともに ItemWrapper に送信します。次に、ItemWrapper は宛先アプリケーションからビジネス・オブジェクトを検索します。ItemWrapper が関連 Item の検索に失敗した場合、ContractSync はエラー・メッセージ番号 5010 をログに書き込み、終了します。ItemWrapper がすべての関連する品目の検証に成功し、トレース・レベルが 3 以上に設定されている場合、情報メッセージ番号 5020 がトレース宛先に表示されます。

「neither」に設定すると、ContractSync は最初に宛先アプリケーションの関連のアイテムを同期したり、既存の関連アイテムを検証したりせずにトリガー Contract ビジネス・オブジェクトを同期します。

neither、sync、verify sync

コラボレーション・メッセージ

注: 警告や情報を提供するメッセージがトレース先に表示されるのは、トレース・レベルが 3 以上に設定されている場合のみです。トレース・レベルは、INFORMATIONAL_EXCEPTIONS と SEND_EMAIL の各プロパティーで設定します。

このコラボレーション・テンプレートのメッセージの説明を表示するには、Log Viewer を起動し、コラボレーション・テンプレートのメッセージ・ファイルを開いてください。Log Viewer を起動してコラボレーション・テンプレートのメッセージ・ファイルを開くには、以下の手順に従います。

  1. 「スタート」メニューで、「プログラム」>「IBM WebSphere InterChange Server」>「IBM WebSphere Business Integration Toolset」>「Administrative」>「Log Viewer」の順にクリックします。
  2. 「ファイル」メニューで、「開く」をクリックします。
  3. 「Look In」フィールドを使用して、現在のフォルダーを WebSphere_ICS_root_dir \collaborations \messages に変更し、このコラボレーション・テンプレートのメッセージ・ファイルを選択します。

アップグレード情報

アップグレード処理

このコラボレーション・テンプレートのより新しいバージョンにアップグレードするには、以下の手順を行います。

  1. ContractSync バージョン x.x.x コラボレーション・テンプレートを停止します。
  2. リポジトリーをバックアップします。詳しくは、「システム管理ガイド」を参照してください。
  3. コラボレーション・テンプレートをカスタマイズしている場合には、以下の手順を行います。
  4. 新規の ContractSync コラボレーション・テンプレートをインストールします。
  5. 新しいコラボレーション・テンプレートにカスタマイズを追加します。
  6. 新しいコラボレーション・オブジェクトを作成し、適切なコネクターにバインドします。 詳しくは、『コラボレーション・オブジェクトのセットアップ』を参照してください。
  7. 新しいコラボレーション・オブジェクトを実行してテストします。
  8. テスト中に見つかった問題点に基づいて、コラボレーション・オブジェクトを変更します。

Copyright IBM Corp. 1997, 2003