Versions Compared

Key

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

This server class provides methods to operate database records.

SimpleRecord(tableName)


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


Parameter(s):

NameTypeMandatoryDefault Value
tableNameStringYN

Example:

Code Block
languagejs
themeEclipse
titleSimpleRecord
linenumberstrue
const tasktaskRecord = new SimpleRecord('task');
task.get('162494866118348768');

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.


REM attribute object


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

Tip

rem_attr has a number of methods equal to methods of the SimpleRecord: 

For example:

record.rem_attr.getValue('my_rem_attribute');

ParameterParameter(s):

NameTypeMandatoryDefault Value
propertyStringYN
operatorString (refer to the Condition Operators article for more information)NNvalueInteger or String or Boolean or ArrayYN

Return:

TypeDescription
SimpleRecord
The query containing OR condition added to
objectThis method returns the SimpleRecord object from the defined RE model.
The method returns null if the record does not have a RE model.

Example:

Code Block
languagejs
themeEclipse
titleaddOrConditionget using REM
linenumberstrue
const taskrecord = new SimpleRecord('task');
taskrecord.addQueryget('subject', 'like', 'not work')
  .addOrCondition('description', 'like', 'not work');
task.query();
160638931615274614');
if (record.getReModelId()) {
    ss.info(task.getRowCount());
task.setMultipleValue('attention_required', true);
// task.updateMultiple();
addQuery
record.rem_attr.description);
}

addOrCondition(property, operator, value)


This method adds a condition to make a selection of records from the database. 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 the Condition Operators list, specified either in lowercase or in uppercase. Please notice Notice that you need to use the system name of the operator in your scripts.

Parameter(s):

NameTypeMandatoryDefault ValuepropertyStringYNoperatorString (refer to the Condition Operators article for more information)NNvalueInteger or String or Boolean or ArrayYN

Return:

TypeDescriptionSimpleRecordThe query condition added to the SimpleRecord object.

You can also specify a RE model attribute of a specific table. To filter records, use the operators corresponding to the attribute type.

Note

The condition may contain criteria based on the attribute of different RE models. If such criteria are built using the AND operator, the selection of records will be empty. To return records that match a condition, use the OR operator.


Parameter(s):

NameTypeMandatoryDefault Value
propertyStringY

N

Info

For the REM attributes use the following pattern:

'<sys_id>:<attr_name>' 

where sys_id – the ID of the model that contain the attribute, and attr_name – the system name of the REM attribute.


operatorString (refer to the Condition Operators article for more information)NN
valueInteger, String, Boolean, Array or SimpleRecord objectYN


Return:

TypeDescription
SimpleRecordThe query containing OR condition added to the SimpleRecord object.


Examples:

Code Block
languagejs
themeEclipse
titleaddOrCondition
linenumberstrue
const record = new SimpleRecord('task');
record.addQuery('subject', 'like', 'not work')
record.addOrCondition('description', 'like', 'not work'

Example:

Code Block
languagejs
themeEclipse
titleaddQuery
linenumberstrue
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('CountCondition query: ' + taskrecord.getRowCountgetConditionQuery());

addEncodedQuery(condition)

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

Parameter(s)

NameTypeMandatoryDefault ValueconditionStringYN

Return:

TypeDescriptionVoidThis method does not return a value.

record.query();
// Info: Condition query: (subjectLIKEnot work)^OR(descriptionLIKEnot work)


Code Block
languagejs
themeEclipse
titleaddOrCondition with REM attribute

Example:

Code Block
languagejs
themeEclipse
titleaddEncodedQuery
linenumberstrue
constlet employeerecord = new SimpleRecord('employeetask');
employeerecord.addEncodedQueryaddQuery('%28locked_out%21%3D0%29%5EmanagerISEMPTY'subject', 'like', 'not work');
employee.query();
employee.setMultipleValue('locked_out', false);
// employee.updateMultiple();

canCreate()

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

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

Return:

TypeDescriptionBooleanThe method returns TRUE if this operation is permitted; otherwise it returns FALSE.
record.addOrCondition('166972638116358001:description', 'contains', 'not work');
ss.info('Condition query: ' + record.getConditionQuery());
record.query();
// Info: Condition query: (subjectLIKEnot work)^OR(166972638116358001:descriptionLIKEnot work)


Info

It is possible to pass the SimpleRecord object as current.{reference_field_name} instead of the record ID as the addOrCondition() method value. The script example

ExamplecanCreate

:

Code Block
languagejs
themeEclipse
title
Passing SimpleRecord as an argument
linenumberstrue
current.canCreate();

canDelete()

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

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

Return:

TypeDescriptionBooleanThe method returns TRUE if this operation is permitted; otherwise it returns FALSE.

Example:

Code Block
languagejs
themeEclipse
titlecanDelete
linenumberstrue
current.canDelete();

canRead()

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

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

Return:

TypeDescriptionBooleanThe method returns TRUE if this operation is permitted; otherwise it returns FALSE.

Example:

Code Block
languagejs
themeEclipse
titlecanRead
linenumberstrue
current.canRead();

canUpdate()

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

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

Return:

TypeDescriptionBooleanThe method returns TRUE if this operation is permitted; otherwise it returns FALSE.

Example:

Code Block
languagejs
themeEclipse
titlecanUpdate
linenumberstrue
current.canUpdate();

deleteMultiple()

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

Note

Do not use this method on tables with dependencies. Always delete each record individually.

Return:

TypeDescriptionBooleanThis method returns TRUE  if deleted successfully; otherwise returns false.
collapsetrue
const task = new SimpleRecord('task');
task.setLimit(1);
task.query();
if (!task.next()) {
  ss.info('No tasks found!');
  return;
}

const relatedTask = new SimpleRecord('task');
relatedTask.addQuery('caller', task.caller);
relatedTask.addOrCondition('assigned_user', task.caller);
relatedTask.query();
ss.info('Tasks count: ' + relatedTask.getRowCount());
// Info: Tasks count: 122



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. Note that you need to use system name of the operator in your scripts.

You can also specify a RE model attribute of a specific table. To filter records, use the operators corresponding to the attribute type. 

Note

The condition may contain criteria based on the attribute of different RE models. If such criteria are built using the AND operator, the selection of records will be empty. To return records that match a condition, use the OR operator.

Parameter(s):

NameTypeMandatoryDefault Value
propertyStringY

N

Info

For the REM attributes use the following pattern:

'<sys_id>:<attr_name>'

where sys_id – the ID of the model that contain the attribute, and attr_name – the system name of the REM attribute.


operatorString (refer to the Condition Operators article for more information)NN
valueInteger or String or Boolean or Array or SimpleRecord objectYN


Return:

TypeDescription
SimpleRecordThe query condition added to the SimpleRecord object.


Examples:

Code Block
languagejs
themeEclipse
titleaddQuery
linenumberstrue
const task = new SimpleRecord('task');
task.addQuery('active', true);
task.addQuery('subject

Example:

Code Block
languagejs
themeEclipse
titledeleteMultiple
linenumberstrue
const record = new SimpleRecord('sys_translation');
record.addQuery('value', 'like', 'networkemail');
recordtask.query();
addQuery('sys_created_at', '<', '2019-04-01 00:00:00');
task.query();
ss.info(record'Count: ' + task.getRowCount());
// record.deleteMultiple();

deleteRecord()

This method deletes the current record.

Return:

TypeDescriptionBooleanThis method returns TRUE if the record is deleted successfully; otherwise it returns FALSE.
 Info: Count: 0


Code Block
languagejs
themeEclipse
titleaddQuery with REM attribute
linenumberstrue
let record

Example:

Code Block
languagejs
themeEclipse
titledeleteRecord
linenumberstrue
const incident = new SimpleRecord('itsm_incidenttask');
incidentrecord.get('155931135900000000addQuery('166972638116358001:description', 'not work');
if (incident.sys_id) {
  const wasDeleted = incident.deleteRecord();
  if (wasDeleted) {
    ss.info('Incident ' + incident.sys_id + ' was deletedrecord.query();
ss.info("Total rows: " + record.getRowCount());
// Info: Total rows: 1


Info

It is possible to pass the SimpleRecord object as current.{reference_field_name} instead of the record ID as the method addQuery() value. The script example:

Code Block
languagejs
themeEclipse
titlePassing SimpleRecord as an argument
linenumberstrue
collapsetrue
const task = new SimpleRecord('task');
task.setLimit(1);
task.query();
if (!task.next()) {
  ss.info('No tasks found!');
  return;
}

const 
else
otherTask 
{
= 
   ss.error('Errors: ' + incident.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):

NameTypeMandatoryDefault ValuepropertyOrValue

String value of record ID or property name. If it is equal to the property name, then the second parameter 'value' is mandatory.

Note

Passing 'NULL' or an empty string as the propertyOrValue parameter value will cause an exception looking alike:

"Argument 1 passed to "get()" must not be empty".

YN
new SimpleRecord('task');
otherTask.addQuery('caller', task.caller);
otherTask.addQuery('sys_id', '!=', task.sys_id);
otherTask.query();
ss.info('Tasks count: ' + otherTask.getRowCount());
// Info: Tasks count: 720



addEncodedQuery(condition)


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

Info

Decoded query is also applicable.

You can also specify a RE model attribute of a specific table. To filter records, use the operators corresponding to the attribute type. 

Note

The condition may contain criteria based on the attribute of different RE models. If such criteria are built using the AND operator, the selection of records will be empty. To return records that match a condition, use the OR operator.

Use curly brackets when setting a filter argument for the text fields of type String, Text, Translated Text, Conditions, and URL. Using parenthesis for the argument may cause a filter query error.

Code Block
languagejava
valueStringNNULL

Return:

TypeDescriptionSimpleRecord objectThis method returns the SimpleRecord object from the table specified in the query.

Example:

Code Block
languagejs
themeEclipse
titlegetFilter with text fields
linenumberstrue
collapsetrue
const service subject = 'Hello, SimpleOne)';
const task = new SimpleRecord('c_servicetask');
servicetask.get(current.getValue('service'));
if (!!service.sys_id)addEncodedQuery(`subjectLIKE${subject}`);
ss.info(task.getConditionQuery());
try {
  const company = new SimpleRecord('org_company');
  company.get('link', service.customer_url);
  ss.eventQueue('notify.responsible', current, company.responsible.email);
}
Code Block
languagejs
themeEclipse
titleget using REM
linenumberstrue
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); // In there, we have called the RE attribute as a property

getAttributes()

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

Return:

TypeDescriptionObjectThe array containing attributes.
 task.query();
} catch (e) {
   ss.error(e.message);
} 
// Info: (subjectLIKEHello, SimpleOne))
// Error: Condition query is invalid

Parameter(s):

NameTypeMandatoryDefault Value
conditionString Y

N

Info

For the REM attributes use the following pattern:

'<sys_id>%3A<attr_name>'

where sys_id – the ID of the model that contain the attribute, and attr_name – the system name of the REM attribute.



Return:

TypeDescription
VoidThis method does not return a value.


Examples:

Code Block
languagejs
themeEclipse
titleaddEncodedQuery
linenumberstrue
const currentUser = ss.getUser();
const receiver = new SimpleRecord('employee');
receiver.addQuery('active', true);
if (currentUser.company.class === 'internal') {
    receiver.addEncodedQuery(`(company=${currentUser.getValue('company')})`);
} else {
    receiver.addEncodedQuery(`%28sys_db_table_id%3D158645243815904649%5Esys_created_byDYNAMIC156957117519820256%29`);
}
ss.info('Decoded condition: ' + receiver.getConditionQuery());
receiver.query();
// Info: Decoded condition: (active=1)^((sys_db_table_id=158645243815904649^sys_created_byDYNAMIC156957117519820256))


Code Block
languagejs
themeEclipse
titlegetAttributesaddEncodedQuery with REM attributes
linenumberstrue
const userRecordreceier = ss.getUser( new SimpleRecord('task');
receiver.addQuery('active', true);
receiver.addEncodedQuery('%28sys_db_table_id%3D158645243815904649%5E166972638116358001%3AdescriptionLIKEwork`);
ss.info(userRecord.getAttributes()'Decoded condition: ' + receiver.getConditionQuery());
receiver.query();
// Info: {"sys_id":"155931135900000001","sys_created_at":"2019-09-30 00:00:00","sys_updated_at":"2021-06-28...
getClassDisplayValue
Decoded condition: (active=1)^((sys_db_table_id=158645243815904649^166972638116358001:descriptionLIKEwork))

canCreate()


This method returns the table title. If the title is not set, then returns name.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.


ReturnReturn:

TypeDescription
StringTitle or name
BooleanThe method returns 'true' if this operation is permitted; otherwise, it returns 'false'.


Example:

Code Block
languagejs
themeEclipse
titlegetClassDisplayValuecanCreate
linenumberstrue
const taskTitle = current.getClassDisplayValuecanCreate();
email.setSubject('New ' + taskTitle + ' has been created');
getConditionQuery

canDelete()


This method

returns current query condition.

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:

TypeDescription
StringThe query condition
BooleanThe method returns 'true' if this operation is permitted; otherwise, it returns 'false'.


Example:

Code Block
languagejs
themeEclipse
titlegetConditionQuerycanDelete
linenumberstrue
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());
// Info: Condition before query: (state=7)^OR(priority<3)
// 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):

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:

TypeDescription
BooleanThe method returns 'true' if this operation is permitted; otherwise, it returns 'false'.


Example:

Code Block
languagejs
themeEclipse
titlecanRead
linenumberstrue
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:

TypeDescription
BooleanThe method returns 'true' if this operation is permitted; otherwise, it returns 'false'.


Example:

Code Block
languagejs
themeEclipse
titlecanUpdate
linenumberstrue
current.canUpdate();

deleteMultiple()


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

Note

Do not use this method on tables with dependencies. Always delete each record individually.


NameTypeMandatoryDefault ValuePropertyStringNNULL

Return:

TypeDescription
StringA field or record value
BooleanThis method returns 'true' if records are deleted successfully; otherwise, it returns 'false'.


Example:

Code Block
languagejs
themeEclipse
titlegetDisplayValuedeleteMultiple
linenumberstrue
const companyNamerecord = current.getDisplayValuenew SimpleRecord('companysys_activity_feed_item');
emailrecord.setSubjectaddQuery('New employee at "' + companyName + '" company');

getErrors()

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.

Warning

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

For example, errors in condition queries passed by methods like addEncodedQuery(condition) or similar methods can be displayed by calling this method.

Return:

content', 'isempty');
record.query();
ss.info(record.getRowCount());
ss.info(record.deleteMultiple());
// Info: 0
// Info: true


deleteRecord()


This method deletes the current record.


Return:

TypeDescription
BooleanThis method returns 'true' if the record is deleted successfully; otherwise it returns 'false'
TypeDescriptionArrayThe error value
.


Example:

Code Block
languagejs
themeEclipse
titlegetErrorsdeleteRecord
linenumberstrue
const recordtask = new SimpleRecord('usertask');
const newUserID = record.insert(task.get('155931135900000000');
if (newUserID == 0!task.sys_id) {
  ss.info(record.getErrors());
}
// Info: ["The \"\"First Name\" [first_name]\" field is mandatory. (record id: )",...

getLabel(property)

This method gets the field title
return;
}
const isDeleted = task.deleteRecord();
if (isDeleted) {
  ss.info('Task with ID ' + task.sys_id + ' was deleted!');
  return;
}
ss.error(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):

NameTypeMandatoryDefault Value
propertyStringYN

Return:

TypeDescriptionStringThe field name.
propertyOrValue

String value of record ID or property name. If it is equal to the property name, then the second parameter 'value' is mandatory.

Note

Passing 'NULL' or an empty string as the propertyOrValue parameter value causes an exception:

"Argument 1 passed to "get()" must not be empty".


YN
valueString or SimpleRecord objectNNULL


Return:

TypeDescription
SimpleRecord objectThis method returns a SimpleRecord object from the table specified in the query.


Example:

Code Block

Example:

Code Block
languagejs
themeEclipse
titlegetLabelget
linenumberstrue
const currenttask = ss.getUser(new SimpleRecord('task');
const fieldLabel = current.getLabeltask.get('username163663310116371174');
ss.addErrorMessage('Field "' +  fieldLabel + '" cannot be blank');
// Field "Login" cannot be blank

getRowCount()

This method gets the amount of items in a row.

Returns:

TypeDescriptionIntegerItems amount in a row specified.
 // get by ID

if (task.state == '18') { // Rejected
  const company = new SimpleRecord('org_company');
  company.get('c_website', task.c_customer_url); // get by Customer URL
  ss.eventQueue('notify.responsible', task, company.responsible.email);
}


Example:

Info

It is possible to pass the SimpleRecord object as current.{reference_field_name} instead of the record ID as the get() method value. The script example:

getRowCount
Code Block
languagejs
themeEclipse
title
Passing SimpleRecord as an argument
linenumberstrue
collapsetrue
const 
incident
task = new SimpleRecord('
itsm_incident
task');
incident
task.setLimit(1);
task.query();
if (!task.next()) {
  ss.
addInfoMessage
info('
Total incident count: ' + incident.getRowCount());

getTableName()

No tasks found!');
  return;
}

const user = new SimpleRecord('user');
user.get(task.caller);
user.language_id = '156628684306541141'; // English
ss.info(user.update());
// Info: 167515292501757147



getAttributes()


This method returns an object with current record properties as keys and properties values as key valuesThis method gets the current table name.


Return:

TypeDescription
String
ObjectThe
current table name
array containing attributes.

Example:


Code Block
languagejs
themeEclipse
titlegetTableNamegetAttributes
linenumberstrue
const currentuserRecord = ss.getUser();
ss.info('/list/' + current.getTableNameuserRecord.getAttributes());
// Info: /list/user
getValue(property
{"sys_id":"155931135900000001","sys_created_at":"2019-09-30 00:00:00","sys_updated_at":"2021-06-28...

getClassDisplayValue()


This method returns the

value of the object property based on its name.

table title. If the

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

title is not set, then returns name.


Return:

TypeDescription
StringTitle or name.


Example:

Code Block
languagejs
themeEclipse
titlegetClassDisplayValue
linenumberstrue
const current = new SimpleRecord('task');
current.get('163663310116371174');
ss.info(current.getClassDisplayValue());
// Info: Task

getConditionQuery()


This method returns current query condition.


Return:

TypeDescription
StringThe query condition.


Example:

Note

To speed up the script execution, use this method to get values of the fields of the Reference type instead of Dot-walking.

As an example, it is preferable to use the current.getValue('reference_field') structure instead of current.reference_field.sys_id one.

Parameter(s):

NameTypeMandatoryDefault ValuepropertyStringYN

Return:

TypeDescriptionMixed

The string value of the object property.

Code Block
languagejs
themeEclipse
titlegetValuegetConditionQuery
linenumberstrue
const currenttask = new ss.getUser(SimpleRecord('task');
const usercondition = new SimpleRecord('usertask.addQuery('state', '7');
usercondition.addQueryaddOrCondition('timezone_idpriority', '<', current.getValue('timezone_id''3');
ss.info('Condition before query: ' + task.getConditionQuery());
usertask.query();
ss.info('SameCondition timezoneafter forquery: ' + usertask.getRowCountgetConditionQuery() + ' users');
// Info: SameCondition timezonebefore forquery: 36 users
hasAttachment
(
)

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

Return:

TypeDescriptionBooleanMethod returns TRUE if the record has an attachment; otherwise, it returns FALSE.
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):

NameTypeMandatoryDefault Value
PropertyStringNNULL


Return:

TypeDescription
StringA field or record value.


Example:

Example:

Code Block
languagejs
themeEclipse
titlehasAttachmentgetDisplayValue
linenumberstrue
const hasAttachcurrent = current.hasAttachment(new SimpleRecord('task');
if (!hasAttach) {
  ss.addErrorMessage('File should be attached');
  current.setAbortAction(true);
}

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")
current.get('163663310116371174');
ss.info(current.getDisplayValue('caller'));
ss.info(current.getValue('caller'));
// Info: John Doe
// Info: 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.

Warning

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

For example, errors in condition queries passed by methods like addEncodedQuery(condition) or similar methods can be displayed by calling this method.


Return:

TypeDescription
VoidThis method does not return a
ArrayThe error value.


Example:

Code Block
languagejs
themeEclipse
titleinitializegetErrors
linenumberstrue
const taskRecordrecord = new SimpleRecord('taskuser');
ss.info(Object.entries(taskRecord.getAttributes()).filter(item => !item.includes('')));
taskRecord.initialize();
const insertedRecordId = record.insert();
if (insertedRecordId == 0) {
  ss.info(Object.entries(taskRecord.getAttributesrecord.getErrors()).filter(item => !item.includes('')));
// Info: [];
}
// Info: [["active",1],["state",7],["opened_at","2021-06-29 10:06:38"],...
insert
The \"\"First Name\" [first_name]\" field is mandatory. (record id: )",...


getLabel(property) 
Anchor
getLabel()
getLabel()


This method uses gets 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 getErrorstitle.

Info

 The getLabel() method cannot be used with REM attributes. Instead, use the getTitle() method.


Parameter(s):

NameTypeMandatoryDefault Value
propertyStringYN


Return:

TypeDescription
Integer
  • If validation errors occurred and record was not updated, then method returns '0' and you can get a message containing list of errors.
  • As a normal case, a unique ID of the inserted record returns.
StringThe field name.


Example:

Code Block
languagejs
themeEclipse
titleinsertgetLabel
linenumberstrue
const newTaskcurrent = new SimpleRecord('task');
newTask.subject = `New task`;
const inserterTaskIDss.getUser();
const fieldLabel = newTaskcurrent.insertgetLabel('username');
if (inserterTaskID != 0) {
  current.parent_id = inserterTaskID;
} else {
  ss.addErrorMessage('Errors: ' + JSON.stringify(newTask.getErrors()));
}

isTableVcsEnabled()

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

getReModelId() 
Anchor
getremodelid
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.This method checks whether the VCS enabled attribute is enabled against the specified table or not. 

Return:

TypeDescription
Boolean

String

Method
The method returns
value of is_vcs_enabled property of record table
the ID of the model. If model is not found, the method returns null.

Example:

Code Block
languagejs
themeEclipse
titleisTableVcsEnabledgetReModelId
linenumberstrue
const table(function executeRule(current, previous = new null /*not null only when action is update*/) {
    if (current.getReModelId()) {
        const model = new SimpleRecord('sys_dbrmc_tablemodel');
ss.info(table.isTableVcsEnabled        model.get(current.getReModelId()); // true

matchesCondition(condition)

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

NameTypeMandatoryDefault ValueconditionStringN''

Return:

TypeDescriptionBooleanThis method returns 'true' if the record meets the condition specified; otherwise; it returns 'false'.
current model
        current.$$service = model.getValue('cmdb_service_id'); // pass service if field exists
    }
})(current, previous);


getRowCount()


This method gets the amount of items in a row.


Returns:

TypeDescription
IntegerItems amount in a row specified.

Example:

Code Block
languagejs
themeEclipse
titlematchesConditiongetRowCount
linenumberstrue
const task = new SimpleRecord('task');
task.description = 'emaik'query();
ss.info(addInfoMessage('All Tasks Count: ' + task.matchesConditiongetRowCount('descriptionLIKEemail')); 
// false
task.description = 'email';
ss.info(task.matchesCondition('descriptionLIKEemail')); // true

next()

If this is a new request, then this method returns the first record from the list; otherwise it returns FALSE, in the case if the record is unavailable
 All Tasks Count: 2


getTableName()


This method gets the current table name.


Return:

Type
Record or Boolean
Description
StringThe current table name.


Example:

Code Block
languagejs
themeEclipse
titlenextgetTableName
linenumberstrue
const usercurrent = new SimpleRecord('user');
user.setLimit(1ss.getUser();
userss.query();
user.next();
ss.info(user.info('/list/' + current.getTableName() + '/' + current.sys_id);
// Info: 100000000000000000
orderBy(column
/list/user/155931135900000001

getTitle(attribute) 
Anchor
getTitle()
getTitle()


This method

sorts records in the ascending order.

returns the title of the defined RE attribute.

Parameter

Tip

Call this method several times to order by multiple columns.

Parameter(s):

NameTypeMandatoryDefault Value
columnStringYN

Return:

TypeDescription
Void
StringThis method
does not return a value
returns the title of the attribute.


Example:

Code Block
languagejs
themeEclipse
titleorderBygetTitle
linenumberstrue
const firstLogcurrent = new SimpleRecord('sys_logtask');
firstLogcurrent.orderByget('sys_created_at163638951512716126'); // 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);
if (current.sys_id) {
    ss.info(current.rem_attr.getTitle('reviewed'));
}
// 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):

NameTypeMandatoryDefault ValuecolumnStringYN

Return:

TypeDescriptionVoidThis method does not return a value.
Review completed


Info

To return column titles which are not part of REM, use the getLabel() method.

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.

Note

To speed up the script execution, use this method to get values of the fields of the Reference type instead of Dot-walking.

As an example, it is preferable to use the current.getValue('reference_field') structure instead of current.reference_field.sys_id one.


Parameter(s):

NameTypeMandatoryDefault Value
propertyStringYN


Return:

TypeDescription
Mixed

The string value of the object property.


Code Block
languagejs
themeEclipse
titlegetValue
linenumberstrue
const current = ss.getUser();
const user = new SimpleRecord('user');
user.addQuery('timezone_id', current.getValue('timezone_id'));
user.selectAttributes('sys_id');
user.query

Example:

Code Block
languagejs
themeEclipse
titleorderByDesc
linenumberstrue
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_nameuser.getRowCount() + ': ' + lastComment.value users have the same timezone as you');
// Info: Admin null: test
query
24 users have the same timezone as you

hasAttachment()


This method

applies query to the selection from a database, based on the $this→query. After this, it fills in the record set

checks whether the record specified has an attachment or not.


Return:

TypeDescription
VoidThis method does not return a value.

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.

Warning

Do not use this method when selecting records that can be updated after being selected. Otherwise, when updating, some of the record field values may be lost, or record updating will throw an exception looking like this:

Info

You can't save incomplete record.

BooleanMethod returns 'true' if the record has an attachment; otherwise, it returns 'false'.


Example:

Code Block
languagejs
themeEclipse
titlehasAttachment
linenumberstrue
const current = new SimpleRecord('task');
current.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"

NameTypeMandatoryDefault ValueattributesString or ArrayYN InfoIt is allowed to pass a single attribute name as a string. But if you need to pass more than one attribute names, please use Array type (as shown in code example below

).


Return:

TypeDescription
SimpleRecord object
VoidThis method
returns a SimpleRecord object containing attributes
does not return a value.


Example:

Code Block
languagejs
themeEclipse
titleselectAttributes (String)initialize
linenumberstrue
const recordtaskRecord = new SimpleRecord('usertask');
record.selectAttributes('email');
record.query(ss.info(taskRecord.getAttributes().caller);
recordtaskRecord.nextinitialize();
ss.info(recordtaskRecord.getAttributes().caller);
// Info: {"email":"john.doe@email.com","sys_id":"162423321917274937"}

Example:

Code Block
languagejs
themeEclipse
titleselectAttributes (Array)
linenumberstrue
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.

Note

Please note that the code will not be executed if it is typed after calling this method in the script body.

Parameter(s):

NameTypeMandatoryDefault ValueflagBooleanYN

Return:

TypeDescriptionVoidThis method does not return a value.
 
// Info: 155931135900000001

insert()


This method 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:

TypeDescription
String
  • If record was not inserted, then method returns '0' and you can get a message containing list of errors.
  • As a normal case, a unique ID of the inserted record returns.


Example:

Code Block

Example:

Code Block
languagejs
themeEclipse
titlesetAbortActioninsert
linenumberstrue
const NOWnewTask = new SimpleDateTimeSimpleRecord('task');
const appropriateDatetimenewTask.subject = new SimpleDateTime(current.appropriate_date);

if (NOW.before(appropriateDatetime)) {
  ss.addErrorMessage("Can't be updated before " + appropriateDatetime.getDisplayValue());
  current.setAbortAction(true);
}

setLimit(maxNumRecords)

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

Parameter(s):

'Subtask';
const inserterTaskID = newTask.insert();
ss.info(`/record/task/${inserterTaskID}`);
// Info: /record/task/163675231910113745

isTableVcsEnabled()


This method checks whether the VCS enabled attribute is enabled against the specified table or not. 

NameTypeMandatoryDefault ValuemaxNumRecordsIntegerYN


Return:

TypeDescription
Void
BooleanThis method
does not return a value
returns the value of the is_vcs_enabled attribute of record table.

Example:

Code Block
languagejs
themeEclipse
titlesetLimitisTableVcsEnabled
linenumberstrue
const recordcurrent = new SimpleRecord('user');
recordss.setLimit(1);
record.queryinfo(current.isTableVcsEnabled());
ss.info(record.getRowCount());
// Info: 1false
setMultipleValue


matchesCondition(

property,value

condition)


This method sets the properties values for every entry checks whether the current record meets the condition in the current selectionstate.

Parameter(s):


NameTypeMandatoryDefault Value
property
conditionString
Y
N
valueStringYN
''


Return:

TypeDescription
Void
BooleanThis method
does not return a value
returns 'true' if the record meets the condition specified; otherwise; it returns 'false'.


Code Block
languagejs
themeEclipse
titlesetMultipleValue
linenumberstrue
titlematchesCondition
linenumberstrue
const task = new SimpleRecord('task');
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:

Type
Record or Boolean


Example:

Code Block
languagejs
themeEclipse
titlenext
linenumberstrue
const user = new SimpleRecord('user');
user.setLimit(1);
user.query();
user.next();
ss.info(user.sys_id);
// Info: 100000000000000000


Note

Until the method is called, the values of a SimpleRecord object are not available, and the 'Current record is not set' message will occur. Consider the example:

Code Block
languagejs
themeEclipse
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 records in the ascending order.


Tip

Call this method several times to order by multiple columns.


Parameter(s):

NameTypeMandatoryDefault Value
columnStringYN


Return:

TypeDescription
VoidThis method does not return a value.


Example:

Code Block
languagejs
themeEclipse
titleorderBy
linenumberstrue
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):

NameTypeMandatoryDefault Value
columnStringYN


Return:

TypeDescription
VoidThis method does not return a value.


Example:

Code Block
languagejs
themeEclipse
titleorderByDesc
linenumberstrue
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()


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

Return:

TypeDescription
VoidThis method does not return a value.


Example:

Code Block
languagejs
themeEclipse
titlequery
linenumberstrue
const tasks = new SimpleRecord('task');
tasks.addQuery('sys_created_at', '>', '2020-01-01');
tasks.orderBy('sys_created_at');
tasks.setLimit(2);
tasks.query();
while (tasks.next()) {
  ss.info('Task number: ' +  tasks.number);
}
// Info: Task number: TSK0000001
// Info: Task number: TSK0000003


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.


Warning

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

You cannot update the record with the set of shortened attributes. Remove the selectAttributes method call and update again.



NameTypeMandatoryDefault Value
attributesString or ArrayYN


Info

It makes sense to pass a single attribute name as a string. But if you need to pass more than one attribute names, please use Array type (as shown in code example below).


Return:

TypeDescription
SimpleRecord object

This method returns a SimpleRecord object containing attributes and values.

Note

Regardless of the initial attribute set content, the returned object always contains the sys_id attribute. See code examples below for more clarity.


Example:

Code Block
languagejs
themeEclipse
titleselectAttributes (String)
linenumberstrue
const record = new SimpleRecord('user');
record.selectAttributes('email');
record.query();
record.next();
ss.info(record.getAttributes());
// Info: {"email":"john.doe@email.com","sys_id":"162423321917274937"}


Example:

Code Block
languagejs
themeEclipse
titleselectAttributes (Array)
linenumberstrue
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.


Note

Please note that the code will not be executed if it is typed after calling this method in the script body.


Note

It is not recommended to use thismethod with async business rules. It may cause unpredictable system behavior.


Parameter(s):

NameTypeMandatoryDefault Value
flagBooleanYN


Return:

TypeDescription
VoidThis method does not return a value.


Example:

Code Block
languagejs
themeEclipse
titlesetAbortAction
linenumberstrue
const current = new SimpleRecord('task');
current.get('163663310116371174');
const hasAttach = current.hasAttachment();
if (!hasAttach) {
    ss.addErrorMessage('File should be attached!');
    current.setAbortAction(true);
}
current.state = '2'; // Open
current.update();

setLimit(maxNumRecords)


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


Parameter(s):

NameTypeMandatoryDefault Value
maxNumRecordsIntegerYN


Return:

TypeDescription
VoidThis method does not return a value.


Example:

Code Block
languagejs
themeEclipse
titlesetLimit
linenumberstrue
const record = new SimpleRecord('user');
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 selection.


Parameter(s):

NameTypeMandatoryDefault Value
propertyStringYN
valueStringYN

Return:

TypeDescription
Void

This method does not return a value.


Code Block
languagejs
themeEclipse
titlesetMultipleValue
linenumberstrue
const task = new SimpleRecord('task');
task.addQuery('state', '7'); // Draft
task.query();
ss.info(task.getRowCount());
task.setMultipleValue('state', '2'); // 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 method.

Parameter(s):

NameTypeMandatoryDefault Value
reModelIdStringYN

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

Return:

TypeDescription
Void

This method does not return a value.

Example:

Code Block
languagejs
themeEclipse
titlegetReModelId
linenumberstrue
const task = new SimpleRecord('task');
task.get('163352033916904699');
if (task.getValue('service') === '164069027812962298') { // Email Server Service
    task.setReModelId('158569205818704980'); // Email Server Access Request
} else {
    task.setReModelId(null);
}
task.update();


Note

When calling the method on a SimpleRecord() instance, the values of its attributes bound to the previous model will be reset.

After calling the method and updating the сurrent record, the attribute values bound to the previous model will be lost.

Example:

Code Block
languagejs
themeEclipse
titlesetReModelId
linenumberstrue
(function executeRule(current, previous = null /*not null only when action is update*/ ) {
    // before rule triggered by service change

    ss.importIncludeScript('getRemAttributes');
    const rmc = new SimpleRecord('sys_rmc_model');
    rmc.addQuery('cmdb_service_id', current.getValue('service'));
    rmc.addQuery('active', true);
    rmc.selectAttributes('sys_id');
    rmc.setLimit(1);
    rmc.query();
    if (rmc.next()) {
        const previousModelAttributes = getRemAttributes(current);
        current.setReModelId(rmc.sys_id);
        const currentModelAttributes = getRemAttributes(current);

        Object.keys(previousModelAttributes).forEach(attributeName => {
            if (currentModelAttributes.hasOwnProperty(attributeName)) {
                current.rem_attr[attributeName] = previousModelAttributes[attributeName];
            }
        })
    } else {
        current.setReModelId(null);
    }

})(current, previousconst task = new SimpleRecord('task');
task.addQuery('state', '7'); // Draft
task.query();
ss.info(task.getRowCount());
task.setMultipleValue('state', '2'); // Open
// task.updateMultiple();

setValue(property, value) 
Anchor
setValue()
setValue()


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

Parameter(s):

NameTypeMandatoryDefault Value
propertyStringYN
valueStringYN


Return:

TypeDescription
VoidThis property does not return a value.


Example:

Code Block
languagejs
themeEclipse
titlesetValue
linenumberstrue
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.


NameTypeMandatoryDefault Value
enableBooleanNtrue


TypeDescription
VoidThis property does not return a value.


Code Block
languagejs
themeEclipse
titlesilentMode
linenumberstrue
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.

Info

This method is used for existing records.

  • If the record existed before, the changes are applied.
  • If the record did not exist before,
it is inserted.
  • the getErrors() method will return this error: "Unable to update new record. Use `insert()` instead. (record id: )"


Return:

TypeDescription
IntegerString
  • If validation errors occurred and record was not updated, then method returns '0' and you can get a message containing list of errors;
  • As a normal case, an ID of the updated (inserted) record returns.


Example:

Code Block
languagejs
themeEclipse
titleupdate
linenumberstrue
const incidentcurrent = new SimpleRecord('itsm_incidentuser');
incidentcurrent.get(record_id(ss.getUserId());
if (incident.syscurrent.timezone_id) {
  incident.subject += " (repair)";
  const updatedID = incident.update();
  if (updatedID == 0) {
    ss.debug(incident= '156076775207670452'; // UTC
ss.info(current.update());
ss.info(current.getErrors());
// Info: }
}155931135900000001
// Info: []


updateMultiple()


This method updates all the selection entries.

Return:

TypeDescription
Void or Integer
  • If validation errors occurred and record was not updated, then method returns '0' and you can get a message containing list of errors;
  • Normally, this method does not return a value.


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


Table of Contents
absoluteUrltrue
printablefalse