Naming Conventions
The user interface finds the pages of your app from the ids and names in the BPMN model. Choose them with that in mind.
Process id
lower case letters and digits only, e.g. | the id becomes the app folder |
stable - do not rename after go-live | drafts, business key configuration and running cases refer to it |
the root process id counts | pages of sub-processes and their tasks are looked up in the app folder of the root process |
processId "purchase"
start form src/apps/purchase/PurchaseStarter.tsx
instance page src/apps/purchase/PurchaseInstance.tsx
task pages src/apps/purchase/tasks/...
renderer src/apps/purchase/renderer/PurchaseTaskDetailRenderer.tsx
business key eccatm.keyindex.processes.purchase.pattern
Use lower-case process ids. Mixed-case ids (e.g. leaveRequest) are resolved inconsistently between start form, instance page and task pages.
Task names
The task page file is derived from the task name of the user task:
|
|
|
|
|
|
Recommendations:
- short, unique names per process
- letters, digits and spaces only - avoid umlauts,
ß,/,-and punctuation, they end up in file names - do not rename a task after pages exist - the page would no longer be found
Data inputs and outputs of user tasks
Name the data inputs and outputs of a user task like the process variables they map (e.g. purchase, decisionBoolean). The task page then reads inputs.purchase... and writes output.decisionBoolean... - see Task Page.
Groups
Assign user tasks to Keycloak groups (GroupId), not to single users. The task list shows a task to all members of its groups; the requester can be excluded (ExcludedOwnerId) for four-eyes approvals.
On this page
- Naming Conventions