表 90 に、コラボレーション・テンプレートのための標準的な構成プロパティーを示します。これらのプロパティーは CollaborationFoundation テンプレートを基にしています。
表 90. コラボレーション・テンプレートの標準プロパティー
標準構成プロパティー
| 説明
|
1_EXCLUDE_VALUES
| トリガー・ビジネス・オブジェクトの同期を回避するためにフィルター操作用として使用するコラボレーションの値を指定します。
|
1_FAIL_ON_INVALID_VALUE
| フィルター操作の基準に合わない、1_FILTER_ATTRIBUTE で指定された属性の値をコラボレーションがどう処理するかを示します。
|
1_FILTER_ATTRIBUTE
| 1_EXCLUDE_VALUES プロパティーと 1_INCLUDE_VALUES プロパティーで指定された値を比較する際に使用するコラボレーションのビジネス・オブジェクト属性を指定します。
|
1_INCLUDE_VALUES
| トリガー・ビジネス・オブジェクトの同期を許可するためにフィルター操作用として使用するコラボレーションの値を指定します。
|
ADDITIONAL_RETRIEVE
| データとの同期が成功した後に、コラボレーションが宛先アプリケーションからビジネス・オブジェクトを検索するかどうかを指定します。
|
CONVERT_CREATE
| ソース・アプリケーションで作成されたトリガー・ビジネス・オブジェクトが宛先アプリケーションにすでに存在する場合の Create 要求へのコラボレーションの対応方法を示します。
|
CONVERT_UPDATE
| ソース・アプリケーションで更新されたトリガー・ビジネス・オブジェクトが宛先アプリケーションに存在しない場合の Update 要求へのコラボレーションの対応方法を示します。
|
INFORMATIONAL_EXCEPTIONS
| コラボレーションが例外にどう対応するかを指定します。
|
SEND_EMAIL
| 例外を受け取った場合にコラボレーションが E メールを送信するかどうかを示します。
|
USE_RETRIEVE
| データとの同期を取る前に、コラボレーションが宛先アプリケーションからトリガー・ビジネス・オブジェクトを検索するかどうかを指定します。
|
1_EXCLUDE_VALUES コラボレーション構成プロパティーは、トリガー・ビジネス・オブジェクトの同期を回避するためにフィルター操作用として使用するコラボレーションの値を指定します。1_FILTER_ATTRIBUTE で指定された属性の値がこのプロパティーにリストされている値のいずれかと一致する場合、コラボレーションはビジネス・オブジェクトを同期から除外します。
1_EXCLUDE_VALUES で使用される値は以下のとおりです。
- 除外する値のコンマ区切りリスト (「in-stock, at-customer」など)。
- オブジェクトを処理から除外しないことを示す値 none。
- 値なし。これは、null (CxIgnore) または空ストリング (CxBlank) の値を持つ属性を除外する場合に便利です。
デフォルト値は none です。
このプロパティーは、コラボレーション・テンプレートに使用できる構成プロパティーのリストから削除することができます。1_EXCLUDE_VALUES プロパティーは、削除されると、フィルター操作プロセスで使用されなくなります。
コラボレーションの指定値に大文字小文字の区別はありません。また、値のリスト内の余分なスペースに関する区別もありません。
排他値のリストが包含値のリストよりも
短い 場合はこのプロパティーの値を指定します。それ以外の場合は、1_INCLUDE_VALUES の値を指定します。1_INCLUDE_VALUES 内で値を指定すると、1_EXCLUDE_VALUES の値は none に設定されます。
1_FAIL_ON_INVALID_VALUE コラボレーション構成プロパティーは、フィルター操作の基準に合わない、1_FILTER_ATTRIBUTE で指定された属性の値をコラボレーションがどう処理するかを示します。1_FAIL_ON_INVALID_VALUE プロパティーは、次の値のいずれかに設定してください。
- true: true に設定すると、コラボレーションは、1_FILTER_ATTRIBUTE で指定された属性の値が 1_EXCLUDE_VALUES または 1_INCLUDE_VALUES で指定されたフィルター操作の基準に合わない場合に、例外を生成して処理を停止します。
- false: false に設定すると、コラボレーションは、指定された属性の値がフィルター操作の基準に合わない場合に、次のいずれかの処理を実行します。
- 1_FILTER_ATTRIBUTE で指定された属性が親ビジネス・オブジェクトに含まれている場合、コラボレーションは処理を継続します。
- 1_FILTER_ATTRIBUTE で指定された属性が子ビジネス・オブジェクトに含まれている場合、コラボレーションは、その属性を含む子ビジネス・オブジェクトおよびその子をすべて除去します。その後、コラボレーションは処理を継続します。
デフォルト値は true です。値に大文字小文字の区別はありません。
このプロパティーは、コラボレーション・テンプレートに使用できる構成プロパティーのリストから削除することができます。プロパティーを削除すると、それはフィルター操作プロセスで使用されなくなります。
1_FILTER_ATTRIBUTE コラボレーション構成プロパティーは、1_EXCLUDE_VALUES プロパティーと 1_INCLUDE_VALUES プロパティーで指定された値を比較する際に使用するコラボレーションのビジネス・オブジェクト属性を指定します。コラボレーションは、特定の値を持つビジネス・オブジェクトの同期を回避または保証するために、指定された属性の値を排他または包含用に指定された値と比較します。例えば、BusObjA というトップレベルのビジネス・オブジェクトに
BusObjB という子ビジネス・オブジェクトの配列が含まれていると想定します。BusObjB ビジネス・オブジェクト内の Type という属性でフィルター操作するには、1_FILTER_ATTRIBUTE の値を BusObjA.BusObjB.Type に設定します。
- 注:
- コラボレーションがこのプロパティーを評価するのは、その 1_EXCLUDE_VALUES が、none 以外の値に評価される場合か、その 1_INCLUDE_VALUES が all 以外の値に評価される場合のみです。
このコラボレーション構成プロパティーの有効な値は、以下のとおりです。
- InterChange Server Express で定義されているビジネス・オブジェクトの正確な名前と属性 (InstallShipment.ShipmentType など)。属性の名前を確認するには、以下のいずれかを実行します。
- System Manager でビジネス・オブジェクトを表示します。
- repository¥BO_BusinessObjectName.txt というビジネス・オブジェクトのリポジトリー・ファイルを表示します。
- 注:
- 本書では、ディレクトリー・パスに円記号 (¥) を使用します。UNIX システムの場合は、円記号をスラッシュ (/) に置き換えてください。ファイルのパス名はすべて、使用システムで製品がインストールされたディレクトリーを基準とした相対パス名です。
- BusinessObjectName.ObjectEventId。これは、各ビジネス・オブジェクトに固有の内部 ID を含む属性です。これは、1_FILTER_ATTRIBUTE のデフォルト値です。
コラボレーション・テンプレートは、任意の数のビジネス・オブジェクト属性でフィルター操作を行うように設計されています。フィルターを追加するには、構成プロパティーのセット (X_FILTER_ATTRIBUTE、X_FAIL_ON_INVALID_VALUE、X_EXCLUDE_VALUES または X_INCLUDE_VALUES) をコラボレーションに追加します。X は、2 から N の整数です。その他のプロパティーは、2 から N の順に追加し、前記の正確な名前を指定する必要があります。
1_INCLUDE_VALUES コラボレーション構成プロパティーは、トリガー・ビジネス・オブジェクトの同期を許可するためにフィルターとして使用するコラボレーションの値を指定します。1_FILTER_ATTRIBUTE で指定された属性の値がこのプロパティーにリストされている値のいずれかと一致する場合、コラボレーションは、指定された値を持つビジネス・オブジェクトのみを同期します。
1_INCLUDE_VALUES プロパティーの有効な値は、以下のとおりです。
- 包含する値のコンマ区切りリスト (「standard, in-stock, at-customer」など)。
- 値 all。これは、すべてのオブジェクトを処理に含めることを示します。
デフォルト値は all です。値に大文字小文字の区別はありません。また、コラボレーションは、値のリスト内にある余分なスペースを無視します。
このプロパティーをフィルター操作プロセスで使用しない場合は、コラボレーションに使用できる構成プロパティーのリストから削除することができます。
包含値のリストが排他値のリストよりも
短い 場合はこのプロパティーの値を指定します。それ以外の場合は、1_EXCLUDE_VALUES の値を指定します。1_EXCLUDE_VALUES 内で値を指定すると、1_INCLUDE_VALUES の値は all に設定されます。
ADDITIONAL_RETRIEVE コラボレーション構成プロパティーは、データとの同期が成功した後に、コラボレーションが宛先アプリケーションからビジネス・オブジェクトを検索するかどうかを指定します。ADDITIONAL_RETRIEVE プロパティーは、以下のように設定します。
- true に設定すると、コラボレーションは、データとの同期が成功した後に、宛先アプリケーションからビジネス・オブジェクトを検索します。この設定は、ソース・アプリケーションが宛先アプリケーションから完全な値を持つビジネス・オブジェクトを受け取る必要があるが、宛先アプリケーションのコネクターがデータの作成または更新後に完全なビジネス・オブジェクトを戻さない場合に役立ちます。
- コラボレーションは、完全な値を持つビジネス・オブジェクトを正常に取り出すと、ソース・アプリケーションに戻すため、それを triggeringBusObj 変数に保存します。同期要求を行うソース・コネクターにコラボレーションがバインドされている場合は、コラボレーションが処理を完了するとすぐに、トリガー・ビジネス・オブジェクトの値がソース・コネクターに戻されます。値は、ビジネス・オブジェクトの値が参照によって受け渡された場合と同じように戻されます。
- 注:
- コラボレーションは、triggeringBusObj 変数の動詞を Retrieve から元の動詞にリセットします。動詞をリセットすると、コラボレーションは、Additional Processing 5 サブプロセスで必要になった場合に元の動詞を使用できます。Additional Retrieve プロセスの詳細については、Additional Retrieve プロセスを参照してください。
- 完全な値を持つビジネス・オブジェクトの検索に成功しなかった場合、コラボレーションは例外を生成します。例外処理は、INFORMATIONAL_EXCEPTIONS プロパティーの設定によって決まります。
- false に設定すると、コラボレーションは、データとの同期が成功した後に、宛先アプリケーションからビジネス・オブジェクトを検索しません。
デフォルト値は false です。
CONVERT_CREATE コラボレーション構成プロパティーは、ソース・アプリケーションで作成されたトリガー・ビジネス・オブジェクトが宛先アプリケーションにすでに存在する場合にコラボレーションが Create 要求にどう対応するかを示します。CONVERT_CREATE プロパティーは、以下のように設定します。
- true に設定すると、ソース・アプリケーションで作成されたトリガー・ビジネス・オブジェクトが宛先にすでに存在する場合に、コラボレーションは Create 要求を Update 要求に変換します。
- false に設定すると、コラボレーションは、例外を生成します。例外処理は、INFORMATIONAL_EXCEPTIONS プロパティーの設定によって決まります。
デフォルト値は false です。
CONVERT_CREATE に対するコラボレーションのアクションは、USE_RETRIEVE コラボレーション構成プロパティーの値によって決まります。
- USE_RETRIEVE が true に評価された場合、コラボレーションが CONVERT_CREATE プロパティーを評価するのは、トリガー動詞が Create で、コラボレーションがビジネス・オブジェクトの検索に成功した場合のみです。
- USE_RETRIEVE が false に評価された場合、コラボレーションが CONVERT_CREATE プロパティーを評価するのは、宛先でのトリガー・ビジネス・オブジェクトの作成に失敗した後のみです。
USE_RETRIEVE 構成プロパティーと CONVERT_CREATE 構成プロパティーの関係については、Use_Retrieve プロセスの表を参照してください。
CONVERT_UPDATE コラボレーション構成プロパティーは、ソース・アプリケーションで更新されたトリガー・ビジネス・オブジェクトが宛先アプリケーションに存在しない場合にコラボレーションが Update 要求にどう対応するかを示します。CONVERT_UPDATE プロパティーは、以下のように設定します。
- true に設定すると、ソース・アプリケーションで作成されたトリガー・ビジネス・オブジェクトが宛先に存在しない場合に、コラボレーションは Update 要求を Create 要求に変換します。
- false に設定すると、コラボレーションは、例外を生成します。例外処理は、INFORMATIONAL_EXCEPTIONS プロパティーの設定によって決まります。
デフォルト値は false です。
CONVERT_UPDATE に対するコラボレーションのアクションは、USE_RETRIEVE コラボレーション構成プロパティーの値によって決まります。
- USE_RETRIEVE が true に評価された場合、コラボレーションが CONVERT_UPDATE プロパティーを評価するのは、トリガー動詞が Update で、ビジネス・オブジェクトが宛先にないことが検索によって確認された場合のみです。
- USE_RETRIEVE が false に評価された場合、コラボレーションが CONVERT_UPDATE プロパティーを評価するのは、宛先でのトリガー・ビジネス・オブジェクトの更新に失敗した後のみです。
INFORMATIONAL_EXCEPTIONS コラボレーション構成プロパティーは、コラボレーションが例外にどう対応するかを指定します。プロパティーには、以下の値を入れることができます。
- All -- 例外が発生するたびに、コラボレーションは例外をトレースに送信し、正常に終了します。
- None -- 例外が発生するたびに、コラボレーションは例外を上げ、処理が失敗します。
- コンマで区切ったメッセージ番号のリスト -- リストされた例外が発生するたびに、コラボレーションは例外をトレースに送信し、正常に終了します。例外メッセージ番号は、コラボレーション・メッセージ・ファイル (collaborations¥messages¥CollaborationName.txt) 内の例外メッセージ番号に対応しています。
デフォルト値は 1000、2000、2005、2010、2015、2020、3000、3010、3020 です。
SEND_EMAIL コラボレーション構成プロパティーは、例外を受け取った場合にコラボレーションが E メールを送信するかどうかを示します。SEND_EMAIL プロパティーは、以下のように設定します。
- All -- 例外が発生するたびに、コラボレーションは E メールを送信します。
- None -- 例外が発生しても、コラボレーションは E メールを送信しません。
- コンマで区切ったメッセージ番号のリスト -- リストされた例外が発生するたびに、コラボレーションは E メールを送信します。例外メッセージ番号は、コラボレーション・メッセージ・ファイル (collaborations¥messages¥CollaborationName.txt) 内の例外メッセージ番号に対応しています。
- メッセージ番号の範囲 -- 指定された範囲にある例外が発生するたびに、コラボレーションは E メールを送信します。
デフォルト値は none です。
- 注:
- System Manager の「Collaboration Object Properties」ダイアログ・ボックスの「E メール通知アドレス」フィールドでアドレスを指定します。コラボレーションに対して E メール・アドレスが指定されている場合、コラボレーションは例外が発生したときに Email コラボレーションを呼び出します。Email コラボレーションは、WebSphere Business Integration Express の一部としてインストールし、構成することができます。
USE_RETRIEVE コラボレーション構成プロパティーは、データとの同期の前に、コラボレーションが宛先アプリケーションからトリガー・ビジネス・オブジェクトを検索するかどうかを指定します。USE_RETRIEVE プロパティーは、以下のように設定します。
- true に設定すると、コラボレーションは、データとの同期の前に、宛先アプリケーションからトリガー・ビジネス・オブジェクトを検索します。この設定は、以下のような場合に役立ちます。
- コラボレーションが別のコラボレーションによって起動され、グループ化されたコラボレーションでなんらかのステップが失敗したときに差し戻し処理を実行する必要がある場合。変更前にコラボレーションで値を検索することにより、コラボレーションが Update プロセスまたは Delete プロセスで元の値を復元することが可能になります。
- コラボレーションは Wrapper Collaboration によって起動された場合。Wrapper Collaboration は常に、トリガー・ビジネス・オブジェクトを Create 動詞で送信します。このプロパティーを true に設定すると、ビジネス・オブジェクトがすでに宛先に存在する場合にコラボレーションの失敗を回避することができます。USE_RETRIEVE が true に評価されると、コラボレーションは、Create または Update の実行前にソース・アプリケーションの値と宛先アプリケーションの値を比較します。オブジェクトが同一であれば、正常に終了します。
- false に設定すると、コラボレーションは、宛先アプリケーションからトリガー・ビジネス・オブジェクトを検索せずに処理を開始します。この設定は、ソース・ビジネス・オブジェクトの値と宛先ビジネス・オブジェクトの値との比較が重要ではない場合に役立ちます。
デフォルト値は false です。
- 注:
- このプロパティーの使用の詳細については、CONVERT_CREATEおよび CONVERT_UPDATEを参照してください。
