WFActivityHandler - グローバル

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間：5分

    • WFActivityHandlerスクリプトインクルードは、すべてのワークフローアクティビティの基底クラスです。

    すべてのワークフローアクティビティの基底クラスとして、このコードは常にアクティビティの一部として実行されます。

    独自のワークフローアクティビティを開発する際は、このクラスから派生させる形でスクリプトオブジェクトを作成し、必要に応じてメソッドを上書きして必要な機能を実現します。意味のあるアクティビティ処理を実行するためには、クライアントコードでメソッド onExecute() を上書きする必要があります。

    WFActivityHandler - debug(文字列 msg, 文字列 args)

    デバッグメッセージをログに記録します。

    表 : 1. パラメーター
    名前 タイプ 説明
    msg 文字列 ログに送信するメッセージ。
    args 文字列 ログに送信する文字列
    表 : 2. 返される内容
    タイプ 説明
    なし

    WFActivityHandler - debug(文字列 msg, アレイ args)

    デバッグメッセージをログに記録します。

    表 : 3. パラメーター
    名前 タイプ 説明
    msg 文字列 ログに送信するメッセージ。
    args アレイ ログに送信する値のアレイ
    表 : 4. 返される内容
    タイプ 説明
    なし

    WFActivityHandler - generate(文字列 activityId, 文字列 order, GlideDateTime startAtDspValue, ブーリアン noCreateFlag)

    今後の作業のプレビューのため、アクティビティを実行する前に承認とタスクを生成します。

    保留中ステータスのワークフローを開始する際にオブジェクトを生成できるようにします。関連情報については、「 ワークフロー アクティビティの生成」を参照してください。

    表 : 5. パラメーター
    名前 タイプ 説明
    activityId 文字列 この実行中アクティビティの sys_id。ワークフローアクティビティ [wf_activity] テーブルにあります。
    order 文字列 タスクまたは承認に関連付けられた順序番号。
    startAtDspValue 文字列 タスクまたは承認の、GlideDateTime 形式の開始時間。
    noCreateFlag ブーリアン

    承認レコードの作成をスキップするかどうかを示すフラグ。

    有効な値：
    • true：承認レコードを作成しない。
    • false：承認レコードを作成する。

    デフォルト：true
    表 : 6. 返される内容
    タイプ 説明
    オブジェクト ワークフロースクラッチパッドに保存されている生成前のオブジェクト。例えば、オブジェクトが承認 ID のアレイであるとします。アクティビティが onExecute 関数を実行すると、次のいずれかの条件を判断するよう生成前のオブジェクトに要求できます。
    • 承認がすでに保留中ステータスで作成されている。
    • アクティビティが onExecute 関数を使用して承認を作成する必要がある。

    WFActivityHandler - info(文字列 msg, 文字列 args)

    情報メッセージをログに記録します。

    表 : 7. パラメーター
    名前 タイプ 説明
    msg 文字列 ログに送信するメッセージ。
    args 文字列 ログに送信する文字列。
    表 : 8. 返される内容
    タイプ 説明
    なし

    WFActivityHandler - info(文字列 msg, アレイ args)

    情報メッセージをログに記録します。

    表 : 9. パラメーター
    名前 タイプ 説明
    msg 文字列 ログに送信するメッセージ。
    args アレイ ログに送信する値のアレイ
    表 : 10. 返される内容
    タイプ 説明
    なし

    WFActivityHandler - js(文字列 str)

    スクリプト内のアクティビティ変数を評価します。

    ${some script} などの el 式を含む文字列または javascript: で始まる文字列を評価するために使用されます。使用例は、ほぼすべての既存のアクティビティに入っていますので参照してください。

    表 : 11. パラメーター
    名前 タイプ 説明
    str 文字列 el 式が埋め込まれている可能性がある文字列。
    表 : 12. 返される内容
    タイプ 説明
    文字列 評価済みの文字列。

    WFActivityHandler - onCancel( )

    cancel イベントのイベントハンドラー。

    アクティビティスクリプトの基底クラスが、このアクティビティをキャンセルするように設定します。このアクティビティをキャンセルするために追加の処理が必要な場合は、派生クラス (アクティビティ) でこのメソッドを上書きできます。アクティビティ Manual Approvals は、このメソッドを上書きして、このアクティビティをキャンセルするための追加処理を実行する処理の例です。

    表 : 13. パラメーター
    名前 タイプ 説明
    なし
    表 : 14. 返される内容
    タイプ 説明
    なし

    WFActivityHandler - onExecute( )

    仮想的なメソッド。アクティビティに適した作業を実行するためには、アクティビティのサブクラスでこのメソッドを上書きする必要があります。

    表 : 15. パラメーター
    名前 タイプ 説明
    なし
    表 : 16. 返される内容
    タイプ 説明
    なし

    WFActivityHandler - runScript(文字列 script)

    スクリプトタイプのアクティビティ変数に含まれるスクリプトをアクティビティで実行できるようにします。

    このメソッドを使用するアクティビティの例としては、If、Wait for condition、および Approval - User があります。

    表 : 17. パラメーター
    名前 タイプ 説明
    スクリプト 文字列 有効な Javascript を含む文字列。
    表 : 18. 返される内容
    タイプ 説明
    変数 スクリプトがワークフロー変数 answer を設定した場合、この値が返されます。そうでない場合は、スクリプトの実行結果が返されます。

    WFActivityHandler - setActivityOutput( )

    アクティビティ出力プロパティを設定します。

    「アクティビティ SOAP Message」を参照してください。

    表 : 19. パラメーター
    名前 タイプ 説明
    なし
    表 : 20. 返される内容
    タイプ 説明
    なし

    WFActivityHandler - setResultFailed(文字列 reason)

    アクティビティの結果を失敗として設定し、オプションの reason 文字列を指定します。

    「アクティビティ SOAP Message」を参照してください。

    表 : 21. パラメーター
    名前 タイプ 説明
    reason 文字列 (オプション) このアクティビティが失敗した理由の説明。
    表 : 22. 返される内容
    タイプ 説明
    なし

    WFActivityHandler - setResultSucceeded( )

    このアクティビティの結果を成功として設定します。

    表 : 23. パラメーター
    名前 タイプ 説明
    なし
    表 : 24. 返される内容
    タイプ 説明
    なし

    WFActivityHandler - warn(文字列 msg, 文字列 args)

    警告メッセージをログに記録します。

    表 : 25. パラメーター
    名前 タイプ 説明
    msg 文字列 ログに送信するメッセージ。
    args 文字列 ログに送信する文字列
    表 : 26. 返される内容
    タイプ 説明
    なし

    WFActivityHandler - warn(文字列 msg, アレイ args)

    警告メッセージをログに記録します。

    表 : 27. パラメーター
    名前 タイプ 説明
    msg 文字列 ログに送信するメッセージ。
    args アレイ ログに送信する値のアレイ
    表 : 28. 返される内容
    タイプ 説明
    なし