| Table of Contents | ||||
|---|---|---|---|---|
|
...
- Start Event (required) – Event that begins the Escalation's life cycle
- Abort Events (optional) – Events which can interrupt the Escalation to prevent unnecessary actions from occurring
- Sequences (required) – Actions the Escalation takes during its life cycle
- Criteria (optional) – A means of narrowing down the conditions under which the Escalation begins
Adding an Escalation
Navigate to the Escalations grid by going to Admin > Escalations / Notifications > Escalations.
To add a new Escalation, click the
button located on the Grid toolbar.
In the Escalation form, must complete the required fields. Enter an "Escalation Name" so that the new Escalation can easily be identified.
...
Once all required fields in the Escalation form have been satisfied, click the
button. The new Escalation appears as an item on the Escalations grid. If the Escalation is set to "Active", the Escalation commences whenever its Start Event occurs.
...
Users can edit existing Escalations by double-clicking on any item on the Escalations grid or by selecting an item and clicking the button located immediately above the Grid.
In the Escalation form, define the item's inputs by following the protocol established earlier in this section. The 'Start Event' cannot change for an existing Escalation. In order to define an Escalation identical or similar without reproducing all the steps to create it, use the form's Options > Copy to New Form menu to create a copy: 
Admin Users can delete existing Escalations by selecting the appropriate item on the Escalations grid and clicking the 
button located immediately above the Grid.
...
Now the User should add a Sequence of actions that occur once the Escalation process begins. In the 'Add New Escalation' form, see the tab labeled 'Sequence'. To add an action to the Sequence, click the button located on the Sequence grid toolbar.
In the form complete the required Required fields.
The 'Sequence #' determines the order in which each action is performed by the application. For example, if a User were to add three actions to the Sequence and each action had a Sequence # of '100', '200', and '300', the application would execute the '100' action before moving on to the '200', etc. The application lets the User enter arbitrary numbers so they can come back to add Sequences in the middle without having to renumber all the existing ones after it. It is also possible to duplicate the Sequence # to execute two actions simultaneously.
...
Uses the Workgroup from the Service Desk Workflow entry that triggered the Escalation to send Notifications to each person in the Workgroup Sequence tab.
If Type is defined as "Workgroup", the User is prompted to select a Notification that is sent. Select a Notification from the list of existing Notifications by clicking on the picker in the Notification field. Available Notifications must match the Escalation's Start Event specified.
...
Sends a selected Notification to a specified list of recipients (Notify To).
]
A couple of tips for using this Type:
...
Note: For "Notify" Type, the User must specify who should receive the Notification as it is a required Required field.
Esc. Sequence Event
Generate a custom Sequence Event that can abort other Escalations or send out Notifications for specific conditions.
Service Host SOAP Escalation
Allows the User to provide raw data structures for a request body to a specific external Host/Method, using the 'Options' field.
Service Host REST Escalation
...
- POST (Create), PATCH (Change), PUT (Replace), and DELETE are the supported Request Types. By default, Request Type POST will be used.
Sequence Events are best used with Criteria so they are only generated when very specific data conditions are met. With these narrowed conditions, more control over aborting certain Escalations or whether to send particular Notifications is provided to an Admin.
...
On the Escalation form, click the Criteria tab, and click the button. On the Criteria form, set a single condition using a piece of Data (that is provided to the Event info) to match against, a Comparison operator, and the Value the data must match to pass and begin the Escalation. Based on the Data field, the Value may be an arbitrary text value, a Picker item, an option from a drop-down, etc.
...
Now, any time a Service Desk Item's Status is changed specifically to 'Void', this Escalation begins. Its only Sequence generates the custom "SD Item Voided" event. Now, make sure the manager's email is only sent if Mary doesn't view the Incident she's assigned.
- Click the button to start another new Escalation:
- Name it "Abort for Assigned Worker Viewed".
- Select "Service Desk Item Viewed" as the Start Event.
- Add a Sequence:
- Name it "Worker Viewed SD Item".
- Select Type Esc. Sequence Event.
- Name it "Assigned Worker Viewed SD Item".
- Set Time To Wait to 0m to make it trigger as soon as possible.
- Save and Close the Sequence form.
- Click the Criteria tab the click the
button to start a new Criteria:- Give it a Description like "Viewed By Assigned Worker".
- From the Data list, select the "global" variable "EVENT_CONTACT" – this is the person who initiated the event. In the case of this Escalation, it is the person who viewed the SD Item.
- Select 'Equals' from the Comparison list.
- To make this custom Event more reusable, use another Hash Variable for the comparison value rather than specifically picking Mary. Type "##" in the value input and choose "##SDWF_WORKER##". This represents the "Service Desk Workflow Worker" Contact to match the person who viewed the SD Item (EVENT_CONTACT).
- Save and Close the Criteria.
- Save and Close the Escalation.
...
Service Host REST Escalation Setup
This is a sample Escalation that will use the Service Host set up previously. It will execute using the "New Estimate Created" Event. Add a single Sequence and a single Criteria that must match for the Escalation to execute at all.
- Go to Admin > Escalations / Notifications > Escalations.
- Open a new Escalation.
- Select a Start Event before adding Sequences. This is to help the Sequence form know what 'Data Variables' it can use. Select "New Estimate Created" as the Start Event.
- Open a new Sequence on the Sequence tab. Set the Sequence # "10", and Time To Wait "0m".
- Select "Service Host REST Escalation" from the Type list.
- When the form updates, choose the Service Host to use ("Sample REST Host" in the example above).
- Set the "Host API Path". This will be the part of the URL that differs from one command to another.
- If the API uses a query string (as described above), do not include it in the Host API Path.
- If there is no additional path to the API URL, enter "/" as the API Path value.
- Set the "Request Type" to match the type of request to make.
- POST (Create)
- PATCH (Change)
- PUT (Replace)
- DELETE
- In the "API Options" use the JSON editor to define the request to be sent to the API. This is a map of field names the API expects with values from PCR-360.
Compare this sample to the "Add Order" command from our Service Host example:
Users can also use items from the "Available Template Data" list to append variable placeholders to the Value to send. These variables (formatted as ##VARIABLE_NAME##) will be replaced with the actual value from the Event when the Sequence is executed. The selected item from the list will always be inserted at the current cursor position in the editor, but can be cut/paste them to other positions in the text as needed. - UDFs are also supported in the Event Variables that can be added to the API Value. When selecting one, there will be a variable name like ##UDF_12345## instead of the label. This ensures the unique UDF ID is used for looking up the correct value to replace the variable with. Should we use a label, and the label changes or contains errant characters, the variable substitution would fail.
- Save the Sequence and close the Sequence form. To use this Escalation to perform other tasks, including other calls to the same or other APIs, set up separate Sequences for those actions.
- Click the Criteria tab and open a new Criteria. However, notice UDFs that apply to the data object the Start Event is generated from are available in the list of data Criteria to can check before the Escalation begins its work. There are also additional Comparison types to choose from for better refinement of acceptable data conditions.
- Save a Criteria if desired.
- Finally, save the new Escalation.
With this sample, when a new Estimate is created in Service Desk, this Escalation will check any Criteria set in place. If ALL of the criteria pass, the Sequence(s) will execute, sending data to the API set up in Service Hosts.
Service Host
...
SOAP Escalation Setup
This is a sample Escalation that will use the Service Host set up previously. It will execute using the "New Service Request Created" Event. Add a single Sequence and a single Criteria that must match for the Escalation to execute at all.
- Go to Admin > Escalations / Notifications > Escalations
- Open a new Escalation.
- Select a Start Event before adding Sequences. This is to help the Sequence form know what data variables it can use. Select "New Service Request Created" as the Start Event.
- Open a new Sequence on the Sequence tab. Set the Sequence # "10", and Time To Wait "0m".
- Select "Service Host SOAP Escalation" from the Type list.
- When the form updates, choose the Service Host to use ("Sample REST Host" in the example above).
- Set the "Target Host". This will define the Service Host that is going to be interacting with this Escalation.
- Set the "Target Method". This will define what endpoint the Escalation is going to be sent to. The expected fields to be sent will be automatically populated.
- Fill in the "API Options" to be sent to the endpoint.
- Save the Sequence and close the Sequence form. To use this Escalation to perform other tasks, including other calls to the same or other endpoints, set up separate Sequences for those actions.
- Click the Criteria tab and open a new Criteria. This operates the same as previous versions. Notice that UDFs which apply to the data object the Start Event is generated from can be found in the list of data Criteria that can be checked before the Escalation begins its work. There are also additional Comparison types to choose from for better refinement of acceptable data conditions.
- Save a Criteria if desired.
- Finally, save the new Escalation.
...
A User can review the results of all Escalation Sequences here. Double-click a Log item to open it, the result data is laid out as a JSON object with various information about the Sequence execution. For an API Sequence, "curlResponse", "curlInfo", and "curlError" message keys are present. These can help identify problems in the setup of the Service Host or Escalations, or indicate successful execution of sending data to the API. Currently, no processing is done to the response data sent back from the API. It is simply logged here for reference.
Include Page
