Send Incident to Workflow: An Automation Rule Example Notifying Users of a Comment Added
In ServiceDesk 7.5, Automation rules have been greatly expanded to add functionality and capability. Many new and interesting things are now capable that were not available before, and a lot of functionality that existed only by customizing a core process is now easily accessible to end users without an extensive knowledge of workflow components.
However, you can still leverage the power and functionality of Workflow to make changes to ServiceDesk incidents. This is done using the "Send Incident to Workflow" Ruleset Action.
The over function of this ruleset action is explained very well in another Connect article entitled "ServiceDesk Customization: Send Incident to Workflow Ruleset Action". This article is simply using that function to provide an idea or example of one that that functionality can be used to improve and customize ServiceDesk 7.5 to meet changing business requirements. This article assumes average workflow knowledge, including the knowledge to create and configure a workflow model and to be able to publish the model to your server.
The premise of this article is to show how you configure your ServiceDesk system to send a notification email to any member of an assigned Service Queue for an incident that has had a comment added by the Affected User, and/or any user has a subtask assignment.
To do this, you should review and follow the process outlined below:
- Complete the Workflow Design
- Capture the configuration information for the Automation Ruleset from the Workflow Model
- Configure the Automation Ruleset and Rule
Complete the Workflow Design
We have provided a sample package for this project which provides the workflow functionality required. Of course you may want to change or build your own. Key items to remember are:
- In your project, setup Input Data to capture the Workflow TrackingID from Servicedesk. This will allow you to correlate your work to a specific incident ID. This is created as shown below.
- Assure that you name your project something meaningful. We chose "CommentAddedLogic"
- In our sample, we used a component called "GetProcessHistory". If you use this component, it must have all options checked under the Process Messages and User Comments tabs. Under the General tab, please make sure Status Changes are checked, but leave "From CurrentProcess" unchecked. This is shown in the screenshots below.
- One caveat that might be a little challenging. You cannot access an email template from within this new external workflow, so you will use a Send Email component to notify the users. You should make this match the format and style of your email templates from other automation rules.
- When you have your workflow process configured correctly, you should test. This can easily be done using Workflow's built-in debugger. It is recommended that you take a couple of test incidents and create comments on those incidents, then copy the exposed workflow tracking ID from those incidents to the correct prompt when executing your process. That trackingID is found in a location similar to the screenshot below.
- Once you have assured that the emails are working correctly, you can publish the application to your server. Make sure that the Virtual Directory is properly titled. You should also capture this Virtual Directory name to a notepad page. You will use this later.
Capturing Configuration Data for the Automation Ruleset from the Workflow Model
There are a couple of items that you will need to capture from the Workflow publishing tab, prior to closing the project.
- In the tree view of your project, browse to the top level of the project. You will see the various properties tab of the project, as shown below. Select the Publishing tab.
- On the Publishing tab, scroll down to the Primary Service section and capture the Service Name and Method Name entries. Copy them to the same open temporary notepad space you opened up earlier. You will use them later.
Configure the Automation Ruleset and Rule
Now, with the project published and the key values for the automation rule ready to be used, you can open the portal and configure your automation rule.
- Open the portal and login in as an Administrator.
- Browse to the Admin>Automation Rules menu choice
- Expand the Incident Management Ruleset list, and click on Service Dashboard
- Click Add Ruleset
- Define the Ruleset similar to what is shown below. Provide a Title and Description. You should make sure that you select the Data Event radio button, and then choose the CommentAdded event. You can leave all other options at default.
- Click Save. This completes the creation of the Ruleset.
- Now we can create the actual automation rule. Expand your newly created Ruleset (if needed).
- Click on the lightning bolt to the far right of your new rule set.
- Click Add Rule
- 1You will see the Add Rule Screen, similar to below. You can create any condition that meets your needs. Our example simply shows the "ANY" condition used.
- In the Actions section, select the "Send Incident to Workflow" option, and then use the "At URL" option. Enter the URL of the WebService created while publishing, without the actual extension. This will be in the form "http:\\Server_Name\Published_name ". This is the published name you captured while sending the workflow project to be published to the web server, in your notepad.
- In the Parameters: section, copy the Workflow Service Name you copied from the publishing properties you captured in the earlier configuration section, step 2. This goes in the Workflow Service Name option here.
- You will need to copy the Method Name captured earlier to the Workflow Start Method Name field here on this page. The method captured in the earlier configuration section, step 2, as well.
- Now click Save.
- This completes the automation rule configuration section.
You should test this process with different users, members of Service Queues, and those users with subtask assignments. You may need to design different capture methods to capture other types of users as well.
This is simply one example of how you can use the "Send Incident to Workflow" automation rule option to improve or add functionality to Servicedesk 7.5. Please take time to review the process, review the libraries included, review the variables used and how they interact.