スクリプトステップ

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

    • 再利用可能なアクションの中実行するカスタムの JavaScript を追加します。ほとんどのコア アクションおよびステップは一般的な使用例に適していますが、コア ステップでは満たされない動作を実行するスクリプト ステップを作成できます。

    ロールと使用可用性

    ワークフロースタジオ アクションステップとして利用可能です。action_designer ロールを持つユーザーは、1 つ以上のアクションステップを使用してカスタムアクションを作成できます。
    注:
    統合ハブ 見る 要求 統合ハブ 統合ハブの使用状況とサブスクリプションに関する情報。

    フィールド

    スクリプトステップには入力変数と出力変数が別々に用意されているため、JavaScript データを ワークフロースタジオ のデータにマップできます。ステップの中で入力変数と出力変数を定義することによって、ワークフロースタジオのどのデータをスクリプトの中で使用できるかを定義でき、どのスクリプト変数をアクションの他のステップで使用できるかを定義できます。

    フィールド 説明
    必須ランタイム
    スクリプトをサポートするために必要な実行時環境。次の選択肢があります。
    • [インスタンス]：アクションステップは、インスタンスからスクリプトを実行します。スクリプトが ServiceNow API またはインスタンスデータにアクセスする必要がある場合は、このオプションを選択します。これがデフォルト値です。
    • [MID]：アクション ステップは、MID サーバーからスクリプトを実行します。スクリプトが MID サーバースクリプトファイルおよび API にアクセスする必要がある場合は、このオプションを選択します。このオプションを選択すると、[使用する MID サーバーを選択] フィールドが表示されます。
    • [Vanilla (Core JavaScript)]：アクションステップは、インスタンスまたは MID サーバーのいずれかからスクリプトを実行します。このオプションは、スクリプトがコア JavaScript API のみを必要としており、ServiceNow API またはインスタンスデータは不要な場合に選択します。

    選択したランタイムによって、コンテキスト依存のヘルプに表示される JavaScript のオブジェクトおよびメソッドが決まります。

    注:
    このフィールドは、統合ハブ が有効化されている場合にのみ表示されます。
    使用する MID サーバーを選択
    使用する MID サーバー選択プロセスを指定します。次の選択肢があります。
    • 任意の MID。システムは、利用可能な MID サーバーからアクションステップを実行します。
    • 接続エイリアスを使用。指定した接続エイリアスを使用してアクションが実行されます。このオプションを選択すると、[接続エイリアス] フィールドが表示されます。
    • インライン選択を使用。アクションで指定した接続の詳細を使用してアクションが実行されます。このオプションを選択すると、[ホスト]、[MID アプリケーション]、および [機能] フィールドが表示されます。
    注:
    このフィールドは、 統合ハブ が有効になっていて、[必須ランタイム] から [MID] を選択した場合にのみ表示されます。
    接続エイリアス アクションステップを実行するために使用される接続および資格情報エイリアスレコード。flow_designer または admin ロールを持つユーザーは、関連する接続レコードを作成または選択できます。エイリアスを使用することで、複数の環境でアクションを使用する場合に、複数の認証情報と接続情報プロファイルを構成する必要がなくなります。また、接続情報が変更された場合に、カスタムアクションを更新する必要がありません。接続と資格情報の詳細については、「資格情報、接続、およびエイリアス」を参照してください。 「基本」接続タイプのエイリアスのみサポートされています。
    注:
    このフィールドは、統合ハブ が有効になっていて、 [使用する MID サーバーを選択] から [接続エイリアスを使用] を選択した場合にのみ表示されます。
    ホスト アクションステップが実行される MID サーバーの完全修飾ドメイン名。たとえば、 mid-server.domain.com です。
    注:
    このフィールドは、統合ハブ が有効になっていて、 [使用する MID サーバーを選択] から [インライン選択を使用] を選択した場合にのみ表示されます。
    MID 選択 特定の MID サーバーまたは MID クラスターを選択するオプション。
    • MID サーバーの自動選択：MID サーバーを自動的に選択します。
    • 特定の MID Server：選択した MID サーバーを使用します。
    • 特定の MID クラスター：選択した MID クラスターを使用します。
    このフィールドは、[必須ランタイム] リストから [MID] が選択されていて、[使用する MID サーバーを選択] リストから [Inline Selection を使用] が選択されている場合に利用可能です。
    MID クラスター 使用する MID クラスターのデータピル。このフィールドは、[必須ランタイム] リストから [MID] が選択されていて、[使用する MID サーバーを選択] リストから [Inline Selection を使用] が選択されている場合に利用可能です。
    MID アプリケーション 選択対象となるために MID サーバーがサポートする必要があるアプリケーションを指定します。選択したアプリケーションをサポートする MID サーバーからアクションステップが実行されます。このフィールドは、統合ハブ を有効化し、MID 選択リストから [MID サーバーの自動選択] が選択され、[使用する MID サーバーを選択] から [インライン選択を使用] を選択した場合にのみ表示されます。
    機能 選択対象となるために MID サーバー がサポートする必要がある機能です。選択した機能をサポートする MID サーバー からアクションステップが実行されます。このフィールドは、統合ハブ を有効化し、MID 選択リストから [MID サーバーの自動選択] が選択され、[使用する MID サーバーを選択] から [インライン選択を使用] を選択した場合にのみ表示されます。
    特定の MID サーバー 必要な MID サーバー のデータピル。このフィールドは、統合ハブ を有効化し、MID 選択リストから [特定の MID サーバー] が選択され、[使用する MID サーバーを選択] から [インライン選択を使用] を選択した場合にのみ表示されます。
    入力変数 アクションのデータを表す名前と値のペア。これにより、アクションの入力と他のステップ データをスクリプトの中で使用できます。
    スクリプト
    アクションの中で実行されるスクリプト。スクリプト内の入力変数と出力変数にアクセスするには、グローバル オブジェクト inputs および outputs を使用します。たとえば、inputs.myVariable などとします。
    注:
    スクリプトステップの入力名および出力名に、次の予約済みシステム名を含めることはできません。
    • sys_id
    • sys_created_by
    • sys_created_on
    • sys_updated_on
    • sys_updated_by
    • sys_mod_count
    一般に、システムフィールドと同じ名前の変数は作成しないでください。スクリプトステップでは、このような入力変数をフィールド名と混同して間違った値を使用する可能性があります。
    スクリプトステップは、inputs および outputs グローバルオブジェクトに格納されているデータを常に文字列に変換します。スクリプトステップで JSON データを処理する必要がある場合は、inputs グローバルオブジェクトを使用して JSON データを文字列に変換できます。また、JavaScript 変数を JavaScript オブジェクトではなく文字列として定義することもできます。たとえば、次のスクリプトは JSON データを出力する 2 つの方法を示しています。
    (function execute(inputs, outputs) {
  outputs.json_object_1 = inputs.json_input;
  var array_of_objs = '[{"name1":"value1"}, {"id":"abcd"}]';
  outputs.json_object_2 = array_of_objs;
})(inputs, outputs);

    デフォルトでは、ワークフロースタジオ はインスタンスでスクリプトを実行します。MID サーバーからスクリプトを実行するには、統合ハブ のサブスクリプションが必要です。

    ワークフロースタジオ は、スクリプトがトリガーまたは開始されたドメインからスクリプトを実行します。「ドメインセパレーションと ワークフロースタジオ」を参照してください。

    利用可能なクラスとメソッドについては、JavaScript API のコンテキスト依存ヘルプまたは API reference を参照してください。
    出力変数 JavaScript 出力をワークフロースタジオのデータ ピルにマップします。スクリプト出力を使用するためにアクションに別のステップを追加する場合は、出力変数を定義します。

    アクションエラー評価

    このステップが失敗した場合
    データタイプ：Choice

    次のステップの実行を続行するか、エラー評価に進むオプション。カスタムアクションのエラー条件のステップのステータスコードやメッセージを使用するには、「アクションエラー評価」を参照してください。

    例

    この例で作成している JSON ペイロードは、簡単に更新または変更して後続の REST ステップに追加できます。

    注:
    REST ステップ 基本システムでは使用できず、ServiceNow® 統合ハブ のサブスクリプションが必要です。

    アクション内の「スクリプト」ステップの例。

    ペイロードを表す出力変数を作成することにより、[ペイロード] データ ピルを REST ステップの [本体] フィールドにドラッグできます。