前へ	次へ		目次	索引	用語集

function AddCorrelation

    (p_subscription_guid in raw, 

     p_event in out wf_event_t) return varchar2;

説明

サブスクリプションを処理しているときに、相関IDをイベント・メッセージに追加します。 AddCorrelation()は、サブスクリプションのパラメータから、ITEMKEYという名前のパラメータを検索します。このパラメータには、イベント・メッセージの相関IDを生成するカスタム関数を指定します。 この関数は、サブスクリプションの「パラメータ」フィールドに次の形式で指定する必要があります。

        ITEMKEY=<package_name.function_name>

AddCorrelation()は、SubscriptionParameters()を使用してITEMKEYパラメータの値を検索および取得します。 「SubscriptionParameters」を参照してください。

相関IDカスタム関数がITEMKEYパラメータに指定されている場合、AddCorrelation()は、その関数を実行し、その関数から返された値に相関IDを設定します。 カスタム関数が指定されていない場合、相関IDはシステム日付に設定されます。イベント・メッセージがワークフロー・プロセスに送信されると、ワークフロー・エンジンはその相関IDを項目キーとして使用して、プロセス・インスタンスを識別します。

注意: プロセス・インスタンスの項目キーに使用できるのは、1バイトのキャラクタのみです。マルチバイトの値を含めることはできません。

AddCorrelation()で例外が発生した場合は、ステータス・コードERRORが返されます。 例外が発生しなかった場合は、ステータス・コードSUCCESSが返されます。

AddCorrelation()は、イベント・サブスクリプションのルール関数の標準APIに従って定義します。 AddCorrelation()をサブスクリプションのルール関数として使用して相関IDをイベントに追加するときに、下位のフェーズ番号を割り当てれば、フェーズ番号が上位のサブスクリプションを続けて実行できます。

たとえば、次の手順で行います。

1. ルール関数WF_EVENT_FUNCTIONS_PKG.AddCorrelationとフェーズ番号10を使用して、対象となるイベントへのサブスクリプションを定義します。そのサブスクリプションの「パラメータ」フィールドにパラメータの名前と値のペアITEMKEY=<package_name.function_name>を入力します。<package_name.function_name>は、相関IDを生成するパッケージおよび関数に置き換えます。

2. フェーズ番号20を使用して、そのイベントへの別のサブスクリプションを定義します。実行する処理として、カスタム・ルール関数またはワークフローの項目タイプとプロセス、あるいはその両方を入力します。

3. イベントを呼び出して、それらのサブスクリプションをトリガーします。最初に、フェーズ番号が下位のサブスクリプションが実行され、相関IDがイベント・メッセージに追加されます。イベントが2番目のサブスクリプションに渡されると、その相関IDが項目キーとして使用されます。

注意: 再利用できない複雑で特別なルール関数を作成するのではなく、再利用できる単純なルール関数を作成して複数のサブスクリプションをイベントに定義することをお薦めします。

引数（入力）

p_subscription_ guid	サブスクリプションのグローバル一意識別子。
p_event	イベント・メッセージ。