Setting up workflows
Configure workflows to match your organizational needs for overseeing model development, validation, implementation, ongoing monitoring, auditing, or other risk management activities.
- Models in your model inventory transition through your organization’s custom model lifecycles via model stages, which are in turn manipulated via workflows.
- Workflows are comprised of workflow steps,1 and have their own workflow states2 discrete from model stages.
- Some step types allow you to define conditional requirements,3 providing flexible customization.
Workflow setup
Workflow elements
A workflow is comprised of an interplay of these elements:
Workflow step types
Model Stage Change
- Transitions a model into another stage.
- Requires available model stages associated with the workflow.4
| Field | Description |
|---|---|
| when these conditions are met (optional) | Add conditional requirements to qualify for this step.5 |
| set model stage to | Select the model stage to transition to. |
Workflow State Change
Transitions the workflow into another workflow state.6
| Field | Description |
|---|---|
| set workflow state to | Select or add7 the workflow state to transition the workflow to. |
| progress | Indicate the progress of the workflow at this transition into the next state. |
7 Click Add New State to create a new state unique to this workflow.
User Action v2
Creates a button that performs an action on behalf of the user.
| Field | Description |
|---|---|
| display action button when (optional) | Add conditional requirements for displaying this step.8 |
| action button label | Text that displays on your action button. |
| request fields (optional) | Include required inventory fields alongside your action.9 |
| user action deadline (optional) | Include a deadline for when users should complete this action by.10 |
| optional fields (optional) | Include optional inventory fields alongside your action.11 |
- 9
- Select the field, then click Add Field to insert.
- Manage model inventory fields
Users must have write permissions for the field in order to enter values.
10 Toggle Enable deadline on to configure a deadline.
- 11
- Select the field, then click Add Field to insert.
- Manage model inventory fields
Users must have write permissions for the field in order to enter values.
Approval
Display a preconfigured message to users in the selected approval group.
- Select from either User Roles, Model Stakeholder Types,or either User Role or User Type inventory field.12
- Must be connected to both a rejection and approval Model Stage Change step.13
- Configure two Model Stage Change steps for your associated rejection and approval stages.
- Then, from the bottom of your Approval step:
- Connect the left (red) to your rejection step.
- Connect the right (green) to your approval step.
| Field | Description |
|---|---|
| approval group | Select the roles, stakeholders, or user fields responsible for approval. |
| fields to review (optional) | Select the model inventory fields shown to approvers for read-only review. |
| Approval Message | When your workflow reaches this Approval step, the selected approval group will shown this message.14 |
14 Enter in a title and a message to display.
Broadcast
Send email notifications to users in selected groups.
Select from either User Roles or Model Stakeholder Types.15
| Field | Description |
|---|---|
| Select roles | Select the Model Stakeholder Types or User Roles to receive the email. |
| subject | Enter the subject of the email. |
| message | Enter the body of the email.16 |
16 Use the rich text editor to compose your message:
- Include optional details about the model the workflow is running on using the { } Insert Variable drop-down.
- Click on the Preview tab and choose a model under select model for preview to confirm how the notification will appear when rendered.
Condition Branch
- Allows diverging paths based on conditional requirements.
- A
defaultbranch will be automatically included as a catch-allelsepath to ensure that your conditional logic is complete.
Workflows cannot be saved until condition branches are connected to other steps.
To configure a condition branch:
On the Configure Condition Branch modal, click Add Branch.
Enter in the path name and designate the conditions17 that apply to this path.
Continue with steps 1 and 2 until your conditional branch logic is complete.
To remove a path, click and select Remove Path.
When you are finished setting up all your branch paths, click Update Step to save your step.
Proceed with linking the Condition Branch with your subsequent steps.18
Wait
- Creates a time condition for displaying next available action.19
- Used to enforce a time delay or a calendar date milestone.
To configure a wait step, select when you would like to resume workflow:
| Option | Required field(s) | Description |
|---|---|---|
| After Time Interval | wait duration | Wait for a set amount of time. Applies to all models under the workflow. |
| At Specified Date | wait until | Wait until a specific timestamp. Applies to all models under the workflow. If the milestone date inputted is in the past, the next workflow step will display immediately. |
| At Specified Date on Model Field | model field20 | Wait until a specific timestamp as defined by a model inventory field on a per model basis. If the selected field is empty21 or the milestone date inputted is in the past, the next workflow step will display immediately. |
| Time Delta from Specified Date on Model Field | model field,22 time delta direction, wait duration | Wait for a calculated time relative to a date in a model field on a per model basis. If the selected field is empty23 or the milestone date inputted is in the past, the next workflow step will display immediately. |
21 Make model inventory fields required when creating models to ensure necessary fields have valid values.
23 Make model inventory fields required when creating models to ensure necessary fields have valid values.
Run Workflow
Triggers another workflow indicated by select workflow to run, allowing you to chain workflows.
End
- Designates the end of your workflow.
- Use this step when all of your other steps have been configured and linked together.24
Conditional requirements
Configure conditional requirements for the following step types:25
Model Stage Change
optional
Under when these conditions are met, set your
ANDandORconditions.Add a single independent rule or a linked condition group. These rules and groups can be nested if desired:
- Click Add Rule to add an independent rule.
- Click Add Group to add a linked group of rules that all must be true to qualify.
User Action v2
optional
- User display rules
-
- Under display action button when, set your
ANDandORconditions. - Add a single independent rule or a linked condition group. These rules and groups can be nested if desired:
- Click Add Rule to add an independent rule.
- Click Add Group to add a linked group of rules that all must be true to qualify.
- Under display action button when, set your
- Require model inventory fields
-
- Select any requested fields26 to be entered by users during the action.
- Toggle Optional to on if the field should be optional and not required.
- Enable user action deadline
-
- Toggle Enable deadline on to configure a user action deadline for when users should complete this action by.
- Then, under end action: select the type of deadline:
- After Time Interval — Set the amount and unit of the deadline.
- At Specified Date — Set the date and time the action should wait until.
- At Specified Date on Model Field — Select a date, date time, or calculated model field that defines the deadline.
- Time Delta from Specified Date on Model Field — Select a date, date time, or calculated model field to calculate a deadline from, then set a time delta direction and wait duration.
Approval
Click Add Rule under approval group to set your
ANDconditions.27Select from either User Roles,28 Model Stakeholder Types,29 or User Type inventory field30 for your approval group.
Select the fields to review shown to your approval groups as read-only fields.
27 One approver per rule must provide approval.
28 Manage roles
Broadcast
Select from either Model Stakeholder Types31 or User Roles.32
Condition Branch
Under each branch’s conditions, set your
ANDandORconditions.Add a single independent rule or a linked condition group. These rules and groups can be nested if desired:
- Click Add Rule to add an independent rule.
- Click Add Group to add a linked group of rules that all must be true to qualify.
Wait
Select when you would like to resume workflow:
- After Time Interval — Set the wait duration in minutes, hours, or days.
- At Specified Date — Set a time to wait until as defined by a specific timestamp.
- At Specified Date on Model Field — Set the model field33 with a valid
DateorDate Timetype model inventory field that defines the specific timestamp on a per model basis. - Time Delta from Specified Date on Model Field —
- Set the model field34 with a valid
DateorDate Timetype model inventory field that defines the specific timestamp on a per model basis. - Select a time delta direction relative to your selected field.
- Enter in a wait duration in minutes, hours, days, or months for the delta.
- Set the model field34 with a valid
Workflow states
Workflow states are statuses unique to a specific workflow, discrete from model stages.35
Add workflow states
Add workflow states by either while configuring a Workflow State Change step,36 or via the Settings page:
In the left sidebar, click Settings.
Under Workspace, select Workflow States.
Click on the workflow you’d like to modify workflow states for.
Click Add New Workflow State.
Enter in a name and a description, then select a color for your workflow state.
Click Save to create the workflow state.
Delete workflow states
If a state is or was previously in use on a workflow within a Workflow State Change step, the state cannot be deleted.
In the left sidebar, click Settings.
Under Workspace, select Workflow States.
Click on the workflow you’d like to delete workflow states for.
Hover over the workflow state until the appears, then click on it.
After you confirm, the workflow state will be removed.