GlideFlow - クライアント

GlideFlow API は、アクション、フロー、およびサブフローとのクライアント側でのインタラクションのためのメソッドを提供します。

この API は、クライアントスクリプトを受け入れるクラシック Now Platform UI エクスペリエンスで使用できます。アクション、フロー、またはサブフローは、クライアント呼び出し可能として設定され、 ワークフロースタジオ のセキュリティ管理機能を使用する有効な ACL を持っている必要があります。

注:

この APi は ワークスペースエクスペリエンス UI と互換性がありません。

GlideFlow API 内の一部のメソッドは、promise オブジェクトを返します。Promise は、非同期操作の最終的な結果を表します。Promise の詳細については、 Promise - Javascript MDN または AngularJS のドキュメントを参照してください。

この API を使用すると、次のことができます。

• スクリプトを介してアクション、フロー、またはサブフローを開始します。
• 既存の実行を取得します。
• ステータスと利用可能な出力を取得します。
• アクション、フロー、またはサブフローの完了を待ちます。

GlideFlow API のコンストラクターはありません。GlideFlow グローバルオブジェクトを使用して GlideFlow メソッドにアクセスします。

GlideFlow - execution.awaitCompletion()

実行の補完オブジェクトを返します。

表 : 1. パラメーター

名前	タイプ	説明
なし

表 : 2. 戻り値

タイプ	説明
オブジェクト	フローまたはアクション実行の完了の詳細を含むオブジェクト。

この例では、実行オブジェクトを返す startAction() を使用してアクションが実行されます。次に、コードはこの実行オブジェクトで awaitCompletion() を使用し、完了オブジェクトを返します。コードでは、この補完オブジェクトを使用して、実行内のステータスと出力を記録します。

(function() {
	var inputs = {};

	inputs['input1'] = 'string input'; // String

	GlideFlow.startAction('global.action_name', inputs)
		.then(function(execution) {
			return execution.awaitCompletion();
		}, errorResolver)
		.then(function(completion) {
			var status = completion.status;
			console.log(status);

			// Available Outputs:
			var outputs = completion.outputs;
			console.log(outputs);
		}, errorResolver());

	function errorResolver(error) {
		// Handle errors in error resolver
		console.error(error);
	}
})();

GlideFlow - execution.getExecutionStatus()

現在の実行の実行ステータスを含む文字列を返します。

表 : 3. パラメーター

名前	タイプ	説明
なし

表 : 4. 戻り値

タイプ	説明
文字列	実行ステータスを含む文字列。

この例では、コードは getExecution メソッドを使用して実行オブジェクトを取得します。getExecution メソッドには ID が必要です。この ID は、実行の開始に使用されたメソッドによって返されます。次に、コードは getExecutionStatus() を使用して、続行する前に実行が完了したかどうかを判断します。

// Get an existing action, getStatus, and getOutputs if complete
(function() {
   GlideFlow.getExecution('mamIN4Q35vmEFe744EwJV5GHrSz8fmJG')
      .then(function(execution) {
         execution.getExecutionStatus().then(
            function(status) {
               if (status === 'COMPLETE')
                  execution.getOutputs().then(
                     function(outputs) {
                        console.log(outputs);
                     },
                     errorResolver
                  );
            },
            errorResolver
         );
      }, errorResolver);

   function errorResolver(error) {
      // Handle errors in error resolver
      console.error(error);
   }
})();

GlideFlow - execution.getOutputs()

実行の出力オブジェクトを返します。

このメソッドを使用して、アクション、フロー、またはサブフローの実行によって生成された出力にアクセスします。

表 : 5. パラメーター

名前	タイプ	説明
なし

表 : 6. 戻り値

タイプ	説明
オブジェクト	アクション、フロー、またはサブフローの出力を含むオブジェクト。

この例では、コードは getExecution メソッドを使用して実行オブジェクトを取得します。実行が完了すると、コードは getOutputs() を使用して outputs オブジェクトを返し、console.log メソッドを使用してログに記録します。

// Get an existing action, getStatus, and getOutputs if complete
(function() {
   GlideFlow.getExecution('mamIN4Q35vmEFe744EwJV5GHrSz8fmJG')
      .then(function(execution) {
         execution.getExecutionStatus().then(
            function(status) {
               if (status === 'COMPLETE')
                  execution.getOutputs().then(
                     function(outputs) {
                        console.log(outputs);
                     },
                     errorResolver
                  );
            },
            errorResolver
         );
      }, errorResolver);

   function errorResolver(error) {
      // Handle errors in error resolver
      console.error(error);
   }
})();

GlideFlow:getExecution(文字列 executionId)

ID で既存の実行インスタンスを取得します。

表 : 7. パラメーター

名前	タイプ	説明
executionId	文字列	取得する実行の ID。

表 : 8. 戻り値

タイプ	説明
オブジェクト	実行オブジェクトの Promise。

この例では、コードは実行を取得し、完了するまで待機してから、実行完了ステータスをログに記録し、console.logを使用して出力します。

// Get an existing action and await completion
(function() {
	GlideFlow.getExecution('79cd437e0b202300a150a95e93673ae3')
		.then(function(execution) {
			return execution.awaitCompletion();
		}, errorResolver)
		.then(function(completion) {

			var status = completion.status;
			console.log(status);

			// Available Outputs:
			var outputs = completion.outputs;
			console.log(outputs);
		}, errorResolver());

	function errorResolver(error) {
		// Handle errors in error resolver
		console.error(error);
	}
})();

GlideFlow - startAction(String scopedName.actionName, Map inputs)

アクションを開始します。

表 : 9. パラメーター

名前	タイプ	説明
scopedName	文字列	実行するフローのスコープ対象の名前。
入力	オブジェクト	アクションに対して定義された入力を含むオブジェクト。

表 : 10. 戻り値

タイプ	説明
オブジェクト	アクション実行の詳細を含むオブジェクト。

この例では、入力入力オブジェクト変数の引数を使用してグローバルaction_nameアクションを開始します。完了すると、この例では console.log または console.error を使用してフローの成功または失敗を報告します。

// Start an action and await completion.
(function() {
	var inputs = {};

	inputs['input1'] = 'string input'; // String

	GlideFlow.startAction('global.action_name', inputs)
		.then(function(execution) {
			return execution.awaitCompletion();
		}, errorResolver)
		.then(function(completion) {
			var status = completion.status;
			console.log(status);

			// Available Outputs:
			var outputs = completion.outputs;
			console.log(outputs);
		}, errorResolver());

	function errorResolver(error) {
		// Handle errors in error resolver
		console.error(error);
	}
})();

GlideFlow - startFlow(文字列 scopedName.flowName, Map inputs)

フローを開始します。

表 : 11. パラメーター

名前	タイプ	説明
scopedName	文字列	実行するフローのスコープ対象の名前。
入力	オブジェクト	フローに対して定義された入力を含むオブジェクト。

表 : 12. 戻り値

タイプ	説明
オブジェクト	フロー実行に関する詳細を含むオブジェクト。

このフローの例は、通常、インシデントテーブルのレコードが更新されるとトリガーされます。クライアントスクリプトからフローをアクティブ化するため、この情報を入力する必要があります。このコードは、現在のレコードとそのレコードのテーブルを含む入力変数を作成します

// Start a Flow
(function() {
      var inputs = {};
      inputs['current'] = { // GlideRecord 
        table : 'incident', 
        sys_id : '79cd437e0b202300a150a95e93673ae3'  
    };
        inputs['table_name'] = 'incident';
         GlideFlow.startFlow('global.flow_name', inputs)
		.then(
			function(execution) {
				console.log('Started flow_name with execution id :' + execution.getExecutionId());
			},
			function(error) {
				console.log('Unable to start flow: ' + error);
			}
		);
})();

GlideFlow - startSubflow(String scopedName.subflowName, Map inputs)

サブフローを開始します。

表 : 13. パラメーター

名前	タイプ	説明
scopedName	文字列	実行するフローのスコープ対象の名前。
入力	オブジェクト	サブフローに使用される入力を含むオブジェクト。

表 : 14. 戻り値

タイプ	説明
オブジェクト	サブフロー実行の詳細を含むオブジェクト。

この例では、コードは入力アレイ変数の引数を使用してグローバルsubflow_nameサブフローを開始します。完了すると、この例では console.log または console.error を使用してフローの成功または失敗を報告します。

// Start an action and await completion.
(function() {
	var inputs = {};

	inputs['input1'] = 'string input'; // String

	GlideFlow.startSubflow('global.subflow_name', inputs)
		.then(function(execution) {
			return execution.awaitCompletion();
		}, errorResolver)
		.then(function(completion) {
			var status = completion.status;
			console.log(status);

			// Available Outputs:
			var outputs = completion.outputs;
			console.log(outputs);
		}, errorResolver());

	function errorResolver(error) {
		// Handle errors in error resolver
		console.error(error);
	}
})();