Workflow Templates
Overview
Workflow templates define the tasks that make up a business process and are organized 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 configured to be automatically added to new submissions and evaluations. However, default workflows are not supported for compliance actions and must be manually added when the compliance action is created.
For more information on configuring default workflows, see the Form Details - Default Workflows Tab page (for submissions) and the Evaluation Types page (for evaluations).
Searching Workflow Templates
To view all available 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
On the Workflow Templates page, click the Add New Workflow Template button to create a new template or click on an existing template to edit it. Click the Actions button (⋮) next to an existing workflow template and select the Copy option to clone it.
The following fields appear on the New Workflow Template and Edit Workflow Template pages.
Field | Description | Notes |
|---|---|---|
Workflow 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 applies. | If no program area is assigned, then the workflow template is available for use on any item, regardless of its program area. |
Workflow Template Tag | The tag for the form control that defines the logic for assigning the appropriate default workflow. | A tag value used to dynamically assign this workflow to a submission based on form data. When a form is submitted, if a form control with the tag |
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 default 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 one. |
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 Final status. 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 status of the related submission, workflows, 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. If 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 is not changed. For more information on Instapermit configuration requirements, see the Configuring Automatic Permit Issuance (Instapermit) 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 with a site in a particular area. Options include Unassigned, Statewide, and By County. | This field only applies to the Application/Request functional area. |
Adding or Editing a Workflow Task
Each workflow template must contain at least one task.
On the New Workflow Template or Edit Workflow Template page, click the Add Task button to add a task or click the Open button next to an existing task to edit it.
To reorder tasks within the workflow, drag and drop them or change the order sequence in the Order column.
The following fields appear on the Edit Task page.
Field | Description | Notes |
|---|---|---|
Task Name | The name of the task. |
|
Task Availability | The condition under which a task is made available for work. Options include:
| For more information on trigger tasks, see the next row. |
Trigger Task | The task that, when marked Complete, makes the current task available for work and prompts it to display on the My Tasks dashboard. | This field only appears when Task Availability is set to “Previous Task Completion.” |
Task Due Date Days from Trigger Event | The number of calendar days after the trigger task is completed that the task is due. | This field only appears 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 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 (Optional) | 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 its name. |
Notify Assigned Process on Status Change | The option to send a notification to the workflow’s assigned processor when the task’s status changes. | The notification method is based on the processor’s notification preferences. |
Allow user to Override Notification | The option to allow users to suppress task status update notifications. | 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.” |
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.” |
Adding or Editing a Task Action
Actions, such as adding a workflow or generating a document or notification, can be configured for each workflow task.
On the New Workflow Template or Edit Workflow Template page, click the Actions button for the selected task to open the Task Actions for [Task Name] page. Click the Add Action button to add a new action, or update the fields on an existing action to edit it.
The following fields appear on the Task Actions for [Task Name] page.
Field | Description | Notes |
|---|---|---|
Sequence | The order in which actions are performed. |
|
Trigger Condition | The criteria that determine when the action is performed. |
|
Action to Perform | The action to be executed. |
|
Details | Additional fields to configure the action. | For “Add Workflow” actions, the Workflow Template field is enabled. For “Generate Document” actions, the Document Template and Document Status Type fields are enabled. For “Generate Notification” actions, the Notification Template, Notification Recipients, Contact Affiliation Recipients, and Additional Emails (semicolon-delimited) fields are enabled. |
When the parent task meets the trigger condition criteria, the action is performed. In the example below, a “Review Application” workflow is added to the submission when the parent task’s status is updated to Complete.
Workflow Component Rules
Component rules prevent users from adding a workflow until a specific program component has been added to a submission. These rules are only available for workflow templates in the Application/Request or Complaint/Incident functional areas.
Creating an Instapermit Workflow
For information on creating an instapermit workflow, see the Configuring Automatic Permit Issuance (Instapermit) page.
Exporting and Importing a Workflow Template
Workflow Templates can now be exported and imported into other environments. Select the Export option under the Actions button (⋮) next to the template on the Workflow Templates page.
The system generates and downloads the jSON file to the user’s Downloads folder.
To import, click the Import Workflow Template button on the Workflow Templates page.
Search for and select the desired workflow template jSON file and click Open.
Workflow Template is displayed when import is complete.
Deleting a Workflow Template
If a workflow template has never been used, it can be deleted by clicking the Actions button (⋮) next to the template on the Workflow Templates page and selecting the Delete option. Once a workflow template has been used, it cannot be deleted, but it can be set to Inactive.
On this page
Related Content