Open topic with navigation

CM.Resource Pool - Resource Actions

Introduction

Resource Actions are a component of the ConSol CM Action Framework. Resource Actions are actions which can be performed for a resource, i.e., an object which is stored in the Resource Pool. The actions can be performed automatically by the system or manually, triggered by an engineer who has the required permissions. You might want to apply Resource Actions for use cases like the following:

• Create a maintenance ticket for a printer.
• Find all companies which use a certain SLA.

You can use the following types of Resource Actions:

• Automatic actions which are performed by the system after one of the following resource operations:
  • CREATE
  • UPDATE
  • DELETE
  • RELATION
  • SEARCH
• Manual actions which are performed by the engineer using Activities links on a resource page in the Web Client (similar to Workflow activities for tickets). Manual actions are executed for the resource which is displayed.

Figure 556: ConSol CM Web Client - Resource Action (on resource page)

Resource Actions are defined as Groovy scripts which are stored in the Script and Template section of the Admin Tool.

The execution of Resource Actions can be controlled using condition scripts, i.e., you can implement a condition script which is executed before the execution script of the Resource Action. The execution script is only executed if the condition script returns true.

So there are two types of scripts you have to deal with when you use ConSol CM Resource Actions:

• Resource Execution Scripts
  Defines the action which should be performed.
• Resource Condition Scripts
  Defines one or more conditions for the execution of the execution script. Has to return true or false. If false is returned the execution script is not executed. If this is a manual action, it is not displayed as Activity in the Web Client.

When you want to implement a Resource Action you have to proceed in three steps:

1. Create a script for the Resource Action (either an execution script only or an execution script and a condition script).
2. Create the Resource Action(s) which use(s) the script(s).
3. Assign the Resource Action(s) to the Resource Type(s) where they should be available.

In the following sections, all three steps are explained in detail.

Creating Resource Actions Using the Admin Tool

Step 1: Write the Resource Execution Script

Create a new Admin Tool script of type Resource action. If required, create another script of type Resource condition.

For a detailed explanation of Admin Tool scripts in general, please refer to section Admin Tool Scripts.

Figure 557: ConSol CM Admin Tool - Resource Action script in Scripts section

Code example 84: Resource execution script

Step 2: Create Resource Action(s) Which Use(s) the Script

To create, edit, or delete Resource Actions, open the navigation item Actions in navigation group Resources in the Admin Tool.

To create or add a new action click the Add button and fill-in the required data in the pop-up window (the pop-up window is the same for adding and for editing a resource action).

Figure 558: ConSol CM Admin Tool - Creating a Resource Action

• Name
  The technical name of the Resource Action. You can localize the value by using the Localize button. The localized name will be displayed in the Web Client. For a detailed explanation of the localization mechanism, please refer to section Localization of Objects in General, Type 1.
• Type
  The Resource Action type. Select one of the following types. Once a type has been defined, it cannot be modified afterwards (when you edit an existing Resource Action).
  
  • Create
    This action will be executed automatically when the resource is created.
  • Update
    This action will be executed automatically when the resource is updated, i.e., when the data has been modified (either manually or automatically) and is saved again.
  • Delete
    This action will be executed automatically when the resource is deleted.

  • Relation
    This script will be executed automatically when a relation to or from a resource of this type is

    • created
    • deleted

    (The script will not be executed when the comment of a relation is changed.)

  • Manual
    The Resource Action is displayed as Activity in the Web Client and can be executed only manually. If a Resource Condition Script is implemented, the activity will only be displayed in the Web Client if the condition script has returned true.
  • Search
    The Resource Action is a search action. Actions of this type are explained in section Action Framework - Search Actions.
• Condition Script
  In case a condition script should be executed before the execution script, the name of the condition script must be entered here. Use the drop-down menu to select from a list with all scripts of type Resource condition which are stored in the Scripts section of the Admin Tool. The execution script will only be executed if the condition script returns true. If there is no condition, just leave this field empty.
• Execution Script
  The name of the execution script which should be executed. Use the drop-down menu to select from a list with all scripts of type Resource action which are stored in the Scripts section of the Admin Tool.
• Description
  Enter the description which should be displayed as mouse-over in the Web Client (for manual actions only).

Save the action. Then you can assign it to Resource Types. Please see following step.

Step 3: Assign Resource Actions to Resource Types

To assign pre-defined Resource Execution and/or Resource Condition Scripts to Resource Types, the respective manual and/or automatic actions have to be assigned to a Resource Type. Open the navigation item Data Models in navigation group Resources in the Admin Tool. Select the Resource Type you would like to edit and click the Edit button to open the pop-up window where you can assign the Resource Actions. An action might contain only a Resource Execution Script or a Resource Condition Script and a Resource Execution Script.

In the following example (next figure), a manual Resource Action is assigned to the resource type PC_Desktop.

Figure 559: ConSol CM Admin Tool - Assigning manual Resource Actions to a resource type

You can assign Resource Actions of the following action types:

• Automatic Actions
  Those actions will be executed automatically when the respective type of event (Create, Update, Delete, Relation) has been triggered. Select an action for each type which is required. Only the actions with the correct type (which have been defined as Resource Actions, see step 2) are listed in each drop-down menu. For example, for an automatic action of type Create, only Resource Actions of type Create (which have been defined in navigation item Actions) will be available.
• Manual Actions
  Those actions are displayed as activities on the resource page in the Web Client and have to be executed manually. An activity is only displayed if either no Resource Condition Script is present or if the respective Resource Condition Script has returned true.
• Search Actions
  See section Action Framework - Search Actions.

Using Resource Actions in the Web Client (as an Engineer)

As an engineer (user), two Resource Action types are relevant for you because they are available as activities in the Web Client:

• Manual
  Manual actions are offered in the Web Client similar to workflow activities for a ticket. Please see Example 1 in the next section.
• Search
  See section Action Framework - Search Actions.

The CREATE, UPDATE, RELATION, and DELETE actions run in the background.

Programming Resource Execution and Resource Condition Scripts

Please read the section about Scripts for the Action Framework for a general introduction about important principles, classes, and methods for execution and condition scripts.

Examples for Resource Actions

Example 1: Simple Manual Action

Use case: The engineer should be able to create a new Service Desk ticket directly from a resource page of a PC. The new ticket should be related to the resource (PC). The main contact of the new Service Desk ticket should be the person who is responsible for the PC. This is implemented as resource-contact relation in the Resource Type PC_Desktops. To implement the Resource Action, perform the following steps.

Write the Resource Execution Script:

Code example 85: Resource Execution Script for PC_Desktops to create a new Service Desk ticket for responsible PC contact

Create a Resource Action based on the script:

Figure 560: ConSol CM Admin Tool - Creating a new Resource Action

Assign the action to the correct Resource Type:

Figure 561: ConSol CM Admin Tool - Assign the Resource Action to the correct resource type

Check the functionality using the Web Client:

Figure 562: ConSol CM Web Client - Resource page with the Resource Action

Figure 563: ConSol CM Web Client - New Service Desk ticket created by the Resource Action

Figure 564: ConSol CM Web Client - Resource page with one or more ticket relations (new Service Desk ticket)

Example 2: Open a Maintenance Ticket from a Resource Using an ACF

The Action Framework offers the possibility to open an ACF (Activity Control Form) when a ticket is created. The ACF is used to gather data for the following workflow activity, i.e., the ticket can be created and moved through the first workflow step very easily. The following example demonstrates this functionality. A maintenance ticket should be created for a resource (an HP printer). During the (sub-) process, an ACF should be offered to ask for data which will then be used during the next workflow activity.

To implement the Resource Action, perform the following steps.

Write the Resource Execution Script:

Code example 86: Resource Execution Script which opens a ticket and uses an ACF

Create a Resource Action based on the script.

Figure 565: ConSol CM Admin Tool - Create the Resource Action for the HP Printer maintenance ticket

Assign the action to the correct Resource Type:

Figure 566: ConSol CM Admin Tool - Assigning the Resource Action to the correct resource type (HP Printer)

Check the functionality using the Web Client:

Figure 567: ConSol CM Web Client - Resource Action for HP Printer

Figure 568: ConSol CM Web Client - New maintenance ticket for resource (HP Printer), ACF

Working with the Changes Object in Resource Update Actions

Starting with CM version 6.10.5.4, it is possible to monitor the changes which have been performed during a resource update action. (The same applies to unit Update actions, explained in section Working with the Changes Object in Customer Update Actions).

To find out which changes have been performed use the object of class ResourceChanges in resource actions.

Please remember, the Update script will be executed:

• in an explicit Update action
• when additional details (comments and/or attachments) are added
• when additional details (comments and/or attachments) are removed

There are two methods of the ResourceChanges object which provide information about the changed data:

• getCustomFieldChangeInfo()
  provides information about changes of resource data (in Resource Fields)
• getContentChangeInfo()
  provides information about changes in the resource history (comments, attachments)

Since the method return parameters contain rather complex components, we recommend to read the API doc of the ResourceChanges class. The following code provides an example for a script where a resourceChanges object is used.

Code example 87: Resource Update script where changes are monitored and printed out to server.log

When for a resource of type PC_Desktops, the content of the two Resource Fields modell and name are modified, the following text is printed into the server.log file.

Code example 88: Log output from the script above