SOAP ステップ

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

    • アクションデザイナーが外部システムへの送信 SOAP Web サービス要求を送信できるようにします。

    注:
    SOAP ステップ 基本システムでは使用できず、ServiceNow® 統合ハブ のサブスクリプションが必要です。 必要なプラグインを有効化した後、ステップは [統合] の下に表示されます。

    ロールと使用可用性

    • ワークフロースタジオ アクションステップとして利用可能です。action_designer ロールを持つユーザーは、1 つ以上のアクションステップを使用してカスタムアクションを作成できます。
    • 次の Web サービスタスクを実行するには、アクションデザイナーに web_service_admin ロールが必要です。
      • WSDL の選択
      • 新しい WSDL のロード
      • WS セキュリティポリシーの選択
    • ServiceNow® MID サーバー では、WS セキュリティポリシーはサポートされません。

    フィールド

    フィールド 説明
    接続の詳細
    接続 使用する接続のタイプ。
    • [インラインで接続を定義]：アクションステップ内の接続情報を定義します。
    • [接続エイリアスを使用]：接続エイリアステーブルを使用して接続情報を定義します。エイリアスを使用することで、複数の環境でアクションを使用する場合に、複数の認証情報と接続情報プロファイルを構成する必要がなくなります。また、接続情報が変更された場合に、カスタムアクションを更新する必要がありません。

    接続と資格情報の詳細については、「資格情報、接続、およびエイリアスについて」を参照してください。
    接続エイリアス アクションステップを実行するために使用される接続および資格情報エイリアスレコード。flow_designer または admin ロールを持つユーザーは、関連する接続レコードを作成または選択できます。エイリアスを使用することで、複数の環境でアクションを使用する場合に、複数の認証情報と接続情報プロファイルを構成する必要がなくなります。また、接続情報が変更された場合に、カスタムアクションを更新する必要がありません。接続と資格情報の詳細については、「資格情報、接続、およびエイリアス」を参照してください。 認証情報の値は、データパネルにパスワード (双方向暗号化) データピルとして表示されます。
    注:
    このフィールドは、接続リストから [接続エイリアスを使用] が選択されている場合に利用可能です。
    認証情報エイリアス アクションステップを実行するために使用される認証情報エイリアス。flow_designer または admin ロールを持つユーザーは、関連する接続レコードを作成または選択できます。エイリアスを使用することで、複数の環境でアクションを使用する場合に、複数の認証情報を構成する必要がなくなります。また、認証情報が変更された場合に、カスタムアクションを更新する必要がありません。接続と資格情報の詳細については、「資格情報、接続、およびエイリアス」を参照してください。 認証情報の値は、データパネルにパスワード (双方向暗号化) データピルとして表示されます。
    注:
    このフィールドは、接続リストから [インラインで接続を定義] が選択されている場合に利用可能です。
    MID を使用 MID サーバー を使用して SOAP ステップ を実行するオプション。[MID 選択]、[MID アプリケーション]、および [機能] フィールドを表示するには、このチェックボックスを選択します。
    注:
    このフィールドは、接続リストから [接続エイリアスを使用] が選択されている場合に利用可能です。
    エンドポイント SOAP 要求の URL エンドポイント。[接続エイリアスを使用] を選択した場合、このフィールドは読み取り専用になり、エイリアスに関連付けられたエンドポイント URL が表示されます。[インラインで接続を定義] を選択した場合は、接続のエンドポイント URL を入力します。
    SOAP ステップをテスト SOAP ステップをテストするボタン。テストするには、[SOAP ステップをテスト (Test SOAP Step)] ボタンを選択します。必要な入力値を入力して [テストを実行] ボタンを選択します。テストの実行後、ステップの出力またはエラーメッセージがテストウィンドウの [テスト結果] セクションに表示されます。
    接続タイムアウト
    システムがホスト接続の成功を待機するミリ秒数。この間にステップが正常に接続されない場合、接続要求はタイムアウトします。[インラインで接続を定義] を選択した場合は、接続のタイムアウト値を入力します。システムのデフォルトの接続タイムアウト値を使用するには、このフィールドを空のままにします。
    注:
    接続タイムアウト値をゼロに設定しないでください。接続が古くなる可能性があるためです。
    MID 選択 特定の MID サーバーまたは MID クラスターを選択するオプション。
    • MID サーバーの自動選択：MID サーバーを自動的に選択します。
    • 特定の MID Server：選択した MID サーバーを使用します。
    • 特定の MID クラスター：選択した MID クラスターを使用します。
    このフィールドは、接続リストから [インラインで接続を定義] が選択されていて、[MID を使用] のチェックがオンの場合に利用可能です。
    MID クラスター 使用する MID クラスターのデータピル。このフィールドは、接続リストから [インラインで接続を定義] が選択されていて、[MID を使用] チェックボックスがオンになっており、MID 選択リストから [特定の MID クラスター] が選択されている場合に利用可能です。
    要求の詳細
    エンベロープの作成 SOAP エンベロープを作成するときに使用する方法。
    • WSDL から (From WSDL)：このオプションを選択すると、[WSDL の選択] および [操作] フィールドが表示されます。
    • 手動：WSDL テキストを手動で入力するか貼り付けるには、このオプションを選択します。
    WSDL の選択 SOAP エンベロープの作成に使用する WSDL。既存の WSDL レコードを選択するか、[新しい WSDL をロード (Load New WSDL)] をクリックし、WSDL ファイルをダウンロードするか手動で入力します。選択した WSDL により、[操作]、[SOAP アクション]、および [SOAP エンベロープ] のフィールドに値が入力されます。
    注:
    このフィールドは、[エンベロープの作成 (Build Envelope)] リストから [WSDL から (From WSDL)] を選択した場合に使用できます。
    新しい WSDL をロードします。 WSDL ファイルをダウンロードするか手動で入力するオプション。
    運用 選択した WSDL から実行する操作。各 WSDL には、利用可能な操作の独自のリストがあります。
    SOAP アクション SOAP アクションを実行する URL。[エンベロープの作成 (Build Envelope)] を [WSDL から (From WSDL)] に設定すると、このフィールドは読み取り専用となり、SOAP アクションを実行する URL が表示されます。[エンベロープの作成 (Build Envelope)] を [手動] に設定した場合は、SOAP アクションを実行する URL を入力します。
    要求タイプ 要求の形式。次のオプションがあります。
    • [テキスト]：JSON、XML、その他のテキスト形式の要求。
    • [バイナリ]：バイナリファイル形式の要求。
    SOAP エンベロープ エンドポイントに送信する XML テキスト。[エンベロープの作成 (Build Envelope)] を [WSDL から (From WSDL)] に設定すると、選択した [操作] に必要な XML が追加されます。[エンベロープの作成 (Build Envelope)] を [手動] に設定した場合は、使用する XML テキストを入力します。適切な SOAP エンベロープ要素には、レコードの値を入力します。たとえば、<short_description>要素にはインシデントの簡単な説明を入力します。
    注:
    このフィールドは、[要求タイプ] が [テキスト] の場合に使用可能です。
    添付ファイル 要求を含む添付ファイルレコード。前のステップでこのレコードを検索または作成して、入力変数として定義できます。スクリプトステップで JSONStreamingBuilder および XMLStreamingBuilder API を使用して作成します。
    注:
    このフィールドは、[要求タイプ] が [バイナリ] の場合に使用可能です。
    エンベロープをリセットします。 SOAP エンベロープのすべての手動変更を破棄するオプション。SOAP エンベロープを元のステータスに復元するには、このチェックボックスをオンにします。
    注:
    このフィールドは、[エンベロープの作成 (Build Envelope)] リストから [WSDL から (From WSDL)] を選択した場合に使用できます。
    新しい WSDL
    名前 作成する WSDL レコードの名前。
    メソッドをインポートします。 WSDL を入力する方法。
    • URL からダウンロード (Download from URL)：[WSDL URL]、[ユーザー名]、および [パスワード] フィールドを表示して、外部ソース、一般的には Web サービスプロバイダーから WSDL を取得するには、これを選択します。
    • WSDL コンテンツを手動で入力：[WSDL コンテンツ] フィールドを表示して WSDL テキストを手動で入力するか貼り付けるには、これを選択します。
    WSDL の URL SOAP Web サービスの URL。
    注:
    このフィールドは、[インポート方法 (Import Method)] リストから [URL からダウンロード (Download from URL)] を選択すると使用可能になります。
    ユーザー名 SOAP Web サービスで認証するユーザー名。
    注:
    このフィールドは、[インポート方法 (Import Method)] リストから [URL からダウンロード (Download from URL)] を選択すると使用可能になります。
    パスワード SOAP Web サービスで認証するパスワード。ユーザーインターフェイスではパスワードが常にマスクされ、プレーンテキストでエクスポートすることが防止されます。
    注:
    このフィールドは、[インポート方法 (Import Method)] リストから [URL からダウンロード (Download from URL)] を選択すると使用可能になります。
    WSDL コンテンツ SOAP Web サービスとそのオペレーションを説明する XML ドキュメント。
    注:
    このフィールドは、[インポート方法 (Import Method)] リストから [WSDL コンテンツを手動で入力] を選択すると使用可能になります。
    インポート SOAP Web サービスの WSDL をインスタンスに追加するためのオプション。
    WS-Security を使用
    WS セキュリティ ポリシーの有効化 SOAP Web サービスをセキュリティ方針に制限するためのオプション。このチェックボックスをオンにすると、[ポリシー] フィールドが表示されます。
    ポリシー Web サービス接続を制限するために使用するポリシーレコード。既存のポリシーレコードを選択します。
    再試行ポリシー
    再試行ポリシーを有効化 再試行ポリシーを有効にするオプション。詳細については、「再試行ポリシー」を参照してください。
    エイリアスのデフォルトポリシーを上書き デフォルトの再試行ポリシーを上書きするオプション。 接続リストの [インラインで接続を定義] が選択されている場合は、このチェックボックスは適用されません。
    再試行ポリシー 接続エイリアスに関連付けられているデフォルトの再試行ポリシー。エイリアスのデフォルトポリシーを上書きが選択されている場合は、デフォルトの再試行ポリシーを上書きして要件に基づいて別の既存の再試行ポリシーを選択できます。
    詳細オプション
    ヘッダー HTTP ヘッダーとして SOAP メッセージに含める名前と値のペア。ヘッダーを追加するには、プラスアイコン プラスアイコンをクリックします。HTTP ヘッダーごとに [名前] と [値] を追加します。
    ヘッダー > 空の場合省略 値が空または null である場合にヘッダーを除外するオプション。
    注:
    このチェックボックスは、下向き矢印をクリックして詳細オプションを表示した後に使用可能になります。

    アクションエラー評価

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

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

    SOAP 応答サイズの制限

    SOAP 応答のサイズは 5 MB に制限されています。この制限を超える直接の SOAP 応答はエラーとなります。応答のサイズを大きくするには、応答サイズの上限を glide.pf.soap.response_payload_max_size システムプロパティで増やします。このシステム プロパティは最大値 10 MB をサポートしています。