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

サイト情報は、顧客用の設置ベースを管理する組織が使用します。 一般的に、サイトとは組織の製品が設置された場所を表します。

Site は、Contract、Case、Service Order、および Return Material Authorizations (RMA) で参照されます。 顧客サービス担当者、サービス技術員、および配送担当者は、サイト情報を使用する必要があります。 この情報は複数のシステム間で配布される場合があるため、情報の整合性の維持と、すべてのシステムを確実に最新情報と同期させることは、企業における重要な課題になります。

SiteSync コラボレーション・テンプレートは、サイト情報を使用するすべてのシステム間で、情報を維持および同期するため共通のプロセスを指定し、この課題に対処します。この結果、組織全体でサイト情報が共通に認識されます。 SiteSync は、カスタマー・インタラクション・マネージメント (CIM) アプリケーションとエンタープライズ・リソース・プランニング (ERP) アプリケーション間でサイト情報を同期します。 これらのアプリケーションのどちらも、同期される情報のソースまたは宛先となることができます。

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

サイトとその参照先顧客の同期

サイト情報には、サイトと他の関連する顧客との関係が含まれる場合があります。 例えば、サイトが SoldTo 顧客にリンクしている場合や、他の取引先 (ShipTo 住所や BillTo 住所) にリンクしている場合です。

IBM では、サイトに関する情報を 汎用 Site ビジネス・オブジェクトに格納します。サイトの RelatedCustomerRef 子ビジネス・オブジェクトには、サイトの参照先顧客および住所それぞれのキーが格納されます。 RelatedCustomerRef の ObjectType 属性は、参照先顧客が Customer であるか CustomerPartner であるかを示します。 SiteSync は Site ビジネス・オブジェクトを使用して、複数のアプリケーション間で、サイトとその参照先顧客を同期します。

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

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

CustomerPartner

VERIFY_SYNC_CUSTOMERPARTNERS CustomerPartnerWrapper CustomerPartnerSync

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

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

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

ポート情報

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

図 1. SiteSync のポート

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

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

Retrieve


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

ポート名: To
ビジネス・オブジェクト バインド先 機能 使用される動詞
Site 宛先アプリケーションのコネクター トリガー・ビジネス・オブジェクトをコラボレーションから送信します。 Create Update Delete

ポート名: ToCustomerWrapper
ビジネス・オブジェクト バインド先 機能 使用される動詞
Customer CustomerWrapper コラボレーションの Form ポート

Customer ビジネス・オブジェクトを CustomerWrapper コラボレーションに送信します。 トリガーとなる動詞に応じて、CustomerWrapper は以下のいずれかを実行します。

  • トリガーとなる動詞が Exists の場合、宛先アプリケーション内の関連する SoldTo 顧客を検証します。
  • トリガーとなる動詞が Sync の場合、CustomerSync を呼び出して、関連する SoldTo 顧客を宛先内に作成します。

いずれの場合も、CustomerWrapper は SiteSync に状況を戻します。

Exists Sync


ポート名: ToCustomerPartnerWrapper
ビジネス・オブジェクト バインド先 機能 使用される動詞
Customer Partner Customer PartnerWrapper コラボレーションの From ポート

CustomerPartner ビジネス・オブジェクトを CustomerPartnerWrapper コラボレーションに送信します。

トリガーとなる動詞に応じて、CustomerPartnerWrapper は以下のいずれかを実行します。

  • トリガーとなる動詞が Exists の場合、宛先アプリケーション内の関連する SoldTo 顧客を検証します。
  • トリガーとなる動詞が Sync の場合、CustomerPartner を同期します。

いずれの場合も、CustomerPartnerWrapper は SiteSync に状況を戻します。

Exists Sync

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

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

SiteSync をスタンドアロンのコラボレーションとして使用する手順は、以下のとおりです。

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

 

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

関連する Customer および CustomerPartner を SiteSync プロセスの一環として検証または同期する場合、SiteSync をコラボレーション・オブジェクト・グループ内で使用します。 以下のコラボレーション・オブジェクト・グループの任意の組み合わせを作成できます。


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

以下に、SiteSync をコラボレーション・オブジェクト・グループの一部として設定する手順を示します。

例として、以下の手順では、Site とその参照先 SoldTo Customer を同期しますが、参照先 CustomerPartner は同期しないものとします。

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

注: 参照先 Customer のほかに参照先 CustomerPartner を同期するには、上記の手順に従って、ポート (ToCustomerPartnerWrapper) をバインドし、構成プロパティー (VERIFY_SYNC_CUSTOMERPARTNERS) を設定し、必要なコラボレーション・オブジェクト (CustomerPartnerWrapper および CustomerPartnerSync) を作成および構成します。

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

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

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

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

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

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

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

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

Customer と CustomerPartner の検証または同期

図 3 に、SiteSync が関連する Customer および CustomerPartner を検証または同期するプロセスを示しています。

注: 各 Site ビジネス・オブジェクトには、複数のカーディナリティーを持つ RelatedCustomerRef ビジネス・オブジェクトが含まれます。SiteSync は、含まれている RelatedCustomerRef ビジネス・オブジェクトの配列をループし、その ObjectType 属性を検査します。 ObjectType 属性を「Customer」と評価すると、SiteSync は、それぞれに Customer ビジネス・オブジェクトを作成し、それを CustomerWrapper に送信します。 ObjectType 属性を「CustomerPartner」と評価すると、SiteSync は、それぞれに CustomerPartner ビジネス・オブジェクトを作成し、それを CustomerPartnerWrapper に送信します。

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

Customer および CustomerPartner への参照の更新

SiteSync が Site ビジネス・オブジェクトを Update 動詞とともに宛先に送信する場合、同期により Customer または CustomerPartner との関係 が更新されますが、この同期によって Customer または CustomerPartner が実際に作成、更新、または削除されるわけではありません。

例えば、Site が Customer または CustomerPartner への参照を削除する場合、アプリケーションは Customer または CustomerPartner を削除しません (物理的削除も論理的削除もしません)。 アプリケーションは、単純に Customer または CustomerPartner への参照を除去します。つまり、Customer または CustomerPartner を除去することなく、Customer または CustomerPartner との関係を除去します。

図 4 に、SiteSync によって同期された Site No.100 のデータを示します。 ソースと宛先のアプリケーションの両方に、同じ 3 つの Customer または CustomerPartner が関連付けられた同一の基本 Site が含まれています。

図 4. Customer および CustomerPartner への参照を削除する前の Site データ

図 5 に、ソース・アプリケーションのいずれかの Customer または CustomerPartner が削除された後の同じ基本 Site を示します。 子ビジネス・オブジェクトが削除されると、ソース・コネクターは Site ビジネス・オブジェクトを Update 動詞とともに SiteSync に送信します。 次の図は、宛先アプリケーションが関連する Customer または CustomerPartner への参照を削除する前に、SiteSync が Site ビジネス・オブジェクトを宛先アプリケーションに送信するときの Site ビジネス・オブジェクトの状態を示しています。

図 5. ソース・アプリケーションが Customer および CustomerPartner への参照を削除した後の Site データ

図 6 は、宛先アプリケーションで関連する Customer または CustomerPartner への参照が削除された後の Site ビジネス・オブジェクトの状態を示しています。

図 6. 宛先アプリケーションでの同期後の Site データ

差し戻し処理

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

SiteSync コラボレーション・オブジェクトをほかのコラボレーション・オブジェクトと無関係に使用する場合、または 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』を参照してください。

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

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

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

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

VERIFY_SYNC_CUSTOMERS

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

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

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

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

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

verify、sync、neither neither

VERIFY_SYNC_CUSTOMERS

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

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

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

  1. 顧客の固有キーを取得し、Site の RelatedCustomerRef 子ビジネス・オブジェクトからそのタイプ (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. 現在の SiteSync コラボレーションを停止します。
  2. リポジトリーをバックアップします。詳しくは、「システム管理ガイド」を参照してください。
  3. コラボレーション・テンプレートをカスタマイズしている場合には、以下の手順を行います。
  4. 新規の SiteSync コラボレーション・テンプレートをインストールします。
  5. 新しいコラボレーション・テンプレートにカスタマイズを追加します。
  6. 新しいコラボレーション・オブジェクトを作成し、適切なコネクターにバインドします。 詳しくは、『コラボレーション・オブジェクトのセットアップ』を参照してください。
  7. 新しいコラボレーション・オブジェクトを実行してテストします。
  8. テスト中に見つかった問題点に基づいて、コラボレーション・オブジェクトを変更します。 

Copyright IBM Corp. 1997, 2003