DevOps ツール統合の作成

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間:5分
  • DevOps ツール統合を作成するには、統合開発者 DevOps ツール統合設定と、ソースツールからデータを収集して変換するための ワークフロースタジオ サブフローを構成します。次に、 DevOps アドミンが DevOps ツール接続を構成します。

    始める前に

    注:
    スコープ対象アプリとして統合を作成する場合、統合開発者が特定のスコープのツール統合および統合機能レコードを作成できるように、システムアドミンはこれらのロールを統合開発者にアサインする必要があります。
    • スコープ対象アプリの開発者ロール
    • DevOps admin ロール

    必要なロール:sn_devops.admin

    このタスクについて

    DevOpsツール統合手順を作成するには、統合開発者とDevOpsアドミンの両方による構成が必要です。
    • 統合開発者は、 DevOps でツール統合レコード、 ワークフロースタジオ サブフロー、ツール機能マッピング、および DevOps で統合機能レコードを作成して、機能とアクションをマッピングします。
      注:
      通知、接続、および検出機能がサポートされています。
    • DevOpsアドミンが DevOps 接続 (計画立案ツールまたはコーディングツール) を設定し、Webhook と認証情報を使用してソースツールを構成します。

    この手順では、 DevOps ツール統合を作成するための詳細な手順を示します。

    手順

    1. 統合開発者:
      ソースツールの統合機能とアクション、およびサブフローを構成します。
      1. 移動先 DevOps > 統合 > ツール統合 統合するツール (ソースツール) を定義するレコードを作成します。
        注:
        DevOps アプリケーションに付属するツール統合レコードは編集しないでください。
        表 : 1. DevOps ツール統合
        ツールラベル サンプルコードツール
        テーブル コードツール [sn_devops_tool]
        パッケージ化可能な統合を使用する 選択済み
        統合バージョン 1.0
        アクティブ 選択済み
      2. 移動先 Flow Designer > デザイナー をクリックし、統合するツール (ソースツール) からデータを収集して変換する サブフローを作成します
        注:
        [ Run As ] フィールドを [System User] に設定し 、[Inputs] ラベルを [current variable] に設定する必要があります。
        表 : 2. 通知サブフローのプロパティ
        名前 コードツール通知
        アプリケーション サンプル統合アプリ
        アクセス可能 すべてのアプリケーションスコープ
        Description (説明) 統合アプリ用のコードツール
        実行方法 システムユーザー
        サブフローには、API 呼び出しによるその他のデータの取得が含まれているか、元のペイロードを変換する必要があります。変換されたペイロードを受信イベントレコードにコピーします。
        注:
        DevOps メインフローは編集しないでください。
      3. 移動先 DevOps > 統合 > ツール機能のマッピング をクリックし、ツール統合レコードをツールタイプ機能にマッピングするレコードを作成します。
        表 : 3. DevOps ツール機能のマッピング
        ツール統合 サンプルツール
        ツールタイプの機能 コード
      4. 移動先 DevOps > 統合 > 統合機能 をクリックし、ツール機能マッピングのアクションを指定するレコードを作成します。
        注:
        DevOps アプリケーションに付属する統合機能レコードは編集しないでください。
        表 : 4. DevOps 統合機能
        ツール統合 サンプルコードツール
        機能マッピング

        サンプルコードツールコード

        注:
        ツールタイプの機能レコードは編集しないでください。
        アクション

        通知

        注:
        ツールアクションレコードは編集しないでください。
        アクティブ 選択済み
        タイムアウト (ミリ秒)

        対応するサブフローのタイムアウト。サブフローの実行がこの値を超えると、タイムアウト例外が発生します。

        値はミリ秒 (ms) 単位です。既定値は 45,000 (45 秒) です。

        サブフロー名

        x_snc_sample_integ.code_tool_notification

        名前にはスコープ名のプリフィックスが付き、実際のサブフロー名の前にドット (.) が付きます。

        たとえば、次のようになります。
        • connect_code_tool サブフロー
        • my_app_scope スコープ
        このフィールドの値は my_app_scope.connect_code_tool です。
        注:
        通知機能の [サブフロー名 ] フィールドを空白のままにすると、通知がデフォルトで処理されます。

        「通知ツール機能のアクション」を参照してください。

        ドメイン global
    2. DevOps 管理者:

      DevOpsからソースツールへの接続を構成します。

      1. ツールレコードには、次のものが含まれている必要があります。
        • 統合開発者が作成したツール統合レコードへの参照 ( [ツール ] フィールド内)
        • ツールラベル
        • 接続エイリアス (接続および資格情報)
      2. DevOps Planning ツールで作成された通知 (Webhook) を通知エンドポイントのソースツールサービスフックにコピーし、認証情報を devops.integration.user に設定します。
      統合イベントのステータスは、[受信イベント] リスト (DevOps > 管理 > 受信イベント).

      オブジェクトが DevOps Core テーブルに挿入されると、受信イベントレコードのステータスは [ 処理済み ] に設定されます。イベントのステータスには、[新規]、[処理中]、[処理済み]、[不一致]、および [エラー] があります。

    3. ツール統合レコードとサブフローが別のスコープで作成された場合、 DevOps アドミンは、アプリが受信イベントテーブルにアクセスできるように、2 つの新しいクロススコープ権限レコードを作成する必要があります。
      移動先 システムアプリケーション > アプリケーションのクロススコープアクセス また、読み取りおよび書き込みのクロススコープ権限レコードを作成して、アプリが受信イベントテーブルにアクセスできるようにします。
      Field (フィールド) 読み込み 書き込み
      ソース スコープ 現在のアプリケーションに基づいて自動入力されます
      ターゲットスコープ DevOps
      ターゲット名 sn_devops_inbound_event
      ターゲットタイプ テーブル
      操作 読み込み 書き込み
      ステータス 許可

    図 : 1. DevOps ツール統合
    DevOpsToolIntegration
    図 : 2. ワークフロースタジオ サブフローのプロパティ
    サブフロープロパティ
    図 : 3. ワークフロースタジオ サブフロー
    サブフロー
    図 : 4. ワークフロースタジオ DevOps 統合 - 通知フロー
    NotificationFlow
    図 : 5. DevOps ツール機能のマッピング
    DevOps ユーザー統合マッピング
    図 : 6. 統合機能
    統合機能
    図 : 7. 計画立案ツール
    統合計画ツール
    図 : 8. クロススコープアクセスレコード (読み取りおよび書き込み)
    クロススコープアクセス