OpenAPI 仕様のインポートによるスポークの作成とアクションのビルド

OpenAPI 仕様をインポートすることで、統合を自動化し、再利用可能なアクションを生成します。

始める前に

• ServiceNow Store からスポークジェネレーターアプリをインストールします。
• ServiceNow 統合ハブ Professional Pack Installer (com.glide.hub.integrations.professional) がインストールされ、ライセンスのエンタイトルメントが付与されていることを確認します。
• 必要なロール：admin

手順

1. 移動先 すべて > プロセス自動化 > ワークフロースタジオ.
2. クリック 新規作成 > スポーク.
3. [スポーク情報 (Spoke Info)] 画面で、スポークを新しいスコープに作成するか既存のスコープに作成するかを指定します。
   1. 新しいスコープでスポークを作成する場合は、統合のロゴとして画像を選択し、フィールドに入力します。

      ここでは、例として Zoom との統合について説明します。

      フィールド	説明
      スポーク名	カスタムスポークを識別する名前
      説明	カスタムスポークの説明

      

      注:

      [アプリスコープ名] の値は、x_<company-code>_<spoke-name>_<spoke> の形式です。デフォルトでは、<company-code> は snc です。システムプロパティ glide.appcreator.company.code の値を設定することで、会社コードを設定できます。

      この構成値は、値 [アプリスコープ名] が生成されるときに使用されます。

   2. 既存のスコープでスポークを作成する場合は、統合のロゴとして画像を選択し、フィールドに入力します。

      ここでは、例として AWS との統合について説明します。

      フィールド	説明
      アプリケーション名	既存のアプリケーション名またはスコープ。
      アプリスコープ名	選択したアプリケーション名に基づいて自動入力されるスコープ名。
      説明	カスタムスポークの説明

      

4. [続行] をクリックします。

   指定した名前と説明に基づいて、ストアに一致するスポークが存在する場合は、スポークの詳細が表示されます。

   1. [ストアの詳細を表示 (View details on Store)] をクリックすると、一致するスポークの詳細が表示されます。
      一致するスポークの詳細が新しいブラウザータブに表示されます。
   2. ストアからスポークをインストールします。
      詳細については、「Install a ServiceNow Store application」を参照してください。
   3. スポークをインストールしたら、[ワークフロースタジオ] タブに移動します。
      [ストアからスポークをインストールしましたか (Have you installed a spoke from the Store?)] というメッセージが表示されます。
   4. これらのオプションのいずれかを選択し、[続行] をクリックします。

      オプション	説明
      はい、インストールされているスポークを表示します (Yes, view the installed spoke.)	[統合] の下の [スポーク] ダッシュボードにリダイレクトするオプション。
      いいえ、カスタムスポークを作成します (No, I will build custom spoke.)	スポークの作成を続行するオプション。
      いいえ、スポークの作成を終了します (No, I want to exit spoke creation.)	現在のタブを閉じるオプション。

5. カスタムスポークをビルドする場合は、[スキップ] をクリックします。
   注:

   次の手順は、[いいえ、カスタムスポークを作成します (No, I will build custom spoke.)] オプションを選択している場合にも適用できます。

   スポークが作成され、確認メッセージが表示されます。

6. [ビルド情報] 画面で、スポークのビルドに使用する方法を選択します。
   OpenAPI 仕様または Postman Collection を使用してスポークをビルドすることを選択できます。
7. [OpenAPI 仕様] を選択し、[続行] をクリックして OpenAPI 仕様をインポートします。
   
8. [OpenAPI ソース] で、[新規のインポート (Import new)] をクリックします。
9. [新しい OpenAPI ソースをインポート(Import new OpenAPI source)] 画面で、次の 2 つのステップのいずれかを実行します。
   1. URL を使用してインポートする場合は、[インポート方法 (Import method)] で [URL からインポート(Import from URL)] を選択し、[OpenAPI URL] で URL を指定します。
      
   2. JSON または YAML コードを使用して手動でインポートする場合は、[インポート方法 (Import method)] で [JSON または YAML から手動でインポート(Import from JSON or YAML manually)] を選択し、JSON または YAML でコードを指定します。
      
10. [インポート] をクリックします。
    OpenAPI ソースがインポートされます。
11. [接続および資格情報エイリアス] で、[新規作成] をクリックします。
12. [新しい接続および資格情報エイリアスを作成 (Create new connection and credential alias)] 画面で、フィールドに入力し、エイリアス情報を入力します。

    フィールド	説明
    接続および認証情報名 (Connection & Credential name)	接続および資格情報エイリアスレコードを識別するための名前です。
    認証用の構成テンプレート (Configuration Template for authentication)	この統合に必要な認証メカニズムです。認証メカニズムと OpenAPI ソースの間に互換性があることを確認します。 注: 構成テンプレートは、指定した OpenAPI 仕様に基づいて自動入力されます。デフォルトのオプションを使用して続行することも、要件に応じて変更することもできます。

    
13. [エイリアス作成して続行 (Create alias and continue)] をクリックします。
14. 同じ画面で、フィールドに入力してエイリアスを構成します。

    フィールド	説明
    接続情報
    接続名	接続レコードを識別する名前です。
    接続 URL	サードパーティのインスタンスまたはサーバーに接続するためのベース URL。この URL は、指定した OpenAPI 仕様に基づいて自動入力されます。
    認証情報
    選択した構成テンプレートに基づいて、関連する認証情報フィールドが表示されます。認証情報レコードを設定するために必要な値を指定します。

    

    エイリアスレコードを後で設定する場合は、[後で行う] をクリックします。

15. [Submit (送信)] をクリックします。
    接続エイリアスレコードが作成されます。
16. [操作を生成(Generate operations)] をクリックします。
    
    OpenAPI 仕様を使用して実行できるすべての操作が一覧表示されます。
17. 必要な操作を選択します。

    検索バーに必要な用語を入力することで、必要なアクションを検索できます。指定した検索用語に一致するアクションが表示されます。

    
18. [公開] をクリックします。
    または、[アクションをドラフトとして保存 (Save actions as Draft)] を選択してアクションをドラフトとして保存すると、要件に応じて変更したり、後から公開したりすることができます。
19. [完了：スポークに移動] をクリックして [スポーク] ページに移動し、公開ステータスを表示します。
    • OpenAPI ステップを含むアクションが作成されます。OpenAPI ステップの詳細については、「OpenAPI support in the REST step」を参照してください。
    • アクションの入力および出力がマッピングされます。
    • アクションが公開され、スポーク詳細ページの アクション > 公開済み.

    公開されたアクションの使用を開始することで、要件に応じてフローまたはサブフローを作成できます。

    • アクションをドラフトとして保存した場合は、スポーク詳細ページの アクション > ドラフト.
    • スポークアクティビティに関するランタイム情報を表示するには、スポークの詳細ページで [スポークアクティビティログ] をクリックします。スポークアクティビティが実行されるたびに、その情報がスポークアクティビティログとして生成されます。アクティビティログを表示するには、必要な番号をクリックします。スポークアクティビティログのすべての操作には、次のいずれかのステータス値があります。

      ステータス	説明
      新規	操作のイベントが作成され、この操作がまもなく実行されます。
      エラー	操作の実行に失敗しました。
      processing	操作の実行が進行中です。
      成功	操作が正常に実行されました。

    スポークの詳細ページでフローとサブフローを作成し、それらを統合で使用できます。詳細については、「フローの構築」と「サブフローのビルド」を参照。

    スポークのアクティビティログとともに、利用可能なフロー、サブフロー、およびアクションの詳細をスポークの詳細ページで表示することもできます。