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

ContactSync コラボレーションは、特定の顧客連絡先に関するデータをソース・アプリケーションと宛先アプリケーションの間で同期します。このコラボレーションは、各顧客サイトでユーザーの組織との連絡を担当する人物に関する情報を含む汎用 Contact ビジネス・オブジェクトを使用します。連絡先情報の同期化により、企業でデータが追加、変更、または削除されても、個々のアプリケーションで矛盾なく情報を共有できます。ContactSync が同期するのは Contact のみですが、適切なコラボレーションを呼び出して次の関連ビジネス・オブジェクトを検証または同期するよう構成できます。

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

CustomerPartner

VERIFY_SYNC_CUSTOMERPARTNERS CustomerPartnerWrapper CustomerPartnerSync

この文書では、コラボレーション・テンプレートの作成および構成方法とそのビジネス・プロセスについて説明します。

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

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

ポート情報

図 1 に、System Manager で表示される ContactSync のポートを示します。各ポートについての情報は、図の後にある表に示します。

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

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

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

Retrieve


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

Create Retrieve Update Delete


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

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

Create Update Delete


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

Sync Exists


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

Sync Exists

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

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

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

  1. ContactSync コラボレーション・オブジェクトを作成します。
  2. 各コラボレーション・オブジェクトの ToBusObjWrapper ポートを宛先アプリケーションのコネクターまたはポート・コネクターにバインドします。例えば、ToCustomerWrapper ポートをポート・コネクターにバインドします。
  3. ポート情報』の説明に従って、残りのポートをバインドします。
  4. このコラボレーション・オブジェクトの VERIFY_SYNC_BusObj 構成プロパティーのデフォルト値「neither」は変更しません。
  5. ContactSync の残りの構成プロパティーを設定します。 

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

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


検証 同期 必要なコラボレーション
Customer   ContactSync、CustomerWrapper
  Customer ContactSync、CustomerWrapper、CustomerSync
CustomerPartner   ContactSync、CustomerPartnerWrapper
  CustomerPartner ContactSync、CustomerPartnerWrapper、CustomerPartnerSync

以下に、ContactSync をコラボレーション・オブジェクト・グループの一部として設定する手順を示します。以下の手順では、Contact をその参照 CustomerPartner ではなく参照 SoldTo Customerと同期するものとします。

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

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

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

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

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

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

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

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

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

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

Customer と CustomerPartner の検証または同期

図 3 に、Customer と CustomerPartner の検証および同期に関する ContactSync のプロセスを示します。

注: 各 Contact ビジネス・オブジェクトには、ContactCustomer ビジネス・オブジェクトが単一のカーディナリティーとともに含まれています。ContactCustomer の RoleName 属性が「Customer」である場合、ContactSync は Customer ビジネス・オブジェクトを作成し、CustomerWrapper へ送信します。RoleName が「CustomerPartner」である場合、ContactSync は CustomerPartner ビジネス・オブジェクトを作成し、CustomerPartnerWrapper へ送信します。

図 3: Customer と CustomerPartner の検証または同期

差し戻し処理

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

ContactSync コラボレーション・オブジェクトをほかのコラボレーション・オブジェクトと無関係に使用する場合、または 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 プロセスの際に元の値を復元できるようになります。

構成プロパティー

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

標準プロパティー

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

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

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

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

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

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

VERIFY_SYNC_CUSTOMERS

「sync」に設定すると、このコラボレーションは、宛先アプリケーション内の関連する SoldTo Customer を同期します。コラボレーションは、以下のステップを実行します。

  1. 顧客の固有キーを取得し、Contact の ContactCustomer 子ビジネス・オブジェクトからそのタイプ (Customer) を判別します。
  2. CustomerId をトリガー・ビジネス・オブジェクトからコピーし、新たに作成する汎用 Customer ビジネス・オブジェクトの固有の ID として使用します。
  3. ビジネス・オブジェクトを Sync 動詞とともに CustomerWrapper に送信します。CustomerWrapper がすべての属性に対する値をソース・アプリケーションから検索し、ビジネス・オブジェクトを Create 動詞とともに CustomerSync に送信します。
  4. 同期コラボレーションが Customer の作成に失敗した場合、このコラボレーションは INFORMATIONAL_EXCEPTIONS プロパティーで指定されたとおりにエラーを処理します。

「verify」に設定すると、このコラボレーションは、宛先アプリケーション内の関連する Customer を検証します。コラボレーションは、以下のステップを実行します。

  1. 顧客の固有キーを取得し、Contact の ContactCustomer 子ビジネス・オブジェクトからそのタイプ (Customer) を判別します。
  2. CustomerId をトリガー・ビジネス・オブジェクトからコピーし、新たに作成する汎用 Customer ビジネス・オブジェクトの固有の ID として使用します。
  3. ビジネス・オブジェクトを Exists 動詞とともに CustomerWrapper に送信します。CustomerWrapper が宛先アプリケーションからビジネス・オブジェクトを検索します。
  4. Wrapper コラボレーションが Customer の検索に失敗した場合、このコラボレーションは INFORMATIONAL_EXCEPTIONS プロパティーで指定されたとおりにエラーを処理します。

「neither」に指定すると、このコラボレーションがトリガー・ビジネス・オブジェクトを同期するときに、宛先アプリケーション内の関連する Customer を最初に同期することはありません。VERIFY_SYNC_CUSTOMERPARTNERS

verify、sync、neither neither

VERIFY_SYNC_CUSTOMERPARTNERS

「sync」に設定すると、このコラボレーションが、SoldTo Customer に関連付けて保管している補助的な顧客情報 (BillTo データや ShipTo データ) を同期します。コラボレーションは、以下のステップを実行します。

  1. 顧客の固有キーを取得し、Contact の ContactCustomer 子ビジネス・オブジェクトからそのタイプ (CustomerPartner) を判別します。
  2. CustomerPartnerId をトリガー・ビジネス・オブジェクトからコピーし、新たに作成する汎用 CustomerPartnerId ビジネス・オブジェクトの固有の ID として使用します。
  3. ビジネス・オブジェクトを Sync 動詞とともに CustomerPartnerWrapper に送信します。 CustomerPartnerWrapper がすべての属性に対する値をソース・アプリケーションから検索し、ビジネス・オブジェクトを Create 動詞とともに CustomerPartnerSync に送信します。
  4. 同期コラボレーションが CustomerPartner の作成に失敗した場合、このコラボレーションは INFORMATIONAL_EXCEPTIONS プロパティーで指定されたとおりにエラーを処理します。

「verify」に設定すると、このコラボレーションは、宛先アプリケーション内で関連する CustomerPartner を検証します。コラボレーションは、以下のステップを実行します。

  1. 顧客の固有キーを取得し、Contact の ContactCustomer 子ビジネス・オブジェクトからそのタイプ (CustomerPartner) を判別します。
  2. CustomerPartnerId をトリガー・ビジネス・オブジェクトからコピーし、新たに作成する汎用 CustomerPartnerId ビジネス・オブジェクトの固有の ID として使用します。
  3. ビジネス・オブジェクトを Exists 動詞とともに CustomerPartnerWrapper に送信します。CustomerPartnerWrapper が宛先アプリケーションからビジネス・オブジェクトを検索します。
  4. Wrapper コラボレーションが CustomerPartner の検索に失敗した場合、このコラボレーションは INFORMATIONAL_EXCEPTIONS プロパティー指定されたとおりにエラーを処理します。

「neither」に指定すると、このコラボレーションがトリガー・ビジネス・オブジェクトを同期するときに、宛先アプリケーション内の関連 CustomerPartner を最初に同期することはありません。

sync、verify、neither

neither

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

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

Copyright IBM Corp. 1997, 2003