Availability
This routine is available starting with katl-commons 2.5.19 / 2.6.11.
Syntax
admAddScreenToTransition(workflow, transition, screen)
Description
Sets the screen for a workflow transition.Parameters
Parameter name | Type | Required | Description |
---|---|---|---|
workflow | string | yes | The workflow name |
transition | string | yes | The transition name or id |
screen | string | yes | The screen name |
Return type
boolean
True if the screen was set on the workflow transition, false otherwise.
Example
admAddScreenToTransition("My workflow", "Start Progress", "Default Screen");
The "Default Screen" will be set on the "Start Progress" transition for the workflow "My Workflow".
You cannot set a transition screen for the system workflow, as it is not editable.
If the workflow is active and already has a draft, the transition screen will only be set on the draft workflow, so you will need to publish the draft for the changes to take effect.
See also