¶ In this lesson you will
- Read the visual editor and the warnings
- Configure a state, a transition and an office assignment
- Use the wizard for processing time, office and next steps
The demo workflow, transition by transition
| Start state | Event | End state | Actions |
|---|---|---|---|
| NEW | APPLY (citizen, agent) | PAYMENT_PENDING | Breaking BILL_ID_GENERATION. endStateTwo PENDING_ASSIGN_OFFICE when free |
| PAYMENT_PENDING | PAY (system) | PENDING_ASSIGN_OFFICE | nextEvent ASSIGN_OFFICE, "submitted" notification |
| PAYMENT_PENDING | EXPIRE_PAYMENT (system) | PAYMENT_EXPIRED | |
| PAYMENT_EXPIRED | PAY (system) | PENDING_ASSIGN_OFFICE | A late payment still counts |
| PENDING_ASSIGN_OFFICE | ASSIGN_OFFICE (system) | PENDING_OFFICER_PROCESSING | Breaking OFFICE_ASSIGNMENT, fixed office |
| PENDING_OFFICER_PROCESSING | APPROVE (officer) | APPROVED | Breaking GENERATE_CERTIFICATE + notification with the certificate |
| PENDING_OFFICER_PROCESSING | REJECT (officer) | REJECTED | Notification with the officer comment |
| PENDING_OFFICER_PROCESSING | REQUEST_FOR_ACTION (officer) | PENDING_RESUBMISSION | Notification |
| PENDING_RESUBMISSION | SUBMIT_RFA (citizen, agent) | PENDING_OFFICER_PROCESSING |
5. Workflow: an empty workflow
- Visual Editor: draw the workflow as a diagram
- Code Editor: edit workflow JSON
- NEW: starting state of every application
- Choose where APPLY goes: add the next state
- Fullscreen: enlarge the canvas
- JSON: view the workflow JSON
The visual editor
- Wizard
- Code
- Visual
- Classic view
- Toolbar: add state, add transition, layout, zoom...
- Warnings: read them all
- The canvas: states are boxes, transitions are arrows
Gotcha · some warnings are expected
The editor warns System event "PAY" from "PAYMENT_PENDING" is never triggered on system events such as PAY or EXPIRE_PAYMENT: nothing in the workflow fires them, because IremboPay and the scheduler do. That warning is expected. Read the others: a transition to a state that does not exist is not blocked on save (lesson D4).
Click a state: its panel
- State name
- State code: what the engine and Kibana use
- Translated names
- Event display names for the officer
- Next event fired automatically on arrival
- Add a breaking action
- Add a non-breaking action
- Save
Click a transition: who can fire it
- Event code
- System authorised
- Authorised roles
- Display names
- Conditions (endStateTwo)
The OFFICE_ASSIGNMENT action on ASSIGN_OFFICE
- Office assignment type: fixed office here
- The office
- Office level
- Copy the office id
The workflow wizard walks through the settings one page at a time
- Wizard: guided workflow setup
- Workflow Config: next steps page
- Step 1 Title: Pay the bill
- Condition: when the step is shown
- Step 2 Title: Download your clearance
- Submit to QA: send for review
Wizard: expected processing time (the demo: 1 day)
- SLA: service level settings
- Overall SLA: number of units
- Days: SLA time unit
- Helper text: shown to the citizen
- Continue: save and go on
Wizard: office assignment
- Wizard pages
- Add an office rule
- The fixed office rule
- Continue
Wizard: validation before saving
- Validation Rules: application constraints
- Block New Applications by State: toggle (Disabled)
- Application state: type a state to block
- Add State: add it to the list
- Common Application States: click to add
- Continue: save and go on
Wizard: next steps shown to the applicant
- Step title
- Description
- Condition: a JavaScript expression, or empty
- Second step's condition
Gotcha · the Condition field is code, not a label
We typed "After submission" in Condition: the step never showed. The field is a JavaScript expression evaluated in the browser over the form data and the application (for example
model => model.price > 0). Plain text throwsSyntaxErrorin the browser console and hides the step silently. Leave it empty to always show the step. We fixed it with a Service Improvement (lesson D3).
Code view: the whole workflow as JSON
One transition of the demo workflow
{
"startState": "PENDING_ASSIGN_OFFICE",
"event": "ASSIGN_OFFICE",
"systemAuthorised": true,
"endStateOne": {
"stateCode": "PENDING_OFFICER_PROCESSING",
"breakingAction": {
"actionType": "OFFICE_ASSIGNMENT",
"args": {
"officeAssignmentType": "CODE_FIXED_OFFICE",
"officeLevel": "LEVEL_1",
"officeId": "bf863562-a69e-4670-9baf-2b904b2e805d"
}
}
}
}
- System event: no person clicks it
- Breaking: no office, no transition
- Use an office id that exists on this environment (lesson D6 shows what happens otherwise)
Tip · reference
Workflow overview · Events · Actions · Workflow templates · Next steps.
¶ Check yourself
After PAY, the demo application must reach an officer with no human action. How?
- A. The officer searches for it
- B. PENDING_ASSIGN_OFFICE has nextEvent ASSIGN_OFFICE, a system event whose breaking action assigns the office
- C. PAY assigns the office itself
- D. The applicant clicks "Send to office"
Show the answer
B. The nextEvent fires ASSIGN_OFFICE as soon as the state is reached. If OFFICE_ASSIGNMENT fails, the application stays in PENDING_ASSIGN_OFFICE and no officer ever sees it.
← A8 · Workflow fundamentals · A10 · Officer form: data the officer adds →