Page History

This scoped server class provides methods to methods to get information about the system, the current user, etc.

Many of the methods provide easy ways to include dates in the query ranges, commonly used in filters and reports.

This class has no constructor, the methods are accessible via the use the ss global object to access the methods.

ss.addInfoMessage(message, params)

This method displays an Use this method to display an informational toast message in the bottom lower right corner. Use this method to display a message according to  according to the current user locale. To do so, in the message parameter, enter the source_messagevalue in the message parameter. See Static Interface Localization value of a record from the app category. See Localization and Multi-Language Support to learn more.  The params parameter allows defining Use the params parameters to define values for the dynamic  dynamic parts of the translated message.

Parameter(s):

Return:

Example:

ss.addInfoMessage("Three days left");
// OR
ss.addInfoMessage("{count} {noun} left", {"count": "Three", "noun": "days"});

ss.addErrorMessage(message, params)

This Use this method displays to display an error toast message in the bottom lower right corner.Use this method to display a message according to  according to the current user locale. To do so, enter the in the message parameter, enter the source_messagevalue in the message parameter. See Static Interface Localization value of a record from the app category. See Localization and Multi-Language Support to learn more. The params parameter allows defining Use the params parameters to define values for the dynamic the dynamic parts of the translated message.

Parameter(s):

Return:

Example:

ss.addErrorMessage('"Name" cannot be blank');
// OR
ss.addErrorMessage('"{title}" cannot be blank', {title: "Name"});

ss.addSuccessMessage(message, params)

This method displays the Use this method to display a success toast message in the bottom lower right corner .Use this method to display a message according to the current user locale. To according to the current user locale. To do so, in the message parameter, enter the source_messagevalue in the message parameter. See Static Interface Localization value of a record from the app category. See Localization and Multi-Language Support to learn more. The params parameter allows defining values for the dynamic parts Use the params parameters to define values for the dynamic parts of the translated message.

Parameters:

Return:

Example:

ss.addSuccessMessage('Successfully updated');
// OR
ss.addSuccessMessage('Successfully {action_name}', {action_name: "updated"});

ss.info(message)

This Use this method to adds an information message into the system journal ( located in the Logs Main Log (sys_log)table).

Parameter(s):

Return:

Example:

const task = new SimpleRecord('task');
task.orderByDesc('sys_created_at');
task.setLimit(1);
task.selectAttributes('number');
task.query();
while(task.next()){
    ss.info(task.number);
}

ss.debug(message)

This Use this method adds to add a debug message into the system journal ( located in the Logs Main Log (sys_log)table).

Parameter(s):

Return:

Return:

Example:

const insertedID = inquiry.insert();
if (insertedID == 0) {
    ss.debug(inquiry.getErrors());
} else {
    ss.debug(`Create inquiry with ID ${insertedID}`)
}

ss.warning(message)

This Use this method adds to add a warning message into the system journal ( located in the Logs Main Log (sys_log)table).

Parameter(s):

Return:

Example:

const task = new SimpleRecord('task');
task.query();
while(task.next()){
  ss.warning(task.sys_id);
}

ss.error(message)

This method adds an error message into the system journal ( located in the Logs Main Log (sys_log)table) table.

Parameter(s):

Return:

Example:

(function executeRule(current, previous /*null when async*/ ) {
    const nowDateTime = new SimpleDateTime();
    const targetDateTime = new SimpleDateTime(current.appropriate_datetime);
    const secondsLeft = targetDateTime.getNumericValue() - nowDateTime.getNumericValue();
    if (secondsLeft < 1800) { // less than half an hour left
        ss.addErrorMessage('Appropriate Datetime cannot be less than half an hour');
        ss.error(`Too Urgent Request: ${secondsLeft} to process`); 
        current.setAbortAction(true);
    }
})(current, previous);

ss.eventQueue(name, current, param_1, param_2, param_3, param_4, param_5)

This Use this method queues to queue an event , basing based on the its name and optional parameters. 

The name argument name should be equal to the the same as the record name in the Event Registers (sys_event_register name) table.

A The table of the passed current object should be equal to the systhe same as the table specified in the record of the Event Register (sys_event_register) table or the table extended from it.

Parameter(s):

Return:

Example:

if (current.state != '10') { // Not Closed
    ss.eventQueue('incident.close', current, ss.getUserID());
}

ss.eventQueueScheduled(name, current, process_started_at, param_1, param_2, param_3, param_4, param_5)

This Use this method queues to queue an event with a specific start and run it at a specified time. 

The name argument name should be equal to the same as the record name in the Event Registers (sys_event_register name) table.

A The table of the passed current object should be equal to the same as the table specified in the record of the Event Register (sys_event_register) table.

Parameter(s):

Return:

Example:

if (current.state != '10') { // Not Closed
    const plusThreeDays = new SimpleDateTime(); // now
    plusThreeDays.addDays(3); // + 3 days
    ss.eventQueueScheduled('incident.autoclose', current, plusThreeDays, ss.getUserID());
}

ss.generateResetToken()

This Use this method to generates a token, for example, when the password resetting has been requested.

Return:

Example:

const resetToken = ss.generateResetToken();
ss.info(resetToken);
//Info: l_kxwLi-TsTwmgLYk3euOCeXeA14nE2U_1610699284

ss.generateUrlAction(

const simpleInstanceUri = ss.getProperty('simple.instance.uri');
const instanceUrl = simpleInstanceUri.startsWith('https://') ? simpleInstanceUri : 'https://' + simpleInstanceUri;


const аctionScript = `
    const task = new SimpleRecord('task');
    task.get('${current.sys_id}');
    if (task.state == '7') { // Completed
        task.state = '10'; // Closed
        task.update();
    }
    message = null;
    redirectUrl = instanceUrl + '/record/task/' + current.sys_id
`;
const nowDateTime = new SimpleDateTime();
nowDateTime.addDays(3);
const url = ss.generateUrlAction(current.getValue('caller'), аctionScript, nowDateTime.getValue());
ss.info(url);
//Info: your-instance-uri.simpleone.ru/url-action/run?key=Q2GqNFRXCRY2

const appId = ss.getApplicationId();
ss.info(appId);
//Info: 155931135900000002

ss.info(ss.getProperty('simple.passwordreset.enabled'));
//Info: false

ss.setProperty('user.timezone.default', 'Europe/Moscow', 'Define the default user time zone');

const session = ss.getSession();
const ipAddress = session.getClientIP();
ss.info(ipAddress);
//Info: 127.0.0.1

ss.info(ss.getUser().username);
//Info: admin

const approval = new SimpleRecord('sys_approval');
approval.addQuery('approver_id', ss.getUserID());
approval.addQuery('state', 'requested');
approval.selectAttributes('sys_id');
approval.query();
if (approval.getRowCount() > 0) {
  //...
}

const docID = ss.getDocIdByIds(current.sys_db_table_id, current.sys_id);
const approval = new SimpleRecord('sys_approval');
approval.addQuery('item', docID);
approval.query();

const tableID = ss.getTableIdByDocId(current.item);
const table = new SimpleRecord('sys_db_table');
table.get(tableID);
const record = new SimpleRecord(table.name);
const recordID = ss.getRecordIdByDocId(current.item);
record.get(recordID);
ss.addInfoMessage(record.sys_created_at);
//Info: 2020-05-24 16:30:21

const tableID = ss.getTableIdByDocId(current.item);
const table = new SimpleRecord('sys_db_table');
table.get(tableID);
const record = new SimpleRecord(table.name);
const recordID = ss.getRecordIdByDocId(current.item);
record.get(recordID);
ss.addInfoMessage(record.sys_created_at);

const isUserManager = ss.hasRole('process_manager'); // true or false
return isUserManager;

const MANAGER_ROLE = 'process_manager';
const userHasRole = new SimpleRecord('sys_user_has_role');
userHasRole.addQuery('user_id', ss.getUserId());
userHasRole.addQuery('role_id.name', MANAGER_ROLE);
userHasRole.setLimit(1);
userHasRole.selectAttributes(['sys_id']);
userHasRole.query();
const isManager = !!userHasRole.next();
return isManager

.next();
return isManager

ss.importIncludeScript('calculateCAB');
const approvers = [];
if (!!current.customized_cab) {
    approvers = approvers.concat(current.customized_cab.split(','));
}
if (!current.ignore_automatically_generated_cab) {
    const includeScriptResult = calculateCAB(current);
    approvers = approvers.concat(includeScriptResult);
}

ss.setRedirect(`/list/${current.getTableName()}`);
// Redirect to the list view of the current table

ss.setRedirect('/record/task');
// Redirect to the default view of the Task table