Versions Compared

Key

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

This server class provides contains 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 taskRecord = new SimpleRecord('task');


REM attribute object


The SimpleRecord class has a special object for Record Extended Modelsrem_attr that contains information about the REM attributes. Use it to read and edit REM attribute values of the current record with other class the 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');

Parameter:

NameTypeMandatoryDefault ValuepropertyStringYN

Return:

TypeDescriptionSimpleRecord 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
titleget using REM
linenumberstrue
const record = new SimpleRecord('task');
record.get('160638931615274614');
if (record.getReModelId()) {
    ss.info(record.rem_attr.description);
}

addOrCondition(property, operator, value)


This method appends a 2-or-3 parameter OR a the OR condition to an existing query. It works in conjunction with any of the addQuery() methodsmethod. In this method, you can use any preferred required operator from the Condition Operators condition operators list, specified either in lowercase lower-or in uppercase. Notice Note that you need to use the system name of the operator in the 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
SimpleRecordA query containing OR a condition added to the SimpleRecord object, or the OR condition added to the 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');
ss.info('Condition query: ' + record.getConditionQuery());
record.query();
// Info: Condition query: (subjectLIKEnot work)^OR(descriptionLIKEnot work)


Code Block
languagejs
themeEclipse
titleaddOrCondition with REM attribute
linenumberstrue
let record = new SimpleRecord('task');
record.addQuery('subject', 'like', 'not work')
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:

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 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 required operator from the Condition Operators the condition operators list, specified either in lowercase lower- or in uppercase. Note that you need to use the system name of the operator in the 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 Operatorscondition 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', 'like', 'email');
task.addQuery('sys_created_at', '<', '2019-04-01 00:00:00');
task.query();
ss.info('Count: ' + task.getRowCount());
// Info: Count: 0


Code Block
languagejs
themeEclipse
titleaddQuery with REM attribute
linenumberstrue
let record = new SimpleRecord('task');
record.addQuery('166972638116358001:description', 'not work');
record.query();
ss.info("Total rows: " + record.getRowCount());
// Info: Total rows: 1


Info

It is possible to pass the value of the Reference field as current.{reference_field_name} instead of the record ID as the addQuery() в method 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 otherTask = 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 methodselect records from the database.

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
themeEclipse
titleFilter with text fields
linenumberstrue
collapsetrue
const subject = 'Hello, SimpleOne)';
const task = new SimpleRecord('task');
task.addEncodedQuery(`subjectLIKE${subject}`);
ss.info(task.getConditionQuery());
try {
    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 reciever = new SimpleRecord('employee');
reciever.addQuery('active', true);
if (currentUser.company.class === 'internal') {
    reciever.addEncodedQuery(`(company=${currentUser.getValue('company')})`);
} else {
    reciever.addEncodedQuery(`%28sys_db_table_id%3D158645243815904649%5Esys_created_byDYNAMIC156957117519820256%29`);
}
ss.info('Decoded condition: ' + reciever.getConditionQuery());
reciever.query();
// Info: Decoded condition: (active=1)^((sys_db_table_id=158645243815904649^sys_created_byDYNAMIC156957117519820256))


Code Block
languagejs
themeEclipse
titleaddEncodedQuery with REM attributes
linenumberstrue
const receier = new SimpleRecord('task');
receiver.addQuery('active', true);
receiver.addEncodedQuery('%28sys_db_table_id%3D158645243815904649%5E166972638116358001%3AdescriptionLIKEwork`);
ss.info('Decoded condition: ' + receiver.getConditionQuery());
receiver.query();
// Info: Decoded condition: (active=1)^((sys_db_table_id=158645243815904649^166972638116358001:descriptionLIKEwork))

canCreate()


This method checks whether inserting new the current user can create records in this the specified table satisfies according to the Access Control Rule (ACL).

Also, use this method in the 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
titlecanCreate
linenumberstrue
current.canCreate();

canDelete()


This method checks whether deleting records from this table satisfies the current user can delete records in the specified table according to the Access Control Rule (ACL).

Also, use this method in the UI Actions to adjust its visibility more precisely.

Return:


Return:

TypeTypeDescription
BooleanThe 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 the current user can read records in this the specified table satisfies according to the Access Control Rule (ACL).Also, use this method in the 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 the current user can edit records in this the specified table satisfies according to the Access Control Rule (ACL).

Also, use this method in the 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. Note that the attachments cannot be deleted using this methodUse this method to delete multiple records form the reveived selection. The attachments of the records that are deleted with this method are not deleted.

Note

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


Return:

TypeDescription
BooleanThis method returns 'true' if records are deleted successfully; otherwise, it returns 'false'.


Example:

Code Block
languagejs
themeEclipse
titledeleteMultiple
linenumberstrue
const record = new SimpleRecord('sys_activity_feed_item');
record.addQuery('content', 'isempty');
record.query();
ss.info(record.getRowCount());
ss.info(record.deleteMultiple());
// Info: 0
// Info: true


deleteRecord(id)


This method deletes the specified record.

When the method is called in a selection of records with a parameter, the record with a specific ID is deleted. To delete the current record, you can either specify an ID or not. In both cases, the record will be deleted.

Parameter:

NameTypeMandatoryDefault Value
idStringNN

Return:

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


Example:

Code Block
languagejs
themeEclipse
titledeleteRecord
linenumberstrue
const task = new SimpleRecord('task');
task.get('155931135900000000');
if (!task.sys_id) {
  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
propertyOrValue

A string value of a record ID or property name. If it is equal to the property name, 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
languagejs
themeEclipse
titleget
linenumberstrue
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);
}


Info

It is possible to pass the value of the Reference field as current.{reference_field_name} instead of the record ID as the get() method 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 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 the current record properties attributes as the keys and properties attribute values as the key values.


Return:

TypeDescription
ObjectAn
array of attributes
object with the record's attributes and their values.


Code Block
languagejs
themeEclipse
titlegetAttributes
linenumberstrue
const userRecord = ss.getUser();
ss.info(userRecord.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, it returns the system name.

Return:

 


Return:

TypeDescription
StringA title or a nameof the record table.


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:

Code Block
languagejs
themeEclipse
titlegetConditionQuery
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) 
Anchor
getDisplayValue()
getDisplayValue()


This method returns the displayed value of the display_by_ref field or a record valuerecord parameter. For example, for the reference field the entity name is returned, not the ID.

With no parameter, the method returns the display value of the record from the field with the display_by_ref checkboxs selected.


Find the values represented in the server scripts according to the field types in the table.

Parameter(s):

NameTypeMandatoryDefault Value
PropertyStringNNULL


Return:

TypeDescription
StringA field or a record valueThe display value of the record or field.


Example:

Code Block
languagejs
themeEclipse
titlegetDisplayValue
linenumberstrue
const current = new SimpleRecord('task');
current.get('163663310116371174');
ss.info(current.getDisplayValue('caller'));
ss.info(current.getValue('caller'));
// Info: John Doe
// Info: 155931135900000001

getErrors() 
Anchor
getErrors()
getErrors()


This method displays returns an error message in case of a failure of a record creating, updating or deleting. 

Use this method for control purposes if there are any validation errors within your scriptsto control the execution of an operation with a record in a script.

Warning

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

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


Return:

TypeDescription
Array
An error value
of StringsError values.


Example:

Code Block
languagejs
themeEclipse
titlegetErrors
linenumberstrue
const record = new SimpleRecord('user');
const insertedRecordId = record.insert();
if (insertedRecordId == 0) {
  ss.info(record.getErrors());
}
// Info: ["The \"\"First NameLogin\" [first_nameusername]\" field is mandatory. (record id: )",...


getLabel(property) 
Anchor
getLabel()
getLabel()


This method gets the field title.

Info

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


Parameter(s):

NameTypeMandatoryDefault Value
propertyStringYN


Return:

TypeDescription
StringA field name.


Example:

Code Block
languagejs
themeEclipse
titlegetLabel
linenumberstrue
const current = ss.getUser();
const fieldLabel = current.getLabel('username');
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.

Return:

TypeDescription

String

The method returns the ID of the model. If the model is not found, the method returns 'null'.

Example:

Code Block
languagejs
themeEclipse
titlegetReModelId
linenumberstrue
(function executeRule(current, previous = 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 method gets the amount of the items in a rowselection.


Returns:

TypeDescription
IntegerA number of the items in a
row
selection.

Example:

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

TypeDescription
StringThe current table name.


Example:

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

NameTypeMandatoryDefault Value
columnStringYN

Return:

TypeDescription
StringThis method returns the title of the REM attribute.


Example:

Code Block
languagejs
themeEclipse
titlegetTitle
linenumberstrue
const current = new SimpleRecord('task');
current.get('163638951512716126');
if (current.sys_id) {
    ss.info(current.rem_attr.getTitle('reviewed'));
}
// Info: 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 specified object property based on its nameattribute.

If the field is of the Reference or List types, then its sys_id value returns. Find the values represented in the server scripts according to the other field types in the table.

Note

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

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


Parameter(s):

NameTypeMandatoryDefault Value
propertyStringYN


Return:

TypeDescription
MixedAny

The string value of the object propertyattribute.


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();
ss.info(user.getRowCount() + ' users have the same timezone as you');
// Info: 24 users have the same timezone as you

hasAttachment()


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


Return:

TypeDescription
BooleanThe method 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 available fields with their predefined default values.

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

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

Return:

TypeDescription
VoidThis method does not return a value.


Example:

Code Block
languagejs
themeEclipse
titleinitialize
linenumberstrue
const taskRecord = new SimpleRecord('task');
ss.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 object to insert into a new onerecord.

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


Return:

TypeDescription
String
  • If record was not insertedcreated, the method returns '0' and you can get generates a message containing that contains a list of errors.
  • If a record was insertedcreated, the method returns a unique ID of the inserted created record.


Example:

Code Block
languagejs
themeEclipse
titleinsert
linenumberstrue
const newTask = new SimpleRecord('task');
newTask.subject = 'Subtask';
const inserterTaskIDinsertedTaskID = newTask.insert();
ss.info(`/record/task/${inserterTaskIDinsertedTaskID}`);
// Info: /record/task/163675231910113745

isTableVcsEnabled()


This method checks whether the VCS enabled attribute checkbox is enabled against selected in the specified table.


Return:

TypeDescription
BooleanThis method returns the value of the is_vcs_enabled attribute of the record table.

Example:

Code Block
languagejs
themeEclipse
titleisTableVcsEnabled
linenumberstrue
const current = new SimpleRecord('user');
ss.info(current.isTableVcsEnabled());
// Info: false


matchesCondition(condition)


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


NameTypeMandatoryDefault Value
conditionStringN''


Return:

TypeDescription
BooleanThis method returns 'true' if the record meets the condition specified; otherwise; it returns 'false'.


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


Return:

TypeDescription
Record SimpleRecord object or BooleanIf this is the first call, this method returns the first record in the query.
If the query is empty, this method returns 'false'.


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

orderBy(column)


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

const task
 = new SimpleRecord('
task
sys_log');
task
firstLog.
setLimit(1); task.query(); // task.next(); ss.info(task.number); // Error: Current record is not set.
Code Block
languagejs
themeEclipse
titleorderBy
linenumberstrue
const firstLog

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

Code Block
languagejs
themeEclipse

orderBy(column)

This method sorts the records in the ascending order.

TipCall this method several times to order by multiple columns
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
titleorderByorderByDesc
linenumberstrue
const firstLoglastComment = new SimpleRecord('sys_activities_logstream_field');
firstLoglastComment.orderByorderByDesc('sys_created_at'); // oldestnewest record first
firstLog.addQuery('message', 'like', 'Connection');
firstLog.lastComment.setLimit(1);
firstLoglastComment.selectAttributes(['messagevalue', 'sys_created_atby']);
firstLoglastComment.query();
firstLoglastComment.next();
ss.info(firstLoglastComment.sys_created_atby.display_name + ': - ' + firstLoglastComment.messagevalue);
// 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
John Doe: test

query()


Use this method to apply a query to retrieve a selection from a database. The selection will be stored in the object on which this method was called.

Return:

TypeDescription
VoidThis

Return:

TypeDescriptionVoidThis
method does not return a value.


Example:

Code Block
languagejs
themeEclipse
titleorderByDescquery
linenumberstrue
const lastCommenttasks = new SimpleRecord('sys_activities_stream_fieldtask');
lastCommenttasks.orderByDescaddQuery('sys_created_at'); // newest record first
lastComment.setLimit(1, '>', '2020-01-01');
lastCommenttasks.selectAttributes(['value', orderBy('sys_created_by']at');
tasks.setLimit(2);
lastCommenttasks.query();
lastCommentwhile (tasks.next()); {
  ss.info(lastComment.sys_created_by.display_name + ''Task number: ' + lastComment tasks.valuenumber);
}
// Info: John Doe: test

query()

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

Return:

TypeDescriptionVoidThis 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)

Use this method tooptimize the database queries, especially when it is necessary to obtain only several object fields, not the whole object. 

Warning
 Task number: TSK0000001
// Info: Task number: TSK0000003


selectAttributes(attributes)


Use this method to optimize the database queries, especially when it is necessary to obtain only several object fields, not the whole object. 


Warning

Do not use this method to select records that can be updated or deleted after selecting. Otherwise, some of the record field values may be lost when these records are updated or deleted. The action performed may also throw an exception similar to:

Info

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



NameTypeMandatoryDefault Value
attributesString / 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, 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 the code examples below.


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)


Use this method in business rules to set a flag indicating that the current operation (insert/update/delete) is interrupted.


Note
  • Note that the code is not executed if it is typed after calling this method in the script body.
  • It is not recommended to use thismethod with async business rules as it may cause unpredictable system behavior.


Parameter(s):

NameTypeMandatoryDefault Value
flagBooleanYN
messageStringNN

Do not use this method to select records that can be updated or deleted after selecting. Otherwise, some of the record field values may be lost when these records are updated or deleted. The action performed may also throw an exception similar to:

Info

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

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


Return:

TypeDescription
SimpleRecord object
VoidThis 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.

does not return a value.


Example:

Code Block
languagejs
themeEclipse
titleselectAttributes (String)setAbortAction
linenumberstrue
const recordcurrent = new SimpleRecord('usertask');
recordcurrent.selectAttributesget('email163663310116371174');
record.queryconst hasAttach = current.hasAttachment();
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)

Use this method in business rules to set a flag indicating that the current operation (insert/update/delete) is interrupted.

Note

Note that the code is not executed if it is typed after calling this method in the script body.

Note
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 the 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)


Use this method to set field values for each record in the current selection

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

Parameter(s):

NameTypeMandatoryDefault ValueflagBooleanYN

Return:

TypeDescriptionVoidThis 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 the SimpleRecord query methods.


Parameter(s):

NameTypeMandatoryDefault Value
maxNumRecordsInteger
propertyStringYN
valueStringYN

Return:

TypeDescription
Void

This method does not

return a

return a value.

Example:


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

NameTypeMandatoryDefault Value
property
reModelIdStringYN
valueStringYN

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
titlesetMultipleValuegetReModelId
linenumberstrue
const task = new SimpleRecord('task');
task.addQueryget('state', '7163352033916904699'); // Draft
task.query();
ss.info
if (task.getRowCount());
task.setMultipleValue('state', '2'); // Open
// task.updateMultiple();
setReModelId(reModelId)  Anchorsetremodelidsetremodelid

This method sets the ID of the defined RE model. To get the model ID, use the getReModelId method.

Parameter(s):

NameTypeMandatoryDefault ValuereModelIdStringYN

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

Return:

TypeDescriptionVoid

This method does not return a value.

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, previous);

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.

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


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

Parameter(s):

NameTypeMandatoryDefault Value
propertyStringYN
valueStringAnyYN


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)


Use this method to update the record without executing any entities related to this record processes 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, the getErrors() method will return this error: "Unable to update new record. Use `insert()` instead. (record id: )"


Return:

TypeDescription
String
  • If record was not updated, then method returns '0' and you can get generates a message containing list of errors;.
  • The method returns an ID of the updated record if no errors occured.


Example:

Code Block
languagejs
themeEclipse
titleupdate
linenumberstrue
const current = new SimpleRecord('user');
current.get(ss.getUserId());
current.timezone_id = '156076775207670452'; // UTC
ss.info(current.update());
ss.info(current.getErrors());
// Info: 155931135900000001
// Info: []


updateMultiple()


This method updates all the selection entries.

Return:

TypeDescription
Void Boolean or Integer
  • If validation errors occurred and the record was not updated, the method returns '0' and generates a message containing a list of errors;.
  • The method does not return a value returns 'true' if no errors occured.


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