You are here: Chapter 7: Configuration and Administration > Project Administration > Automated Workflow > Escalation > Setting up an Escalation Rule

Setting up an Escalation Rule

This section covers the following steps to create an escalation:

Note

Master Issues cannot be closed by an escalation rule.

Step 1: Basic Escalation Options

Step 2: Escalation Type

There are two kinds of escalation rules: instant and time-based.  Instant escalation rules are run at the time an Issue is created,edited, or both.  Time-based escalations are only applied after an Issue has remained open or unedited for a specified amount of time.  Depending on which option is chosen, a number of sub-options are available.

Note

The "Age" option is not available in the FootPrints database versions.

    1. Time unedited/Age based on “Work Time”—This option also counts the time since an Issue was created or last edited, but uses the project Work Calendar rather than the standard 24/7 schedule.  Regular working days and hours, as well as holidays, can be configured for the organization by clicking the link for Work time or by selecting Work Calendar from the Project Administration page. When using the Work Calendar, only one unit of time can be chosen (minutes, hours, or days).  Complete instructions for the Work Calendar can be found earlier in this chapter.

 

Example:

In the above case, the Issue will be escalated at 12pm on Monday (6 working hours later).

Step 3: Additional Criteria

The criteria chosen here determine which Issues are automatically escalated.  Available criteria include virtually all options that appears on the Advanced Search page, including Status, Priority, Assignee, Project fields, Address Book fields, etc. (see the section on Advanced Search for more information).

NOTE

If your rule requires that Create/edit must be by an agent, but a Customer Request status (such as Request) is used as a criterion for escalating an Issue, then it becomes possible for Customer Requests to be escalated (i.e., an escalation created by a Customer).

Select the criteria for this escalation rule

Step 4: Escalation Actions

  1. Notification
  1. EmailOne or more email actions can be selected.

Note

The different email address types are defined for each user on the Edit Agent Administration page, or on the My Preferences page by the Agent.

  1. Broadcast Message—One or more broadcast message types can be selected.
  2. Display pop-up notification to the following usersSpecify a user or users to receive a broadcast message from FootPrints.
  3. Display pop-up notification to the AssigneesAgents assigned to the escalated Issues receive a broadcast message from FootPrints.
  1. Workflow—One or more workflow actions can be selected.
  1. Priority—Automatically raises or lowers the Issue’s priority as specified.  You can also change the priority of all escalated Issues to a specific priority.
  2. Status—Automatically change the status of the escalated Issue.
  3. Project/Address Book Fields—Automatically change specified Project/Address Book fields.  If you check this box, you must click the Click here to configure field edits link to specify the changes.
  4. Click here to configure field edits—This page allows you to update Project and Address Book fields via an escalation. In addition to editing other fields, you can change the Title field or append a description to the Description field.  Fill in the fields with the appropriate data and then click the "GO" button.

Note

If you notice that dependent fields are being displayed with a null value when an escalated Issue is edited, it may be that the dependent field was configured with an incorrect value in the escalation rule.  If you configure a dependent field to be changed to an invalid choice as a result of an escalation, the dependent field is populated with null data.  For example, if the first field were set to Software and the dependent field were changed to Printer when escalated, and Printer is not a valid choice for the Software dependent drop-down, when the Issue is edited, the dependent field will show no selection.  The drop-down for the dependent field will contain the normal, valid choices, so it can be corrected at that time.  To correct the problem at its source, edit the escalation rule and replace the incorrect choice with the correct choice.

  1. Assignment—Highlighted users are assigned to the escalated Issue.  If Add Selected Users is chosen, the original assignees of the Issue remain assigned.  If  Re-Assign is chosen, the original assignees are unassigned.  Teams and/or individual users can be selected.  Re-assignment can also automatically be made to Team Leaders or Assignees' Supervisor(s) by checking the appropriate box.
  2. Sub-tasks for this Issue—Automatically creates sub-tasks for the Issue using the Master Quick Issue template that you select from the drop-down list.

Note

Sub-tasks are not created for an escalated Issue if the Issue is itself a sub-task, a GlobalLink, a Global Issue, or a Solution.

  1. Cross-project—The Issue is automatically copied or moved to the Project specified. If Copy with a Dynamic Link is selected, the Issues update each other when field data changes.  If Include Related Subtasks is checked, then when a Master Issue is copied or moved across Projects, the related subtasks are also copied or moved.

NOTE

Subtasks are not accepted by the receiving  Project unless the receiving Project is configured for Cross-project copy/move of subtasks.  Refer to the topic for Issue Workflow for more information on setting this option.

  1. Color—The Issue is displayed on the FootPrints Homepage with the specified color.
  2. External Action—An external application can be run by the rule.  This feature is especially useful for running scripts.  The application must be one that can run and stop on its own without any user intervention.  In addition, if the program involves running a graphical user interface (GUI), it may not be able to display the interface to a screen, which could cause the application to hang and fail.  Therefore, the application should also be one that can run from a command line rather than a GUI.  Enter the full path to the program, e.g., D:\Programs\AppLite\applite.exe. Some field data from the escalated Issue can also be passed to the program as arguments:
  3. Issue Number—%%MRID%%
  4. Title—%%Title%%
  5. Priority—%%Priority%%
  6. Status—%%Status%%
  7. Submitter—%%SUBMITTER%%
  8. Project ID—%%PROJID%%
  9. Project and Address Book fields—%%FIELD NAME%% where "FIELD NAME" is the name of the field in upper case.

External actions run applications from the CGI directory.  Make sure that directory has permission to run the application or the external action will fail.

i. Surveys—If checked, a customer satisfaction survey is sent to the contact when the escalation occurs.

  1. When to Run Escalation
  1. Any Time—Escalate the Issue at the moment the Issue is found to match escalation criteria.
  2. Follow-the-Sun—Run at the time and on the days specified.  You can also specify multiple times.

Unassigning One Agent While Keeping the Rest Assigned

The administrator may need to build an escalation in which one agent, who is always the same agent, is removed from the assignments list while others, who vary from Issue to Issue, remain assigned to the Issue.  In this instance, it would not be possible to use the standard escalations page to unassign everyone and then re-assign the Issue because the agents who are to remain would vary from Issue to Issue.  An example where this might be needed is in the case of an Issue requiring an approval.  The approver might be the same agent every time, but the other assignees could vary.  This re-assignment can be accomplished via an escalation, but not by using the Assigment section of Step 4: Escalation Actions.  Instead, you would use the External Action function to run a command from FootPrints' API.  To do so, specify the following as an external action:

C:\footprints\bin\perl\bin\perl C:\footprints\bin\mrUnassign.pl %%MRID%% userID

Step 5: When to Run Escalation

Choose when to check an Issue against escalation criteria. There are two options:

To set Follow the Sun criteria:

  1. Select Follow the Sun.
  2. Select the time range for the escalation rule.
  3. If this escalation should run during a span of time that includes a change of date, you must specify the time spanned during both dates in order to cover the entire period.  For example, the four hours between 8:00pm and 2:00am can be covered by selecting 8:00pm-11:59pm above and, additionally, Midnight-2:00am in the second set of time criteria.
  4. Check the boxes corresponding to the days of the week that the escalation is required to run.

 

Step 6: Create New Escalation

After criteria and actions are chosen, enter your password and click GO; the escalation rule is enabled.  When an Issue matches the criteria of the rule, the specified actions occur.  If an escalation rule fails for any reason, the Project Administrator receives an email notification.

Note

Escalated Issues lose their urgent status once they are edited.  If an Issue is reported as escalated, it is not escalated again until it has lost its urgency (by being edited) and then becomes urgent again. The exception to this is if Re-escalate Issue is selected under the Time criteria.

Scheduler Service

Escalations are run by the FootPrints Scheduler service. On Windows, FPSchedule.exe is automatically set as a service on the FootPrints server.  On UNIX, a cron job is automatically created that runs the MRrunScheduledScripts.pl file. This service handles incoming email, outgoing email notification, escalations, mass emails, and scheduled reports.