Custom Trigger
With Custom Trigger, the required 'Action' can be automatically triggered using the script file or custom class file.
To configure a new action,
1.Click Admin>>Problem/Change management>>Change Custom Triggers.The list of configured actions will be displayed.
2.Click 'Add New Action'. The 'New Action' window appears. Provide an unique name and description for the new action. The 'Action Name' is a mandatory field.
From the drop-down list, select the instant at which the action has to be executed. The New Action can be executed when a change is
* created
* edited and
* created or edited.
3.Set the 'Criteria' fields, its corresponding conditions and their field values. Click 'Add another criteria' to add more criteria to the new action.
4.Select the 'Action Type' and the corresponding script/class file that has to be triggered. Ensure that the html/script /class file is stored only in the specified locations. Store them in the directory as follows: [SDPMSP_Home]/integration/custom_scripts/
If 'Execute Script' is selected, then the name and path of the script file should be specifed in the field provided. Eg: py addApprovers.py $TITLE $TYPE $TEMPLATE
If 'Execute class' is selected, then the the class should be specifed in the field provided.Eg: com.servicedeskplus.integration.ChangeActionImplementation $TITLE $TYPE $TEMPLATE
Other Parameters Supported:
$COMPLETE_JSON_FILE ---> Complete Request Object will be saved to a JSON file and the file path will be passed as String Object. If the Operation is 'When a Change is edited', then DIFF_JSON (difference between the old change data and new change data) will also be saved to a JSON file.
JSON File Path : (SDPMSP_Home\integration\custom_scripts\change\12_1426143538036.json).
5.Deselecting 'Stop processing subsequent actions' checkbox will execute successive action even after an action rule is applied on a change.
Arguments for Custom Script can also be passed.
Eg: cmd / c Index.bat $SUBJECT $PRIORITY $STATUS
Other Parameters Supported:
$COMPLETE_JSON_FILE ---> Complete change Object will be saved to a JSON file and the file path will be passed as String Object. If the Operation is 'When a Change is edited', then DIFF_JSON (difference between the old change data and new change data) will also be saved to a JSON file.
JSON File Path : (SDPMSP_Home\integration\custom_scripts\change\12_1426143538036.json).
6.Click 'Save' to save the new customized action.
NOTE: To organize the order in which the actions have to be executed , Click 'Organize Actions' in the List View page. A pop-up window showing the list of actions and the order in which are executed will be executed. The order can be re-arranged by making use of the 'Move up' or 'Move down' buttons. Click 'Save' to save the order.
Click here to view a sample scenario for 'custom triggers' with sample class file and script.
We can also pass arguments for Custom Script. All API parameters are supported as arguments and the below table lists the supported arguments.
PARAMETER | DESCRIPTION |
$TITLE | Denotes the title of the change |
$DESCRIPTION | Provides the description provided for the change |
$TEMPLATE | Denotes the name of the template used to create the change |
$SUBCATEGORY | Denotes the subcategory configured for the particular change |
$CATEGORY | Denotes the category configured for the particular change |
$ITEM | Denotes the item configured for the particular change |
$SITE | Denotes the site for which the change was raised |
$TYPE | denotes the significance of a change initiated in the organization |
$SCHEDULED_START_ON | Provides the scheduled start time of the change |
$ASSETS | Provides the assets related to the particular change |
$ROLES | Denotes the access permissions defined exclusively for the change |
$REASON_FOR_CHANGE | Denotes the purpose of initiating a change request |
$URGENCY | Denotes the level of urgency of the change |
$IMPACT | Provides the impact of the change |
$GROUP | Denotes the group under which the change falls |
$ISOVERDUE | Denotes if the change is overdue |
$SERVICES_AFFECTED | Denotes the services affected because of the change |
$COMPLETED_ON | Provides the completed time of the change |
$RISK | Denotes the level of risk during implementation of the change |
$SCHEDULED__END_ON | Provides the scheduled end time of the change |
$STATE | Denotes the stage and status of the change |
$ID | Provides the unique id generated for the change |
$PRIORITY | Denotes the level of priority of the change |
$CUSTOM_FIELDS | Provides information about the custom fields configured for the change |