ServiceNow

Konektor ServiceNow memungkinkan Anda melakukan operasi penyisipan, penghapusan, pembaruan, dan baca pada database ServiceNow.

Sebelum memulai

Sebelum menggunakan konektor Servicenow, lakukan tugas berikut:

  • Di project Google Cloud Anda:
    • 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 melakukan autentikasi dan diberi otorisasi untuk mengakses data di Google API. Jika 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.

  • Berikan akses ke tabel berikut di instance ServiceNow Anda:

    • sys_db_object
    • sys_dictionary
    • sys_glide_object

    Izin ini diperlukan agar konektor dapat terhubung ke data Anda. Untuk memberikan akses, lakukan langkah-langkah berikut:

    1. Di aplikasi ServiceNow, buka Keamanan Sistem > Kontrol Akses (ACL).
    2. Pilih New untuk membuat objek kontrol akses.
    3. Untuk Type, pilih record.
    4. Untuk Operation, pilih read.
    5. Untuk Name, pilih Table [sys_db_object] di menu drop-down pertama dan --None-- di drop-down kedua.
    6. Di bagian Memerlukan peran, klik dua kali kotak teks Sisipkan baris baru...., lalu telusuri dan pilih peran yang diinginkan.
    7. Klik Submit untuk membuat objek ACL.
    8. Tetapkan peran yang memiliki ACL yang dibuat ke pengguna yang melakukan autentikasi. Untuk melakukannya, buka Administrasi Pengguna > Pengguna > Pilih autentikasi pengguna > Peran > Edit... > . lalu tambahkan peran dari koleksi Anda.

Mengonfigurasi konektor

Mengonfigurasi konektor mengharuskan Anda membuat koneksi ke sumber data (sistem backend). Koneksi bersifat khusus untuk sumber data. Artinya, jika memiliki banyak sumber data, Anda harus membuat koneksi terpisah untuk setiap sumber data. Untuk membuat koneksi, lakukan langkah-langkah berikut:

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

    Buka halaman Connections

  2. Klik + CREATE NEW untuk membuka halaman Create Connection.
  3. Di bagian Lokasi, pilih lokasi untuk koneksi.
    1. Region: Pilih lokasi dari menu drop-down.

      Untuk mengetahui daftar semua wilayah yang didukung, lihat Lokasi.

    2. Klik BERIKUTNYA.
  4. Di bagian Connection Details, selesaikan tindakan berikut:
    1. Konektor: Pilih Servicenow dari menu drop-down Konektor yang tersedia.
    2. Versi konektor: Pilih versi Konektor dari menu drop-down versi yang tersedia.
    3. Di kolom Connection Name, masukkan nama untuk instance Connection.

      Nama koneksi harus memenuhi kriteria berikut:

      • Nama koneksi dapat menggunakan huruf, angka, atau tanda hubung.
      • Huruf harus kecil.
      • Nama koneksi harus dimulai dengan huruf dan diakhiri dengan huruf atau angka.
      • Nama koneksi tidak boleh lebih dari 63 karakter.
    4. Secara opsional, masukkan Deskripsi untuk instance koneksi.
    5. Akun Layanan: Pilih akun layanan yang memiliki peran yang diperlukan.
    6. Untuk menggunakan koneksi untuk langganan acara, pilih Aktifkan langganan acara. Jika dipilih, opsi berikut akan ditampilkan:
      • Enable event subscription with entity and actions: Pilih opsi ini untuk menggunakan koneksi untuk operasi konektor dan langganan peristiwa (entity dan tindakan).
      • Aktifkan hanya langganan acara: Pilih opsi ini untuk menggunakan koneksi hanya untuk langganan acara.

      Untuk kedua pilihan ini, Anda akan diminta untuk mengonfigurasi detail peristiwa pada langkah berikutnya.

    7. Secara opsional, konfigurasikan Setelan node koneksi:

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

      {i>Node<i} adalah unit (atau replika) koneksi yang memproses transaksi. Lebih banyak node diperlukan untuk memproses lebih banyak transaksi untuk sebuah koneksi dan sebaliknya, lebih sedikit node diperlukan untuk memproses transaksi yang lebih sedikit. Untuk memahami pengaruh node terhadap harga konektor Anda, lihat Harga untuk node koneksi. Jika Anda tidak memasukkan nilai apa pun, secara default node minimum akan ditetapkan ke 2 (untuk ketersediaan yang lebih baik) dan node maksimum ditetapkan ke 50.

    8. Use proxy: Centang kotak ini guna 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.
        • Ringkasan: Autentikasi HTTP ringkasan.
      • Pengguna Proxy: Nama pengguna yang akan digunakan untuk melakukan autentikasi dengan server proxy.
      • Sandi Proxy: Rahasia Secret manager 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 digunakan.
        • Selalu: Koneksi selalu mengaktifkan SSL.
        • Tidak pernah: Koneksi tidak mengaktifkan SSL.
        • Tunnel: Koneksi melalui proxy tunneling. Server proxy membuka koneksi ke host jarak jauh dan traffic mengalir bolak-balik 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 ingin membuat koneksi pribadi ke sistem backend Anda, lakukan hal berikut:

    9. Secara opsional, klik + TAMBAHKAN LABEL untuk menambahkan label ke Koneksi dalam bentuk pasangan kunci/nilai.
    10. Klik BERIKUTNYA.
  5. Di bagian Destinations, masukkan detail host jarak jauh (sistem backend) yang ingin Anda hubungkan.
    1. Jenis Tujuan: Pilih Jenis Tujuan.
      1. Di kolom Host address, tentukan nama host atau alamat IP tujuan.
        1. Jika ingin membuat koneksi pribadi ke sistem backend, ikuti langkah-langkah berikut:
          1. Buat lampiran layanan PSC.
          2. Buat lampiran endpoint, lalu masukkan detail lampiran endpoint di kolom Alamat host.
        2. Jika ingin membuat koneksi publik ke sistem backend dengan keamanan tambahan, Anda dapat mempertimbangkan untuk 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 BERIKUTNYA.
  6. Di bagian Authentication, masukkan detail autentikasi.
    1. Pilih Jenis autentikasi, lalu masukkan detail yang relevan.

      Jenis autentikasi berikut didukung oleh koneksi Servicenow:

      • Nama pengguna dan sandi

      2. Untuk memahami cara mengonfigurasi jenis autentikasi ini, lihat Mengonfigurasi autentikasi.

    2. Klik BERIKUTNYA.
  7. Jika Anda telah mengaktifkan langganan acara, bagian Detail Langganan Acara akan muncul di halaman pembuatan koneksi. Untuk memahami cara mengonfigurasi detail langganan peristiwa, lihat Mengonfigurasi langganan peristiwa.
  8. Tinjau: Tinjau detail koneksi dan autentikasi Anda.
  9. Klik Create.

Mengonfigurasi autentikasi

Masukkan detail berdasarkan autentikasi yang ingin Anda gunakan.

  • Nama pengguna dan sandi
    • Username: Nama pengguna ServiceNow yang akan digunakan untuk koneksi.
    • Sandi: Rahasia Secret Manager berisi sandi yang terkait dengan nama pengguna ServiceNow.

Mengonfigurasi langganan acara [Preview]

Jika Anda telah mengaktifkan langganan acara, masukkan nilai berikut di bagian Detail Langganan Acara:

  • Authentication Token: (Opsional) Pilih rahasia Secret Manager token autentikasi Anda, dan versi secret yang sesuai dari drop-down Secret Version.
  • Algoritma HMAC: (Opsional) Pilih algoritma HMAC untuk mengenkripsi payload respons.
  • Kunci Rahasia HMAC: Jika Anda telah memilih Algoritma HMAC, pilih rahasia Secret Manager untuk kunci HMAC, dan versi rahasia yang sesuai dari menu drop-down Secret Version.

Langkah-langkah pembuatan koneksi postingan

Untuk menyelesaikan konfigurasi langganan peristiwa, Anda harus mendaftarkan URL webhook dengan aplikasi ServiceNow. Oleh karena itu, setelah pembuatan koneksi berhasil, lakukan langkah-langkah tambahan berikut:

  1. Buka halaman detail koneksi dari koneksi yang baru dibuat, lalu salin URL webhook untuk langganan acara.
  2. Login ke aplikasi ServiceNow Anda, lalu lakukan hal berikut:
    1. Di halaman All > Business Rules > When to run, pilih operasi yang ingin Anda dengarkan.
    2. Klik tab Lanjutan. Tindakan ini akan membuka editor skrip.
    3. Masukkan JavaScript yang akan mengirimkan permintaan ke URL callback. Permintaan berisi payload yang dipicu setiap kali operasi yang diaktifkan terjadi. Contoh JavaScript adalah sebagai berikut:

      Template

      (function executeRule(current, previous /*null when async*/ ) {
var request = new sn_ws.RESTMessageV2();
request.setEndpoint('WEBHOOK_URL'); // here you must the listener url where you want send the event payload

request.setHttpMethod('POST');

var authToken = "AUTHENTICATION_TOKEN"
request.setRequestHeader("authorization", authToken);
request.setRequestHeader("Accept", "application/json");
request.setRequestHeader('Content-Type', 'application/json');

request.setRequestBody("{\"eventType\":\"" +
"EVENT_TYPE" + CUSTOM_FIELDS "\"}");

var data = request.getRequestBody();
var secretKey = "SECRET_KEY";

var signature = SncAuthentication.encode(data, secretKey, "ENCRYPTION_ALGORITHM");
request.setRequestHeader("hmacauthorization",signature);
var response = request.execute();

})(current, previous);

      Ganti kode berikut:

      • WEBHOOK_URL: URL webhook untuk langganan peristiwa yang akan Anda dapatkan dari halaman detail koneksi Integration Connectors.
      • AUTHENTICATION_TOKEN: Teks sebenarnya untuk token autentikasi yang telah Anda konfigurasi untuk koneksi.
      • EVENT_TYPE: Teks sebenarnya untuk jenis peristiwa yang telah Anda konfigurasi di pemicu ServiceNow.
      • CUSTOM_FIELDS: Isi permintaan harus selalu memiliki kolom eventType. Selain kolom ini, Anda dapat menambahkan kolom lain berdasarkan persyaratan Anda.
      • SECRET_KEY: Teks sebenarnya untuk kunci rahasia yang telah Anda konfigurasi untuk koneksi.
      • ENCRYPTION_ALGORITHM: Harus berupa salah satu dari nilai berikut:
        • HmacSHA224
        • HmacSHA256
        • HmacSHA384
        • HmacSHA512

        Algoritma harus sama dengan algoritma yang telah Anda konfigurasi untuk koneksi.

      Contoh

      (function executeRule(current, previous /*null when async*/ ) {
var request = new sn_ws.RESTMessageV2();
request.setEndpoint('https://webhook.site/bb37937e-24ea-19b3-9dcd-84eca77f60eg'); // here you must the listener url where you want send the event payload

request.setHttpMethod('POST');

var authToken = "YWRtaW46ZkVpNypxVzhCL3VY"
request.setRequestHeader("authorization", authToken);
request.setRequestHeader("Accept", "application/json");
request.setRequestHeader('Content-Type', 'application/json');

request.setRequestBody("{\"caller_id\":\"" +
current.caller_id + "\",\"eventType\":\"" +
"service_now_event_type_1" + "\",\"company\":\"" +
current.company + "\",\"number\":\"" +
current.number + "\",\"description\":\"" +
current.description + "\",\"FirstName\":\"" +
current.u_firstname + "\",\"LastName\":\"" +
current.u_lastname + "\",\"status\":\"" +
current.u_status + "\",\"Element\":\"" +
current.getElement() + "\",\"category\":\"" +
current.category + "\",\"opened_at\":\"" +
current.opened_at + "\",\"opened_by\":\"" +
current.opened_by + "\",\"location\":\"" +
current.location + "\",\"salesforceId\":\"" +
current.u_salesforceid + "\"}"); //fields you want

var data = request.getRequestBody();
var secretKey = "YWRtaW46ZkVpNypxVzhCL3VY";

// var MAC_ALG_4 = "HmacSHA384";
var MAC_ALG_3 = "HmacSHA256";
// var MAC_ALG_5 = "HmacSHA512";
// var MAC_ALG_2 = "HmacSHA224";

var signature = SncAuthentication.encode(data, secretKey, MAC_ALG_3);
request.setRequestHeader("hmacauthorization",signature);
var response = request.execute();

})(current, previous);

Entitas, operasi, dan tindakan

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

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

    Namun, mungkin saja konektor tidak mendukung atau memiliki entitas, dalam hal ini daftar Entities akan kosong.

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

    Memilih entity dari daftar yang tersedia akan menghasilkan daftar operasi yang tersedia untuk entity tersebut. Untuk deskripsi operasi secara mendetail, lihat operasi entity tugas Konektor. Namun, jika konektor tidak mendukung salah satu operasi entity, operasi yang tidak didukung tersebut tidak akan dicantumkan 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 bervariasi dari satu konektor ke konektor lainnya. Namun, mungkin saja konektor tidak mendukung tindakan apa pun, dalam hal ini daftar Actions akan kosong.

Tindakan

Bagian ini mencantumkan semua tindakan yang didukung oleh koneksi Servicenow.

Tindakan Upload lampiran

Tindakan ini Upload file sebagai lampiran ke data yang ditentukan.

Parameter input tindakan UploadLampiran

Nama parameter Jenis data Diperlukan Deskripsi
Konten String Tidak Konten String yang akan diupload sebagai file.
ContentBytes String Tidak Konten byte yang akan diupload sebagai file.
HasBytes Boolean Tidak Apakah akan mengupload konten sebagai byte.
TableName String Tidak Nama tabel untuk melampirkan file.
TableSysId String Tidak Sys_id dari kumpulan data dalam tabel yang ditentukan oleh TableName tempat Anda ingin melampirkan file.

Parameter output tindakan UploadLampiran

Tindakan ini menampilkan kumpulan parameter dari entity yang diupload

Untuk mengetahui contoh cara mengonfigurasi tindakan UploadAttachment, lihat Contoh.

Tindakan DownloadLampiran

Tindakan ini Mendownload lampiran file dari data tertentu.

Parameter input tindakan DownloadLampiran

Nama parameter Jenis data Diperlukan Deskripsi
SysId String Ya Sys_id dari file lampiran.
HasBytes Boolean Tidak Apakah akan mendownload konten sebagai byte.

Parameter output tindakan DownloadLampiran

Tindakan ini akan menampilkan apakah download bernilai Benar atau salah melalui Parameter Berhasil dan jika Benar, akan menghasilkan Konten DownloadLampiran

Untuk mengetahui contoh cara mengonfigurasi tindakan DownloadAttachment, lihat Contoh.

Contoh

Bagian ini menjelaskan cara menjalankan beberapa operasi dan tindakan entity di konektor ini.

Contoh - Upload lampiran untuk suatu insiden

  1. Dalam dialog Configure connector task, klik Actions.
  2. Pilih tindakan UploadAttachment, lalu klik Done.
  3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value: 
    {
  "Content": "File is uploaded",
  "TableName": "Incident",
  "TableSysId": "018f4057473ae5104593a6b5316d4357"
}

    4. Contoh ini mengupload nilai Content dari Payload sebagai lampiran dan menampilkan kumpulan Parameter untuk entity yang diupload . Jika tindakan tersebut berhasil, parameter respons connectorOutputPayload tugas UploadAttachment akan memiliki nilai yang mirip dengan yang berikut:

    {
                      "SysId": "a667f5d1939be110ff87352d6cba10fc",
                      "FileName": "7043426257788756581.connector.txt",
                      "TableSysId": "018f4057473ae5104593a6b5316d4357",
                      "TableName": "Incident",
                      "DownloadLink": "https://gcp.service-now.com/api/now/v1/attachment/a667f5d1939be110ff87352d6cba10fc/file",
                      "ContentType": "text/plain",
                      "SizeBytes": "16",
                      "ChunkSizeBytes": "700000",
                      "Compressed": "true",
                      "SizeCompressed": "36",
                      "SysTags": "",
                      "ImageHeight": "",
                      "ImageWidth": "",
                      "AverageImageColor": "",
                      "SysModCount": "0",
                      "Hash": "807e96c2942c41ad699d004a9d6a74595c84fab09111d479b6bbe013d5debff6",
                      "State": "pending",
                      "SysUpdatedBy": "gcp2",
                      "SysUpdatedOn": "2023-06-07 07:23:34",
                      "SysCreatedBy": "gcp2",
                      "SysCreatedOn": "2023-06-07 07:23:34",
                      "encryption_context": ""
                    }

Contoh - Download lampiran insiden

  1. Dalam dialog Configure connector task, klik Actions.
  2. Pilih tindakan DownloadAttachment, lalu klik Done.
  3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value: 
    {
  "SysId": "440c3995471fe1104593a6b5316d4384"
}

    4. Contoh ini menampilkan apakah download bernilai Benar atau salah melalui Parameter Berhasil dan jika Benar, akan menghasilkan Konten DownloadLampiran. Jika tindakan tersebut berhasil, parameter respons connectorOutputPayload tugas DownloadAttachment akan memiliki nilai yang mirip dengan yang berikut:

    [
                    {
                      "Success": "True"
                    },
                    {
                      "Content": " A Simple Text File \r\n\r\n\r\n This is a small demonstration .txt file - \r\n just for use in the Virtual Mechanics tutorials. More text. And more \r\n text. And more text. And more text. And more text. \r\n And more text. And more text. And more text. And more text. And more \r\n text. And more text. Boring, zzzzz. And more text. And more text. And \r\n more text. And more text. And more text. And more text. And more text. \r\n And more text. And more text. \r\n And more text. And more text. And more text. And more text. And more \r\n text. And more text. And more text. Even more. Continued on page 2 ...\r\n Simple PDF File 2 \r\n ...continued from page 1. Yet more text. And more text. And more text. \r\n And more text. And more text. And more text. And more text. And more \r\n text. Oh, how boring typing this stuff. But not as boring as watching \r\n paint dry. And more text. And more text. And more text. And more text. \r\n Boring. More, a little more text. The end, and just as well. "
                    }]

Keterbatasan sistem

Konektor ServiceNow dapat memproses maksimum 10 transaksi per detik, per node, dan throttle setiap transaksi di luar batas ini. Secara default, Integration Connectors mengalokasikan 2 node (untuk ketersediaan yang lebih baik) untuk satu koneksi.

Untuk informasi tentang batas yang berlaku untuk Konektor Integrasi, lihat Batas.

Gunakan terraform untuk membuat koneksi

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 Diperlukan Deskripsi
proxy_enabled BOOLEAN Salah Pilih kotak centang ini untuk mengonfigurasi server proxy untuk koneksi.
proxy_auth_scheme ENUM Salah Jenis autentikasi yang akan digunakan untuk mengautentikasi ke proxy ProxyServer. Nilai yang didukung adalah: BASIC, DIGEST, NONE
proxy_user STRING Salah Nama pengguna yang akan digunakan untuk mengautentikasi ke proxy ProxyServer.
proxy_password SECRET Salah Sandi yang akan digunakan untuk mengautentikasi ke proxy ProxyServer.
proxy_ssltype ENUM Salah Jenis SSL yang akan digunakan saat menghubungkan ke proxy ProxyServer. Nilai yang didukung adalah: AUTO, ALWAYS, NEVER, WorkManager
include_system_tables BOOLEAN Salah Mengontrol apakah akan mengekspos tabel sistem atau tidak.
filter_tables STRING Salah Tentukan tabel yang ingin Anda masukkan ke daftar yang dipisahkan koma.

Menggunakan koneksi Servicenow 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 Integrasi Apigee, lihat Tugas konektor.
  • Untuk memahami cara membuat dan menggunakan tugas Konektor dalam Application Integration, lihat tugas konektor.

Dapatkan bantuan dari komunitas Google Cloud

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

Langkah selanjutnya