Excerpt | ||||||
---|---|---|---|---|---|---|
| ||||||
Learn how you can configure Workflow Rules -
|
Status | ||||
---|---|---|---|---|
|
What does this section cover?
Table of Contents | ||
---|---|---|
|
What are Workflow Rules ?
Workflow Rules are used in order to apply actions on specific entities, triggered by specific events, considering that the specified conditions are fulfilled. Each configured Workflow Rules refers to a specific Entity. The supported entities are the following:
- Activities
- Jobs
- Service Requests
- Subscriptions
Creating, Editing & Deleting Validations & Restrictions
Action | Validations | Restrictions | Additional Information |
---|---|---|---|
General | You can have multiple Effective and Not Effective definitions | ||
Create |
| ||
Edit |
| Definition can be edited at any time, the Workflow Rule's Entity however, can never be changed, since this information affects the Workflow Rule's Conditions and Actions. | |
Delete |
| Definition can be deleted at any time | |
Setting Workflow Definition to Not Effective | If the Approval definition is used in at least one effective workflow rule then
|
Workflow Rules attributes
NAME | DESCRIPTION |
---|---|
Name * | The Workflow Rule's Name. Each Workflow Rule name should be unique |
Alternative Code * | The Alternative Code of the Workflow Rule. The Alternative Code is mandatory so if none is define its value will default to the first letter of the Workflow Rule's name |
Description | A Description of the Workflow Rule |
Life Cycle State | The life cycle state of the Workflow Rule which can either be Effective or Not Effective. Only effective workflow rules are applicable |
Entity * | The Entity for which the Workflow Rule is applied. Each Workflow Rule must be related to one and only one Entity and this related is defined at the Entity Type. |
Entity Types | The Type of the Entities for which the Workflow Rule will be triggered, evaluated and applied. The Entity of the Workflow Rule defines which Entity Types will be available for selection. Multiple Entity Types can be defined |
Processing Order | Defines the ordering of the Workflow Rule's actions. The Workflow Rule's actions are categorized as Updates and various Actions, so the Processing order defines whether the entity which triggers the rule will at first be updated and then actions will be performed based on its updated information or the other way around. The available options are:
|
Priority | A priority of the rule in case that multiple rules are applied on each entity. The available values are Low, Medium, High. |
Triggers * | A list of events that will be triggering the workflow rule. Multiple triggers can be selected. The triggers should include the following:
|
Conditions | A set of Conditions that should be fulfilled in order to apply the Workflow Rule. Multiple Conditions can exist per Workflow Rule. The Workflow Rule's Conditions are met either when at least one of the Conditions is met or if all Conditions are met and this option is available when setting up the conditions. Conditions always refer to the information of the entity related to the Workflow Rule. Each Condition might include more than one fields of the related entity and at least one of them should be bet in order for the condition to be met. Each Condition also has a specific type that indicates how the entity's information will be evaluated. The Conditions include:
|
Actions * | A set of Actions that should be applied according to the Workflow Rule but only as long as the Conditions are met. Multiple Actions can exist per Workflow Rule and all of them will be applied if the Conditions are met. The Workflow Rule's Processing Order setting defines the order in which the Actions will be applied. The Workflow Rule Actions include the following:
Each Entity Type has different Workflow Rule Actions described in the tables below |
Activity Workflow Rule Conditions and Actions
Conditions | Actions | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Name | Description | Name | Description | |||||||||
Who performs the update | Defines a set of Users or Units which either created new or modify an existing Activity. More than one options can be selected. If more than one options are defined then at least one of them should be met. The available Condition options are:
| Update Information | Defines how specific Activity fields should be updated and the new value that should be assigned to them as the result of successfully applying a Workflow Rule. Multiple fields can be selected to be updated within the set of actions of the same Workflow Rule, but only as long as they are not conflicting. The available fields to be updated are the following: | Specific Field Change to Value | Defines a specific value that specific field should have when the Condition is to be evaluated. Only one value per field is allowed to be defined. Multiple fields along with their values can be defined within the same set of Conditions
| |||||||
Specific Field Change | Defines a set of Activity fields for which the Condition is met if their value changes (change to any value). More than one fields can be selected. If more than one fields are defined, then at least one of them must change in order for the Condition to be met. The available fields are:
| Send Alerts | Sends alerts to the users. Existing or new alert definitions related with activities can be used Note that both effective and not effective definitions can be selected | |||||||||
| ||||||||||||
Specific Field Change | Defines a set of Activity fields for which the Condition is met if their value changes (change to any value). More than one fields can be selected. If more than one fields are defined, then at least one of them should be evaluated to true must change in order for the Condition to be met. The available fields are: TypeTriggers Webhooks
| Trigger Webhooks |
| Send Alerts | Sends alerts to the users. Existing or new webhook alert definitions related with activities can be used Note that both effective and not effective definitions can be selected | |||||||
Specific Field Change From Value to another Value | Defines a specific value that aspecific field should initiallyhave and the value that the same field should have after the entity's updatewhen the Condition is to be evaluated. Only one value per field is allowed to be defined. Multiple fields along with their values can be defined within the same set of Conditions. If more than one fields are defined, then at least one of them should be evaluated to true in order for the Condition to be met. The available fields are:
| Request Approvals | Sets the approval settingsTrigger Webhooks | Triggers Webhooks. Existing or new approval webhook definitions related with activities can be used Note that both effective and not effective definitions can be selected |
Job Workflow Rule Condition and Action Attritbutes
Conditions | Actions | ||||||||
---|---|---|---|---|---|---|---|---|---|
Name | Description | Name | Description | ||||||
Who performs the update | Defines a set of Users or Units which either created a new or modified an existing Job. More than one options can be selectedSpecific Field Change From Value to another Value | Defines a specific value that a specific field should initially have and the value that the same field should have after the entity's update. Multiple fields along with their values can be defined within the same set of Conditions. If more than one options fields are defined, then at least one of them should be evaluated to true in order for the Condition to be met. The available Condition options fields are: | Specific Field Change | Defines a set of Job fields for which the Condition is met if their value changes (change to any value). More than one fields
| Update Information | Defines how specific Service Request fields should be updated and the new value that should be assigned to them as the result of successfully applying a Workflow Rule. Multiple fields can be selected to be updated within the set of actions of the same Workflow Rule, but only as long as they are not conflicting. The available fields to be updated are the following:
|
| Request Approvals | Sets the approval settings. Existing or new approval definitions related with activities can be used Note that both effective and not effective definitions can be selected |
Job Workflow Rule Condition and Action Attributes
Conditions | Actions | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Name | Description | Name | Description | ||||||||||||
Who performs the update | Defines a set of Users or Units which either created a new or modified an existing Job. More than one options can be selected. If more than one fields options are defined , then at least one of them must change in order for the Condition to should be met. The available fields Condition options are:
| Send Alerts | Sends alerts to the users. Existing or new alert definitions related with jobs can be used Note that both effective and not effective definitions can be selected | ||||||||||||
Specific Field Change to Value | Defines a specific value that specific field should have when the Condition is to be evaluated. Only one value per field is allowed to be defined. Multiple fields along with their values can be defined within the same set of Conditions. If more than one fields are defined, then at least one of them should be evaluated to true in order for the Condition to be met. The available fields are:
| Trigger Webhooks | Triggers Webhooks. Existing or new webhook definitions related with jobs can be used Note that both effective and not effective definitions can be selected | Specific Field Change From Value to another Value | Defines a specific value that a specific field should initially have and the value that the same field should have after the entity's update. Multiple fields along with their values can be defined within the same set of Conditions. If more than one fields are defined, then at least one of them should be evaluated to true in order for the Condition to be met. The available fields are:|||||||||||
| Update Information | Defines how specific Service Request fields should be updated and the new value that should be assigned to them as the result of successfully applying a Workflow Rule. Multiple fields can be selected to be updated within the set of actions of the same Workflow Rule, but only as long as they are not conflicting. The available fields to be updated are the following: | |||||||||||||
Conditions | Actions | ||||||||||||||
Name | Description | Name | Description | ||||||||||||
Who performs the update | Defines a set of Users or Units which either created a new or modified an existing Service Request. More than one options can be selected. If more than one options are defined then at least one of them should be met. The available Condition options are:
| Update Information | Defines how specific Service Request fields should be updated and the new value that should be assigned to them as the result of successfully applying a Workflow Rule. Multiple fields can be selected to be updated within the set of actions of the same Workflow Rule, but only as long as they are not conflicting. The available fields to be updated are the following:
| Request Approvals | Sets the approval settings. Existing or new approval definitions related with jobs can be used Note that both effective and not effective definitions can be selected | ||||||||||
Schedule Activities | Schedule Activities to be performed for the entity which triggers the Workflow Rule by setting up the Activity Types of the Activities that will be scheduled. Multiple Activity Types can be configured. For the automatic activity scheduling you must also configure activity assignments in Creating Automatic Collaboration Rules (ACR) as the assignment will be automatically done. |
Service Request Workflow Rule Condition and Action Attributes
| |||
Specific Field Change | Defines a set of Job fields for which the Condition is met if their value changes (change to any value). More than one fields can be selected. If more than one fields are defined, then at least one of them must change in order for the Condition to be met. The available fields are:
| Send Alerts | Sends alerts to the users. Existing or new alert definitions related with jobs can be used Note that both effective and not effective definitions can be selected |
---|---|---|---|
Specific Field Change to Value | Defines a specific value that specific field should have when the Condition is to be evaluated. Only one value per field is allowed to be defined. Multiple fields along with their values can be defined within the same set of Conditions. If more than one fields are defined, then at least one of them should be evaluated to true in order for the Condition to be met. The available fields are:
| Trigger Webhooks | Triggers Webhooks. Existing or new webhook definitions related with jobs can be used Note that both effective and not effective definitions can be selected |
Specific Field Change From Value to another Value | Defines a specific value that a specific field should initially have and the value that the same field should have after the entity's update. Multiple fields along with their values can be defined within the same set of Conditions. If more than one fields are defined, then at least one of them should be evaluated to true in order for the Condition to be met. The available fields are:
| Request Approvals | Sets the approval settings. Existing or new approval definitions related with jobs can be used Note that both effective and not effective definitions can be selected |
Schedule Activities | Schedule Activities to be performed for the entity which triggers the Workflow Rule by setting up the Activity Types of the Activities that will be scheduled. Multiple Activity Types can be configured. For the automatic activity scheduling you must also configure activity assignments in Creating Automatic Collaboration Rules (ACR) as the assignment will be automatically done. |
Service Request Workflow Rule Condition and Action Attributes
Conditions | Actions | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Name | Description | Name | Description | ||||||||||||
Who performs the update | Defines a set of Users or Units which either created a new or modified an existing Service Request. More than one options can be selected. If more than one options are defined then at least one of them should be met. The available Condition options are:
| Update Information | Defines how specific Service Request fields should be updated and the new value that should be assigned to them as the result of successfully applying a Workflow Rule. Multiple fields can be selected to be updated within the set of actions of the same Workflow Rule, but only as long as they are not conflicting. The available fields to be updated are the following:
| ||||||||||||
Specific Field Change | Defines a set of Service Request fields for which the Condition is met if their value changes (change to any value). More than one fields can be selected. If more than one fields are defined, then at least one of them must change in order for the Condition to be met. The available fields are:
| Send Alerts | Sends alerts to the users. Existing or new alert definitions related with service requests can be used Note that both effective and not effective definitions can be selected | ||||||||||||
Specific Field Change to Value | Defines a specific value that specific field should have when the Condition is to be evaluated. Only one value per field is allowed to be defined. Multiple fields along with their values can be defined within the same set of Conditions. If more than one fields are defined, then at least one of them should be evaluated to true in order for the Condition to be met. The available fields are:
| Trigger Webhooks | Triggers Webhooks. Existing or new webhook definitions related with Service Requests can be used Note that both effective and not effective definitions can be selected | ||||||||||||
Specific Field Change From Value to another Value | Defines a specific value that a specific field should initially have and the value that the same field should have after the entity's update. Multiple fields along with their values can be defined within the same set of Conditions. If more than one fields are defined, then at least one of them should be evaluated to true in order for the Condition to be met. The available fields are:
| Request Approvals | Sets the approval settings. Existing or new approval definitions related with Service Requests can be used Note that both effective and not effective definitions can be selected | ||||||||||||
Schedule Activities | Schedule Activities to be performed for the entity which triggers the Workflow Rule by setting up the Activity Types of the Activities that will be scheduled. Multiple Activity Types can be configured. For the automatic activity scheduling you must also configure activity assignments in Creating Automatic Collaboration Rules (ACR) as the assignment will be automatically done. |
Subscriptions Workflow Rule Condition and Action Attributes
Conditions | Actions | ||
---|---|---|---|
Name | Description | Name | Description |
Who performs the update | Defines a set of Users or Units which either created a new or modified an existing Job. More than one options can be selected. If more than one options are defined then at least one of them should be met. The available Condition options are:
| Update Information | Defines how specific Service Request fields should be updated and the new value that should be assigned to them as the result of successfully applying a Workflow Rule. Multiple fields can be selected to be updated within the set of actions of the same Workflow Rule, but only as long as they are not conflicting. The available fields to be updated are the following:
|
Specific Field Change | Defines a set of Subscription fields for which the Condition is met if their value changes (change to any value). More than one fields can be selected. If more than one fields are defined, then at least one of them must change in order for the Condition to be met. The available fields are:
| Send Alerts | Sends alerts to the users. Existing or new alert definitions related with subscriptions can be used Note that both effective and not effective definitions can be selected |
Specific Field Change to Value | Defines a specific value that specific field should have when the Condition is to be evaluated. Only one value per field is allowed to be defined. Multiple fields along with their values can be defined within the same set of Conditions. If more than one fields are defined, then at least one of them should be evaluated to true in order for the Condition to be met. The available fields are:
| Trigger Webhooks | Triggers Webhooks. Existing or new webhook definitions related with subscriptions can be used Note that both effective and not effective definitions can be selected |
Specific Field Change From Value to another Value | Defines a specific value that a specific field should initially have and the value that the same field should have after the entity's update. Multiple fields along with their values can be defined within the same set of Conditions. If more than one fields are defined, then at least one of them should be evaluated to true in order for the Condition to be met. The available fields are:
| Request Approvals | Sets the approval settings. Existing or new approval definitions related with subscriptions can be used Note that both effective and not effective definitions can be selected |
Schedule Activities | Schedule Activities to be performed for the entity which triggers the Workflow Rule by setting up the Activity Types of the Activities that will be scheduled. Multiple Activity Types can be configured. For the automatic activity scheduling you must also configure activity assignments in Creating Automatic Collaboration Rules (ACR) as the assignment will be automatically done. |
Defining your own Workflow Rules tailored to your company's needs
- Navigate to FOUNDATION > WORKFLOWS > SET UP WORKFLOW RULES
- Either search for an existing one or from the Top Menu click on NEW
MAIN INFORMATION
- Provide the main information as explained in the table above
SETTINGS
Provide the following information- Entity: Select from the drop down list the entity for which the rule will be created
- Processing Order: Select from the drop down list the order by which the rule will work
- Priority: Select from the drop down the priority for the specific rule
In case more rules eist for the same entity - Applicable on Entity Types: Click on ADD and select from the drop down list the entity types that the rule will be applied for
TRIGGERS
Select the events which will trigger the workflow rule- On Create : Check the box if you would like the rule to be triggered on creating the entity
- On Update: Check the box if you would like the rule to be triggered on updating the entity
- On WEB API: Check the box if you would like the rule to be triggered on using WEB API Call: GET workflow_rules/trigger
CONDITIONS
Define a set of conditions which have to be met in order for the workflow rule's actions to be applied.- Select how the conditions will be validated, between
- All Conditions are met
- At least one condition is met
- Click on ADD
- From the list on the left select the Condition Added
- Condition Type: Select from the drop down list the condition you would like to apply
According to the condition type you will need to add the respective conditions. i.e. if you select specific User or Unit you will need to add the Unit or Users that condition applis to
If you select on a field change you will need to select a field e.t.c - Click on ADD
- Select from the drop down list the:
- User or unit setting on When Specific User or Unit Makes a change
- Field on When Specific Field Changes
- Field and Value on When Specific Field Contains Specific Value
- Field From Value and To Value on When Specific Field Changes from a Specific Value to Another Specific Value
- Condition Type: Select from the drop down list the condition you would like to apply
- From the list on the left select the Condition Added
- Select how the conditions will be validated, between
ACTIONS
Define which entity fields will be updated as part of the workflow rule's actions as well as each field's new value. Multiple fields can be added. The fields and their available values depend on the workflow rule's referred to entity.
UPDATE INFORMATION
- Click on ADD
- Field: Select from the drop down list the field that will be updated
- Value: Provide the value the selected field will be updated to
- Click on ADD
SEND ALERTS
TRIGGER WEBHOOKS
SCHEDULE ACTIVITIES
This is not available if the selected Entity in the Settings Tab is Activities
Click on ADD and search for the Activity Typeyou would like to be created
Info When setting activities scheduling for Jobs, the Job Types Fulfilment method is taken into account.
If there is at least one applicable Job Type with fulfilment method "Based on ordered items" then additional Activities cannot be scheduled for Job instances of that type. On saving the workflow rule an informational message is displayed that activities will not be scheduled for such jobs. This applies when:
- The workflow rule is applied on specific Job Types and at least one of them has "Based on ordered items" fulfilment method or
- The workflow rule does not have any applicable Job Types but there is at least one Job Type configured in the system with "Based on ordered items" fulfilment method
LOG INFORMATION
Include Page Log Information - Global Log Information - Global From the Actions Menu click on SAVE
Deleting Workflow Rules
Include Page | ||||
---|---|---|---|---|
|
Changing the Life Cycle State of Approval Definition
- Navigate to FOUNDATION > WORKFLOWS > SET UP WORKFLOW RULES
- Either search for an existing one or from the Top Menu click on NEW
- From the Actions Menu click on ACTIONS > SET AS EFFECTIVE
OR - From the Actions Menu click on ACTIONS > SET AS NOT EFFECTIVE
Panel | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
Related Areas
|
Panel | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
Popular Labels Popular Labels | Helpful Links
|