Jira Server（Data Center）

Jira Server（Data Center）コネクタを使用すると、Jira Software Data Center に接続して、挿入、削除、更新、読み取りのオペレーションを実行できます。

サポート対象のバージョン

このコネクタは、Jira Server Data Center API バージョン V2 と V3 をサポートしています。

始める前に

Google Cloud プロジェクトで次のタスクを行います。

  • ネットワーク接続が設定されていることを確認します。ネットワーク パターンの詳細については、Network Connectivity をご覧ください。
  • コネクタを構成するユーザーに roles/connectors.admin IAM ロールを付与します。
  • コネクタに使用するサービス アカウントに、roles/secretmanager.viewer と roles/secretmanager.secretAccessor の IAM ロールを付与します。
  • 次のサービスを有効にします。
    • secretmanager.googleapis.com（Secret Manager API）
    • connectors.googleapis.com（Connectors API）

    サービスを有効にする方法については、サービスを有効にするをご覧ください。以前にプロジェクトでこうしたサービスを有効にしていない場合は、コネクタを構成するときに有効にするよう求められます。

コネクタを構成する

接続はデータソースに特有です。つまり、多数のデータソースがある場合は、データソースごとに別々の接続を作成する必要があります。接続を作成する手順は次のとおりです。

  1. Cloud コンソールで、[Integration Connectors] > [接続] ページに移動し、Google Cloud プロジェクトを選択または作成します。

    [接続] ページに移動

  2. [+ 新規作成] をクリックして [接続の作成] ページを開きます。
  3. [ロケーション] セクションで、接続のロケーションを選択します。
    1. リージョン: プルダウン リストからロケーションを選択します

      サポートされているすべてのリージョンの一覧については、ロケーションをご覧ください。

    2. [NEXT] をクリックします。
  4. [接続の詳細] セクションで、次の操作を行います。
    1. コネクタ: 使用可能なコネクタのプルダウン リストから [Jira Server（Data Center）] を選択します。
    2. コネクタのバージョン: 使用可能なバージョンのプルダウン リストからコネクタのバージョンを選択します。
    3. [接続名] フィールドに、接続インスタンスの名前を入力します。

      接続名は次の条件を満たす必要があります。

      • 接続名には英字、数字、ハイフンを使用できます。
      • 文字は小文字のみを使用できます。
      • 接続名の先頭には英字を設定し、末尾には英字または数字を設定する必要があります。
      • 接続名は 49 文字以内で指定してください。
    4. 必要に応じて、接続インスタンスの [説明] を入力します。
    5. 必要に応じて、Cloud Logging を有効にして、ログレベルを選択します。デフォルトのログレベルは Error に設定されています。
    6. サービス アカウント: 必要なロールを持つサービス アカウントを選択します。
    7. イベント サブスクリプションの接続を使用するには、[イベント サブスクリプションを有効にする] を選択します。次のオプションが表示されます。
      • エンティティとアクションを使用したイベント サブスクリプションを有効にする: このオプションを選択すると、イベント サブスクリプションとコネクタ オペレーション（エンティティとアクション）の両方に対して接続が使用されます。
      • イベント サブスクリプションのみを有効にする: イベント サブスクリプションに対してのみ接続を使用するには、このオプションを選択します。このオプションを選択した場合は、[次へ] をクリックして、イベント サブスクリプションを構成します。
    8. 必要に応じて、接続ノードの設定を構成します。

      • ノードの最小数: 接続ノードの最小数を入力します。
      • ノードの最大数: 接続ノードの最大数を入力します。

      ノードは、トランザクションを処理する接続の単位（またはレプリカ）です。1 つの接続でより多くのトランザクションを処理するには、より多くのノードが必要になります。逆に、より少ないトランザクションを処理するには、より少ないノードが必要になります。ノードがコネクタの料金に与える影響については、接続ノードの料金をご覧ください。値を入力しない場合は、デフォルトで最小ノード数は 2 に設定され（可用性を高めるため）、最大ノード数は 50 に設定されます。

    9. （省略可）[詳細設定] セクションで、[プロキシを使用する] チェックボックスをオンにして、接続用のプロキシ サーバーを構成し、次の値を構成します。
      • Proxy Auth Scheme: プロキシ サーバーで認証する認証タイプを選択します。次の認証タイプがサポートされています。
        • 基本: 基本的な HTTP 認証。
        • ダイジェスト: ダイジェスト HTTP 認証。
      • Proxy User: プロキシ サーバーでの認証に使用されるユーザー名。
      • プロキシ パスワード: ユーザーのパスワードの Secret Manager シークレット。
      • Proxy SSL Type: プロキシ サーバーへの接続時に使用する SSL タイプ。次の認証タイプがサポートされています。
        • 自動: デフォルトの設定。URL が HTTPS URL の場合は、[トンネル] オプションが使用されます。URL が HTTP URL の場合、[なし] オプションが使用されます。
        • 常に: 接続は常に SSL 対応です。
        • なし: 接続は SSL に対応していません。
        • トンネル: 接続はトンネリング プロキシ経由で行われます。プロキシ サーバーがリモートホストへの接続を開き、トラフィックはプロキシを経由するようになります。
      • [Proxy Server] セクションで、プロキシ サーバーの詳細を入力します。
        1. [+ 宛先を追加] をクリックします。
        2. [宛先の種類] を選択します。
          • Host address: 宛先のホスト名または IP アドレスを指定します。

            バックエンドへのプライベート接続を確立する場合は、次のようにします。

    10. 必要に応じて SSL を使用する場合は、[SSL を有効にする] を選択します。これにより、SSL 構成の詳細が表示されます。
      1. トラストストアの種類を選択します。[パブリック]、[プライベート]、[安全でない接続] のいずれかになります。
      2. トラストストアの選択に基づいて表示される証明書を選択します。
      3. mTLS を使用している場合は、[Key Store] セクションでキーストア証明書を選択します。
    11. 必要に応じて、[+ ラベルを追加] をクリックして Key-Value ペアの形式でラベルを接続に追加します。
    12. [NEXT] をクリックします。
  5. [宛先] セクションに、接続するリモートホスト（バックエンド システム）の詳細を入力します。
    1. 宛先の種類: 宛先の種類を選択します。
      • 宛先のホスト名または IP アドレスを指定するには、[ホストアドレス] を選択し、[ホスト 1] フィールドにアドレスを入力します。
      • プライベート接続を確立するには、[エンドポイント アタッチメント] を選択し、[エンドポイント アタッチメント] リストから必要なアタッチメントを選択します。

      セキュリティをさらに強化してバックエンドシステムへのパブリック接続を確立する場合は、接続用の静的アウトバウンド IP アドレスの構成を検討してから、特定の静的 IP アドレスのみを許可リストに登録するようファイアウォール ルールを構成します。

      他の宛先を入力するには、[+ 宛先を追加] をクリックします。

    2. [NEXT] をクリックします。
  6. [認証] セクションで、認証の詳細を入力します。
    1. [認証タイプ] を選択し、関連する詳細を入力します。

      Jira Server（Data Center）接続でサポートされる認証タイプは次のとおりです。

      • ユーザー パスワード
      • API トークン
      • 個人用アクセス トークン
      • OAuth 2.0 - 認証コード

      2. これらの認証タイプの構成方法については、認証を構成するをご覧ください。

    2. [NEXT] をクリックします。
  7. Review: 接続と認証の詳細を確認します。
  8. [作成] をクリックします。

イベント サブスクリプションの詳細

[イベント サブスクリプションの詳細] セクションで、イベント サブスクリプションが作成される Jira Server（Data Center）アカウントの詳細を入力します。

  1. 宛先タイプ: [ホストアドレス] を選択します。
  2. ホスト: Jira Server（Data Center）アカウントの登録 URL を入力します。この URL に対してイベント サブスクリプションが作成されます。
  3. API トークン: ユーザー名に関連付けられた API トークンを含む Secret Manager の Secret を選択します。
  4. シークレット バージョン: シークレット バージョンを選択します。
  5. データ拡充を有効にする: Jira Server（Data Center）トリガーで Jira Server（Data Center）インスタンスから完全なイベント ペイロードを取得する場合は、このチェックボックスをオンにします。例については、トリガー出力をご覧ください。
  6. バックエンド アプリケーションと接続間を安全に接続するには、[プライベート接続を有効にする] を選択します。このオプションを選択した場合は、接続の作成後に追加の構成手順を実行する必要があります。詳細については、イベント サブスクリプションのプライベート接続をご覧ください。
  7. デッドレター構成を入力します。デッドレターを構成すると、指定された Pub/Sub トピックに未処理のイベントが書き込まれます。次の詳細情報を入力します。
    1. デッドレター プロジェクト ID: デッドレター Pub/Sub トピックを構成した Google Cloud プロジェクト ID。
    2. デッドレター トピック: 未処理イベントの詳細を書き込む Pub/Sub トピック。

認証を構成する

使用する認証に基づいて詳細を入力します。

  • ユーザーパスワード
    • ユーザー名: 認証に使用される Jira Server（Data Center）ユーザー アカウントを入力します。
    • パスワード: アカウントに関連付けられているパスワードを入力します。
  • API トークン
    • ユーザー名: API トークンの作成に使用した Jira Server（Data Center）のユーザー名を入力します。
    • API トークン: API トークンを含む Secret Manager の Secret を選択します。
  • 個人用アクセス トークン
    • 個人用アクセス トークン: 個人用アクセス トークンを含む Secret Manager のシークレットを指定します。
    • シークレットのバージョン: 選択したシークレットのシークレット バージョンを選択します。
  • OAuth 2.0 - 認証コード
    • クライアント ID: 外部アプリケーションによって提供されるクライアント ID を指定します。
    • スコープ: 必要な権限スコープを指定します。
    • クライアント シークレット : Secret Manager のシークレットを選択します。この認証を構成する前に、Secret Manager のシークレットを作成しておく必要があります。
    • シークレットのバージョン: クライアント シークレットの Secret Manager シークレットのバージョンを選択します。
    • 認証 URL: クライアントの作成時に生成された URL を指定します。

      • Authorization code 認証タイプの場合は、接続を作成した後、認証を構成するためにいくつかの追加手順を行う必要があります。詳しくは、接続作成後の追加手順をご覧ください。

Jira Server（Data Center）の構成

Atlassian アカウントを設定して Jira Cloud にログインする

Altassian アカウントの設定と Jira Cloud へのログインについては、Atlassian ホームをご覧ください。

ホスト アドレスと認証情報を設定する

  1. Jira Cloud インスタンスにログインします。
  2. インスタンスの詳細であるホスト アドレスを入力します。
  3. Atlassian アカウント ID であるユーザー名を入力します。
  4. [設定] に移動して、API トークンを生成します。
  5. 個人設定から [Atlassian アカウント設定] を選択します。
  6. [セキュリティ] タブをクリックし、API トークンを見つけて [API トークンの作成と管理] をクリックします。
  7. [API トークンを作成] をクリックします。
  8. 表示されたダイアログで、トークンのわかりやすいラベルを入力し、[作成] をクリックします。
  9. [クリップボードにコピー] をクリックし、トークンをスクリプトに貼り付けて、後で使用できるように保存します。

接続作成後の追加手順

認証に OAuth 2.0 - Authorization code を選択した場合は、接続の作成後に次の追加の手順を行う必要があります。

  1. 接続ページで、新しく作成された接続を見つけます。

    新しいコネクタの [ステータス] は [承認が必要] になります。

  2. [承認が必要] をクリックします。

    これにより、[承認の編集] ペインが表示されます。

  3. [リダイレクト URI] の値を外部アプリケーションにコピーします。
  4. 認可の詳細を確認します。
  5. [Authorize（承認）] をクリックします。

    認可が成功すると、[接続] ページの接続ステータスが「有効」に設定されます。

認証コードの再認可

Authorization code 認証タイプを使用しているユーザーが、Jira Server（Data Center）アプリケーションの構成を変更した場合は、Jira Server（Data Center）接続を再認可する必要があります。接続を再認可するには、次の手順を行います。

  1. [接続] ページで必要な接続をクリックします。

    これにより、[接続の詳細] ページが開きます。

  2. [編集] をクリックして、接続の詳細を編集します。
  3. [認証] セクションで [OAuth 2.0 - 認証コード] の詳細を確認します。

    必要に応じて必要な変更を加えます。

  4. [保存] をクリックします。接続の詳細ページに移動します。
  5. [認証] セクションで [承認の編集] をクリックします。これにより、[承認] ペインが表示されます。
  6. [Authorize（承認）] をクリックします。

    認可が成功すると、[接続] ページの接続ステータスが「有効」に設定されます。

接続構成のサンプル

このセクションでは、Jira Server 接続を作成するときに構成するさまざまなフィールドのサンプル値を示します。

Jira ウェブ接続のタイプ

フィールド名 詳細
ロケーション us-east1
コネクタ Jira Server（Data Center）
コネクタのバージョン 1
接続名 google-cloud-jira-rest-conn
サービス アカウント my-service-account@my-project.iam.gserviceaccount.com
ノードの最小数 2
ノードの最大数 50
宛先の種類 ホストアドレス
ホスト 192.0.2.0
ユーザー名 ユーザー名
API トークン API_TOKEN
シークレット バージョン 1

システムの上限

Jira Server（Data Center）コネクタは、ノードごとに 1 秒あたり最大 15 件のトランザクションを処理し、この上限を超えるトランザクションをスロットル調整します。デフォルトでは、Integration Connectors は、接続に 2 つのノードを割り当てます（可用性を高めるため）。

Integration Connectors に適用される上限の詳細については、上限をご覧ください。

統合で Jira Server（Data Center）接続を使用する

接続を作成すると、Apigee Integration と Application Integration の両方で使用できるようになります。この接続は、コネクタタスクを介して統合で使用できます。

  • Apigee Integration で Connectors タスクを作成して使用する方法については、Connectors タスクをご覧ください。
  • Application Integration で Connectors タスクを作成して使用する方法については、Connectors タスクをご覧ください。

エンティティ オペレーションの例

このセクションでは、このコネクタでエンティティ オペレーションを実行する方法の例を示します。

例 - 問題を一覧表示する

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity リストから Issues を選択します。
  3. [LIST] オペレーションを選択し、[完了] をクリックします。
  4. [コネクタ] タスクの [タスク入力] セクションで、お客様の要件に応じて filterClause を設定できます。

    5. フィルタ句の値は単一引用符（'）で囲む必要があります。フィルタ句を使用すると、列に基づいてレコードをフィルタできます。

    フィルタ句を使用すると、列に基づいてレコードをフィルタできます。たとえば、レコードをフィルタリングするには、filterClause（Location='US' と region='us-east1'）を使用します。

    エンティティ ID のみを渡すとエラーが発生するエンティティで filterClause を使用することもできます。

例 - 問題を取得する

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity リストから Issues を選択します。
  3. [GET] オペレーションを選択し、[完了] をクリックします。
  4. エンティティ ID を 10000 に設定します。これは、問題に渡されるキー ID です。エンティティ ID を設定するには、[コネクタ] タスクの [タスク入力] セクションで [EntityId] をクリックし、[デフォルト値] に 10000 を入力します。

    エンティティ ID の値は直接渡す必要があります。例: 10000。ここで、10000 は一意の主キー値であり、渡されます。

    Get オペレーションを使用するには、エンティティに一意の主キーが必要です。そうでない場合、Get オペレーションは実行できません。

例 - 問題を削除する

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity リストから Issues を選択します。
  3. [DELETE] オペレーションを選択し、[完了] をクリックします。
  4. エンティティ ID を 10000 に設定します。これは渡されるキーです。エンティティ ID を設定するには、[コネクタ] タスクの [タスク入力] セクションで [EntityId] をクリックし、[デフォルト値] に 10000 を入力します。

例 - IssueType を作成する

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity リストから IssueTypes を選択します。
  3. [Create] オペレーションを選択し、[完了] をクリックします。
  4. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
  "Name": "task123456",
  "Description": "New description is added."
}

    統合が成功すると、コネクタタスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

    {
  "Id": "10041"
}

例 - Issues を作成する

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity リストから Issues を選択します。
  3. [Create] オペレーションを選択し、[完了] をクリックします。
  4. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
    "IssueTypeName": "Subtask", 
    "ProjectName": "kanban4", 
    "Summary": "Summary Added", 
    "ParentKey": "KN-6" 
}

    統合が成功すると、コネクタタスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

    {
  "Id": 10071.0
}

例 - スプリントを作成する

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity リストから [Sprints] を選択します。
  3. [Create] オペレーションを選択し、[完了] をクリックします。
  4. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
  "Name": "PROJ Sprint Googlecloud",
  "State": "future",
  "Goal": null,
  "OriginBoardId": 2.0,
  "StartDate": "2023-06-27 07:06:08",
  "EndDate": "2023-07-27 07:06:08"
}

    統合が成功すると、コネクタタスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

    {
  "Id": 23.0
}

例 - コメントを作成する

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity リストから Comments を選択します。
  3. [Create] オペレーションを選択し、[完了] をクリックします。
  4. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
  "IssueId": 10001.0,
  "Body": "Adding comments to above ID by editing it"
}

    統合が成功すると、コネクタタスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

    {
  "Id": 10023.0,
  "IssueId": null
}

例 - ユーザーを作成する

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity リストから [Users] を選択します。
  3. [Create] オペレーションを選択し、[完了] をクリックします。
  4. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
  "GroupName": null,
  "DisplayName": "Sample",
  "EmailAddress": "sample@gmail.com",
  "Active": true,
  "TimeZone": null,
  "Locale": "en_US",
  "AccountType": "atlassian"
}

    統合が成功すると、コネクタタスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

    {
  "AccountId": "557058:0a04612c-746d-4d47-a909-71ba797fe228"
}

例 - Worklogs を作成する

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity リストから Worklogs を選択します。
  3. [Create] オペレーションを選択し、[完了] をクリックします。
  4. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
  "IssueKey": "GJCT-1",
  "Started": "2023-06-10 08:08:08",
  "TimeSpent": "2000"
}

    統合が成功すると、コネクタタスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

    {
  "Id": "41718",
  "IssueId": 10000.0
}

例 - IssueTypes を更新する

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity リストから IssueTypes を選択します。
  3. [Update] オペレーションを選択し、[完了] をクリックします。
  4. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
  "Name": "NEW_TASK",
  "Description": "New Description"
}
  5. エンティティ ID を IssueTypes のエンティティに設定します。エンティティ ID を設定するには、[エンティティ ID] をクリックし、[デフォルト値] フィールドに「 10038 」と入力します。

    統合が成功すると、コネクタタスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

    {
  "Id": "10038"
}

例 - 問題を更新する

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity リストから Issues を選択します。
  3. [Update] オペレーションを選択し、[完了] をクリックします。
  4. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
  "AssigneeAccountId": "61d572aa7c6f9800705289a1",
  "AssigneeName": "Charlie b"
}
  5. エンティティ ID を Issues のエンティティに設定します。エンティティ ID を設定するには、[エンティティ ID] をクリックし、[デフォルト値] フィールドに「 10024 」と入力します。

    統合が成功すると、コネクタタスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

    {
  "AssigneeDisplayName": "Charlie b"
}

例 - スプリントを更新する

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity リストから [Sprints] を選択します。
  3. [Update] オペレーションを選択し、[完了] をクリックします。
  4. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
  "Name": "PROJ Sprint Googlecloud_Updated",
  "State": "future",
  "StartDate": "2023-06-27 07:06:08",
  "EndDate": "2023-07-27 07:06:08"
}
  5. エンティティ ID をスプリントのエンティティに設定します。エンティティ ID を設定するには、[エンティティ ID] をクリックし、[デフォルト値] フィールドに「 2 」と入力します。

    統合が成功すると、コネクタタスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

    {
}

例 - コメントを更新する

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity リストから Comments を選択します。
  3. [Update] オペレーションを選択し、[完了] をクリックします。
  4. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
  "Name": "PROJ Sprint Googlecloud_Updated",
  "State": "future",
  "StartDate": "2023-06-27 07:06:08",
  "EndDate": "2023-07-27 07:06:08"
}
  5. エンティティ ID をコメントのエンティティに設定します。エンティティ ID を設定するには、[エンティティ ID] をクリックし、[デフォルト値] フィールドに「 2 」と入力します。

    統合が成功すると、コネクタタスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

    {
}

Google Cloud コミュニティの助けを借りる

Google Cloud コミュニティの Cloud フォーラムで質問を投稿したり、このコネクタについてディスカッションしたりできます。

次のステップ