Generic Field Update Script
Currently, every time one has to update a field with values, they need to adhere to a specific format, which can be challenging as not everyone is familiar with it. To simplify this process, we propose a generic function that can handle the formatting automatically.
Instead of remembering complex formats, users can simply provide values in a straightforward structure like this:
{ "category": "Hardware",
"udf_sline_301": "Shawn Adams",
"priority": "High",
"scheduled_start_time": "1734500415037",
"resolution": "Sample resolution"
}
This input will be parsed and converted into the required format:
{ "request": {
"udf_fields": {
"udf_sline_301": "Shawn Adams"
},
"category": {
"name": "Hardware"
},
"priority": {
"name": "High"
},
"scheduled_start_time": {
"value": "1734500415037"
}
"resolution": {
"content": "Sample resolution"
}
}
}
By using this function, the need to remember or manually structure the field formats is eliminated, making the process faster and more user-friendly.
This function will work only if the provided keys adhere to the allowed format. Refer to the documentation for the correct attribute names: ManageEngine API Documentation.
- The date and time field will only update if the value is provided as a Unix timestamp in milliseconds; otherwise, the update will not proceed.
- For picklist fields, the value used for the update must match the exact value in the picklist dropdown. Even minor discrepancies, such as an extra space, can prevent the update from occurring.
- If you are using this generic script for the Request module and need the request attributes, they can be found here: Request API Attributes.
- Download the attached scripts.
- Goto Admin > Developer Space > Global Function > Copy & Paste the attached GF_4 - Configuration.txt and save it with a name.
- Update the URL and technician key as per your instance.
- For Integration key/Technician key refer this KB link: https://pitstop.manageengine.com/portal/en/kb/articles/creating-integration-key
- Goto Admin > Developer Space > Global Custom Function > Copy & paste GF_genericFieldUpdate.txt and save it with a name.
- The global function will accept a simplified input structure provided by the user, and the name of the module.
We need to configure a module-level custom function to update the entity by calling the global function to automatically format the user-provided input and use the formatted data for the update.
The custom functions for the Change module and Request module are attached as samples. Configure these functions in custom triggers, and set the invoking conditions based on your requirements.
Request Module Configuration for reference
Request Custom Function:
Request Custom Trigger:
Request Module Configuration for reference
Change Custom Function:
Change Custom Trigger:
New to ADSelfService Plus?
Related Articles
Script to Update Date additional field (to 3 days) based on priority inside the request
In some cases the customer will need to update the date additional field based on priority set inside the request. (Applicable for builds 14300 & above) Please follow the below mentioned steps to configure: First Download and extract the attached zip ...Script to update Request with another Group when the request is approved
Use case: Assume a requester is requesting for an gadget asset and it requires approval from their managers. This ticket needs to be moved to "Asset" group only when the ticket gets approved. Pre-requisite - Python should be installed in the ...Auto-update due date time field based on the onhold scheduler
Please follow the below steps. 1.Goto Admin > Developer space --> Custom Functions > Global function > New > Paste the content from the attachment configuration.txt and save it with a name. 2.Update the URL and technician key in the script. Refer to ...Script to Update date/time additional field inside request when note is added.
(Applicable for builds 14300 & above) Please follow the below mentioned steps to configure: First Download and extract the attached zip file containing the scripts & attachments (screenshots) 1.Goto Admin > Developer space --> Custom Functions > ...Script to auto-populate the "Estimated Efforts" of a task based on the "Category" and "Sub-Category" of an incident request
REQUIREMENT: When an incident request is created, a task should be automatically added to the request. In the created task, the "Estimated Efforts" field should be automatically calculated based on the Category and Sub-Category of the incident ...