Versions Compared

Old Version 1

changes.mady.by.user Dina Baksheeva

Saved on

compared with

New Version 2

changes.mady.by.user Dina Baksheeva

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Script Includes Include scripts are used to store JavaScript functions and JavaScript functions and classes that will execute are executed on the server. Script Includes Include scripts generally specify either an object class or a function.

Tip

Role required: admin.

Creating a script include

Create an include script


An include script 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:

  1. Navigate to SystemDefinition → ScriptIncludes.
  2. Click New and fill in the fields.
  3. Click Save or Save and Exit to apply the changes.

Script Include form fields

FieldMandatoryDescription
NameYScript Specify the include script name.  Should It should match with the class name declared used in the script field. Also, the include script include name should be unique and can not contain spaces.
DescriptionNShort action descriptionAdd a short description of the action.
ActiveNSelect this checkbox to activate this script. When selected, the script will execute is executed when it is called; otherwise, it will is not executeexecuted.
Client CallableNSelect this checkbox to make this script available to call on the client-side scripts.
Disable ACL CheckNSelect this checkbox to let this script include do so that the include script does not go through an ACL check when it is executed within the Client Scripts.
ScriptY

Define the server-side script to run when called from other scripts.

Note

When invoking script includes in other server-side scripts, please use the ss.importIncludeScript method of the SimpleSystem class like shown on the example below:

Code Block
languagejs
themeEclipse
linenumberstrue
ss.importIncludeScript('EmailHelper');
const helper = new EmailHelper();

Otherwise, the script would be unavailableis not available.

Practical case


Use cases


Use You can use client callable script includes include scripts in case you need to use the server-side methods on the client-side. For more clarity, let us consider Consider two simple examples of calling a an include script include from:

  • a client-side
  • a server-side
Using

Use a client callable include script

include

on the forms

A practical use case is a calculation of the time period between two specified values using a specific schedule.

For To do this, let us create an include script include with the following parameters like shown below:

NameDurationCalculator
Activetrue
Client Callabletrue
Script

Enter a script from the code example belowthe following script:

Code Block
languagejs
themeEclipse
titleClient callable script include
linenumberstrue
ss.importIncludeScript('AbstractAjaxProcessor');

var DurationCalculator = Class.create();
DurationCalculator.prototype = Object.extendsObject(AbstractAjaxProcessor, {
    getDuration() {
        const start = new SimpleDateTime(this.getParameter('sysparm_start'));
        const end = new SimpleDateTime(this.getParameter('sysparm_end'));
        const scheduleID = this.getParameter('sysparm_schedule');
        const schedule = new SimpleSchedule(scheduleID);
        // value that would be passed to client-side
        return schedule.duration(start, end).getDurationSeconds() * 1000;
    }
});


Note

When you call values passing from the client-side, use this.getParameter like like shown in a the code example above to get the sysparm_ parameter value.


On the client-side, we use SimpleAjax:

  1. Create a SimpleAjax instance.
  2. Transfer the called method name Pass the name of the method to be called using the reserved parameter parameter sysparm_name.
  3. Transfer Pass the values from a form using the the sysparm_start, sysparm_end, sysparm_schedule parameters.
  4. Call an the include script using the getXML(callback) method.
    1. Process its response in the callback-function listed below.
  5. The answer variable will contain contains the value return by the getDuration() method.
Code Block
languagejs
themeEclipse
titleUsing script include on the client-side
linenumberstrue
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) {
    	// value received from server-side
        const answer = response.responseXML.documentElement.getAttribute('answer');
        s_form.setValue('duration', answer);
    }
}
Using

Use a client callable include script

include

on the lists

Another example is the calculation of list items after filtering.

For To do this, let us create script include with parameters like shown below:

NamegetListItemsCount
Activetrue
Client Callabletrue
Script

Enter a script from the code example below:

Code Block
languagejs
themeEclipse
titleClient callable script include
linenumberstrue
ss.importIncludeScript('AbstractAjaxProcessor');
 
var getListItemsCount = Class.create();
getListItemsCount.prototype = Object.extendsObject(AbstractAjaxProcessor, {
    
  getCount() {
    const table_name = this.getParameter('sysparm_table_name');
    const condition = this.getParameter('sysparm_condition_query');
    const list = new SimpleRecord(table_name);
    list.addEncodedQuery(condition);
    list.selectAttributes('sys_id');
    list.query();
    // value that would be passed to client-side
    return list.getRowCount();
  }
  });

Note

When you call values passing from the client-side, use this.getParameter like like shown in a the code example above to get the sysparm_ parameter value.


The client-side code will be script is the following:

Code Block
languagejs
themeEclipse
titleUsing script include on the client-side
linenumberstrue
const queryString = window.location.search;
const urlParams = new URLSearchParams(queryString);

const sAjax = new SimpleAjax('getListItemsCount'); // initialize script include
sAjax.addParam('sysparm_name', 'getCount'); // call method
sAjax.addParam('sysparm_table_name', s_list.getTablesName()[0]); // pass param
sAjax.addParam('sysparm_condition_query', urlParams.get('condition') || '()'); // pass param
sAjax.getXML(callback);

function callback(response) {
    // value received from server-side
    const answer = response.responseXML.documentElement.getAttribute('answer');
    s_list.clearMessages();
    s_list.addInfoMessage(`List items count: ${answer}`, 2000);
}


Table of Contents
absoluteUrltrue
classfixedPosition

...