Lewati ke konten

R01 — Text Annotation

KodeR01
Nama BPMNText Annotation
TierA (wajib dikuasai)
DiperkenalkanModul 4
SpesifikasiOMG BPMN 2.0.2 §10.5 TODO-VERIFY

R01 — Text Annotation: tanda kurung siku kiri dengan teks di dalam
Unduh .bpmn

Memuat diagram…

Tanda kurung siku kiri [ dengan teks di dalam. Dihubungkan ke elemen yang dianotasi via Association (garis putus-putus).

Cara membuat di demo.bpmn.io: Klik task → ikon “Append Text Annotation” dari context menu. Atau seret “Text Annotation” dari palet lalu hubungkan dengan Association.


Text Annotation menyatakan: “Informasi ini relevan untuk elemen ini, tapi tidak merupakan bagian dari alur eksekusi.”

Ia adalah catatan pemodelan yang tertempel pada diagram — bukan elemen yang dieksekusi.


Menambahkan konteks yang tidak bisa dimasukkan dalam label singkat: SLA, constraint bisnis, aturan, asumsi, atau catatan implementasi.


Text Annotation tidak dieksekusi. Token tidak menyentuh Text Annotation. Ia adalah artefak murni — ada di diagram sebagai dokumentasi, tidak ada di runtime.


Gunakan Text Annotation ketika:

  • Ada SLA atau batas waktu yang tidak bisa diekspresikan dengan elemen BPMN (misalnya batas waktu yang tidak diterapkan sebagai Timer Event).
  • Ada constraint bisnis yang perlu diketahui oleh pembaca diagram.
  • Ada asumsi atau keputusan pemodelan yang perlu dijelaskan.
  • Label task terlalu panjang jika semua informasi dimasukkan.

Jangan gunakan Text Annotation untuk:

  • Batas waktu yang harus diterapkan oleh proses → gunakan Timer Event (E03).
  • Kondisi keputusan yang harus dievaluasi → masukkan di label Sequence Flow atau condition expression.
  • Penjelasan panjang yang lebih cocok di dokumentasi eksternal.

Dalam Modul 4, Text Annotation “SLA: catat pesanan dalam 30 menit” ditempelkan pada task “Catat data pesanan” via Association. Ini menyatakan bahwa ada SLA untuk task tersebut — tapi SLA ini tidak ditegakkan oleh mesin proses; ia adalah informasi untuk tim operasional.


Text Annotation SLA pada task 'Catat data pesanan'
Unduh .bpmn

Memuat diagram…


  1. Temukan tanda [ dengan teks di dalam.
  2. Ikuti garis putus-putus (Association) ke elemen yang dianotasi.
  3. Baca teks sebagai informasi tambahan tentang elemen tersebut.
  4. Teks ini tidak mengubah perilaku eksekusi.

“Text Annotation dengan ‘24 jam’ cukup untuk menyatakan batas waktu.”

Tidak. Text Annotation hanya dokumentasi — ia tidak membuat proses menunggu atau memicu tindakan apa pun. Jika batas waktu harus diterapkan (proses berhenti selama 24 jam atau mengambil jalur tertentu setelah 24 jam), dibutuhkan Timer Event atau Boundary Timer.


Anti-pattern: Menggunakan Text Annotation untuk menyatakan kondisi gateway.

Gejala: Sequence Flow keluar dari Gateway tidak memiliki label kondisi — kondisi ditulis di Text Annotation yang ditempelkan pada Sequence Flow.

Text Annotation tidak dapat dievaluasi oleh mesin proses. Kondisi harus ada di label Sequence Flow atau conditionExpression.


ElemenBedanya
Text Annotation (R01)Dokumentasi; tidak dieksekusi
Timer Event (E03)Menunggu durasi/waktu tertentu; dieksekusi
Label Sequence FlowKondisi yang dievaluasi gateway; dieksekusi

  • Informasi hanya untuk dibaca manusia → Text Annotation.
  • Batas waktu yang harus diterapkan oleh mesin → Timer Event.
  • Kondisi percabangan → label Sequence Flow.

  • Apakah informasi ini perlu dieksekusi atau hanya diketahui? → Jika hanya diketahui, Text Annotation.
  • Apakah ini batas waktu yang harus membatalkan atau memindahkan proses? → Timer Event.
  • Apakah ini kondisi yang menentukan jalur mana yang diambil? → Label Sequence Flow.

Mengapa perlu Text Annotation jika informasi bisa ditulis dalam dokumentasi eksternal?

Karena dokumentasi eksternal sering tidak dibaca, atau tidak mudah dikaitkan dengan elemen spesifik. Text Annotation memastikan bahwa orang yang membaca diagram langsung mendapatkan konteks yang relevan — tanpa harus membuka dokumen lain.


  • Text Annotation harus dihubungkan ke elemen via Association — Text Annotation yang mengambang (tanpa Association) tidak salah secara BPMN tapi ambigu.
  • Text Annotation boleh ada tanpa Association jika konteksnya sudah jelas dari posisi visual.

Text Annotation tidak diproses oleh Camunda Engine. Ia tersedia di diagram XML tapi tidak mempengaruhi eksekusi. Beberapa tool melaporkan Text Annotation dalam laporan audit sebagai metadata.


Text Annotation adalah catatan yang tertempel pada elemen diagram — murni untuk dokumentasi, tidak mempengaruhi eksekusi token sama sekali.