Script Includes are used to store JavaScript functions and classes that will execute on the server. Script Includes generally specify either an object class or a function.
Role required: admin. |
A script include has a name, a description, and a script itself. Also, it is possible to specify options active or client-callable.
To create a new script include, please complete the following steps:
Field | Mandatory | Description | ||
---|---|---|---|---|
Name | Y | Script include name. Should match with the class name declared in the script field. Also, script include name should be unique and can not contain spaces. | ||
Description | N | Short action description. | ||
Active | Select this checkbox to activate this script. When selected, the script will execute when called; otherwise, it will not execute. | |||
Client Callable | Select this checkbox to make this script available to call on the client-side scripts. | |||
Disable ACL Check | Select this checkbox to let this script include do go through an ACL check when executed within Client Scripts. | |||
Script | Y | Define the server-side script to run when called from other scripts.
|
You can call a script include in case you need to use server-side methods on the client-side. To perform this, the Client Callable attribute.
For more clarity, let us consider a simple example of calling a script include from a client-side.
A practical case is a calculation of the time period between two specified values using a specific schedule.
For this, let us create script include with parameters like shown below:
Name | DurationCalculator | ||
---|---|---|---|
Active | true | ||
ClientCallable | true | ||
Script | Enter a script from the code example below
|
In another example listed below, we use SimpleAjax on a client-side, and that's what we do:
if (s_form.getValue('start') && s_form.getValue('end') && s_form.getValue('schedule_id')) { const calculate = new SimpleAjax('DurationCalculator'); // call script include calculate.addParam('sysparm_name', 'getDuration'); // call method calculate.addParam('sysparm_start', s_form.getValue('start')); // pass param calculate.addParam('sysparm_end', s_form.getValue('end')); // pass param calculate.addParam('sysparm_schedule', s_form.getValue('schedule_id')); // pass param calculate.getXML(callback); function callback(response) { const answer = response.responseXML.documentElement.getAttribute('answer'); // value received from server-side s_form.setValue('duration', answer); } } |