Cara mengonfigurasi dan menggunakan saluran khusus - Quick BI

Bot channel Quick BI menyederhanakan komunikasi perusahaan dengan mengelola berbagai saluran pesan. Layanan ini memungkinkan konfigurasi port eksternal untuk menerima informasi peringatan dan notifikasi persetujuan di berbagai saluran. Topik ini menjelaskan cara menyiapkan saluran kustom.

Buat Saluran Kustom

Masuk ke Konsol Quick BI.
Navigasikan ke halaman pembuatan saluran kustom dari halaman beranda produk Quick BI seperti yang ditunjukkan pada gambar di bawah ini.

Dalam kotak dialog Create Custom Channel, atur parameter berikut.

Parameter	Deskripsi
Name	Masukkan nama saluran kustom.
Push Address	Masukkan alamat antarmuka saluran kustom target untuk menerima push pesan. Alamat antarmuka yang dikonfigurasi harus mendukung metode permintaan `POST`.
Request Add Key	Masukkan kunci penandatanganan saluran kustom target untuk memverifikasi tanda tangan permintaan. Anda dapat memasukkan kunci secara manual atau klik Auto-generate Key untuk menghasilkan kunci secara otomatis dan mengisinya di Quick BI. Pihak bisnis perlu memverifikasi tanda tangan konten yang diterima.

Klik Save And Test.
Setelah berhasil disimpan, saluran kustom baru akan muncul dalam daftar bot channel.

Konfigurasikan Saluran Kustom Saat Menerima Langganan

Saat menyiapkan langganan, sertakan saluran kustom dalam konfigurasi metode peringatan.

Akses halaman manajemen langganan dari halaman beranda Quick BI seperti yang diilustrasikan di bawah ini.
Selama pembuatan tugas langganan, pilih Saluran Kustom sebagai Metode Penerimaan untuk melihat saluran kustom di bawah Saluran Penerimaan.
Untuk informasi lebih lanjut, lihat Buat Tugas Langganan.

Format pesan untuk notifikasi langganan ke saluran kustom adalah sebagai berikut:

{
    "schema":"1.0",
    "header":{
        "organizationId":"b5fb3d10xx",  # ID Organisasi
        "eventId":"bc679418-9e7xx",      # ID Acara Unik
        "createTime":"1705398011696",
        "eventType":"SUBSCRIBE"  # Jenis acara, berlangganan; digunakan untuk menentukan logika bisnis
    },
    "event":{
        "createTime":"1705397830000",
        "customParams":"{\"param\":\"this is a test\"}",   # Parameter khusus dalam langganan. Format JSON, struktur kunci.
        "customReceiveGroups":"xxx",   # Grup penerima khusus
        "customReceiveUsers":[   # Penerima khusus.
            {
                "nick":"Zhang San",     # Nama panggilan
                "accountId":"cQUPAaY81L", # ID akun pihak ketiga yang disimpan di Quick BI
                "accountType":4,   # Jenis akun.
                "userId":"053da9"   # Quick BI userId
            }
        ],
        "worksInfo":{              # Informasi terkait laporan
            "components":[        # Informasi komponen
                {
                    "componentId":"123", 
                    "componentName":"Tabel Silang",
                    "componentType":4
                }
            ],
            "worksId":"0458e831-0250-486",   # ID Laporan
            "worksName":"Daftar Peringkat",             # Nama Laporan
            "worksType":"PAGE",
            "workspaceName":"Rencana Sumber Daya Li Si Impor",    # Nama Ruang Kerja
            "workspaceId":"3e60ee7f-a99f-4231-913",   # ID Ruang Kerja
            "worksUrl":"https://baidu.com/xxxx"       # URL Pratinjau Laporan
 
        },
        "subscribeId":"73a1d0b2420",          # ID Langganan
        "taskId": "4899407788885930938",      # ID Tugas Langganan
        "ownerId":"fec0741443204",            # Pemilik Tugas Langganan
        "title":"Saluran Push Webhook Kustom",        # Judul Tugas Langganan
        "subject":"Kustom",                     # Subjek Tugas Langganan
        "content":{         # Teks Tugas Langganan
            "head":"<p style=\";\">Saluran Push Webhook Kustom</p>",   
            "tail":"<p style=\";\">Saluran Push Webhook Kustom</p>"
        },
        "snapshot":{       
            "images":[           # Lampiran tangkapan layar
                {
                    "name":"2467699471858258259-1.jpeg",
                    "url":"https://qbi-dev.cn-shanghai.aliyuncs.com/xxxx"
                }
            ],
            "pdfs":[            # Lampiran PDF
                {
                    "name":"2467699471858258259-1.pdf",
                    "url":"https://qbi-dev.cn-shanghai.aliyuncs.com/xxxx"
                }
            ],
            "excels":[          # Lampiran Excel
                {
                    "name":"2467699471858258259-1.xlsx",
                    "url":"https://qbi-dev.cn-shanghai.aliyuncs.com/xxxx"
                }
            ]
        }
    }
}

Konfigurasikan Saluran Kustom Saat Menerima Peringatan

Tambahkan saluran kustom ke konfigurasi metode peringatan saat memantau metrik.

Pergi ke halaman pemantauan metrik dari halaman beranda Quick BI seperti yang ditunjukkan pada gambar di bawah ini.
Dalam kotak dialog Monitor Alert Settings, pilih Custom Channel sebagai metode peringatan untuk melihat saluran kustom di bawah Custom Channel.
Untuk detail lebih lanjut, lihat Konfigurasikan Pemantauan.

Konfigurasikan Saluran Kustom dalam Penerbitan Tugas Laporan

Pilih Saluran Kustom saat menyiapkan Penerbitan Tugas Laporan untuk pelaporan data.

Format pesan untuk notifikasi tugas laporan ke saluran kustom adalah sebagai berikut:

{
 "deadlineTime": "2024-07-26 20:00:00", # Batas waktu pelaporan
 "taskUrl": "https://bi.aliyun.com/xxx", # Tautan pelaporan
 "taskTitle": "Nama Tugas Laporan", # Nama tugas laporan
 "sendTime": "2024-07-04 19:19:20", # Waktu penerbitan tugas laporan
 "dashboardName": "Laporan Wang Wu" # Nama laporan
}

Konfigurasikan Saluran Kustom dalam Alur Persetujuan Elektronik Eksternal

Administrator organisasi dapat mengintegrasikan saluran kustom ke dalam proses persetujuan eksternal.

Buat saluran kustom di halaman manajemen konfigurasi seperti yang ditunjukkan pada gambar di bawah ini.
Aktifkan saluran persetujuan kustom di halaman konfigurasi kolaborasi seperti yang ditunjukkan pada gambar di bawah ini.
Sekarang, ketika pengguna meminta akses ke sumber daya Quick BI, saluran kustom juga akan menerima notifikasi aplikasi.

Format pesan untuk notifikasi persetujuan Quick BI ke saluran kustom adalah sebagai berikut:

{
    "authPointsValue":3,    # Poin izin.
    "resourceId":"b8b5392b-bb44-4bd8-e9642787e8d",   # ID sumber daya untuk mana izin diminta.
    "resourceName":"20 widget di layar pertama (8 di layar pertama klien seluler)",     # Nama sumber daya laporan.
    "approverId":"e52b777a1dde4bfb94f91e18128bcfb0",  # UID pemberi persetujuan.
    "roleId":0,
    "applyReason":"123123",              # Alasan permintaan.
    "extInfo": [                         # Informasi tambahan. Jika jenis sumber daya adalah dataFormInsertData, bidang ini menampilkan nama, jenis, dan informasi yang dikirimkan untuk setiap kontrol dalam formulir yang diajukan pengguna.
      {
          "data": {                     # Informasi entri data kontrol.
            "63912418-e311-4573-84be-1f732ffd9f35": 20,   # ID kontrol dan nilainya yang dikirimkan.
            "f9a46753-98a1-4709-9327-949c6a03af08": "test",
            "ffe8327a-9de8-4699-a23a-097088a22d2e": "test1"
          },
          "dataId": null,               # ID catatan data.
          "dataWithComponent": {        # Detail kontrol.
            "63912418-e311-4573-84be-1f732ffd9f35": {   # ID kontrol.
            "componentType": "number",  # Jenis kontrol.
            "data": 20,                 # Nilai yang dikirimkan oleh pengguna dalam kontrol ini.
            "label": "Usia"              # Nama kontrol.
          },
            "f9a46753-98a1-4709-9327-949c6a03af08": {
            "componentType": "text",
            "data": "test",
            "label": "Catatan"
          },
            "ffe8327a-9de8-4699-a23a-097088a22d2e": {
            "componentType": "text",
            "data": "test1",
            "label": "Nama"
          }
        }
      }
    ],
    "resources": [                       # Informasi menu. Bidang ini tersedia hanya untuk portal BI.    
      {
          "resourceId": "a8d78c04-df99-42c3-a0a2-dbe7350b077c",  # ID menu.
          "resourceName": "Menu level-3",     # Nama menu.
          "resourceType": "0"            # Jenis menu.
      }
    ],
    "applicantName":"Tuan Zhang",                 # Nama panggilan pemohon.
    "gmtCreate":1705399339000,               # Waktu pembuatan.
    "approverName":"Nyonya Wang",                  # Nama panggilan pemberi persetujuan.
    "expireDate":1708077734000,              # Masa berlaku izin.
    "workspaceName":"Ruang Kerja Evaluasi Quick BI",        # Nama ruang kerja.
    "applicantId":"e9a40c524ef8471faefbd",   # UID pemohon.
    "applicationId":"b31c8cf5-aa31-42f7-927a-da3cb2feefd4",  # ID persetujuan.
    "resourceType":"dashboard"               # Jenis sumber daya.
}

Catatan 1: Bidang resources, yang berisi informasi menu, tersedia hanya untuk persetujuan portal BI. resourceType dalam resources hanya mendukung jenis-jenis berikut:

resourceType dalam resources hanya mendukung jenis-jenis berikut:

0: Dasbor
2: Buku kerja
5: Entri Data
6: Unduhan
7: Analisis ad hoc
8: Dasbor data

Catatan 2: Tabel berikut menjelaskan jenis sumber daya. Jenis sumber daya tidak peka huruf besar-kecil.

dataProduct: Portal BI
portal_menu: Menu portal BI
dashboard: Dasbor
screen: Dasbor data
report: Buku kerja
ANALYSIS: Analisis ad hoc
dashboardOfflineQuery: Unduhan
dataForm: Entri Data
cube: Dataset
datasource: Sumber data
dataFormInsertData: Entri data ke penyimpanan

Catatan 3: Tabel berikut menjelaskan poin izin authPointsValue untuk setiap jenis sumber daya.

Jenis sumber daya	Deskripsi poin izin authPointsValue
Entri Data	1: Kirim data 9: Kelola data sendiri 10: Kelola semua data 11: Edit
Dataset, Sumber data, Persiapan data	1: Gunakan 11: Edit
Dasbor data, Buku kerja, Dasbor, Unduhan	1: Hanya lihat 2: Ekspor 3: Lihat dan ekspor 11: Edit
Portal BI	Izin portal BI 11: Edit Izin konten menu Sama seperti di atas Penting Catatan: Untuk entri data, nilai untuk mengelola data Anda sendiri adalah 3.

Lampiran: Metode Penerimaan Sistem Eksternal dan Verifikasi Tanda Tangan

Quick BI menggunakan metode POST untuk pengiriman konten, menambahkan detail berikut ke permintaan. Setelah menerima konten, sistem pengguna dapat memverifikasi nilai sign untuk autentikasi tanda tangan sesuai kebutuhan.

Header Permintaan:
X-TaskId, ID tugas unik, memungkinkan pengguna untuk mengonfirmasi permintaan tugas sekali, melakukan pemeriksaan anti-replay, atau memberikannya kepada dukungan Quick BI untuk pemecahan masalah.
Parameter Permintaan:
- timestamp: Cap waktu
- nonce: String acak
- sign: Informasi tanda tangan

Parameter permintaan ini dirancang untuk keamanan, memungkinkan sistem pengguna melakukan pemeriksaan anti-replay dan proteksi anti-pemalsuan. Metode untuk menghasilkan tanda tangan adalah sebagai berikut:

sign = SHA256.digest(timestamp + nonce + token)

Catatan

Nilai token adalah Request Add Key yang dihasilkan selama pembuatan saluran. Penerima harus memverifikasi sign terhadap nilai yang diharapkan.
Karena batas waktu 30 detik untuk pengiriman webhook, disarankan untuk memproses pesan secara asinkron setelah penerimaan untuk mencegah percobaan ulang atau kegagalan. Quick BI hanya memerlukan kode status HTTP 200 dan teks apa pun yang tidak kosong sebagai konfirmasi penerimaan.