スポークジェネレーターを使用したスポークのビルド

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

    • スポークと呼ばれるカスタム統合を開発するための一連の再利用可能なアクションを作成することで、統合タスクを自動化します。

    ストアでアプリを要求する

    にアクセス ServiceNow Store 利用可能なすべてのアプリを表示したり、ストアに要求を送信したり、 スポークジェネレーター (sn_spoke_builder) をダウンロードしてインストールしたりするための Web サイト。リリースされたすべてのアプリの累積リリースノート情報については、 ServiceNow Store バージョン履歴 リリースノート.

    アプリの依存関係

    アプリのインストールで問題が発生した場合は、依存プラグイン ServiceNow 統合ハブプロフェッショナルパックインストーラー (com.glide.hub.integrations.professional) がインストールされていることを確認してください。

    注:
    これらのプラグインの一部はライセンス可能な機能であり、スポーク実装の外部で使用する場合は適切なライセンスが必要です。

    できること

    統合ハブ のカスタムスポークにより、サードパーティのアプリケーションとのインバウンド統合とアウトバウンド統合の両方が実現します。この統合のことを「スポーク」と呼びます。スポークは、設定が簡単で、スクリプトを作成しなくても強力なアクションをすばやく追加することができます。この機能には、統合ハブ サブスクリプションが必要です。詳細については「法務スケジュール - 統合ハブ の概要」を参照してください。

    必要なサードパーティのアプリケーションにカスタムスポークをビルドするには、OpenAPI 仕様または Postman Collection をインポートするか、または手動でスポークを作成します。

    必要なユーザーロール

    • admin ロールを持つユーザーは、次の操作を実行できます。
      • [スポーク] タブを表示する。
      • 新規スポークを作成する。
      • OpenAPI 仕様をインポートする。
      • 接続エイリアスを作成する。
      • アクションを公開し、アクションをドラフトとして保存する。
      • スポークアクティビティログを確認する。
    • action_designer および fd_read_actions ロールを持つユーザーは、次の操作を実行できます。
      • [スポーク] タブを表示する。
      • スポーク内アクションを表示する。
    • action_designer ロールを持つユーザーは、アクションを手動で追加できます。
      注:
      fd_read_actions ロールのみを持つユーザーは、アクションの表示のみ可能です。
    • flow_operator または flow_designer を持つユーザーは、フローとサブフローを表示できます。

    OpenAPI 仕様のサイズの制限

    デフォルトでは、システムは最大 10 MB の OpenAPI 仕様をインポートできます。インポートサイズを増やすには、glide.rest.openapi.max_request_size システムプロパティを更新します。最大値は 100 MB です。

    OpenAPI 仕様の制限事項

    OpenAPI 仕様をインポートして作成されたスポークアクションには、OpenAPI ステップが含まれています。これらの OpenAPI ステップの制限事項を必ず確認してください。

    要求本文メディアタイプ
    要求本文は、JSON のメディアタイプのみをサポートしています。
    注:
    OpenAPI スキーマに additionalProperties プロパティがある場合、またはプロパティがひとつもない場合は、文字列タイプの出力オブジェクトが作成されます。
    OpenAPI 3.0 コンポーネント

    OpenAPI 3.0 では、API をさらに詳細に記述するための新しいコンポーネントが Swagger 2.0 に追加されています。OpenAPI ステップの OpenAPI サポートは、これらのコンポーネントの一部をサポートしていますが、すべてをサポートしているわけではありません。現在、OpenAPI ステップはこれらのコンポーネントをサポートしていません。

    • スキーマオブジェクト：oneOf、anyOf、additionalProperties プロパティ
    • 識別子オブジェクト
    • 情報オブジェクト：termsOfService、連絡先、ライセンスフィールド
    • サンプルオブジェクト
    • リンクオブジェクト
    • コールバックオブジェクト
    • セキュリティスキームオブジェクト
    • セキュリティ要件オブジェクト
    • タグオブジェクト
    • 外部ドキュメントオブジェクト
    • サーバーオブジェクト
    • 仕様拡張
    • 再帰参照

    これらのコンポーネントの詳細については、OpenAPI ドキュメントを参照してください。「OpenAPI 仕様」を参照してください。

    サポートされる操作の最大数
    API 操作の数は、デフォルトで 500 に制限されています。ただし、システムプロパティ glide.rest.openapi.max_operation_limit を使用すると、操作の数を 1 ～ 1000 の範囲で設定できます。

    アプリバージョン

    スポークジェネレーター v3.0.0 が最新バージョンです。