SimpleAjax

This class allows the client-side script execution of the code on the server side using Script Includes.

To use the SimpleAjax class, complete the following steps:

1. Call the SimpleAjax constructor to create a SimpleAjax instance. The script includes a name, which involves the class with the necessary methods, should be the argument for the constructor.

2. Call the addParam(paramName, paramValue) method.

3. When calling it, complete the following steps:

   1. provide sysparm_name as a parameter
   2. and the method name taken from the include part of the script called.

   To provide other parameters to the script code, call this method as many times as you need.

4. Сall the getXML(callback) method to execute the method declared above.

addParam(paramName, paramValue)

This method passes the specified parameter name and value to the server-side function associated with the current SimpleAjax object. The addParam() method can be used several times with different parameters and values.

Parameter(s):

Return:

Example:

const sAjax = new SimpleAjax('DurationCalculator'); // call script include
sAjax.addParam('sysparm_name', 'getDuration'); // call class method
sAjax.addParam('sysparm_start', s_form.getValue('start')); // pass parameter
sAjax.getXML(callback);

function callback(response) {
  const answer = response.responseXML.documentElement.getAttribute('answer');
  console.log(answer);
}

getXML(callback)

By calling this method, the client script sends a request to the server where the method and parameters related to the current SimpleAjax object are executed. The request is processed asynchronously. The results will be returned via the function specified as a callback. 

Return:

Example:

const sAjax = new SimpleAjax('DurationCalculator'); // call script include
sAjax.addParam('sysparm_name', 'getDuration'); // call class method
sAjax.addParam('sysparm_start', s_form.getValue('start')); // pass parameter
sAjax.getXML(callback);

function callback(response) {
  const answer = response.responseXML.documentElement.getAttribute('answer');
  console.log(answer);
}

runScript(scriptValue, tableName, callback)

Use this method to run a script against a table specified. The script is run with the ACL restrictions.

Parameter(s):

Return:

Example:

const CURRENT_ID = s_form.getUniqueValue();

const simpleAjax = new SimpleAjax();
await simpleAjax.runScript(
  `const current = new SimpleRecord('task');
  current.get('${CURRENT_ID}');
  setResult(current.caller.email)`,
  null,
  (response) => {
    console.log(response.data.result);
  }
)

runAdminScript(scriptValue, tableName, callback)

Use this method to run a script by a user with the administrator role. There are no ACL restrictions for the script. If a user, who does not have the administrator role, attempts to a run the script, the method returns an empty result. Therefore, before using the script result, verify that the response.data.result is not empty.

Parameter(s):

Return:

Example:

const simpleAjax = new SimpleAjax();
await simpleAjax.runAdminScript(
  `const supportSiteURL = ss.getProperty('simple.auth_page.support_site');
  setResult(supportSiteURL)`,
  null,
  (response) => {
    const serverData = response.data.result;
    console.log(serverData);
  }
)