Jira Service Management

Konektor Jira Service Management memungkinkan Anda terhubung ke Jira Service Management dan melakukan operasi penyisipan, penghapusan, pembaruan, dan pembacaan.

Sebelum memulai

Sebelum menggunakan konektor Jira Service Management, lakukan tugas berikut:

  • Di project Google Cloud Anda:
    • Pastikan konektivitas jaringan telah disiapkan. Untuk mengetahui informasi tentang pola jaringan, lihat Konektivitas jaringan.
    • Berikan peran IAM roles/connectors.admin kepada pengguna yang mengonfigurasi konektor.
    • Berikan peran IAM berikut ke akun layanan yang ingin Anda gunakan untuk konektor:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Akun layanan adalah jenis Akun Google khusus yang dimaksudkan untuk mewakili pengguna non-manusia yang perlu diautentikasi dan diberi otorisasi untuk mengakses data di Google API. Jika Anda tidak memiliki akun layanan, Anda harus membuat akun layanan. Untuk mengetahui informasi selengkapnya, lihat Membuat akun layanan.

    • Aktifkan layanan berikut:
      • secretmanager.googleapis.com (Secret Manager API)
      • connectors.googleapis.com (Connectors API)

      Untuk memahami cara mengaktifkan layanan, lihat Mengaktifkan layanan.

    Jika layanan atau izin ini belum diaktifkan untuk project Anda sebelumnya, Anda akan diminta untuk mengaktifkannya saat mengonfigurasi konektor.

Mengonfigurasi konektor

Koneksi khusus untuk sumber data. Artinya, jika Anda memiliki banyak sumber data, Anda harus membuat koneksi terpisah untuk setiap sumber data. Untuk membuat koneksi, lakukan hal berikut:

  1. Di Konsol Cloud, buka halaman Integration Connectors > Connections lalu pilih atau buat project Google Cloud.

    Buka halaman Koneksi

  2. Klik + BUAT BARU untuk membuka halaman Buat Koneksi.
  3. Di bagian Location, pilih lokasi untuk koneksi.
    1. Wilayah: Pilih lokasi dari menu drop-down.

      Untuk mengetahui daftar semua region yang didukung, lihat Lokasi.

    2. Klik NEXT.
  4. Di bagian Detail Koneksi, selesaikan langkah-langkah berikut:
    1. Connector: Pilih Jira Service Management dari daftar drop-down Connector yang tersedia.
    2. Versi konektor: Pilih versi Konektor dari daftar drop-down versi yang tersedia.
    3. Di kolom Connection Name, masukkan nama untuk instance Koneksi.

      Nama koneksi harus memenuhi kriteria berikut:

      • Nama koneksi dapat menggunakan huruf, angka, atau tanda hubung.
      • Huruf harus berupa huruf kecil.
      • Nama koneksi harus diawali dengan huruf dan diakhiri dengan huruf atau angka.
      • Nama koneksi tidak boleh melebihi 49 karakter.
    4. Secara opsional, masukkan Deskripsi untuk instance koneksi.
    5. Secara opsional, aktifkan Cloud Logging, lalu pilih level log. Secara default, level log ditetapkan ke Error.
    6. Akun Layanan: Pilih akun layanan yang memiliki peran yang diperlukan.
    7. Masukkan ID Meja Bantuan pengguna yang diautentikasi. Secara default, kita mendapatkan ID pertama yang ditampilkan dari panggilan tambahan untuk mendapatkan semua meja bantuan. Anda bisa mendapatkan ServiceDeskId dengan menjalankan kueri daftar ke entity ServiceDesks.
    8. Masukkan Tingkat Keberagaman untuk koneksi, bervariasi dari 1-5. Tingkat kejelasan yang lebih tinggi akan mencatat semua detail komunikasi (permintaan,respons & sertifikat SSL).
    9. Jika perlu, konfigurasikan Setelan node koneksi:

      • Jumlah minimum node: Masukkan jumlah minimum node koneksi.
      • Jumlah node maksimum: Masukkan jumlah maksimum node koneksi.

      Node adalah unit (atau replika) koneksi yang memproses transaksi. Jumlah node yang diperlukan untuk memproses lebih banyak transaksi untuk suatu koneksi akan bertambah dan sebaliknya, jumlah node yang diperlukan untuk memproses lebih sedikit transaksi akan berkurang. Untuk memahami pengaruh node terhadap harga konektor, lihat Harga untuk node koneksi. Jika Anda tidak memasukkan nilai apa pun, secara default node minimum ditetapkan ke 2 (untuk ketersediaan yang lebih baik) dan node maksimum ditetapkan ke 50.

    10. (Opsional) Di bagian Setelan lanjutan, centang kotak Gunakan proxy untuk mengonfigurasi server proxy untuk koneksi dan mengonfigurasi nilai berikut:
      • Proxy Auth Scheme: Pilih jenis autentikasi untuk mengautentikasi dengan server proxy. Jenis autentikasi berikut didukung:
        • Dasar: Autentikasi HTTP dasar.
        • Digest: Autentikasi HTTP Digest.
      • Pengguna Proxy: Nama pengguna yang akan digunakan untuk melakukan autentikasi dengan server proxy.
      • Sandi Proxy: Secret Manager secret dari sandi pengguna.
      • Jenis SSL Proxy: Jenis SSL yang akan digunakan saat terhubung ke server proxy. Jenis autentikasi berikut didukung:
        • Otomatis: Setelan default. Jika URL adalah URL HTTPS, opsi Tunnel akan digunakan. Jika URL adalah URL HTTP, opsi JANGAN PERNAH akan digunakan.
        • Selalu: Koneksi selalu diaktifkan SSL.
        • Tidak Pernah: Koneksi tidak diaktifkan untuk SSL.
        • Tunnel: Koneksi dilakukan melalui proxy tunneling. Server proxy membuka koneksi ke host jarak jauh dan traffic mengalir dua arah melalui proxy.
      • Di bagian Server Proxy, masukkan detail server proxy.
        1. Klik + Tambahkan tujuan.
        2. Pilih Jenis Tujuan.
          • Alamat host: Tentukan nama host atau alamat IP tujuan.

            Jika Anda ingin membuat koneksi pribadi ke sistem backend, lakukan langkah berikut:

    11. Secara opsional, klik + TAMBAHKAN LABEL untuk menambahkan label ke Koneksi dalam bentuk pasangan kunci/nilai.
    12. Klik NEXT.
  5. Di bagian Destinations, masukkan detail host jarak jauh (sistem backend) yang ingin Anda hubungkan.
    1. Jenis Tujuan: Pilih Jenis Tujuan.
      • Untuk menentukan nama host atau alamat IP tujuan, pilih Alamat host dan masukkan alamat di kolom Host 1.
      • Untuk membuat koneksi pribadi, pilih Endpoint attachment dan pilih lampiran yang diperlukan dari daftar Endpoint Attachment.

      Jika ingin membuat koneksi publik ke sistem backend dengan keamanan tambahan, Anda dapat mempertimbangkan mengonfigurasi alamat IP keluar statis untuk koneksi Anda, lalu mengonfigurasi aturan firewall untuk hanya mengizinkan alamat IP statis tertentu.

      Untuk memasukkan tujuan tambahan, klik +TAMBAHKAN TUJUAN.

    2. Klik NEXT.
  6. Di bagian Authentication, masukkan detail autentikasi.
    1. Pilih Jenis autentikasi dan masukkan detail yang relevan.

      Jenis autentikasi berikut didukung oleh koneksi Jira Service Management:

      • OAuth2.0
      • Dasar
      • APIToken
    2. Untuk memahami cara mengonfigurasi jenis autentikasi ini, lihat Mengonfigurasi autentikasi.

    3. Klik NEXT.
  7. Tinjau: Tinjau detail koneksi dan autentikasi Anda.
  8. Klik Buat.

Mengonfigurasi autentikasi

Masukkan detail berdasarkan autentikasi yang ingin Anda gunakan.

  • OAuth2.0
    • Client ID: Client ID sebagaimana diberikan oleh aplikasi eksternal Anda.
    • Cakupan: Cakupan izin. Cakupan offline_access harus digunakan dengan konektor Jira Service Management. Untuk memahami cara kerja cakupan dan melihat semua cakupan yang tersedia untuk Jira Service Management, lihat Cakupan.
    • Client secret: Pilih Secret Manager secret. Anda harus membuat secret Secret Manager sebelum mengonfigurasi otorisasi ini.
    • Versi secret: Versi secret Secret Manager untuk secret klien.
    • Untuk jenis autentikasi Authorization code, setelah membuat koneksi, Anda harus melakukan beberapa langkah tambahan untuk mengonfigurasi autentikasi. Untuk mengetahui informasi selengkapnya, lihat Langkah tambahan setelah pembuatan koneksi.

  • Dasar
    • Nama pengguna: Akun pengguna Jira Service Management yang digunakan untuk mengautentikasi.
    • Sandi: Sandi yang terkait dengan akun.
  • APIToken
    • Nama Pengguna: Nama pengguna Jira Service Management yang digunakan untuk membuat token API.
    • Token API: Sandi untuk nama pengguna akan berupa token API. Pilih Secret Manager Secret yang berisi Token API yang terkait dengan nama pengguna Jira Cloud.

Langkah tambahan setelah pembuatan koneksi

Jika Anda memilih OAuth 2.0 - Authorization code untuk autentikasi, Anda harus melakukan langkah-langkah tambahan berikut setelah membuat koneksi:

  1. Di halaman Koneksi, temukan koneksi yang baru dibuat.

    Perhatikan bahwa Status untuk konektor baru akan menjadi Otorisasi diperlukan.

  2. Klik Otorisasi diperlukan.

    Tindakan ini akan menampilkan panel Edit otorisasi.

  3. Salin nilai Redirect URI ke aplikasi eksternal Anda.
  4. Verifikasi detail otorisasi.
  5. Klik Otorisasi.

    Jika otorisasi berhasil, status koneksi akan disetel ke Aktif di halaman Koneksi.

Otorisasi ulang untuk kode otorisasi

Jika Anda menggunakan jenis autentikasi Authorization code dan telah melakukan perubahan konfigurasi di aplikasi Jira Service Management, Anda harus mengotorisasi ulang koneksi Jira Service Management. Untuk memberikan kembali otorisasi koneksi, lakukan langkah-langkah berikut:

  1. Klik koneksi yang diperlukan di halaman Koneksi.

    Tindakan ini akan membuka halaman detail koneksi.

  2. Klik Edit untuk mengedit detail koneksi.
  3. Verifikasi detail OAuth 2.0 - Authorization code di bagian Authentication.

    Jika diperlukan, buat perubahan yang diperlukan.

  4. Klik Simpan. Tindakan ini akan mengarahkan Anda ke halaman detail koneksi.
  5. Klik Edit otorisasi di bagian Autentikasi. Tindakan ini akan menampilkan panel Authorize.
  6. Klik Otorisasi.

    Jika otorisasi berhasil, status koneksi akan disetel ke Aktif di halaman Koneksi.

Entitas, operasi, dan tindakan

Semua Konektor Integrasi menyediakan lapisan abstraksi untuk objek aplikasi yang terhubung. Anda hanya dapat mengakses objek aplikasi melalui abstraksi ini. Abstraksi ini ditampilkan kepada Anda sebagai entitas, operasi, dan tindakan.

  • Entitas: Entitas dapat dianggap sebagai objek, atau kumpulan properti, dalam aplikasi atau layanan yang terhubung. Definisi entitas berbeda dari konektor ke konektor. Misalnya, di konektor database, tabel adalah entitas, di konektor server file, folder adalah entitas, dan di konektor sistem pesan, antrean adalah entitas.

    Namun, ada kemungkinan konektor tidak mendukung atau tidak memiliki entity apa pun, sehingga daftar Entities akan kosong.

  • Operasi: Operasi adalah aktivitas yang dapat Anda lakukan pada entity. Anda dapat melakukan salah satu operasi berikut pada entitas:

    Memilih entitas dari daftar yang tersedia akan menghasilkan daftar operasi yang tersedia untuk entitas tersebut. Untuk deskripsi mendetail tentang operasi, lihat operasi entitas tugas Konektor. Namun, jika konektor tidak mendukung operasi entitas apa pun, operasi yang tidak didukung tersebut tidak tercantum dalam daftar Operations.

  • Tindakan: Tindakan adalah fungsi kelas pertama yang tersedia untuk integrasi melalui antarmuka konektor. Tindakan memungkinkan Anda membuat perubahan pada satu atau beberapa entitas, dan berbeda-beda dari konektor ke konektor. Biasanya, tindakan akan memiliki beberapa parameter input, dan parameter output. Namun, ada kemungkinan konektor tidak mendukung tindakan apa pun, sehingga daftar Actions akan kosong.

Batasan sistem

Konektor Jira Service Management dapat memproses 15 transaksi per detik, per node, dan membatasi laju transaksi apa pun yang melampaui batas ini. Secara default, Integration Connectors mengalokasikan 2 node (untuk ketersediaan yang lebih baik) untuk koneksi.

Untuk mengetahui informasi tentang batas yang berlaku untuk Integration Connectors, lihat Batas.

Tindakan

Konektor Jira Service Management menyediakan tindakan, seperti AddAttachment, AttachTemporaryFile, dan CreateCustomer. Untuk memahami cara mengonfigurasi tindakan, lihat Contoh tindakan.

Contoh tindakan

Bagian ini menjelaskan cara melakukan beberapa tindakan di konektor ini.

Contoh - Melampirkan file sementara

Contoh ini melampirkan file sementara dan memberikan ID lampiran yang Anda gunakan untuk menambahkan lampiran.

  1. Dalam dialog Configure connector task, klik Actions.
  2. Pilih tindakan AttachTemporaryFile, lalu klik Selesai.
  3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:
      {
        "Content": "test to create 1 temporaryid"
      }
  4. Jika tindakan berhasil, parameter respons connectorOutputPayload tugas konektor Anda akan memiliki nilai yang mirip dengan berikut ini:

    [{
        "TemporaryAttachmentId": "3ef17ee7-3877-4ac6-b586-481cb2121ef8",
        "FileName": "16324233309516250343.connector.txt"
    }] 

Contoh - Menambahkan lampiran

Contoh ini melampirkan file sementara ke ID Permintaan yang diberikan dalam payload input.

  1. Dalam dialog Configure connector task, klik Actions.
  2. Pilih tindakan AddAttachment, lalu klik Selesai.
  3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:
    {
        "AttachmentId": "3ef17ee7-3877-4ac6-b586-481cb2121ef8",
        "RequestId": "10032"
    }  
  4. Jika tindakan berhasil, parameter respons connectorOutputPayload tugas konektor Anda akan memiliki nilai yang mirip dengan berikut ini:

    [{
      "Success": "true",
      "filename": "16324233309516250343.connector.txt",
    }] 

Contoh - Membuat pelanggan

Contoh ini membuat pelanggan.

  1. Dalam dialog Configure connector task, klik Actions.
  2. Pilih tindakan CreateCustomer, lalu klik Selesai.
  3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:
    {
      "Email": "something@something.com",
      "FullName": "Something"
    } 
  4. Jika tindakan berhasil, parameter respons connectorOutputPayload tugas konektor Anda akan memiliki nilai yang mirip dengan berikut ini:

    [{
        "Key": null,
        "AccountId": "qm:476582de-e968-4bc9-b0be-0349e8e3ec97:244dd7e4-0b49-4468-adac-561ab09bf2bb",
        "Name": null,
        "EmailAddress": "something@something.com",
        "DisplayName": "Something",
        "Active": "true",
        "Timezone": "Asia/Calcutta",
        "_links.jirarest": "https://google-team-zlre6yes.atlassian.net/rest/api/2/user?accountId=qm%3A476582de-e968-4bc9-b0be-0349e8e3ec97%3A244dd7e4-0b49-4468-adac-561ab09bf2bb",
        "_links.avatarurls.48x48": "https://avatar-management.services.atlassian.com/default/48",
        "_links.avatarurls.24x24": "https://avatar-management.services.atlassian.com/default/24",
        "_links.avatarurls.16x16": "https://avatar-management.services.atlassian.com/default/16",
        "_links.avatarurls.32x32": "https://avatar-management.services.atlassian.com/default/32",
        "_links.self": "https://google-team-zlre6yes.atlassian.net/rest/api/2/user?accountId=qm%3A476582de-e968-4bc9-b0be-0349e8e3ec97%3A244dd7e4-0b49-4468-adac-561ab09bf2bb"
    }]

Contoh operasi entity

Contoh - Mencantumkan semua Permintaan

Contoh ini mencantumkan semua permintaan dalam entity Requests.

  1. Dalam dialog Configure connector task, klik Entities.
  2. Pilih Permintaan dari daftar Entity.
  3. Pilih operasi LIST, lalu klik Selesai.

Contoh - Mendapatkan Permintaan dari ID Meja Bantuan tertentu

Contoh ini mendapatkan permintaan dengan RequestKey sebagai DP1-14 dari entity Requests.

  1. Dalam dialog Configure connector task, klik Entities.
  2. Pilih Requests dari daftar Entity.
  3. Pilih operasi LIST, lalu klik Selesai.
  4. Di bagian Task Input pada tugas Connectors, klik filterClause, lalu masukkan RequestKey='DP1-14' di kolom Default Value.

    Di sini, RequestKey adalah nilai kunci utama entity Requests.

Contoh - Membuat Permintaan

Contoh ini membuat permintaan di entitas Requests.

  1. Dalam dialog Configure connector task, klik Entities.
  2. Pilih Requests dari daftar Entity.
  3. Pilih operasi Create, lalu klik Selesai.
  4. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:
    {, , ,) VALUES ('2', '1', '','test');
        "RequestTypeId": "2",
        "ServiceDeskId": "1",
        "Summary": "test",
        "Description": "test"
      }
      

    Jika integrasi berhasil, kolom connectorOutputPayload tugas konektor Anda akan memiliki nilai yang mirip dengan berikut ini:

     {
        "RequestId": "10032"
      } 
      

Membuat koneksi menggunakan Terraform

Anda dapat menggunakan resource Terraform untuk membuat koneksi baru.

Untuk mempelajari cara menerapkan atau menghapus konfigurasi Terraform, lihat Perintah dasar Terraform.

Untuk melihat contoh template terraform untuk pembuatan koneksi, lihat contoh template.

Saat membuat koneksi ini menggunakan Terraform, Anda harus menetapkan variabel berikut dalam file konfigurasi Terraform:

Nama parameter Jenis data Wajib Deskripsi
proxy_enabled BOOLEAN Salah Centang kotak ini untuk mengonfigurasi server proxy untuk koneksi.
proxy_auth_scheme ENUM Salah Jenis autentikasi yang akan digunakan untuk melakukan autentikasi ke proxy ProxyServer. Nilai yang didukung adalah: BASIC, DIGEST, NONE
proxy_user STRING Salah Nama pengguna yang akan digunakan untuk melakukan autentikasi ke proxy ProxyServer.
proxy_password SECRET Salah Sandi yang akan digunakan untuk melakukan autentikasi ke proxy ProxyServer.
proxy_ssltype ENUM Salah Jenis SSL yang akan digunakan saat terhubung ke proxy ProxyServer. Nilai yang didukung adalah: AUTO, ALWAYS, NEVER, TUNNEL

Menggunakan koneksi Jira Service Management dalam integrasi

Setelah Anda membuat koneksi, koneksi tersebut akan tersedia di Apigee Integration dan Application Integration. Anda dapat menggunakan koneksi dalam integrasi melalui tugas Konektor.

  • Untuk memahami cara membuat dan menggunakan tugas Konektor di Apigee Integration, lihat Tugas konektor.
  • Untuk memahami cara membuat dan menggunakan tugas Konektor di Integrasi Aplikasi, lihat Tugas konektor.

Mendapatkan bantuan dari komunitas Google Cloud

Anda dapat memposting pertanyaan dan mendiskusikan konektor ini di komunitas Google Cloud di Forum Cloud.

Langkah berikutnya