Menambahkan tindakan Jira Cloud

Jika tindakan Jira diaktifkan, pengguna akhir dapat meminta asisten untuk melakukan tindakan Jira Cloud berikut:

  • Membuat masalah Jira
  • Mengedit masalah Jira

Misalnya, pengguna dapat memasukkan "buat story jira bernama 'Luncurkan Project Y' di project ABC" atau "perbarui judul tiket jira JCD-1 menjadi 'Luncurkan Project Y'" ke dalam aplikasi Anda. Asisten akan meminta detail tambahan jika diperlukan, lalu meminta pengguna untuk mengonfirmasi permintaan pembuatan atau pengeditan.

Asisten dapat membaca dan mengedit kolom Jira berikut melalui tindakan:

Kolom Deskripsi
ID Masalah Wajib. ID masalah yang akan diubah, misalnya KAN-123.
Judul Judul masalah.
Jenis masalah Jenis masalah.
Prioritas Prioritas masalah.
Status Status masalah.
Deskripsi Deskripsi masalah dalam format Markdown.
Komponen Komponen masalah.
Penerima tugas Penerima tugas masalah, misalnya user@google.com.

Menyiapkan autentikasi dan izin di Jira

Sebelum mengaktifkan tindakan Jira, administrator Jira harus menyiapkan kredensial OAuth 2.0 khusus untuk tindakan di Jira. Hal ini diperlukan untuk menghubungkan integrasi Jira Anda dan mengizinkan izin baca dan tulis untuk tindakan.

Klien otorisasi untuk tindakan Jira berbeda dengan klien otorisasi untuk menyerap data Jira. Mereka menggunakan izin yang berbeda dan konfigurasi URL panggilan balik yang berbeda. Untuk mengetahui cara menyiapkan klien otorisasi bagi konektor Jira Cloud untuk menyerap data, lihat Menghubungkan Jira Cloud.

Petunjuk ini menjelaskan cara membuat ID klien dan rahasia klien melalui Konsol Developer Atlassian, mengonfigurasi cakupan OAuth 2.0 yang diperlukan, dan menyiapkan izin untuk pengguna. Terakhir, ambil URL dan ID instance Anda, konfigurasikan peran, dan lakukan autentikasi untuk membaca dan menulis data antara Jira Cloud dan Google.

Buat client ID dan rahasia klien

  1. Login ke developer.atlassian.com.
  2. Klik ikon profil di sudut kanan atas, lalu pilih Developer Console.
  3. Klik Buat, lalu pilih Integrasi OAuth 2.0.
  4. Masukkan nama untuk aplikasi.
    • Centang kotak persyaratan dan ketentuan.
    • Klik Buat.
  5. Klik Authorization.
  6. Di tabel Authorization type, pilih Add untuk OAuth 2.0 (3LO).
  7. Di kolom URL Panggilan Balik, masukkan https://vertexaisearch.cloud.google.com/oauth-redirect, lalu klik Simpan perubahan.

  8. Klik Izin:

    1. Buka Jira API, klik Add, lalu klik Configure.

    2. Buka tab Cakupan klasik, lalu klik Edit Cakupan. Pilih cakupan berikut, lalu simpan perubahan Anda:

      • Cakupan klasik:

        • read:jira-work
        • read:jira-user
        • write:jira-work

      • Cakupan terperinci:

        • read:user:jira

  9. Klik Distribusi, pilih Edit, lalu lakukan tindakan berikut:

    1. Pilih tombol pilihan Berbagi terlebih dahulu untuk mengaktifkan pengeditan kolom lainnya.
    2. Isi kolom yang tersisa.
      1. Untuk Vendor, pilih Google.
      2. Untuk Kebijakan privasi, masukkan https://policies.google.com.
      3. Untuk Apakah aplikasi Anda menyimpan data pribadi?, pilih Yes.
      4. Centang kotak Saya mengonfirmasi bahwa saya telah menerapkan API pelaporan data pribadi.
    3. Klik Simpan perubahan.

  10. Pilih Setelan untuk menyalin Client ID dan Client Secret Anda.

Mengambil URL instance dan ID instance

Untuk mendapatkan URL instance:

  1. Buka atlassian.net, lalu login dengan akun administrator Anda.
  2. Pilih aplikasi yang ingin Anda sinkronkan. Misalnya, sinkronkan aplikasi pertama.
  3. Temukan URL instance, yang merupakan subdomain di kolom URL.

Untuk mendapatkan ID instance:

  1. Buka tab baru, salin URL instance, dan tambahkan /_edge/tenant_info ke URL instance. Contoh, https://YOUR-INSTANCE.atlassian.net/_edge/tenant_info.
  2. Buka link untuk menemukan nilai cloudId. cloudId adalah ID Instance Anda.

Menyiapkan izin dan peran

  1. Login ke atlassian.com dengan akun administrator Anda.
  2. Klik ikon menu di kiri atas atau buka admin.atlassian.com.
  3. Di halaman Admin, klik Kelola pengguna, lalu buka halaman Grup.
  4. Klik Buat grup. Masukkan nama grup dan buat grup.
  5. Di bagian Group product access pada halaman grup baru, klik Add products to group.
  6. Untuk Jira, pilih Admin akses pengguna sebagai peran produk.
  7. Untuk Jira Admin, pilih Product admin sebagai peran produk dan simpan perubahan Anda.
  8. Di halaman Grup, klik Tambahkan anggota grup, lalu tambahkan pengguna atau akun yang akan diautentikasi oleh konektor.

Mendapatkan token refresh

Jika berencana mengonfigurasi tindakan Jira menggunakan Google Cloud konsol, Anda tidak perlu mendapatkan token refresh.

Jika Anda perlu menggunakan API untuk mengonfigurasi tindakan Jira, token refresh diperlukan. Untuk mendapatkan token refresh:

  1. Buka aplikasi Anda di konsol Google Cloud .
  2. Pilih Otorisasi.
  3. Pilih Konfigurasi di samping OAuth 2.0 (3LO).
  4. Untuk URL pengalihan, gunakan placeholder seperti https://example.com.
  5. Untuk mendapatkan token refresh dalam alur otorisasi awal, tambahkan offline_access ke parameter cakupan URL otorisasi. Contoh: https://auth.atlassian.com/authorize?audience=api.atlassian.com&client_id=your_client_id**&scope=offline_access**%20read%3Ajira-user&redirect_uri=https%3A%2F%2Fyour-redirect-url&state=%24%7BYOUR_USER_BOUND_VALUE%7D&response_type=code&prompt=consent
  6. Setelah Anda diberi otorisasi, Anda akan dialihkan kembali ke URL pengalihan. Di kolom URL, Anda akan melihat parameter kueri yang disebut "code". Catat nilainya.

  7. Gunakan alat seperti curl atau postman untuk mengirim permintaan POST ke https://auth.atlassian.com/oauth/token, dengan objek JSON yang memiliki kunci berikut:

    1. grant_type: authorization_code
    2. client_id: ID klien Anda
    3. client_secret: rahasia klien Anda
    4. code: Kode yang Anda peroleh dari langkah 6
    5. redirect_uri: URI pengalihan Anda

  8. Anda akan mendapatkan refresh_token dalam respons

Untuk mengetahui informasi selengkapnya tentang token refresh, lihat Menerapkan alur token refresh dalam dokumentasi Atlassian.

Mengonfigurasi tindakan Jira

Bagian ini menjelaskan cara membuat konektor Jira untuk tindakan dan mengaktifkan tindakan Jira untuk asisten Anda.

Sebelum memulai

Sebelum mengonfigurasi tindakan, pastikan langkah-langkah berikut telah selesai:

  • Project Anda harus ditambahkan ke daftar yang diizinkan untuk tindakan asisten
  • Administrator Jira telah menyelesaikan langkah-langkah di Menyiapkan autentikasi dan izin di Jira dan memberikan informasi berikut kepada Anda:
    • ID Klien
    • Rahasia klien
    • ID instance
    • Token refresh. Hanya diperlukan untuk membuat tindakan Jira melalui API, bukan melalui konsol Google Cloud . Google merekomendasikan pembuatan tindakan melalui konsol Google Cloud .

Mengonfigurasi tindakan Jira di konsol Google Cloud

Google merekomendasikan pembuatan tindakan melalui konsol Google Cloud .

Untuk menambahkan tindakan ke aplikasi menggunakan konsol, lakukan hal berikut:

  1. Di konsol Google Cloud , buka halaman Gemini Enterprise.
  2. Buka aplikasi Anda.
  3. Di menu navigasi, klik Tindakan.
  4. Untuk Jira, klik Hubungkan.
  5. Pilih instance Jira.
  6. Jika diminta, masukkan informasi otorisasi untuk konektor Anda. Tindakan ini hanya diperlukan jika instance belum dikonfigurasi untuk suatu tindakan.
  7. Pilih tindakan yang akan diaktifkan.
  8. Klik Selesaikan penyiapan. Tindakan Anda ditampilkan di halaman Tindakan.

Membuat dan mengaktifkan tindakan Jira menggunakan API

Google merekomendasikan agar Anda membuat tindakan melalui konsol Google Cloud . Jika Anda perlu membuat tindakan menggunakan API, lakukan hal berikut:

  1. Buat konektor Jira dan konfigurasikan untuk penelusuran:

    curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-H "X-GFE-SSL: yes" \
-H "X-Goog-User-Project: PROJECT_NUMBER" \
"https://discoveryengine.googleapis.com/v1alpha/projects/PROJECT_NUMBER/locations/global:setUpDataConnector" \
-d '{
  "collectionId": "COLLECTION_ID",
  "collectionDisplayName": "COLLECTION_DISPLAY_NAME",
  "dataConnector": {
    "dataSource": "jira",
    "params": {
      "client_id": "{Client ID of your Jira integration}",
      "client_secret": "{Client Secret of your Jira integration}",
      "refresh_token": "{Refresh Token of your Jira integration}",
      "instance_id": "{Your Jira Cloud instance ID}"
    },
    "refreshInterval": "{ >1800 }s",
    "entities": [
      {
        "entityName" : "project",
        "params" : {
          "inclusion_filters" : {}
        }
      },
      {
        "entityName": "{attachment/comment/issue/worklog}" // Optional, you can build up to 4 different entities
      }
    ],
    "syncMode": "PERIODIC"
  }
}

    Ganti kode berikut:

    • PROJECT_NUMBER: jumlah project Google Cloud Anda.
    • COLLECTION_ID: ID untuk koleksi.
    • COLLECTION_DISPLAY_NAME: nama tampilan untuk koleksi.

  2. Sertakan konfigurasi tindakan di konektor Jira Anda:

    curl -X PATCH \
  -H "Authorization: Bearer $(gcloud auth print-access-token --project "PROJECT_NUMBER")" \
  -H "Content-Type: application/json" \
  -H "X-Goog-User-Project: PROJECT_NUMBER" \
  "https://discoveryengine.googleapis.com/v1alpha/projects/PROJECT_NUMBER/locations/global/collections/COLLECTION_ID/dataConnector?update_mask=action_config" \
  -d '{
  "name": "projects/PROJECT_NUMBER/locations/global/collections/COLLECTION_ID/dataConnector",
  "action_config": {
    "is_action_configured": true,
    "action_params": {
        "client_id": "{Client id from Jira integration}",
        "client_secret": "{Client secret from Jira integration}",
        "instance_uri": "{instance URI of your Jira instance}"
      }
    }
  }'

  3. Mengaktifkan tindakan Jira untuk asisten Anda:

    curl -X PATCH \
  -H "Authorization: Bearer $(gcloud auth print-access-token --project "<var>PROJECT_NUMBER</var>")" \
  -H "Content-Type: application/json" \
  -H "X-Goog-User-Project: PROJECT_NUMBER" \
  "https://discoveryengine.googleapis.com/v1alpha/projects/PROJECT_NUMBER/locations/global/collections/default_collection/engines/APP_ID/assistants/default_assistant?update_mask=enabledActions" \
  -d '{
    "name": "projects/PROJECT_NUMBER/locations/global/collections/default_collection/engines/APP_ID/assistants/default_assistant",
    "enabledActions": {
      "projects/PROJECT_NUMBER/locations/global/collections/CONNECTOR_ID/dataConnector": {
        "actionInfo": [
          {
            "actionName": "create_jira_issue",
            "actionDisplayName": "Create Jira Issue"
          }
        ]
      }
    }
  }'

    Ganti kode berikut:

    • PROJECT_NUMBER: jumlah project Google Cloud Anda.

    • APP_ID: ID aplikasi.

    • CONNECTOR_ID: ID kumpulan data konektor yang Anda buat pada langkah sebelumnya.

Setelah Anda menambahkan tindakan, asisten dapat melakukan tindakan tersebut atas nama pengguna akhir Anda di aplikasi. Saat pengguna pertama kali meminta asisten untuk melakukan tindakan Jira Cloud, mereka akan diminta untuk mengizinkan akses ke akun Atlassian mereka.