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

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

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

スコープ指定の Workflow - debug(文字列 message, オブジェクト args)

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

表 : 1. パラメーター

名前	タイプ	説明
message	文字列	ログに追加するメッセージ。
args	オブジェクト	メッセージに追加する引数。

表 : 2. 返される内容

タイプ	説明
文字列	ログに追加されたメッセージ。

var loggedMessage = workflow.debug("All is well");

スコープ指定の Workflow - error(文字列 message, オブジェクト args)

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

表 : 3. パラメーター

名前	タイプ	説明
message	文字列	ログに追加するメッセージ。
args	オブジェクト	メッセージに追加する引数。

表 : 4. 返される内容

タイプ	説明
文字列	ログに記録されたメッセージ

var loggedMessage = workflow.error("An error has occurred. ");

スコープ指定の Workflow - getVariable(文字列 name)

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

表 : 5. パラメーター

名前	タイプ	説明
name	文字列	変数名

表 : 6. 返される内容

タイプ	説明
オブジェクト	変数の値

var value = workflow.getVariable("task");

スコープ指定の Workflow - info(文字列 message, オブジェクト args)

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

表 : 7. パラメーター

名前	タイプ	説明
message	文字列	ログに追加するメッセージ。
args	オブジェクト	メッセージに追加する引数。

表 : 8. 返される内容

タイプ	説明
文字列	ログに記録されるメッセージ。

var loggedMessage = workflow.info("All is well");

スコープ指定の Workflow - inputs

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

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

表 : 9. フィールド

名前	タイプ	説明
inputs	オブジェクト	名前と値のペアとしてのワークフロー変数。ワークフローオブジェクトの変数は、インテグレーターの実装に合わせてカスタマイズされています。

var user = workflow.inputs.u_user;

スコープ指定の Workflow - name()

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

表 : 10. パラメーター

名前	タイプ	説明
なし

表 : 11. 返される内容

タイプ	説明
文字列	ワークフロー名

var name = workflow.name();

スコープ指定の Workflow - removeVariable(文字列 name)

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

表 : 12. パラメーター

名前	タイプ	説明
name	文字列	変数名

表 : 13. 返される内容

タイプ	説明
なし

var value = workflow.removeVariable("task");

スコープ指定の Workflow - result

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

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

表 : 14. フィールド

名前	タイプ	説明
result	文字列	ワークフローの結果。

var wfResult = workflow.result;

スコープ指定の Workflow - scratchpad()

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

表 : 15. パラメーター

名前	タイプ	説明
なし

表 : 16. 返される内容

タイプ	説明
オブジェクト	スクラッチパッドオブジェクト。

var scratchpad = workflow.scratchpad();

スコープ指定の Workflow - setResult(文字列 result)

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

表 : 17. パラメーター

名前	タイプ	説明
result	文字列	ワークフローの結果

表 : 18. 返される内容

タイプ	説明
なし

workflow.setResult("Success");

スコープ指定の Workflow - setVariable(文字列 name, オブジェクト value)

指定の変数を指定の値に設定します。

表 : 19. パラメーター

名前	タイプ	説明
name	文字列	変数名
value	オブジェクト	変数に割り当てられる値。

表 : 20. 返される内容

タイプ	説明
なし

workflow.setVariable("task", "terrible");

スコープ指定の Workflow - warn(文字列 message, オブジェクト args)

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

表 : 21. パラメーター

名前	タイプ	説明
message	文字列	ログに追加するメッセージ。
args	オブジェクト	メッセージに追加する引数。

表 : 22. 返される内容

タイプ	説明
文字列	ログに記録されたメッセージ

var loggedMessage = workflow.warn("Check your permissions.");