ナビゲーションに戻る

ApprovalManager クラス メソッド

承認マネージャ オブジェクトとは、承認フレームワークへのアプリケーション開発者インターフェイスです。ほとんどの開発者が、承認フレームワーク オブジェクトに直接アクセスする必要があるとは感じません。アプリケーション開発者は、このクラスをコンポーネント有効範囲付き変数としてインスタンス化する必要があります。このクラスを初期化する最適な場所は、コンポーネント事後ビルド イベント内です。このクラスは、開発者がコンポーネントの事後ビルド時に容易に入手できる情報を使用してインスタンス化できます。開発者は、承認コンポーネントに入るユーザーに保留中の承認ワークがあるかどうかを確認するため、このオブジェクトのブール値のプロパティを調べる必要があります。保留中の承認がある場合、GetPending() メソッドは何か保留中かを特定し、DoApprove() または DoDeny() などのアクション メソッドが承認機能全体を実装するためにそれらを有効にします。

このセクションでは、承認マネージャ クラス メソッドについてアルファベット順に列挙します。

構文

ApprovalManager(&awprcs_id, &hdr_, &approver_)

説明

開発者は、リクエストが承認のために送信されることを示すアプリケーションのメイン レコードのインスタンス内でこれらのトランザクション ID を渡す必要があります。これらによって、承認者が承認フレームワークに対して明示的に示される必要もあります。

パラメータ

パラメータ

説明

&awprcs_id

トランザクション レジストリに定義した承認プロセス ID を文字列として指定します。

&hdr_

トランザクション レジストリ内のトランザクション承認レベルの承認プロセスに対して定義したヘッダー レコードをレコードとして指定します。

&approver_

トランザクションを承認するユーザーのユーザー ID を文字列として指定します。

例

import EOAW_CORE:*;
Component EOAW_CORE:ApprovalManager &approvalMgr;
&vchrRecord = CreateRecord(Record.VCHR_AF_HDR_VW);
GetLevel0()(1).GetRecord(Record.VCHR_FS).CopyFieldsTo(&vchrRecord);
&approvalMgr = create EOAW_CORE:ApprovalManager("VoucherApproval",&vchrRecord, %UserId);

構文

DoApprove(&rec)

説明

このメソッドは、レコードのトランザクションを承認するために使用します。

パラメータ

パラメータ

説明

&rec

トランザクション レジストリ内のトランザクション承認レベルの承認プロセスに対して定義したレコードをレコードとして指定します。

構文

DoApproveRowSet(&rs)

説明

このメソッドは、行セット全体のトランザクションを承認するために使用します。これが行レベルのレコードである場合、このレコードを承認者に転送した全てのパスは、次へ進みます。

たとえば、経費レポートに 3 行があり、3 行全てを承認する場合、このレコードを行セットに挿入し、その行セットを DoApproveRowset に渡します。承認フレームワークでその行セット内の各行が承認されます。こうすることで、Approve への呼出が繰り返されることがありません。

パラメータ

パラメータ

説明

&rs

承認する行セットを行セットとして指定します。

戻り値

なし。

構文

DoReassign(&rec, &reassignee, &bAllowAutoApprove, &bAllowSelfApprove, &comment)

説明

このメソッドは、レコード インスタンスを別の承認者に再割当てするために使用します。

パラメータ

パラメータ

説明

&rec

再割当てするトランザクション レコードをレコードとして指定します。

&reassignee

承認の再割当て先のユーザーを文字列として指定します。

&bAllowAutoApprove

自動承認がアクティブかどうかをブール値として示します。

&bAllowSelfApprove

自己承認がアクティブかどうかをブール値として示します。

&comment

コメントを文字列として含めます。

戻り値

文字列。

構文

DoReassignAll(&reassignee, &bAllowAutoApprove, &bAllowSelfApprove, &comment)

説明

注: このメソッドは、トランザクションの全ての行アイテムを承認のために別のユーザーに再割当てするために使用します。

パラメータ

パラメータ

説明

&reassignee

再割当て先のユーザー ID を文字列として指定します。

&bAllowAutoApprove

自動承認がアクティブかどうかをブール値として示します。

&bAllowSelfApprove

自己承認がアクティブかどうかをブール値として示します。

&comment

コメントを文字列として含めます。

戻り値

文字列。

構文

DoDeny(&rec)

説明

このメソッドは、レコード インスタンスの承認を却下するために使用します。これがヘッダー レベルのレコードである場合、承認プロセスは終了します。これが行レベルのレコードである場合、その特定の行の処理は終了し、そのトランザクション内の他のレコードの処理は続行します。

パラメータ

パラメータ

説明

&rec

トランザクション レジストリ内のトランザクション承認レベルの承認プロセスに対して定義したレコード名をレコードとして指定します。

戻り値

なし。

例

&approvalMgr.DoDeny(&reqRecord);

構文

DoDenyRowset(&rs)

説明

このメソッドは、行セットの承認を却下するために使用します。これは、複数の行がある場合に、各行をループするのでなく、複数の行を承認フレームワークが一度に却下できるようにするために使用します。

パラメータ

パラメータ

説明

&rs

行セットの名前を行セットとして指定します。

戻り値

なし。

構文

DoDenyWithAllowUndeny(&rs)

説明

このメソッドは、行セットに再送信が許可されていない行セットの承認を却下するために使用します。

パラメータ

パラメータ

説明

&rs

行セットの名前を行セットとして指定します。

戻り値

なし。

構文

DoHardDeny(&rec)

説明

このメソッドは、レコード インスタンスの承認を却下し、再送信を許可しないために使用します。これがヘッダー レベルのレコードである場合、承認プロセスは終了します。これが行レベルのレコードである場合、その特定の行の処理は終了し、そのトランザクション内の他のレコードの処理は続行します。

パラメータ

パラメータ

説明

&rec

トランザクション レジストリ内のトランザクション承認レベルの承認プロセスに対して定義したレコード名をレコードとして指定します。

戻り値

なし。

構文

DoLineResubmit(&rec, &start)

説明

再送信するための行を実行中のトランザクションに渡すことができます。ユーザーは、その行が現在のステージから再開されるか、最初から再開されるかを決定します。最初から再開する場合、最初のヘッダー ステージ以後の全ての履歴は失われます。

パラメータ

パラメータ

説明

&rec

トランザクション レジストリ内のトランザクション承認レベルの承認プロセスに対して定義したレコードをレコードとして指定します。

&start

承認プロセスの最初から開始する場合は True、現在のステージから開始する場合は False を使用します。

戻り値

なし。

例

&approvalMgr.DoLineResubmit(&reqLnRecord, True);

構文

DoAddNewLine(&rec, &start)

説明

追加するための行を実行中のトランザクションに渡すことができます。ユーザーは、その行が現在のステージから再開されるか、最初から再開されるかを決定します。最初から再開する場合、最初のヘッダー ステージ以後の全ての履歴は失われます。

パラメータ

パラメータ

説明

&rec

トランザクション レジストリ内のトランザクション承認レベルの承認プロセスに対して定義したレコードをレコードとして指定します。

&start

承認プロセスの最初から開始する場合は True、現在のステージから開始する場合は False を使用します。

戻り値

なし。

構文

GetPending()

説明

このメソッドでは、保留中の任意のヘッダー行または行を含むアプリケーション ヘッダーまたは行レコードの形式で、行セットが返されます。

パラメータ

なし。

戻り値

保留中のトランザクションを含む行セット。

例

&LINERS = CreateRowset(Record.PV_REQLIN_AW_VW);
&LINERS = &approvalMgr.GetPending();

構文

DoPushback(&rec)

説明

このメソッドは、前の承認者にプロセスを差し戻すために使用します。これは、トランザクションの承認目的で、状態をより明確にするよう前の承認者にリクエストする手段を承認者に提供するために使用します。

注: ワークフローの差戻しは、同じパス内の前のステップに差し戻す場合にのみ機能します。パス内の最初のステップで Pushback() を呼び出しても、何も動作しません。

パラメータ

パラメータ

説明

&rec

トランザクション レジストリ内のトランザクション承認レベルの承認プロセスに対して定義したレコードをレコードとして指定します。

戻り値

なし。

例

&approvalMgr.DoPushback(&reqRecord);

構文

AddComments(&username, &rec, &comments)

説明

このメソッドは、承認プロセスにコメントを追加するために使用します。

パラメータ

パラメータ

説明

&username

現在のユーザーのユーザー名を文字列として指定します。

&rec

トランザクション レジストリ内のトランザクション承認レベルの承認プロセスに対して定義したレコードをレコードとして指定します。

&comments

承認トランザクションに対するコメントを文字列として指定します。

戻り値

なし。

例

&approvalMgr.AddComments(getUserName(%OperatorId), &reqRecord, PV_REQ_APPPG_WK.COMMENTS_2000);

構文

TakeNoAction(&rec)

説明

このメソッドは、実行されるアクションがないときにユーザーのステータスを更新するために使用します。このステップで全ての承認者がアクションを実行しなかった場合、ステップは次に進み、現在のステップには [実行されたアクションなし] ステータスが格納されます。

パラメータ

パラメータ

説明

&rec

トランザクション レジストリ内のトランザクション承認レベルの承認プロセスに対して定義したレコードをレコードとして指定します。

戻り値

なし。

構文

PutOnHold(&rec)

説明

このステップの渡されたレコード インスタンスを保留にするために使用します。これが行レベルのレコードである場合、このレコードを承認者に転送した全てのパスは、次へ進みます。

パラメータ

パラメータ

説明

&rec

トランザクション レジストリ内のトランザクション承認レベルの承認プロセスに対して定義したレコードをレコードとして指定します。

戻り値

なし。

構文

PutOnHoldCount(&rec)

説明

このメソッドは、承認トランザクションを保留にした承認者数をカウントするために使用します。たとえば、10 人の承認者がいて 5 件の承認が必要な場合、チェック時に 3 人の承認者がトランザクションを保留にしたとわかったとすると、7 人の承認者がまだ見ていないことになります。

パラメータ

パラメータ

説明

&rec

トランザクション レジストリ内のトランザクション承認レベルの承認プロセスに対して定義したレコードをレコードとして指定します。

戻り値

文字列の配列。

構文

GetPushedBack()

説明

このメソッドは、トランザクション内の差し戻された全ての行を取得するために使用します。

戻り値

行セット。

構文

GetPertinentThreads(&checkApprover, &userType)

説明

このメソッドは、レビューまたは承認が保留中のスレッドを特定するために使用します。

パラメータ

パラメータ

説明

&checkApprover

文字列として指定します。

&userType

文字列として指定します。

戻り値

行セット。

構文

GetStage(&rec)

説明

このメソッドは、トランザクションの承認プロセスの現在のステージを取得するために使用します。

パラメータ

パラメータ

説明

&rec

トランザクション レジストリ内のトランザクション承認レベルの承認プロセスに対して定義したレコードをレコードとして指定します。

戻り値

EOAW_CORE:ENGINE:StageInst

構文

GetPendingSteps()

説明

このメソッドは、承認プロセスの全ての保留中のステップを特定するために使用します。このメソッドでは、このトランザクションの保留中のステップインスタンス オブジェクトのリストが返されます。

パラメータ

なし。

戻り値

EOAW_CORE:ENGINE:UserStepInst の配列。

構文

DoLineTerminate(&LineRec)

説明

このメソッドは、指定した行レベル承認を終了するために使用します。

パラメータ

パラメータ

説明

&LineRec

承認プロセスの行レベル レコードを指定します。

構文

GetParticipant(&username)

説明

このメソッドは、ユーザーが承認プロセスの加入者かどうかを特定するために使用します。このメソッドでは、現在保留中またはアクションを実行したユーザーの加入者ステータスが返されます。

パラメータ

パラメータ

説明

&username

ユーザー ID を文字列として指定します。

戻り値

承認プロセスでのユーザーの加入者ステータスを特定する文字列。

  • N- ユーザーが承認の加入者でない場合。

  • AA- ユーザーが実際の承認者である場合。

  • OA- ユーザーが元の承認者である場合。

  • RR- ユーザーがレビュー担当者である場合。

  • O- ユーザーが作成者である場合。

  • R- ユーザーが依頼者である場合。

構文

GetAllActiveParticipants()

説明

このメソッドは、承認者、レビュー担当者、依頼者、作成者のいずれかのフラグが付いている全てのユーザーのリストを取得するために使用します。

パラメータ

なし。

戻り値

文字列の配列。

構文

RequestInformation(&user, &rs)

説明

このメソッドは、指定したユーザーが情報を提供するまでの間、ステップを保留にするために使用します。

パラメータ

パラメータ

説明

&user

レビュー担当者として挿入されるリクエスト情報元の UserID を文字列として指定します。

&rs

レビュー担当者をそのステップに留める行セットを行セットとして指定します。

戻り値

なし。

構文

SetAttributeObject(&attrObj_)

説明

このメソッドは、Approval Attribute クラスを Appinst クラスに設定するために使用します。

パラメータ

パラメータ

説明

&attrObj

EOAW_CORE:ENGINE:AppAttributes として指定します。

戻り値

なし。