#Persetujuan

#Pengantar

Persetujuan adalah bentuk alur khusus yang diinisiasi manual dan diproses manual untuk menentukan status data terkait. Biasanya digunakan untuk otomatisasi kantor atau manajemen alur urusan keputusan manual lainnya, misalnya dapat membuat dan mengelola alur manual untuk skenario seperti "Permohonan Cuti", "Persetujuan Reimburse Biaya", dan "Persetujuan Pembelian Bahan Baku".

Plugin persetujuan menyediakan tipe Workflow khusus (Trigger) "Persetujuan (Event)" dan Node "Persetujuan" khusus untuk alur ini. Dikombinasikan dengan tabel data kustom dan Block kustom yang khas dari NocoBase, dapat dengan cepat dan fleksibel membuat dan mengelola berbagai skenario persetujuan.

#Membuat Alur

Saat membuat Workflow, pilih tipe "Persetujuan", maka dapat membuat alur persetujuan:

Kemudian pada antarmuka konfigurasi Workflow, klik Trigger untuk membuka dialog dan melakukan konfigurasi lebih lanjut.

#Konfigurasi Trigger

#Ikat Tabel Data

Plugin persetujuan NocoBase berdasarkan desain fleksibel, dapat digunakan dengan tabel data kustom apa pun, yaitu konfigurasi persetujuan tidak perlu mengonfigurasi ulang model data, tetapi langsung menggunakan kembali tabel data yang sudah dibuat. Jadi setelah masuk ke konfigurasi Trigger, pertama Anda perlu memilih tabel data, untuk menentukan terhadap data tabel data mana alur ini melakukan persetujuan:

#Cara Pemicuan

Saat menginisiasi persetujuan untuk data bisnis, dapat memilih dua cara pemicuan berikut:

• Sebelum Penyimpanan Data

  Menginisiasi persetujuan sebelum data yang dikirim disimpan, cocok untuk skenario di mana data baru disimpan setelah persetujuan disetujui. Pada mode ini, data saat persetujuan diinisiasi hanya data sementara, hanya akan disimpan secara resmi ke tabel data yang sesuai setelah persetujuan disetujui.

• Setelah Penyimpanan Data

  Menginisiasi persetujuan setelah data yang dikirim disimpan, cocok untuk skenario di mana data dapat disimpan terlebih dahulu, baru dilakukan persetujuan. Pada mode ini, data saat persetujuan diinisiasi sudah disimpan ke tabel data yang sesuai, modifikasi terhadapnya selama proses persetujuan juga akan disimpan.

#Lokasi Inisiasi Persetujuan

Anda dapat memilih lokasi inisiasi persetujuan dalam sistem:

• Hanya Inisiasi di Block Data

  Anda dapat mengikat operasi Block formulir tabel ini ke Workflow ini untuk menginisiasi persetujuan, dan memproses serta melacak proses persetujuan di Block persetujuan single data. Biasanya cocok untuk data bisnis.

• Inisiasi di Block Data dan Pusat Tugas

  Selain Block data, juga dapat menginisiasi dan memproses persetujuan di Pusat Tugas global, biasanya cocok untuk data administratif.

#Siapa yang Dapat Menginisiasi Persetujuan

Dapat mengonfigurasi izin berdasarkan lingkup pengguna, menentukan pengguna mana yang dapat menginisiasi persetujuan ini:

• Semua Pengguna

  Semua pengguna dalam sistem dapat menginisiasi persetujuan ini.

• Hanya Pengguna yang Dipilih

  Hanya mengizinkan pengguna dalam lingkup yang ditentukan untuk menginisiasi persetujuan ini, dapat memilih beberapa.

  

#Konfigurasi Antarmuka Formulir Inisiasi Persetujuan

Terakhir perlu mengonfigurasi antarmuka formulir penginisiasi, antarmuka ini akan digunakan untuk operasi pengiriman saat menginisiasi dari Block pusat persetujuan dan saat penginisiasi menarik kembali dan menginisiasi ulang. Klik tombol konfigurasi untuk membuka dialog:

Anda dapat menambahkan formulir pengisian berbasis tabel data yang diikat untuk antarmuka penginisiasi, atau teks penjelasan untuk tip dan panduan (Markdown). Di mana formulir wajib ditambahkan, jika tidak penginisiasi tidak akan dapat melakukan operasi setelah masuk ke antarmuka tersebut.

Setelah menambahkan Block formulir, sama dengan antarmuka konfigurasi formulir biasa, dapat menambahkan komponen field tabel data yang sesuai, dan dapat diatur dengan bebas untuk mengorganisir konten yang perlu diisi formulir:

Berbeda dengan tombol kirim langsung, juga dapat menambahkan tombol operasi "Simpan Draft", untuk mendukung alur pemrosesan penyimpanan sementara:

Jika sebuah alur persetujuan mengizinkan penginisiasi menarik kembali, perlu mengaktifkan tombol "Tarik Kembali" pada konfigurasi antarmuka penginisiasi:

Setelah diaktifkan, persetujuan yang diinisiasi alur ini dapat ditarik kembali oleh penginisiasi sebelum penyetuju manapun memproses, tetapi setelah Node persetujuan berikutnya manapun yang dikonfigurasi dengan penyetuju memproses, tidak dapat ditarik kembali lagi.

#Kartu "Permohonan Saya" 2.0+

Dapat digunakan untuk mengonfigurasi kartu tugas dalam daftar "Permohonan Saya" pusat tugas.

Pada kartu dapat dengan bebas mengonfigurasi field bisnis (kecuali field relasi) yang ingin ditampilkan, atau informasi terkait persetujuan.

Setelah permohonan persetujuan dibuat, daftar pusat tugas dapat melihat kartu tugas kustom:

#Mode Tampilan Record dalam Alur

• Snapshot

  Pada alur persetujuan, status record yang dilihat pemohon dan penyetuju saat masuk, dan setelah dikirim hanya dapat melihat record yang dimodifikasi sendiri—tidak akan melihat pembaruan yang dilakukan orang lain setelahnya.

• Terbaru

  Pada alur persetujuan, pemohon dan penyetuju selalu melihat versi terbaru record di sepanjang alur, terlepas dari status record sebelum mereka mengoperasikan. Setelah alur berakhir, mereka akan melihat versi akhir record.

#Node Persetujuan

Pada alur kerja persetujuan, perlu menggunakan Node "Persetujuan" khusus untuk mengonfigurasi logika operasi pemrosesan (setujui, tolak, atau kembalikan) persetujuan yang diinisiasi untuk penyetuju. Node "Persetujuan" juga hanya dapat digunakan dalam alur persetujuan. Lihat Node Persetujuan untuk detailnya.

#Konfigurasi Inisiasi Persetujuan

Setelah mengonfigurasi alur persetujuan dan mengaktifkan, Anda dapat mengikat alur ini pada tombol kirim formulir tabel data yang sesuai, untuk pengguna menginisiasi persetujuan saat mengirim:

Setelah itu pengiriman pengguna terhadap formulir tersebut akan memicu alur persetujuan yang sesuai. Selain disimpan ke tabel data yang sesuai, data yang dikirim juga akan di-snapshot ke alur persetujuan, untuk dilihat dan digunakan oleh penyetuju berikutnya.

#Pusat Tugas

Pusat Tugas menyediakan pintu masuk yang terpadu, memudahkan pengguna melihat dan memproses tugas yang harus dilakukan. Persetujuan yang diinisiasi pengguna saat ini dan tugas yang harus dilakukan semuanya dapat dimasuki melalui Pusat Tugas di bilah alat atas, dan melihat tipe tugas yang berbeda melalui navigasi kategori di sebelah kiri.

#Diinisiasi Saya

#Lihat Persetujuan yang Sudah Diinisiasi

#Inisiasi Persetujuan Baru Langsung

#Tugas Saya

#Daftar Tugas

#Detail Tugas

#HTTP API

#Penginisiasi

#Inisiasi dari Tabel Data

Inisiasi dari Block data, semua dapat dipanggil seperti ini (contoh tombol buat tabel posts):

curl -X POST -H 'Authorization: Bearer <your token>' -H 'X-Role: <roleName>' -d \
  '{
    "title": "Hello, world!",
    "content": "This is a test post."
  }'
  "http://localhost:3000/api/posts:create?triggerWorkflows=workflowKey"

Di mana parameter URL triggerWorkflows adalah key Workflow, beberapa Workflow dipisahkan dengan koma. Key tersebut dapat diperoleh dengan hover mouse di nama Workflow di bagian atas kanvas Workflow:

Setelah panggilan sukses, akan memicu alur persetujuan tabel posts yang sesuai.

Jika perlu memicu event data relasi to-one (to-many belum didukung) dalam operasi tersebut, dapat menggunakan ! dalam parameter untuk menentukan data pemicu field relasi:

curl -X POST -H 'Authorization: Bearer <your token>' -H 'X-Role: <roleName>' -d \
  '{
    "title": "Hello, world!",
    "content": "This is a test post.",
    "category": {
      "title": "Test category"
    }
  }'
  "http://localhost:3000/api/posts:create?triggerWorkflows=workflowKey!category"

Setelah panggilan di atas sukses, akan memicu event persetujuan tabel categories yang sesuai.

#Inisiasi dari Pusat Persetujuan

curl -X POST -H 'Authorization: Bearer <your token>' -H 'X-Role: <roleName>' -d \
  '{
    "collectionName": "<collection name>",
    "workflowId": <workflow id>,
    "data": { "<field>": "<value>" },
    "status": <initial approval status>,
  }'
  "http://localhost:3000/api/approvals:create"

Parameter

• collectionName: nama tabel data target inisiasi persetujuan, wajib.
• workflowId: ID Workflow yang digunakan untuk inisiasi persetujuan, wajib.
• data: field record tabel data yang dibuat saat inisiasi persetujuan, wajib.
• status: status record yang dibuat saat inisiasi persetujuan, wajib. Nilai opsional meliputi:
  • 0: draft, menyatakan disimpan tetapi tidak mengirim persetujuan.
  • 2: kirim persetujuan, menyatakan penginisiasi mengirim permohonan persetujuan, masuk ke persetujuan.

#Simpan dan Kirim

Ketika persetujuan yang diinisiasi (atau ditarik kembali) berada dalam status draft, dapat menyimpan atau mengirim ulang melalui interface berikut:

curl -X POST -H 'Authorization: Bearer <your token>' -H 'X-Role: <roleName>' -d \
  '{
    "data": { "<field>": "<value>" },
    "status": 2
  }'
  "http://localhost:3000/api/approvals:update/<approval id>"

#Dapatkan Daftar Persetujuan yang Sudah Diinisiasi

curl -X GET -H 'Authorization: Bearer <your token>' -H 'X-Role: <roleName>' \
  "http://localhost:3000/api/approvals:listMine"

#Tarik Kembali

Penginisiasi dapat menarik kembali record yang sedang dalam persetujuan melalui interface berikut:

curl -X POST -H 'Authorization: Bearer <your token>' -H 'X-Role: <roleName>' -d \
  "http://localhost:3000/api/approvals:withdraw/<approval id>"

Parameter

• <approval id>: ID record persetujuan yang akan ditarik kembali, wajib.

#Penyetuju

Setelah alur persetujuan masuk ke Node persetujuan, akan dibuat tugas yang harus dilakukan untuk penyetuju saat ini. Penyetuju dapat menyelesaikan tugas persetujuan melalui operasi antarmuka, juga dapat menyelesaikan melalui panggilan API HTTP.

#Dapatkan Record Pemrosesan Persetujuan

Tugas yang harus dilakukan adalah record pemrosesan persetujuan, dapat melalui interface berikut untuk mendapatkan semua record pemrosesan persetujuan pengguna saat ini:

curl -X GET -H 'Authorization: Bearer <your token>' \
  "http://localhost:3000/api/approvalRecords:listMine"

Di mana approvalRecords sebagai resource tabel data, juga dapat menggunakan kondisi kueri umum, seperti filter, sort, pageSize, dan page, dll.

#Dapatkan Single Record Pemrosesan Persetujuan

curl -X GET -H 'Authorization: Bearer <your token>' \
  "http://localhost:3000/api/approvalRecords:get/<record id>"

#Setujui dan Tolak

curl -X POST -H 'Authorization: Bearer <your token>' -d \
  '{
    "status": 2,
    "comment": "Looks good to me.",
    "data": { "<field to modify>": "<value>" }
  }'
  "http://localhost:3000/api/approvalRecords:submit/<record id>"

Parameter

• <record id>: ID record yang akan diproses persetujuannya, wajib.
• status: field adalah status pemrosesan persetujuan, 2 artinya "Setujui", -1 artinya "Tolak", wajib.
• comment: informasi catatan pemrosesan persetujuan, opsional.
• data: menyatakan modifikasi terhadap record tabel data tempat Node persetujuan saat ini berada setelah persetujuan disetujui, opsional (hanya valid saat disetujui).

#Kembalikan v1.9.0+

Sebelum versi v1.9.0, kembalikan menggunakan interface yang sama dengan "Setujui" dan "Tolak", menggunakan "status": 1 untuk merepresentasikan kembalikan.

Mulai versi v1.9.0, kembalikan memiliki interface terpisah:

curl -X POST -H 'Authorization: Bearer <your token>' -d \
  '{
    "returnToNodeKey": "<node key>",
  }'
  "http://localhost:3000/api/approvalRecords:return/<record id>"

Parameter

• <record id>: ID record yang akan diproses persetujuannya, wajib.
• returnToNodeKey: key Node target kembalikan, opsional. Ketika dalam Node dikonfigurasi lingkup Node yang dapat dikembalikan, dapat menggunakan parameter ini untuk menentukan dikembalikan ke Node mana. Pada kondisi tidak dikonfigurasi, parameter ini tidak perlu dimasukkan, secara default akan dikembalikan ke titik awal, oleh penginisiasi mengirim ulang.

#Pemindahan Tanda Tangan

curl -X POST -H 'Authorization: Bearer <your token>' -d \
  '{
    "assignee": <user id>,
  }'
  "http://localhost:3000/api/approvalRecords:delegate/<record id>"

Parameter

• <record id>: ID record yang akan diproses persetujuannya, wajib.
• assignee: ID pengguna yang dipindahkan tanda tangan, wajib.

#Penambahan Tanda Tangan

curl -X POST -H 'Authorization: Bearer <your token>' -d \
  '{
    "assignees": [<user id>],
    "order": <order>,
  }'
  "http://localhost:3000/api/approvalRecords:add/<record id>"

Parameter

• <record id>: ID record yang akan diproses persetujuannya, wajib.
• assignees: daftar ID pengguna yang ditambahkan tanda tangan, wajib.
• order: urutan penambahan tanda tangan, -1 menandai sebelum "saya", 1 menandai setelah "saya".