Page History

This class allows provides methods that allow the client-side script execution of the code to be executed on the server side using Script Include Scripts.

To use the SimpleAjax class, complete the following steps:

1. Call the SimpleAjax constructor to create a SimpleAjax instance. An argument for the constructor should be the name of the script include that involves the class with the necessary methods.

2. Call the addParam(paramName, paramValue) method. Pass the required parameters defining the method needed as the main call. To do so, complete the following steps:

   1. set the sysparm_name parameter.
   2. and the method name taken from the defined class called by the script include script.

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

3. Call the getXML(callback) method to execute the method declared above.

addParam( paramName, paramValue)

This Use this method passes to pass 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)

Anchor
XML XML

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 is executed with the specified parameters. The request is processed asynchronously. The results of the server-side method execution will be passed to the specified callback function. 

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 runs with the ACL restrictions.

Parameters:

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. To do so, an administrator role is necessary. There are no ACL restrictions restrictions for the script. If a user , who that does not have the administrator role, attempts to a run the script, the method returns an empty result as callback. Therefore, before Before using the script result, verify that the response.data.result is not empty.

Parameters:

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);
  }
)