Skip to content
3

Naming rules ​

An element id is not diagram-internal. Process tests assert against it, and Operate or Cockpit label incidents with it. A generated token such as Activity_0049ryx tells nobody which step it is, and it churns on every regeneration.

Two rules keep ids chosen and consistent, and two more hold topics and message names to one scheme. Flip each example between the reported and the clean model; the findings are the real output of the rule on that model.

Ids generated rather than chosen ​

no-generated-ids/invalid.bpmn
Reported model for no-generated-ids
Clean model for no-generated-ids
5 findings
  • StartEvent_1 Element id looks generated — give it a readable, stable name
  • Activity_0049ryx Element id looks generated — give it a readable, stable name
  • Event_1x9j8k7 Element id looks generated — give it a readable, stable name
  • Flow_0a1b2c3 Element id looks generated — give it a readable, stable name
  • Flow_1sy6h9p Element id looks generated — give it a readable, stable name
IDs generated rather than chosen (Activity_0049ryx, StartEvent_1). Read the rule
The same process, drawn so the rule stays quiet. Read the rule

Ids off the naming convention ​

element-id-naming/invalid.bpmn
Reported model for element-id-naming
Clean model for element-id-naming
5 findings
  • OrderReceived Element id must match the naming convention <startEvent_camelCase>
  • ReviewOrder Element id must match the naming convention <serviceTask_camelCase>
  • OrderReviewed Element id must match the naming convention <endEvent_camelCase>
  • ReceivedToReview Element id must match the naming convention <flow_camelCase>
  • ReviewToReviewed Element id must match the naming convention <flow_camelCase>
IDs that don't follow the type-prefix + case convention. Read the rule
The same process, drawn so the rule stays quiet. Read the rule

Worker topics off the naming scheme ​

worker-topic-naming/invalid.bpmn
Reported model for worker-topic-naming
Clean model for worker-topic-naming
1 finding
  • serviceTask_reviewOrder Worker topic <review-order> must match <camelCase>
A worker topic (C7 external task topic, C8 job type) off the configured scheme. Read the rule
The same process, drawn so the rule stays quiet. Read the rule

Message names off the naming scheme ​

message-name-naming/invalid.bpmn
Reported model for message-name-naming
Clean model for message-name-naming
1 finding
  • message_orderReceived Message name <Order received> must match <camelCase>
A message name off the configured scheme. Read the rule
The same process, drawn so the rule stays quiet. Read the rule

All four rules are off while modeling. The two id rules switch on once a process is wired up for execution; the two scheme rules stay off until you configure your scheme. See Presets.