Page History

This server class provides methods to operate database records.

SimpleRecord(tableName)

This method instantiates a SimpleRecord class object for a particular table.

Parameter(s):

Example:

const taskRecord = new SimpleRecord('task');

REM attribute object

The SimpleRecord class has a special object for Record Extended Models – rem_attr – containing information about the REM attributes. It is used to read and define REM attributes of the current record with other class methods as in the example below.

Parameter:

Return:

Example:

const record = new SimpleRecord('task');
record.get('160638931615274614'); // Example record ID supposing to be extended with RE attributes 
// record.rem_attr - an object containing information about RE attributes
ss.info(record.rem_attr.description); // Here, we have called the RE attribute as a property

addOrCondition(property, operator, value)

This method appends a 2-or-3 parameter OR condition to an existing query. It works in conjunction with any of the addQuery() methods. In this method, you can use any preferred operator from the Condition Operators list, specified either in lowercase or in uppercase. Please notice that you need to use system name of the operator in your scripts.

Parameter(s):

Return:

Example:

const record = new SimpleRecord('task');
record.addQuery('subject', 'like', 'not work')
record.addOrCondition('description', 'like', 'not work');
ss.info('Condition query: ' + record.getConditionQuery());
// Info: Condition query: (subjectLIKEnot work)^OR(descriptionLIKEnot work)

addQuery(property, operator, value)

This method adds a condition to make a selection of records from the database. In this method, you can use any preferred operator from the Condition Operators list, specified either in lowercase or in uppercase. Please notice that you need to use system name of the operator in your scripts.

Parameter(s):

Return:

Example:

const task = new SimpleRecord('task');
task.addQuery('active', true);
task.addQuery('subject', 'like', 'email');
task.addQuery('sys_created_at', '<', '2019-04-01 00:00:00');
task.query();
ss.info('Count: ' + task.getRowCount());
// Info: Count: 0

addEncodedQuery(condition)

This method adds encoded query and applies it to the current query method.

Parameter(s):

Return:

Example:

const employee = new SimpleRecord('employee');
employee.addEncodedQuery('%28locked_out%3D0%29%5EmanagerISEMPTY');
ss.info('Decoded condition: ' + employee.getConditionQuery());
// Info: Decoded condition: ((locked_out=0)^managerISEMPTY)

canCreate()

This method checks whether inserting new records in this table satisfies the Access Control Rule (ACL).

Also, you can use this method in your UI Actions to adjust its visibility more precisely.

Return:

Example:

current.canCreate();

canDelete()

This method checks whether deleting records in this table satisfies the Access Control Rule (ACL).

Also, you can use this method in your UI Actions to adjust its visibility more precisely.

Return:

Example:

current.canDelete();

canRead()

This method checks whether reading records in this table satisfies the Access Control Rule (ACL).

Also, you can use this method in your UI Actions to adjust its visibility more precisely.

Return:

Example:

current.canRead();

canUpdate()

This method checks whether updating records in this table satisfies the Access Control Rule (ACL).

Also, you can use this method in your UI Actions to adjust its visibility more precisely.

Return:

Example:

current.canUpdate();

deleteMultiple()

This method allows deleting multiple records in a query selection. Please note that attachments cannot be deleted using this method.

Return:

Example:

const record = new SimpleRecord('sys_activity_feed_item');
record.addQuery('content', 'isempty');
record.setLimit(1);
record.query();
ss.info(record.getRowCount());
ss.info(record.deleteMultiple());
// Info: 0
// Info: true

deleteRecord()

This method deletes the current record.

Return:

Example:

const task = new SimpleRecord('task');
task.get('155931135900000000');
const isDeleted = task.deleteRecord();
if (isDeleted) {
    ss.info('Task with ID ' + task.sys_id + ' was deleted!');
} else {
    ss.error('Errors: ' + task.getErrors());
}

get(propertyOrValue, value)

This method loads an object from a database by the field value, or, in a specific case, by the sys_id.

Parameter(s):

Return:

Example:

const current = new SimpleRecord('task');
current.get('163663310116371174');

if (current.sys_id) {
    const company = new SimpleRecord('org_company');
    company.get('c_website', current.c_customer_url);
    ss.eventQueue('notify.responsible', current, company.responsible.email);
}

getAttributes()

This method returns an object with current record properties as keys and properties values as key values.

Return:

const recorduserRecord = new SimpleRecord('task'ss.getUser();
record.get('160638931615274614'); ss.info(userRecord.getAttributes());
// Example record ID supposing to be extended with RE attributes 
// record.rem_attr - an object containing information about RE attributes
ss.info(record.rem_attr.description); // In there, we have called the RE attribute as a property

getAttributes()

Info: {"sys_id":"155931135900000001","sys_created_at":"2019-09-30 00:00:00","sys_updated_at":"2021-06-28...

getClassDisplayValue()

This method returns the table title. If the title is not set, then returns name.

Return:

Example:

const userRecordcurrent = ss.getUser( new SimpleRecord('task');
current.get('163663310116371174');
ss.info(userRecordcurrent.getAttributesgetClassDisplayValue());
// Info: {"sys_id":"155931135900000001","sys_created_at":"2019-09-30 00:00:00","sys_updated_at":"2021-06-28...

getClassDisplayValue()

This method returns the table title. If the title is not set, then returns name.

Return:

Task

getConditionQuery()

This method returns current query condition.

Return:

Example:

const currenttask = new SimpleRecord('task');
current.get('163663310116371174const condition = task.addQuery('state', '7');
condition.addOrCondition('priority', '<', '3');
ss.info(current.getClassDisplayValue());
// Info: Task

getConditionQuery()

This method returns current query condition.

Return:

'Condition before query: ' + task.getConditionQuery());
task.query();
ss.info('Condition after query: ' + task.getConditionQuery());
// Info: Condition before query: (state=7)^OR(priority<3)
// Info: Condition after query:

getDisplayValue(property) 

Anchor
getDisplayValue() getDisplayValue()

This method returns the value of display_by_ref field or record value. For example, for the reference field the entity name will be returned, but not the ID.

Parameter(s):

Return:

Example:

const current = new SimpleRecord('task');
current.get('163663310116371174'

Example:

const task = new SimpleRecord('task');
const condition = task.addQuery('state', '7');
condition.addOrCondition('priority', '<', '3');
ss.info('Condition before query: ' + task.getConditionQuery());
task.query();
ss.info('Condition after query: ' + task.getConditionQuery(current.getDisplayValue('caller'));
ss.info(current.getValue('caller'));
// Info: Condition before query: (state=7)^OR(priority<3)John Doe
// Info: Condition after query:

getDisplayValue(property)

This method returns the displayed field value (the display_by_ref field) or record value. For example, for the reference field the entity name will be returned, but not the ID.

Parameter(s):

Return:

155931135900000001

getErrors() 

Anchor
getErrors() getErrors()

If the record creating, updating or deleting fails, then this method will display an error message.

Use this method for control purposes if there any validation errors within your scripts.

Return:

Example:

Example:

const currentrecord = new SimpleRecord('taskuser');
current.get('163663310116371174'const insertedRecordId = record.insert();
ss.info(current.getDisplayValue('caller'));
if (insertedRecordId == 0) {
  ss.info(currentrecord.getValuegetErrors('caller'));
}
// Info: John Doe
// Info: 155931135900000001

 ["The \"\"First Name\" [first_name]\" field is mandatory. (record id: )",...

getLabel(property) 

Anchor

getLabel()

getLabel()

If the record creating, updating or deleting fails, then this method will display error message.

Use this method for control purposes if there any validation errors within your scripts.

This method gets the field title.

Parameter(s):

Some validation errors may not be displayed within the debug process, so it is highly recommended to use this method.

Return:

Example:

const recordcurrent = new SimpleRecord('user'ss.getUser();
const insertedRecordIdfieldLabel = recordcurrent.insertgetLabel('username');
if (insertedRecordId == 0) {
  ss.info(record.getErrors());
}
// Info: ["The \"\"First Name\" [first_name]\" field is mandatory. (record id: )",...

getLabel(property)

This method gets the field title.

Parameter(s):

ss.addErrorMessage('Field "' +  fieldLabel + '" cannot be blank');
// Field "Login" cannot be blank

getReModelId()

This method retrieves the ID of the RE model related to the current record. To set a new model ID use the setReModelId method.

Return:

Return:

Example:

const(function executeRule(current, previous = ss.getUser();
const fieldLabel = current.getLabel('username');
ss.addErrorMessage('Field "' +  fieldLabel + '" cannot be blank');
// Field "Login" cannot be blank

getRowCount()

 null /*not null only when action is update*/) {
    if (current.getReModelId()) {
        const model = new SimpleRecord('sys_rmc_model');
        model.get(current.getReModelId()); // current model
        current.$$service = model.getValue('cmdb_service_id'); // pass service if field exists
    }
})(current, previous);

getRowCount()

This This method gets the amount of items in a row.

Returns:

Example:

const task = new SimpleRecord('task');
task.query();
ss.addInfoMessage('All Tasks Count: ' + task.getRowCount());
// All Tasks Count: 2

getTableName()

This method gets the current table name.

Return:

Example:

const current = ss.getUser();
ss.info('/list/' + current.getTableName() + '/' + current.sys_id);
// Info: /list/user/155931135900000001

getTitle(attribute) 

Anchor
getTitle() getTitle()

This method returns the

title of the

defined RE attribute.

Parameter:

Return:

Example:

If the field is of the Reference or List types, then its sys_id value returns.

Parameter(s):

Return:

const current = ss.getUser();
const user = new SimpleRecord('usertask');
usercurrent.addQueryget('timezone_id', current.getValue('timezone_id'));
user.query();
ss.info('Same timezone for: ' + user.getRowCount() + ' users');
163638951512716126');
if (current.sys_id) {
    ss.info(current.rem_attr.getTitle('reviewed'));
}
// Info: Same timezone for: 36 users

hasAttachment()

This method checks whether the record specified has an attachment or not.

Return:

Review completed

getValue(property) 

Anchor
getValue() getValue()

This method returns the value of the object property based on its name.

If the field is of the Reference or List types, then its sys_id value returns.

Parameter(s):

Return:

const current = ss.getUser();
const user 

Example:

const current = new SimpleRecord('taskuser');
user.addQuery('timezone_id', current.getgetValue('163663310116371174timezone_id'));
const hasAttach = current.hasAttachmentuser.query();
if (!hasAttach) {
  ss.addErrorMessage('File should be attachedss.info('Same timezone for: ' + user.getRowCount() + ' users');
//  return;
}
current.state = '2'; // Open
current.update();

initialize()

This method populates all active empty fields with their predefined default values.

It works only for new records that were never saved and cannot be called repeatedly.

This method is called automatically and implicitly at the first set operation (also known as "the setter").

Info: Same timezone for: 36 users

hasAttachment()

This method checks whether the record specified has an attachment or not.

ReturnReturn:

Example:

const taskRecordcurrent = new SimpleRecord('task');
sscurrent.info(taskRecord.getAttributes().caller);
taskRecord.initialize();
ss.info(taskRecord.getAttributes().caller);
// Info: 
// Info: 155931135900000001

insert()

This method uses the field values of the current record to insert a new one.

get('163663310116371174');
const hasAttach = current.hasAttachment();
if (!hasAttach) {
  ss.addErrorMessage('File should be attached');
  return;
}
current.state = '2'; // Open
current.update();

initialize()

This method populates all active empty fields with their predefined default values.

It works only for new records that were never saved and cannot be called repeatedly.

This method is called automatically and implicitly at the first set operation (also known as "the setter")If the record is not inserted then method returns '0' (zero) and adds an informative error message which can be obtained with getErrors() method.

Return:

Example:

const newTasktaskRecord = new SimpleRecord('task');
newTask.subject = 'Subtask';
const inserterTaskID = newTask.insertss.info(taskRecord.getAttributes().caller);
taskRecord.initialize();
ss.info(`/record/task/${inserterTaskID}`(taskRecord.getAttributes().caller);
// Info: 
/record/task/163675231910113745

/ Info: 155931135900000001

insert()

This method checks whether the VCS enabled attribute is enabled against the specified table or not. uses the field values of the current record to insert a new one.

If the record is not inserted then method returns '0' (zero) and adds an informative error message which can be obtained with getErrors() method.

Return:

Example:

const tablenewTask = new SimpleRecord('sys_db_table'task');
newTask.subject = 'Subtask';
const inserterTaskID = newTask.insert();
ss.info(table.isTableVcsEnabled())`/record/task/${inserterTaskID}`);
// Info: true

/record/task/163675231910113745

isTableVcsEnabled()

This method checks whether the current record meets the condition in the current state.

VCS enabled attribute is enabled against the specified table or not. 

Return:

Example:

const tasktable = new SimpleRecord('tasksys_db_table');
task.description = 'emaio';
ss.info(tasktable.matchesConditionisTableVcsEnabled('descriptionLIKEemail')); 
// false
task.description = 'email';
ss.info(task.matchesCondition('descriptionLIKEemail')); // true

Info: true

matchesCondition(condition)

This method returns checks whether the next current record in the query. If this is the first call, this method returns the first record in query. If the query is empty, this method returns 'false'.

Return:

meets the condition in the current state.

Return:

Example:

const usertask = new SimpleRecord('usertask');
user.setLimit(1);
user.query();
user.next();
ss.info(user.sys_id);
// Info: 100000000000000000

task.description = 'emaio';
ss.info(task.matchesCondition('descriptionLIKEemail')); // false
task.description = 'email';
ss.info(task.matchesCondition('descriptionLIKEemail')); // true

next()

This method returns the next record in the query. If this is the first call, this method returns the first record in query. If the query is empty, this method returns 'false'.

Return:

Example:

const 

user = new SimpleRecord('

user');

user.setLimit(1);

user.query();

user.next();
ss.info(

user.

sys_id);
// 

Info: 

orderBy(column)

100000000000000000

const task = new SimpleRecord('task');
task.setLimit(1);
task.query();
// task.next();
ss.info(task.number);
// Error: Current record is not set.

orderBy(column)

This method sorts This method sorts records in the ascending order.

Parameter(s):

Return:

Example:

const firstLog = new SimpleRecord('sys_log');
firstLog.orderBy('sys_created_at'); // oldest record first
firstLog.addQuery('message', 'like', 'Connection');
firstLog.setLimit(1);
firstLog.selectAttributes(['message', 'sys_created_at']);
firstLog.query();
firstLog.next();
ss.info(firstLog.sys_created_at + ' - ' + firstLog.message);
// Info: 2021-06-03 06:34:02 - IMAP IMAP (Default): Connection error: ...

orderByDesc(column)

This method sorts the records in the descending order.

Parameter(s):

Return:

Example:

const lastComment = new SimpleRecord('sys_activities_stream_field');
lastComment.orderByDesc('sys_created_at'); // newest record first
lastComment.setLimit(1);
lastComment.selectAttributes(['value', 'sys_created_by']);
lastComment.query();
lastComment.next();
ss.info(lastComment.sys_created_by.display_name + ': ' + lastComment.value);
// Info: John Doe: test

query()

lastComment.value);
// Info: John Doe: test

query()

This method applies query to the database selection. After this, it fills in the record set.

Return:

Example:

const tasks = new SimpleRecord('task');
tasks.addQuery('sys_created_at', '>', '2020-01-01');
tasks.orderBy('sys_created_at');
tasks.setLimit(5);
tasks.query();
while(tasks.next()){
ss.info('Tasks numbers: ' +  tasks.number);
}
// RQTSK0000001, CHG0000004, CHG0000006, CHG0000007, CHG0000008

selectAttributes(attributes)

This method is intended to optimize database queries. Sometimes, it is necessary to obtain only several object fields, not the whole object. Therefore, this method was added.

Return:

Example:

const tasks = new SimpleRecord('task');
tasks.addQuery('sys_created_at', '>', '2020-01-01const record = new SimpleRecord('user');
tasksrecord.orderByselectAttributes('sys_created_atemail');
tasks.setLimit(5);
tasksrecord.query();
while(tasksrecord.next()){;
ss.info('Tasks numbers: ' +  tasks.number);
}record.getAttributes());
// RQTSK0000001, CHG0000004, CHG0000006, CHG0000007, CHG0000008

selectAttributes(attributes)

This method is intended to optimize database queries. Sometimes, it is necessary to obtain only several object fields, not the whole object. Therefore, this method was added.

Do not use this method to select records that could be updated or deleted after selecting. Otherwise, some of the record field values may be lost when these records are updated or deleted. Or the action performed may throw an exception looking like this (the example text is given below):

Info: {"email":"john.doe@email.com","sys_id":"162423321917274937"}

Example:

const record = new SimpleRecord('user');
record.selectAttributes(['email', 'username']);
record.query();
record.next();
ss.info(record.getAttributes());
// Info: {"email":"john.doe@email.com","username":"john.doe","sys_id":"162423321917274937"}

setAbortAction(flag)

This method is used in business rules and sets a flag, indicating that the current operation (insert/update/delete) will be interrupted.

Parameter(s):

Return:

Return:

This method returns a SimpleRecord object containing attributes and values.

Example:

Example:

const recordcurrent = new SimpleRecord('usertask');
recordcurrent.selectAttributesget(['email', 'username']163663310116371174');
record.query();
record.next();
ss.info(record.getAttributes());
// Info: {"email":"john.doe@email.com","username":"john.doe","sys_id":"162423321917274937"}

setAbortAction(flag)

This method is used in business rules and sets a flag, indicating that the current operation (insert/update/delete) will be interrupted.

const hasAttach = current.hasAttachment();
current.setAbortAction(!hasAttach); // same as return;
current.state = '2'; // Open
current.update();

setLimit(maxNumRecords)

This method limits the number of records selected by SimpleRecord query methods.

Parameter(s):

Return:

Example:

const currentrecord = new SimpleRecord('taskuser');
current.get('163663310116371174');
const hasAttach = current.hasAttachment();
current.setAbortAction(!hasAttach); // same as return;
current.state = '2'; // Open
current.update();

setLimit(maxNumRecords)

record.setLimit(3);
record.query();
ss.info(record.getRowCount());
// Info: 3

setMultipleValue(property,value)

This method sets the properties values for every entry in the current selectionThis method limits the number of records selected by SimpleRecord query methods.

Parameter(s):

Return:

const recordtask = new SimpleRecord('usertask');
recordtask.setLimit(3);
recordaddQuery('state', '7'); // Draft
task.query();
ss.info(recordtask.getRowCount());
task.setMultipleValue('state', '2'); // Info: 3

setMultipleValue(property,value)

Open
// task.updateMultiple();

setReModelId(reModelId) 

Anchor
setremodelid setremodelid

This method sets the ID of the defined RE model. To get the model ID, use the getReModelId methodThis method sets the properties values for every entry in the current selection.

Parameter(s):

If the reModelId parameter is equal to 'null', the REM, related to the record, will be detached. 

Return:

Example:

const task = new SimpleRecord('task');
task.addQueryget('state155931135900000000', '7'); // Draft
task.querysetReModelId('158569205818704980');
ss.info(task.getRowCountupdate());
task.setMultipleValue('state', '2'); // Open
// task.updateMultiple();setReModelId(null);
task.update();

setValue(property, value) 

Anchor
setValue() setValue()

This method sets the value of the field in the current record.

Parameter(s):

Return:

Example:

const task = new SimpleRecord('task');
task.setValue('subject', 'mail');
task.insert();

silentMode(enable)

This method is intended to update the record without executing any entities related to this record implementing the business logic, such as business rules, notifications, workflows, etc.

const task = new SimpleRecord('task');
task.addQuery('active', false);
task.addQuery('approval_state', 'isempty');
task.query();
ss.info(task.getRowCount());
task.silentMode();
task.setMultipleValue('approval_state', 'not_requested'); // set Default Value
//task.updateMultiple();

update()

This method updates a database record.

Return:

Example:

const current = new SimpleRecord('task');
current.get('undefined');
current.subject = 'Test';
const updatedRecordID = ss.info(current.update();
ss.info(updatedRecordID);
ss.info(current.getErrors());
// Info: 0
// Info: ["Invalid condition query: Use only digits","Unable to update new record. Use `insert()` instead. (record id: )"]

updateMultiple()

This method updates all the selection entries.

Return:

const task = new SimpleRecord('task');
task.addQuery('state', '0'); // Open
task.query();
ss.info(task.getRowCount());
task.setMultipleValue('state', '10'); // Canceled
// task.updateMultiple();