ワークフロー - スコープ対象

  • リリースバージョン: Yokohama
  • 更新日 2025年01月30日
  • 所要時間：4分

    • スコープ付き ワークフロー API は、アクティビティ定義スクリプトで使用できるメソッドを提供します。

    スコープ付きワークフローオブジェクトのインスタンスを作成するためのコンストラクタはありません。代わりに、アクティビティスクリプトで利用可能なグローバルワークフローオブジェクトを使用します。このワークフローオブジェクトは、ワークフロー内の任意のスクリプトの場所で使用できます。

    スコープ対象ワークフロー:debug(文字列メッセージ、オブジェクト引数)

    ログにデバッグメッセージを追加します。

    表 : 1. パラメーター
    名前 タイプ 説明
    メッセージ 文字列 ログに追加するメッセージ。
    引数 オブジェクト メッセージに追加する引数。
    表 : 2. 戻り値
    タイプ 説明
    文字列 ログに追加されたメッセージ。 
    var loggedMessage = workflow.debug("All is well");

    スコープ対象ワークフロー:error(文字列メッセージ、オブジェクト引数)

    エラーメッセージをログに追加します。

    表 : 3. パラメーター
    名前 タイプ 説明
    メッセージ 文字列 ログに追加するメッセージ。
    引数 オブジェクト メッセージに追加する引数。
    表 : 4. 戻り値
    タイプ 説明
    文字列 ログに記録されたメッセージ 
    var loggedMessage = workflow.error("An error has occurred. ");

    スコープ対象ワークフロー:getVariable(文字列名)

    指定された変数の値を返します。

    表 : 5. パラメーター
    名前 タイプ 説明
    名前 文字列 変数名
    表 : 6. 戻り値
    タイプ 説明
    オブジェクト 変数の値 
    var value = workflow.getVariable("task");

    スコープ対象ワークフロー:info(文字列メッセージ、オブジェクト引数)

    ログに情報メッセージを追加します。

    表 : 7. パラメーター
    名前 タイプ 説明
    メッセージ 文字列 ログに追加するメッセージ。
    引数 オブジェクト メッセージに追加する引数。
    表 : 8. 戻り値
    タイプ 説明
    文字列 ログに記録されるメッセージ。 
    var loggedMessage = workflow.info("All is well");

    スコープ対象ワークフロー - 入力

    ワークフロー変数を含むオブジェクト。

    これはメソッドではなく、ユーザーなどのワークフローオブジェクト内の変数を参照する方法です。ワークフロー変数は、ワークフローのプロパティまたはスクリプト化されたアクティビティによって定義されます。

    表 : 9. フィールド
    名前 タイプ 説明
    入力 オブジェクト 名前と値のペアとしてのワークフロー変数。ワークフローオブジェクトの変数は、インテグレーターの実装に合わせてカスタム設定されます。 
    var user = workflow.inputs.u_user;

    スコープ対象ワークフロー:name()

    ワークフロー名を返します。

    表 : 10. パラメーター
    名前 タイプ 説明
    なし
    表 : 11. 戻り値
    タイプ 説明
    文字列 ワークフロー名 
    var name = workflow.name();

    スコープ対象ワークフロー:removeVariable(文字列名)

    指定された変数をワークフローから削除します。

    表 : 12. パラメーター
    名前 タイプ 説明
    名前 文字列 変数名
    表 : 13. 戻り値
    タイプ 説明
    なし 
    var value = workflow.removeVariable("task");

    スコープ対象ワークフロー:結果

    ワークフロー結果を含むワークフローオブジェクトの要素。

    これはメソッドではなく、ワークフローの結果を含むワークフローオブジェクト内の要素です。

    表 : 14. フィールド
    名前 タイプ 説明
    結果 文字列 ワークフローの結果。 
    var wfResult = workflow.result;

    スコープ対象ワークフロー:scratchpad()

    ワークフローのスクラッチパッドオブジェクトを返します。

    表 : 15. パラメーター
    名前 タイプ 説明
    なし
    表 : 16. 戻り値
    タイプ 説明
    オブジェクト スクラッチパッドオブジェクト。 
    var scratchpad = workflow.scratchpad();

    スコープ対象ワークフロー:setResult(String result)

    ワークフローの結果を設定します。

    表 : 17. パラメーター
    名前 タイプ 説明
    結果 文字列 ワークフローの結果
    表 : 18. 戻り値
    タイプ 説明
    なし 
    workflow.setResult("Success");

    スコープ対象ワークフロー:setVariable(文字列名, オブジェクト値)

    指定された変数を指定された値に設定します。

    表 : 19. パラメーター
    名前 タイプ 説明
    名前 文字列 変数名
    値 オブジェクト 変数に割り当てる値。
    表 : 20. 戻り値
    タイプ 説明
    なし 
    workflow.setVariable("task", "terrible");

    スコープ対象ワークフロー:warn(文字列メッセージ、オブジェクト引数)

    ログに警告メッセージを追加します。

    表 : 21. パラメーター
    名前 タイプ 説明
    メッセージ 文字列 ログに追加するメッセージ。
    引数 オブジェクト メッセージに追加する引数。
    表 : 22. 戻り値
    タイプ 説明
    文字列 ログに記録されたメッセージ 
    var loggedMessage = workflow.warn("Check your permissions.");