グループ ビルド機能を導入したアプリケーション プログラムまたはバッチ プログラムの作成

PeopleCode API 関数

このリストは、PeopleCode の関数ライブラリ (DERIVED_HR_GB.GB_API FieldFormula) です。使用する API グループ、絞り込み用のクエリー名、結果テーブルを指定します。

• 使用するグループ、クエリー名、結果テーブルを指定します。

  &ret_bool = GB_DECLARE(group_id, AsOfDate of the group, query_name, result_table_name)

  • パラメータ group_id は必須です。

  • パラメータ AsOfDate は必須です。

  • パラメータ query_name で、絞り込むための開発者クエリーの名前を指定します。このパラメータは省略できます。デフォルトのクエリー名は、GB_DEFAULT_QUERY (ビューは PS_GB_QRY_LINK_VW) です。

  • パラメータ result_table_name は、カスタム結果テーブルを作成した場合に必要です。このパラメータは省略できます。デフォルトの結果テーブルは、PS_GB_GRP_RES_TBL です。パラメータ result_table_name には、PS_MY_RESULT_TABLE など、完全な名前を指定する必要があります。

• 値をバインドします。

  &ret_bool = GB_BIND(prompt_code, value)

  • カスタム開発者クエリーでプロンプトが定義されている場合、値をバインドできます。標準クエリー GB_DEFAULT_QUERY を使用する場合、バインドされる値は絞込日のみです。その場合は、システムに用意されている API の GB_BIND_DATE を使用します。

  • パラメータ prompt_code は、開発者クエリーにプロンプトとして定義する必要があります。

  • パラメータ value は必須です。

• 標準クエリーの使用時に日付を絞込日としてバインドします。

  &ret_bool = GB_BIND_DATE(value)

  • この関数は、標準クエリー GB_DEFAULT_QUERY を使用しているときに使います。日付 (値) を絞込日としてバインドできます。

  • パラメータ value は省略でき、絞込日を指定します。デフォルト設定は %date です。

• SQL ステートメントを作成、実行します。

  &group_version_number = GB_EXEC(refresh_flag)

  • この API により、SQL ステートメントが作成および実行されます。

  • 作成されたグループのバージョン番号が返されます。

  • パラメータ refresh_flag に Y を設定すると、この関数がコールされるたびに SQL ステートメントが作成されます。refresh_flag に N を設定すると、作成済みのグループが存在するかどうかが確認され、そのバージョン番号が返されます。グループが存在しない場合は、パラメータによって作成されます。パラメータ refresh_flag は必須です。

• 結果テーブルの内容を削除します。

  GB_DELETE()

• 汎用ワークフローおよび専用ワークフローの使用可/不可の切り替えを行います。

  GB_SET_JOB_WF(job_name)

  • job_name の値に従って、汎用ワークフローと専用ワークフローの使用可/不可を切り替えます。必要に応じて、デフォルトのジョブ名 (汎用ワークフローに使用) の代わりにジョブ (job_name) を指定し、スケジュールに使用します。

  • パラメータ job_name は省略できます。

  • job_name を指定する場合は、ワークフローに関するトピックで説明されているように、job_name に指定した名前のジョブを PeopleSoft プロセス スケジューラで指定する必要があります。

  • job_name にヌル以外の値を指定すると、対応するワークフローが使用可能になります。汎用ワーク フローは使用不可になります。

  • job_name にヌルを指定すると、汎用ワークフロー (デフォルトのワークフロー) が使用可能になります。

  • DERIVED_MyClientModule.MyClientModule_GEN_BTN の PeopleCode イベントの FieldChange で、次の 2 つのシナリオのいずれかに従って、以下のコードを追加します。

シナリオ 1

標準のグループ結果テーブルとクエリーを使ってグループ ビルド コールを導入する場合、DERIVED_MyClientModule.MyClientModule_GEN_BTN の PeopleCode イベント FieldChange は、以下のようになります。

Declare Function GB_DECLARE PeopleCode DERIVED_HR_GB.GB_API FieldFormula;

Declare Function GB_BIND PeopleCode DERIVED_HR_GB.GB_API FieldFormula;

Declare Function GB_EXEC PeopleCode DERIVED_HR_GB.GB_API FieldFormula;

/* Use this instruction if you plan to use GB_GRP_RES_TBL */

GB_DECLARE (MyClientModuleRecord.GB_GROUP_ID, MyClientModuleRecord.MyAsOfDate, « », « ») ;

/* Bind all parameters for the default Query : The Effdt of JOB */

GB_BIND_DATE(Any Date ) ;

/* Execute the SQL and fill the group result table */

&MyVersion = GB_EXEC ( « Y » ) ;   /* <Y> Forces to rebuild the group even if one is available */

* The list of employees for the group is now available for your own usage */

/* The code presented above populates the Group Result table GB_GRP_RES_TBL */

/* You can now use this record to populate your scrolls or can be used as a join for a SQL Statement */

/* ADD YOUR CODE HERE  */

/* Clear the group result table only in the case you know the group will not be used anymore*/

[GB_DELETE() ;]

シナリオ 2

ユーザー独自のカスタム グループ結果テーブルとクエリーを使ってグループ ビルド コールを導入する場合、DERIVED_MyClientModule.MyClientModule_GEN_BTN の PeopleCode イベント FieldChange は、以下のようになります。

Declare Function GB_DECLARE PeopleCode DERIVED_HR_GB.GB_API FieldFormula;

Declare Function GB_BIND PeopleCode DERIVED_HR_GB.GB_API FieldFormula;

Declare Function GB_EXEC PeopleCode DERIVED_HR_GB.GB_API FieldFormula;

/* Give your result table name to GB_DECLARE  (STEP 1 must have been previously performed) and your Query Name if  you created one */

GB_DECLARE (MyClientModuleRecord.GB_GROUP_ID, MyClientModuleRecord. MyAsOfDate, « MyDeveloperQueryName », «MyClientModuleResultTable ») ;

/* Bind all parameters for MyDeveloperQueryName */

/* Each prompt in MyDeveloperQueryName must be binded */

GB_BIND (« :1 », MyClientModuleRecord.MyField1) ;

[…]

GB_BIND (« :n », MyClientModuleRecord.MyFieldn) ;

/* Or use local variable for binding */

GB_BIND(« :n », &MyLocalVarn) ;

/* Execute the SQL and fill the group result table */

&MyVersion = GB_EXEC ( « N » ) ;   /* <N> Don't rebuild the group if it is available */

/* Employee group is now available for your module */

/* This populates the group result table MyClientModuleResultTable  */

/* You can now use this record to populate your scrolls or work on this table… */

/* ADD YOUR CODE HERE  */

/* Clear the group result table only in the case you know the group will not be used anymore*/

[GB_DELETE() ;]

グループ ビルド クエリーの制約 (開発者向け)

PeopleTools クエリーの標準的な使用に際しては、以下のような制約があります。

• 開発者クエリーは、PUBLIC クエリーとして定義する必要があります。

• ユニオンは使用できません。

• 集計式は使用できません。

• ツリー オプションは式として使用できません。

• ビュー GB_QRY_LINK_VW をクエリーに含める必要があります。

• QUERY に追加するレコードには、最低 1 つの条件が必要です。

• プロンプトは、変数をバインドする式として使用できます。

PeopleCode API とアプリケーション エンジン API の相違点

要約

クライアント アプリケーションの開発者は、以下の作業を行う必要があります。

1. ページ キー、グループ ID、およびバージョン番号の各フィールドを保存するために新規テーブル (MySpecificWorkflowTable) を定義します。

2. 新しいワークリスト テーブル レコードを定義します。

3. ワークフローのトリガを実行するディライブド/ワーク フィールドを定義します。

4. そのフィールドを非表示フィールドとして、クライアント アプリケーション ページに追加します。

5. グループ ビルドをコールする前にページ キー値を保存する PeopleCode を指定します。

6. キー フィールド値であるグループ ID、バージョン番号、ユーザー ID を取得するためのデータベース エージェント クエリーを定義します。

7. ビジネス プロセス (アクティビティ、ステップ、ビジネス イベント、ワークリスト ルート、電子メール ルート、データベース エージェント、およびメッセージ エージェント) を設計し、必要な属性とフィールド マッピングを定義します。

8. PeopleSoft プロセス スケジューラで、カスタム データベース エージェント (MyDBAGProcess) 用に新しいプロセスを定義します。

9. PeopleSoft アプリケーション エンジン (アプリケーション エンジン GB_API でセクション GB_EXEC をコール) と、カスタム データベース エージェント プロセス (MyDBAGProcess) を順次処理するジョブ (MySpecificJobName) を新しく定義します。

10. この新しいジョブ名をパラメータとして、新しい API 関数 GB_SET_JOB_WF (MySpecificJobName) を介してグループ ビルドに渡します。API 関数 GB_SET_JOB_WF では、スケジュール対象の新しいジョブ名を渡し、専用ワークフローを使用可能にし、汎用ワークフローを使用不可にします。この関数のコールは、GB_EXEC のコールより先に行う必要があります。

11. MySpecificWorkflowTable に必要な情報を保存するための PeopleCode を追加します (次の手順を参照してください)。

MySpecificWorkflowTable に情報を保存するための PeopleCode を追加するには、次の手順に従います。

1. MySpecificWorkflowTable を、クライアント アプリケーション ページへのアクセスに必要なキー フィールドが全て記録されるように設計します。

   1. 2 つのキー フィールド GB_GROUP_ID と VERSIONGBQDM をレコードに追加します。

   2. ワークフロー フラグ WF_FLAG を追加します。

2. MySpecificWorkflowDerived/Work を設計します。

   1. ワークフローをトリガする GB_TRIGGER_WF とルーティングで重要な OPRID の 2 つのフィールドを追加します。

   2. これらのフィールドは非表示に設定します。

3. コール元のクライアント アプリケーション ページにルーティングするためのワークリスト レコード MyWorklistRecord を定義します。

   BUSPROCNAME、ACTIVITYNAME、EVENTNAME、WORKLISTNAME、INSTANCEID、および TRANSACTIONID は、どのワークリスト レコードについても標準の必須フィールドです。

   ページの全てのキー フィールドと、GB_GROUP_ID および VERSIONGBQDM フィールドを追加します。

4. データベース エージェント (DBAG) クエリーを定義します。

   DBAG クエリーによって、グループ ID、グループのバージョン番号、およびユーザー ID といったクライアント アプリケーションのキー フィールド値がコールされます。

   1. PeopleSoft ツリー マネージャを使用して、次の手順で MySpecificWorkflowTable を HR ACCESS GROUP に追加します。

   2. PeopleSoft クエリーに移動します。

   3. MySpecificWorkflowTable と GB_GENERICWF をグループ ID およびバージョン番号で結合し、グループ ID、グループのバージョン番号、ワークフロー トリガ フラグ、およびユーザー ID といった特定のキー値を返すようにします。

   4. グループ ID と バージョン番号の 2 つのプロンプトを条件に含めます。

   5. クエリーをパブリック データベース エージェント クエリーとして、_DBAG_MySpecificWorkflowQuery という名前で保存します。

5. MySpecificBusinessProcess を設計します。

   1. PeopleSoft アプリケーション デザイナで、ビジネス プロセスを定義します。

      MySpecificBusinessProcess には、以下の 2 つのアクティビティがあります。

      MySpecificWorkflowModule

      MySpecificWorkflowModuleResult

      それぞれのアクティビティには、クライアント アプリケーション ページに分岐するステップが 1 つだけあります。

   2. MySpecificWorkflowModule アクティビティに、ビジネス イベント、ワークリスト ルート、電子メール ルート、データベース エージェント、およびリンクを追加します。

   3. 各アイテムとその必須属性を定義します。

      ビジネス イベントは MySpecificWorkflowDerived/Work レコードからトリガされます。

   4. [Edit Business Rules (ビジネス ルールの編集)] ボタンを使用してワークフロー PeopleCode を追加し、表示されているとおりにコードを記述して、TriggerBusinessEvent 関数をコールするための条件を指定します。トリガするビジネス プロセス、アクティビティ、およびビジネス イベントの各パラメータを正しく指定します。

   5. Worklist Attributes (ワークリスト属性) ページで、手順 3 で定義したレコードをワークリスト レコードとして選択します。ワークリスト (MySpecificWorkflowModuleResult) を実行するアクティビティを持つビジネス プロセスを指定します。

   6. フィールド マッピングのページで、ワークリスト レコードのフィールドとクライアント アプリケーション ページのキーをマッピングします。

   7. OPRID フィールドについては、ロール名 Roleuser by Oprid Qry を選択し、OPRID クエリー変数を MySpecificWorkflowDerived/Work.OPRID フィールドにバインドします。

   8. 電子メール ルートについては、電子メールのフィールド (SUBJECT、NOTETEXT、TO、CC、および BCC) とアプリケーション フィールドの間にフィールド マッピングを定義します。

   9. データベース エージェント アイテムを定義します。

      Message Attributes (メッセージ属性) ページでターゲット コンポーネントを定義し、クライアント アプリケーション コンポーネントへのパスを指定します。

      [Query Name (クエリー名)] フィールドに、手順 4 で定義したデータベース エージェント クエリーを入力します。

      クエリー選択のフィールド (2 列目) とクライアント アプリケーション ページのフィールド (最後の列) の間にマッピングを定義します。

6. PeopleSoft プロセス スケジューラへ移動し、MySpecificWorkflowDBAGProcess を定義します。

   1. プロセス タイプが Database Agent の新しいプロセスをプロセス定義ページで追加します。

   2. プロセス定義オプション ページで、値の追加モードでパラメータ リストを上書きし、以下をパラメータとして指定します。

      E100 -T -L /A MySpecificWorkflowModule /MD MyDatabaseAgentName

      kbind1=:DERIVED_HR_GB.GB_GROUP_ID2 -kbind2=:DERIVED_HR_GB.VERSIONGBQDM

      /A は、アクティビティ名を表します。

      /MD は、メッセージ定義を表します。

      -kbind1 および -kbind2 は、API ワーク ページのバインド変数です。

7. PeopleSoft プロセス スケジューラで、MySpecificWorkflowJob を定義します。

   グループ ビルドの アプリケーション エンジン プロセス (GB_API.GB_EXEC をコールするプロセス) と MySpecificWorkflowDBAG データベース エージェント プロセスを順次処理する新しいジョブを追加します。

8. グループ ビルド API へのコールをクライアント アプリケーションに追加します。

   グループ ビルド コール ボタンの PeopleCode イベント FieldChange で、「PeopleCode API コールの導入」トピックの手順 7 で説明されているように、グループ ビルド API を使用します。必ず GB_SET_JOB_WF 関数をコールして、専用ワークフローを使用可能に、汎用ワークフローを使用不可にしてください。

9. MySpecificWorkflowTable に必要な情報を保存するための PeopleCode を追加します。