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

ProductInstallation は、サービス管理や顧客サービスと言われるより大きなビジネス・プロセスの一部として、InstalledProductSync コラボレーション・テンプレートとともに使用します。このビジネス・プロセスは、顧客サイトに設置された商品へのアフター・サービスを提供する設置ベースを企業が管理するために使用します。

ProductInstallation によって、企業が設置ベースを使用して、フロント・オフィスおよびバック・オフィスのアプリケーションのユーザーが顧客サイトに設置されている商品を把握できるようになります。 IBM では、ProductInstallation を使用する企業が以下のようにフロント・オフィスおよびバック・オフィスのアプリケーションを使用すると想定しています。

バック・オフィス・アプリケーションが、設置ベースの一部として管理されている商品を配送する場合、イベントは汎用 InstallShipment ビジネス・オブジェクトを送信します。InstallShipment は ProductInstallation を起動し、ProductInstallation はフロント・オフィス・アプリケーションに設置済み商品オブジェクトを作成します。 次に、フロント・オフィス・アプリケーションはその設置済み商品の任意のケース、契約、および送り状を処理します。

ProductInstallation がサブスクライブする汎用 InstallShipment ビジネス・オブジェクトには配送情報しか含まれませんが、InstallShipment は InstalledProduct ビジネス・オブジェクトを作成するために ProductInstallation の情報が十分に含まれるよう設計されています。 ProductInstallation は、宛先アプリケーションに InstalledProduct ビジネス・オブジェクトを送信します。

注: InstalledProducts の修正や削除を許可したり、参照先ビジネス・オブジェクト (Contacts、Customers、CustomerPartners、Items、および Sites) の検証や同期を許可するには、ProductInstallation の Send ポートを InstalledProductSync にバインドします。詳しくは、『ポート情報』を参照してください。

問題と前提事項

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

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

ポート情報

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

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

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

ポート名: DestinationAppRetrieve
ビジネス・オブジェクト バインド先 機能 使用される動詞
なし ポート・コネクター ProductInstallation はこのポートを使用しません。 ProductInstallation は宛先からビジネス・オブジェクトを検索しないので、USE_RETRIEVE プロパティーのデフォルト値「false」を保持する必要があります。 なし

ポート名: From
ビジネス・オブジェクト バインド先 機能 使用される動詞
InstallShipment ソース・アプリケーションのコネクター、または呼び出し側コラボレーション トリガー・ビジネス・オブジェクトを受け取ります。

Create Retrieve Update Delete


ポート名: To
ビジネス・オブジェクト バインド先 機能 使用される動詞
InstalledProduct

宛先アプリケーションのコネクター (InstalledProduct を作成する場合のみ)

InstalledProductSync の From ポート (InstalledProduct の変更と削除、および参照される Contact、Customer、CustomerPartner、Item、Site の検証または同期を可能にします)

InstallShipment の InstallShipmentLine ビジネス・オブジェクト配列に含まれるビジネス・オブジェクトごとに、1 つの InstalledProduct ビジネス・オブジェクトをコラボレーションの外部に送信します。

Create

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

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

バック・オフィス・アプリケーションが注文配送業務のみを処理するので、トリガー・デリバリー・オブジェクトで参照される Contact、Customer、CustomerPartner、Item、Site を検証または同期する必要がない場合、ProductInstallation をスタンドアロンとして使用します。 ProductInstallation をスタンドアロンのコラボレーションとして作成する手順は、以下のとおりです。

  1. ProductInstallation コラボレーション・オブジェクトを作成します。
  2. コラボレーション・オブジェクトの From ポートをソース・アプリケーションのコネクターに、To ポートを宛先アプリケーションのコネクターにバインドします。
  3. ポート情報』の説明に従って、DestinationAppRetrieve ポートをポート・コネクターにバインドします。
  4. ProductInstallation の ADDITIONAL_RETRIEVE、CONVERT_CREATE、CONVERT_UPDATE、および USE_RETRIEVE 構成プロパティーのデフォルト値「false」を保持します。
  5. フィルター操作を使用可能にするには、フィルター操作プロパティーを設定します。 例外処理を指定するには、INFORMATIONAL_EXCEPTIONS および SEND_EMAIL プロパティーを設定します。 詳しくは、『構成プロパティー』を参照してください。  

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

ProductInstallation プロセスの一環として、関連する Contact、Customer、CustomerPartner、(特定タイプの) Item、Site を検証または同期するには、以下のコラボレーション・オブジェクト・グループの任意の組み合わせを作成します。


検証 同期 必要なコラボレーション
Contact   ProductInstallation、InstalledProductSync、ContactWrapper
  Contact ProductInstallation、InstalledProductSync、ContactWrapper、ContactSync
Customer   ProductInstallation、CustomerWrapper
  Customer ProductInstallation、InstalledProductSync、CustomerWrapper、CustomerSync
CustomerPartner   ProductInstallation、InstalledProductSync、CustomerPartnerWrapper
  CustomerPartner ProductInstallation、InstalledProductSync、CustomerPartnerWrapper、CustomerPartnerSync
Item   ProductInstallation、InstalledProductSync、ItemWrapper
  Item ProductInstallation、InstalledProductSync、ItemWrapper、ItemSync
Site   ProductInstallation、InstalledProductSync、SiteWrapper
  Site ProductInstallation、InstalledProductSync、SiteWrapper, SiteSync
  InstalledProduct(Create のほかに Update および Delete) ProductInstallation、InstalledProductSync

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

以下の手順は、ProductInstallation をコラボレーション・グループの一部としてセットアップするためのステップを示しています。

  1. ProductInstallation および必要なラッパーや同期コラボレーションのテンプレートからコラボレーション・オブジェクトを作成します。
  2. ProductInstallation コラボレーション・オブジェクトを編集して、To ポートを InstalledProductSync の From ポートに、From ポートをソース・アプリケーションのコネクターにバインドします。
  3. コラボレーション・オブジェクト・グループのメンバーである各コラボレーション・オブジェクトのポートをバインドします。 詳しくは、各コラボレーションの参照資料の『ポート情報』節を参照してください。
  4. ProductInstallation のコラボレーション・プロパティーを設定します。
  5. メンバーである各コラボレーション・オブジェクトのコラボレーション・プロパティーを設定します。 詳しくは、各コラボレーションの参照資料の『構成プロパティー』節を参照してください。

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

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

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

主なビジネス・プロセスには、InstalledProduct ビジネス・オブジェクトの階層の同期があります。 図 2 は、ProductInstallation の主なビジネス・プロセスを示しています。

図 2. ProductInstallation コラボレーションの主なビジネス・プロセス

ProductInstallation は InstallShipment によって起動されます。InstallShipment には、複数のカーディナリティーを持つ InstallShipmentLine という子ビジネス・オブジェクトあります。 それぞれの InstallShipmentLine 子ビジネス・オブジェクトにおいて、ProductInstallation は対応する InstalledProduct を Create 動詞とともに To ポートを介して送信します。 ProductInstallation は、最初に最上位の親 InstalledProduct ビジネス・オブジェクト (つまり親を持たない親) を送信します。 次に、コラボレーションはそのビジネス・オブジェクトの直接の子を送信します。 含まれる InstallShipmentLine ごとに 1 つの InstalledProduct が完全に送信されるまで、次の直接の子を送信します。

: ProductInstallation が親ビジネス・オブジェクトを正しい順序で送信するように、InstallShipmentLine ビジネス・オブジェクトの配列は、最上位に親を置き、それに直接の子が続くように並べる必要があります。各子ビジネス・オブジェクトには、自身の直接の子が続く必要があります。 配列の最後のビジネス・オブジェクトは、自身の子を持たない子である必要があります。

コラボレーションのプロセスを理解するため、InstallShipmentLine に 3 つのビジネス・オブジェクトが含まれているとします。 この場合、ProductInstallation は以下の手順を行います。

  1. InstallShipmentLine ビジネス・オブジェクトの配列から最初のビジネス・オブジェクトを取得し、そこから InstalledProduct ビジネス・オブジェクトを作成します。 最初の InstallShipmentLine ビジネス・オブジェクトは、親を持っていない (つまり LineNoOfParent 属性がヌルと評価される) ことが必要です。 ProductInstallation が作成する最初の InstalledProduct ビジネス・オブジェクトには、ParentId 属性に null、HierachyLevel 属性に値 1 が含まれます。
  2. InstalledProduct ビジネス・オブジェクトを Create 動詞とともに To ポートを介して送信します。
  3. Create が成功したら、次の子 InstallShipmentLine から InstalledProduct ビジネス・オブジェクトを作成します。 直前に送信した InstalledProduct の ObjectId 属性の値を使用して、現在のビジネス・オブジェクトの親を識別します。 また、HierachyLevel 属性の値を 1 ずつ増分し、すべての属性に移植します。 2 番目の InstalledProduct を送信します。
  4. Create が成功したら、3 番目の InstallShipmentLine ビジネス・オブジェクトにステップ 3 を繰り返します。

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

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

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

差し戻し処理

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

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

構成プロパティー

ProductInstallation コラボレーション・テンプレートは、標準コラボレーション・プロパティーのみを使用します。 自身の処理に固有のプロパティーを持たないだけでなく、標準プロパティーもすべてを使用するわけではありません。 例えば、ProductInstallation は Create 操作のみを実行し、トリガーとなる InstallShipment ビジネス・オブジェクトを宛先アプリケーションから検索することはないので、CONVERT_CREATE、CONVERT_UPDATE、ADDITIONAL_RETRIEVE、および USE_RETRIEVE プロパティーのデフォルト構成を変更する必要はありません。

標準プロパティー

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

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

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

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

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

Copyright IBM Corp. 1997, 2003