Custom Menu

Custom functions can be executed using Custom Menu to perform a variety of user-defined actions within ServiceDesk Plus MSP Cloud and external applications.

You can configure custom functions for custom menu actions in requests, problems, changes, projects, releases, assets, CMDB, purchase, and contracts.

Learn about custom menus.

Supported Modules	Role Required
Requests	SDAdmin, SDSiteAdmin, HelpDeskConfig
Problems, Changes, Projects, Releases, Assets, CMDB, Purchase, and Contracts	SDAdmin

Configure Custom Functions for Custom Menu Actions

Go to Setup > Developer Space > Custom Functions.
In the module drop-down, select Custom Menu Actions.
Click New Custom Function. You can alternately write the custom function while creating/editing a custom menu.
Fill out the necessary information as described in the below:

Field	Description
Custom Function Name*	Provide a unique name for the custom function.
Description	Describe the objective and usage of the custom function.
Applies to	Choose the sub-entities within the module where the custom function is applied.
Deluge Script Editor	Compile the custom function in the Deluge Script Editor using a simple drag-and-drop motion. To learn more about Deluge and how to write custom functions, click here. Depending on the module selected, the following arguments will be passed in the custom function. Requests - 'requestObj' and 'context' Problems - 'problemObj' and 'context' Changes - ' changeObj ' and 'context' Projects - 'projectObj' and 'context' Releases - 'releaseObj' and 'context' Assets - 'assetObj' and 'context' CMDB - 'ciObj' and 'context' Purchase - 'purchaseorderObj' and 'context' Contracts - 'contractObj' and 'context' '[module]Obj' - Stores the details of the module on which the custom menu must be configured. 'context' - Stores the current instance and the logged-in user details. If the custom function is configured for a module sub-entity, the respective sub-entity object will be passed in the parameter.

*mandatory fields

After compiling the custom function, click Save or Save & Execute Script.

Points to remember:

Ensure custom function returns "Map" value.

Note that you can update only the following request fields in requestObj: subject, resolution, mode, group, item, level, impact, service_category, update_reason, priority, udf_fields, impact_details, subcategory, status, request_type, description, urgency, technician, category.

You cannot return any object from the custom function to modify the request. You can, however, modify the request by making API calls.

Test Execution of Scripts

After writing the custom function, you can test it by following the steps given below:

Click Save & Execute Script.
Choose a sample request from the list of requests displayed.
Click Next.
The data that will be passed to the custom function will be displayed under the parameter 'requestObj'. Optionally, you can modify the requestObj values.
Click Execute.

The script will be executed, and the output will be displayed.

Test execution of a custom function does not affect any data in your production account. However, if you make any API calls (by using zoho.sdp.invokeurl or invokeurl) while testing the custom function, the API will be invoked. Make sure you don't invoke an API that might result in unintended consequences.

Debugging Tip

Deluge allows debugging through an action called info. You can use this action to print the output of your custom function.

For example, to understand the structure of requestObj and context, you can simply run the following script and study the response.

info requestObj;
info context;
return true;

Sample Script

The new field values must be returned from the custom function in a specific format as demonstrated in the following sample script that can be used to auto-close linked requests upon the closure of the reference request:

/*Gets the request status*/
status = requestObj.get("status").get("name");
returnMap = Map();
/*Checks if the request is closed*/
if(status.equals("Closed"))
{
/*Gets the name of the portal in which the request is logged*/
portal_name = context.get("instance");
request_url = "/app/" + portal_name + "/api/v3/requests/";
/*Checks if the request has been linked to other requests*/
if(requestObj.get("has_linked_requests").equals("true"))
{
/*Specifies criteria to fetch the linked requests*/
linked_request_criteria = {"field":"linked_to_request.request.id","condition":"is","value":requestObj.get("id")};
not_closed_criteria = {"field":"status.name","condition":"is not","value":"Closed","logical_operator":"and"};
/*Makes an API call to fetch the 10 oldest linked requests*/
fetch_response = zoho.sdp.invokeurl
[
url :request_url
type :GET
parameters:{"input_data":{"list_info":{"row_count":"10","sort_field":"display_id","sort_order":"asc","search_criteria":{linked_request_criteria,not_closed_criteria}}}}
];
requests = fetch_response.getJSON("requests");
request_ids = "";
/*Gets the IDs of the requests that are fetched*/
for each request in requests
{
request_id = request.get("id");
if(request_ids == "")
{
request_ids = request_id;
}
else
{
request_ids = request_ids + "," + request_id;
}
}
if(request_ids != "")
{
/*Makes an API call to close the requests that are fetched*/
close_response = zoho.sdp.invokeurl
[
url :request_url + "close"
type :PUT
parameters:{"ids":request_ids}
];
if(close_response.get("response_status").get(0).get("status") == "success")
{
returnMap.put("success",true);
returnMap.put("message","Child requests are changed successfully");
}
else
{
returnMap.put("success",false);
returnMap.put("message",close_response.get("response_status").get("message"));
}
}
}
}
return returnMap

As demonstrated in the above sample script, after the custom function is executed, you can optionally prompt the user of the success or the failure of the action execution by including the following section in the script:

{"success": true/false, "message": "<custom message>"}