Workflow Templates
Overview
Workflow templates define the tasks that make up a business process. They are categorized by functional area. For example, a “Conduct Inspection” workflow template can be defined for evaluations, and a “Process Submission” workflow can be defined to support an application or service request. Workflows can be applied to submissions, evaluations, and compliance actions.
Workflow templates can be automatically added to new submissions and evaluations if configured. However, default workflows are not supported for compliance actions—they must be manually added when the compliance action is created.
For more information about configuring default workflows for submissions, see the Form Details - Default Workflows Tab page. For more information about configuring default workflows for evaluations, see the Evaluation Types page.
Searching Workflow Templates
To search for workflow templates, navigate to Admin > Workflow Templates. Use the sort buttons or filters at the top of each column to locate a specific template. When using a filter, the list dynamically updates to display all workflows that match the entered value.
Adding or Editing a Workflow Template
From the Workflow Templates list page, click the Add New Workflow Template button to create a new template. Click the Copy button to clone an existing template. To edit an existing template, click the Open button.
Workflow Template Fields
The following fields can be configured on the New Workflow Template or Edit Workflow Template page:
Field | Description | Notes |
|---|---|---|
Workflow Template Name | The name of the workflow template. |
|
Functional Area | The functional area to which the workflow template relates. |
|
Program Area(s) | The program area(s) to which the workflow template relates. | If no program area is assigned, then the workflow template is available for use on any item, regardless of its program area. |
Link Workflow To | What effect, if any, the workflow will have in creating or modifying a permit. Options include:
| This field only applies to the Application/Request and Schedule functional areas. |
Permit Category to Create | The category of permit to create (if the workflow creates a new permit). | This field only applies to Application/Request and Schedule functional areas when a workflow is set to create a new permit and only one program area is selected. |
Permit Type to Create | The type of permit to create (if the workflow creates a new permit). | This field only applies to Application/Request and Schedule functional areas when a workflow is set to create a new permit and only one program area is selected. Available choices are filtered based on the selected permit category. |
Default General Permit | The general permit used when this workflow is added to a submission. | This field only applies to Application/Request and Schedule functional areas when a workflow is set to create a new permit, only one program area is selected, and the selected permit category has a “Coverage under Master General Permit” coverage type. If a default general permit has become inactive, an alert message appears below this field prompting the user to select a new general permit. |
New Permit Version Copy Contact Behavior | How contact creation affects the new permit version or revision. Options include:
| This field only applies when a workflow creates a new permit version or revision. For more information, see the How Contacts are Created on New Permit Versions/Revisions page. |
Permit Document Template to Automatically Generate | The document template that is automatically generated and saved to the new permit record. | This field only applies to Application/Request and Schedule functional areas when a workflow is set to create a new permit and only one program area is selected. The document is generated as a PDF and set to public/final. When using this feature, ensure all merge field data required by the template are available on the permit record at the time of creation. For example, default issued, effective, and expiration dates may need to be configured. |
Immediately Set Permit to Issued/In Effect | The option to set the permit status to Issued or In Effect immediately when the draft permit is created. This also sets the related submission, workflow, and tasks to Complete. | This field only applies to Application/Request and Schedule functional areas when a workflow is set to create a new permit and only one program area is selected. This option bypasses the standard validation checks required to issue a permit. If the permit category is not properly configured, using this option may result in a permit that would normally fail issuance validation rules. In the event the permit’s related submission is not in In Process status, or if there are other In Process workflows on the submission, the submission’s status will not be updated. For more information on Insta-Permit configuration requirements, see the Configuring Automatic Permit Issuance upon Submission Receipt (Insta-Permit) page. |
Permit Issuance Notification Template | The notification template used to create notifications of permit issuance. | This field only applies if the template is configured to immediately set the permit to Issued/In Effect status. Notifications are sent to both the original submission creator (if the creator is an external user) and the permittee (if a valid email address is provided). If a default document template is provided, the generated document will be attached to the notification email. |
On Submission Import, Assign this Workflow based on Site Location | The option to only create the workflow template if the workflow is attached to a submission whose site is in a particular area. Options include Unassigned, Statewide, and By County. | This field only applies to the Application/Request functional area. |
Workflow Template Tasks
Each workflow template must contain at least one task. To add a task to a workflow template, click the Add Task button or to modify a task, click the Open button.
Tasks can be reordered via drag-and-drop or by changing the order sequence.
The following fields are available on the Edit Task page:
Field | Description | Notes |
|---|---|---|
Task Name | The name of the task. |
|
Task Availability | The condition under which a task should be made available to be worked on. Options include:
| For more information on trigger tasks, see next row. |
Trigger Task | The task which, when marked complete, makes this task available for work and prompts it to display on the My Tasks dashboard. | This field only appears when when Task Availability is set to “Previous Task Completion.” |
Task Due Date Days from Trigger Event | The number of days after the trigger task is completed that the task is due. | This field only appears when when Task Availability is set to “Previous Task Completion.” |
Allow user to override calculated due date | The option to allows users to update the task due date calculated by the system. | This field only appears when when Task Availability is set to “Previous Task Completion.” Once overridden by a user, the system will no longer update the due date based on the trigger condition. |
Task Decisions | A list of “decisions” (for example, “Acknowledged” or “Approved”) that a user must choose from when marking the task complete. |
|
Don't Create Task By Default | The option to allow users to manually add the task if needed, rather than including it in the default workflow. |
|
Task must be closed before associated Workflow can be closed (e.g. Required Task) | The option to require that the task be set to Completed or Withdrawn status before the workflow can be closed. | A required task will have an orange circle next to the task name. |
Notify Assigned Process on Status Change | The option to send a notification to the assigned processor for the workflow when the task’s status changes. | The notification method is based on the processor’s notification preference settings. |
Allow user to Override Notification | The option to allow users to suppress the task status update notification. | If this option is selected, the user will see a corresponding checkbox on the Edit Task page. |
Default Assignment Setting | Who the task is assigned to when created. Options include:
|
|
Default Role | The workgroup role to which the task is assigned when created. | This field only appears when Default Assignment Setting is set to “Selected Role.” Roles are configured in the Role Type lookup. |
Default Workgroup and User | The workgroup and user to which the task is assigned when created. | This field only appears when Default Assignment Setting is set to “Selected Workgroup/User.” |
Workflow Actions
Actions can now be configured for each task. Click the Actions button for the selected task. The following fields are displayed:
Field | Description | Notes |
|---|---|---|
Sequence | The order in which actions should be performed. |
|
Trigger Condition | The criteria to apply to trigger the condition. | Options are Task In Progress or Task Complete. |
Action to Perform | The action which should be performed when triggered. | Options are Add Workflow, Generate Document, Generate Notification. |
Details | The relevant workflow for this action. |
|
Once the workflow task status is moved the selected trigger condition, the action will be performed. In the example below, a new workflow “Review Application” will be added to the submission when the selected task status is updated to Complete.
Workflow Component Rules
Component rules prevent a user from adding a workflow until a specific program component has been added to a submission.
Workflow component rules are only available for Application/Request or Complaint/Incident functional area workflow templates.
Creating an Instapermit Workflow
For information on creating an instapermit workflow, see the Configuring Automatic Permit Issuance (Instapermit) page.
Deleting a Workflow Template
If a workflow template has never been used, a Delete button will appear on the Workflow Templates list page beside the workflow template. Once a workflow template has been used, it cannot be deleted, but it can be set to Inactive.
On this page
Related Content