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 taskRecord = new SimpleRecord('task');


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

Parameter:

NameTypeMandatoryDefault Value
propertyStringYN

Return:

TypeDescription
SimpleRecord 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 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. Notice that you need to use the 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

operatorString (refer to the Condition Operators article for more information)
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 containing OR condition added to the SimpleRecord object.


ExampleExamples:

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)


const task
 = new SimpleRecord('task');
task
record.
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
addQuery('subject', 'like', 'not work')
record.addOrCondition('166972638116358001:description', 'contains', 'not work');
ss.info('Condition query: ' + record.getConditionQuery());
record.query();
ss.info('Tasks count
// Info: 
'
Condition 
+ relatedTask.getRowCount()); // Info: Tasks count: 122
Code Block
languagejs
themeEclipse
titleaddOrCondition with REM attribute
linenumberstrue
let record
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

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.

Parameter(s):

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

Return:

TypeDescriptionSimpleRecordThe query condition added to the SimpleRecord object.
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

Example:

Code Block
languagejs
themeEclipse
titleaddQuery
linenumberstrue
const task
 = new SimpleRecord('task');
task
relatedTask.addQuery('
active
caller', 
true
task.caller);
task
relatedTask.
addQuery
addOrCondition('
subject', 'like
assigned_user', 
'email'); task.addQuery('sys_created_at', '<', '2019-04-01 00:00:00'
task.caller);
task
relatedTask.query();
ss.info('
Count
Tasks count: ' + 
task
relatedTask.getRowCount());
// Info: Tasks 
Count
count: 
0
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:

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
task.addQuery('
caller
active', 
task.caller
true);
otherTask
task.addQuery('
sys_id
subject', '
!=
like', 
task.sys_id
'email');
otherTask.query(); ss.info('Tasks count
task.addQuery('sys_created_at', '<', '2019-04-01 00:00:00');
task.query();
ss.info('Count: ' + 
otherTask
task.getRowCount());
// Info: 
Tasks count
Count: 
720
Code Block
languagejs
themeEclipse
titleaddQuery
linenumberstrue
const task
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

addEncodedQuery(condition)

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

Info

Decoded query is also applicable.

Parameter(s):

NameTypeMandatoryDefault ValueconditionString YN

Return:

TypeDescriptionVoidThis method does not return a value.
0


Code Block
languagejs
themeEclipse
titleaddQuery with REM attribute
linenumberstrue
let record

Example:

Code Block
languagejs
themeEclipse
titleaddEncodedQuery
linenumberstrue
const currentUser = ss.getUser();
const reciever = new SimpleRecord('employeetask');
recieverrecord.addQuery('active166972638116358001:description', 'not truework');
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(record.query();
ss.info("Total rows: " + record.getRowCount());
// Info: DecodedTotal condition: (active=1)^((sys_db_table_id=158645243815904649^sys_created_byDYNAMIC156957117519820256))

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:

TypeDescriptionBooleanThe method returns 'true' if this operation is permitted; otherwise, it returns 'false'.
rows: 1


Info

Example:

canCreate
Code Block
language

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
language
js
themeEclipse
title
Passing SimpleRecord as an argument
linenumberstrue
collapsetrue
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:

TypeDescriptionBooleanThe method returns 'true' if this operation is permitted; otherwise, it returns 'false'.
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 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
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
language

Example:

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

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 (ACL).

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
titlecanUpdateaddEncodedQuery
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 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()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: 0
// Info: true

deleteRecord()

This method deletes the current record.

Return:

TypeDescriptionBooleanThis method returns 'true' if the record is deleted successfully; otherwise it returns 'false'.Example:
Decoded condition: (active=1)^((sys_db_table_id=158645243815904649^sys_created_byDYNAMIC156957117519820256))


Code Block
languagejs
themeEclipse
titledeleteRecordaddEncodedQuery with REM attributes
linenumberstrue
const taskreceier = new SimpleRecord('task');
taskreceiver.getaddQuery('155931135900000000');
if (!task.sys_id) {
  return;
}
const isDeleted = task.deleteRecord();
if (isDeleted) {
  active', true);
receiver.addEncodedQuery('%28sys_db_table_id%3D158645243815904649%5E166972638116358001%3AdescriptionLIKEwork`);
ss.info('Task with IDDecoded condition: ' + 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 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 causes an exception:

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

YN
receiver.getConditionQuery());
receiver.query();
// Info: Decoded condition: (active=1)^((sys_db_table_id=158645243815904649^166972638116358001:descriptionLIKEwork))

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:

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 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.


valueString or SimpleRecord objectNNULL

Return:

TypeDescription
SimpleRecord object
Boolean
This method returns a SimpleRecord object from the table specified in the query
The method returns 'true' if this operation is permitted; otherwise, it returns 'false'.


Example:

Code Block
languagejs
themeEclipse
titlegetcanDelete
linenumberstrue
const task = new SimpleRecord('task');
task.get('163663310116371174'); // 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);
}
Info
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.


Return:

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


Example:

const task = new SimpleRecord('task'); task.setLimit(1); task.query(); if (!task.next()) { ss.info('No tasks found!'); return; } const user
 = new SimpleRecord('
user
sys_activity_feed_item');
user
record.
get(task.caller
addQuery('content', 'isempty');
record.query();
user.language_id = '156628684306541141'; // English
ss.info(record.getRowCount());
ss.info(
user
record.
update
deleteMultiple());
// Info: 0
// Info: 
167515292501757147
true
Code Block
languagejs
themeEclipse
titledeleteMultiple
linenumberstrue
const record

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:

Code Block
languagejs
themeEclipse
titlePassing SimpleRecord as an argument
linenumberstrue
collapsetrue
getAttributes


deleteRecord()


This method

returns an object with

deletes the current record

properties as keys and properties values as key values

.


Return:

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


Example:

Code Block
languagejs
themeEclipse
titlegetAttributesdeleteRecord
linenumberstrue
const userRecordtask = new ss.getUser(SimpleRecord('task');
sstask.info(userRecord.getAttributes()get('155931135900000000');
// 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:

TypeDescriptionStringTitle 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.
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

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
StringThe query condition
SimpleRecord objectThis method returns a SimpleRecord object from the table specified in the query.


Example:

Code Block
languagejs
themeEclipse
titlegetConditionQueryget
linenumberstrue
const task = new SimpleRecord('task');
const condition = task.addQueryget('state', '7163663310116371174');
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)  AnchorgetDisplayValue()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 ValuePropertyStringNNULL

Return:

TypeDescriptionStringA field or record value.
 // 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);
}


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

ExamplegetDisplayValue

:

Code Block
languagejs
themeEclipse
title
Passing SimpleRecord as an argument
linenumberstrue
collapsetrue
const 
current
task = new SimpleRecord('task');
current
task.
get('163663310116371174'); ss.info(current.getDisplayValue('caller'));
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(
current
user.
getValue
update(
'caller'
));
// Info: 
John Doe // Info: 155931135900000001
getErrors()  AnchorgetErrors()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:

TypeDescriptionArrayThe error value.
167515292501757147



getAttributes()


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


Return:

TypeDescription
ObjectThe array containing attributes.


Code Block
languagejs
themeEclipse
titlegetAttributes

Example:

Code Block
languagejs
themeEclipse
titlegetErrors
linenumberstrue
const recorduserRecord = new SimpleRecord('user'ss.getUser();
const insertedRecordId = record.insertss.info(userRecord.getAttributes();
if (insertedRecordId == 0) {
  ss.info(record.getErrors());
}
/);
// Info: ["The \"\"First Name\" [first_name]\" field is mandatory. (record id: )",...
getLabel(property) 
{"sys_id":"155931135900000001","sys_created_at":"2019-09-30 00:00:00","sys_updated_at":"2021-06-28...

getClassDisplayValue

AnchorgetLabel()getLabel

()


This method gets returns the field title.

Info

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

Parameter(s):

NameTypeMandatoryDefault ValuepropertyStringYN

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


Return:

TypeDescription
String
The field
Title or name.


Example:

Code Block
languagejs
themeEclipse
titlegetLabelgetClassDisplayValue
linenumberstrue
const current = new ss.getUser(SimpleRecord('task');
const fieldLabel = current.getLabelget('username163663310116371174');
ss.addErrorMessage('Field "' +  fieldLabel + '" cannot be blank'info(current.getClassDisplayValue());
// Field "Login" cannot be blank
getReModelId()  AnchorgetremodelidgetremodelidThis method retrieves the ID of the RE model related to the current record. To set a new model ID use the setReModelId method
Info: Task

getConditionQuery()


This method returns current query condition.


Return:

TypeDescription
StringThe
method returns the ID of the model. If model is not found, the method returns null
query condition.


Example:

Code Block
languagejs
themeEclipse
titlegetReModelIdgetConditionQuery
linenumberstrue
(function executeRule(current, previousconst task = 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 items in a row.

Returns:

TypeDescriptionIntegerItems amount in a row specified.
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 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:

Code Block
languagejs
themeEclipse
titlegetDisplayValue

Example:

Code Block
languagejs
themeEclipse
titlegetRowCount
linenumberstrue
const taskcurrent = new SimpleRecord('task');
taskcurrent.queryget('163663310116371174');
ss.info(current.addInfoMessagegetDisplayValue('All Tasks Count: ' + task.getRowCount(caller'));
ss.info(current.getValue('caller'));
// Info: All Tasks CountJohn Doe
// Info: 2155931135900000001
getTableName

getErrors()

This method gets the current table name.

Return:

TypeDescriptionStringThe current table name.

 
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
ArrayThe error value.


Example:

Code Block
language

Example:

Code Block
languagejs
themeEclipse
titlegetTableNamegetErrors
linenumberstrue
const currentrecord = new ss.getUser(SimpleRecord('user');
ss.info('/list/' + current.getTableName() + '/' + current.sys_id);const insertedRecordId = record.insert();
if (insertedRecordId == 0) {
  ss.info(record.getErrors());
}
// Info: /list/user/155931135900000001
getTitle(attribute
 ["The \"\"First Name\" [first_name]\" field is mandatory. (record id: )",...


getLabel(property
Anchor

getTitle

getLabel()

getTitle

getLabel()


This method returns gets the title of the defined RE attributefield title.

Info

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


Parameter(s):

NameTypeMandatoryDefault Value
column
propertyStringYN


Return:

TypeDescription
String
This method returns the title of the attribute
The field name.


Example:

Code Block
languagejs
themeEclipse
titlegetTitlegetLabel
linenumberstrue
const current = new SimpleRecord('task'ss.getUser();
const fieldLabel = current.getgetLabel('163638951512716126username');
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
ss.addErrorMessage('Field "' +  fieldLabel + '" cannot be blank');
// Field "Login" cannot be blank

getReModelId(
Anchor

getValue()

getremodelid
getremodelid

getValue()


This method

returns

retrieves the

value

ID 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 ValuepropertyStringYN

Return:

TypeDescriptionMixedThe string value of the object property.

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 model is not found, the method returns null.

Example:

Code Block
languagejs
themeEclipse
titlegetValuegetReModelId
linenumberstrue
const(function executeRule(current, previous = 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
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 items in a row.


Returns:

TypeDescription
BooleanMethod returns 'true' if the record has an attachment; otherwise, it returns 'false'
IntegerItems amount in a row specified.

Example:

Code Block
languagejs
themeEclipse
titlehasAttachmentgetRowCount
linenumberstrue
const currenttask = new SimpleRecord('task');
currenttask.getquery('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")
ss.addInfoMessage('All Tasks Count: ' + task.getRowCount());
// All Tasks Count: 2


getTableName()


This method gets the current table name.


Return:

TypeDescription
VoidThis method does not return a value
StringThe current table name.


Example:

Code Block
languagejs
themeEclipse
titleinitializegetTableName
linenumberstrue
const taskRecordcurrent = new SimpleRecord('task'ss.getUser();
ss.info(taskRecord.getAttributes().caller);
taskRecord.initialize();
ss.info(taskRecord.getAttributes().caller'/list/' + current.getTableName() + '/' + current.sys_id);
// Info: 
/list/user/ Info: 155931135900000001
insert
155931135900000001

getTitle(attribute) 
Anchor
getTitle()
getTitle()


This method uses returns the field values title 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.defined RE attribute.

Parameter:

NameTypeMandatoryDefault Value
columnStringYN

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
    This method returns the title of the attribute.


    Example:

    Code Block
    languagejs
    themeEclipse
    titleinsertgetTitle
    linenumberstrue
    const newTaskcurrent = new SimpleRecord('task');
    newTask.subject = 'Subtask';
    const inserterTaskID = newTask.insert();
    ss.info(`/record/task/${inserterTaskID}`);current.get('163638951512716126');
    if (current.sys_id) {
        ss.info(current.rem_attr.getTitle('reviewed'));
    }
    // Info: /record/task/163675231910113745

    isTableVcsEnabled()

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

    Return:

    TypeDescription
     Review completed


    Info

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

    getValue(property) 
    Anchor
    getValue()
    getValue()

    Boolean


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

    If the field is

    _vcs_enabled attribute of record table.

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

    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
    condition
    propertyStringYN
    ''


    Return:

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

    The string value of the object property.


    Code Block
    languagejs
    themeEclipse
    titlematchesConditiongetValue
    linenumberstrue
    const taskcurrent = new SimpleRecord('task'ss.getUser();
    task.descriptionconst user = new SimpleRecord('emaiouser');
    ssuser.info(task.matchesCondition('descriptionLIKEemailaddQuery('timezone_id', current.getValue('timezone_id')); // false
    task.description = 'email'user.selectAttributes('sys_id');
    user.query();
    ss.info(taskuser.matchesConditiongetRowCount('descriptionLIKEemail')); // true
    next
    ) + ' users have the same timezone as you');
    // Info: 24 users have the same timezone as you

    hasAttachment()


    This method returns checks whether 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 record specified has an attachment or not.


    Return:

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

    Return:

    TypeRecord or Boolean


    Example:

    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
    titlenexthasAttachment
    linenumberstrue
    const usercurrent = new SimpleRecord('usertask');
    usercurrent.setLimitget(1'163663310116371174');
    user.queryconst hasAttach = current.hasAttachment();
    user.next();
    ss.info(user.sys_id);
    // Info: 100000000000000000
    Note
    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").


    Return:

    TypeDescription
    VoidThis method does not return a value.


    Example:

    Code Block
    languagejs
    themeEclipse
    titleinitialize
    linenumberstrue
    const 
    task
    taskRecord = new SimpleRecord('task');
    
    task.setLimit(1); task.query(
    ss.info(taskRecord.getAttributes().caller);
    
    // task.next
    taskRecord.initialize();
    ss.info(taskRecord.getAttributes(
    task
    ).
    number
    caller);
    // 
    Error
    Info: 
    Current record is not set.
    orderBy(column
    
    // Info: 155931135900000001

    insert()


    This method

    sorts records in the ascending order.

    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
    Tip

    Call this method several times to order by multiple columns.

    Parameter(s):NameTypeMandatoryDefault ValuecolumnStringYN

    Return:

    TypeDescriptionVoidThis method does not return a value
    • .


    Example:

    Code Block
    languagejs
    themeEclipse
    titleorderByinsert
    linenumberstrue
    const firstLognewTask = new SimpleRecord('sys_logtask');
    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.nextnewTask.subject = 'Subtask';
    const inserterTaskID = newTask.insert();
    ss.info(firstLog.sys_created_at + ' - ' + firstLog.message`/record/task/${inserterTaskID}`);
    // Info: 2021-06-03 06:34:02 - IMAP IMAP (Default): Connection error: ...

    orderByDesc(column)

    This method sorts the records in the descending order.

    /record/task/163675231910113745

    isTableVcsEnabled()


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


    Return:

    TypeDescription
    BooleanThis method returns the value of the is_vcs_enabled attribute of 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. 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.

    Parameter(s):



    NameTypeMandatoryDefault Value
    columnStringYN
    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
    Void
    SimpleRecord object

    This method

    does not return a value

    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
    titleorderByDescselectAttributes (String)
    linenumberstrue
    const lastCommentrecord = new SimpleRecord('sys_activities_stream_field');
    lastComment.orderByDesc('sys_created_at'); // newest record first
    lastComment.setLimit(1user');
    lastCommentrecord.selectAttributes(['value', 'sys_created_by']'email');
    lastCommentrecord.query();
    lastCommentrecord.next();
    ss.info(lastComment.sys_created_by.display_name + ': ' + lastComment.valuerecord.getAttributes());
    // Info: John Doe: test

    query()

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

    Return:

    TypeDescriptionVoidThis method does not return a value.
    {"email":"john.doe@email.com","sys_id":"162423321917274937"}


    Example:

    Code Block
    languagejs
    themeEclipse
    titlequeryselectAttributes (Array)
    linenumberstrue
    const tasksrecord = new SimpleRecord('taskuser');
    tasksrecord.addQueryselectAttributes(['sys_created_atemail', '>', '2020-01-01');
    tasks.orderBy('sys_created_at');
    tasks.setLimit(2);
    tasksusername']);
    record.query();
    while (tasksrecord.next()) {;
      ss.info('Task number: ' +  tasks.number);
    }(record.getAttributes());
    // 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
    {"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):

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

    InfoYou can`t save incomplete record.

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

    NameTypeMandatoryDefault Value
    attributes
    flag
    String or Array
    BooleanYN
    Info


    Return:

    TypeDescription
    SimpleRecord object

    This method returns a SimpleRecord object containing attributes and values.

    NoteRegardless of the initial attribute set content, the returned object always contains the sys_id attribute. See code examples below for more clarity
    VoidThis method does not return a value.


    Example:

    Code Block
    languagejs
    themeEclipse
    titleselectAttributes (String)setAbortAction
    linenumberstrue
    const recordcurrent = new SimpleRecord('user('task');
    current.get('163663310116371174');
    const hasAttach = current.hasAttachment();
    if (!hasAttach) {
        ss.addErrorMessage('File should be attached!');
    record.selectAttributes('email');
    record.query();
    record.next();
    ss.info(record.getAttributes());
    // Info: {"email":"john.doe@email.com","sys_id":"162423321917274937"}    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
    titleselectAttributes (Array)setLimit
    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
    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

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

    .


    Parameter(s):

    NameTypeMandatoryDefault Value
    flagBoolean
    propertyStringYN
    valueStringYN

    Return:

    TypeDescription
    Void

    This method does not

    return a

    return a value.

    Example:


    Code Block
    languagejs
    themeEclipse
    titlesetAbortActionsetMultipleValue
    linenumberstrue
    const currenttask = new SimpleRecord('task');
    currenttask.getaddQuery('163663310116371174');
    const hasAttach = current.hasAttachment();
    if (!hasAttach) {
        ss.addErrorMessage('File should be attached!');
        current.setAbortAction(true);
    }
    current.state = '2'state', '7'); // Draft
    task.query();
    ss.info(task.getRowCount());
    task.setMultipleValue('state', '2'); // Open
    current.update// task.updateMultiple();
    setLimit

    setReModelId(

    maxNumRecords)

    reModelId) 
    Anchor
    setremodelid
    setremodelid


    This method limits sets the number of records selected by SimpleRecord query methodsID of the defined RE model. To get the model ID, use the getReModelId method.

    Parameter(s):

    NameTypeMandatoryDefault Value
    maxNumRecords
    reModelId
    IntegerYN
    StringYN

    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

    return a value.

    Example:

    Code Block
    languagejs
    themeEclipse
    titlesetLimitgetReModelId
    linenumberstrue
    const recordtask = new SimpleRecord('usertask');
    recordtask.setLimitget(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 ValuepropertyStringYNvalueStringYN

    Return:

    TypeDescription
    '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:

    VoidThis method does not return a value.

    Code Block
    languagejs
    themeEclipse
    titlesetMultipleValue
    linenumberstrue
    setReModelId
    linenumberstrue
    (function executeRule(current, previous = null /*not null only when action is update*/ ) {
        // before rule triggered by service change
    
        ss.importIncludeScript('getRemAttributes');
        const rmcconst task = new SimpleRecord('tasksys_rmc_model');
    task    rmc.addQuery('statecmdb_service_id', current.getValue('7service'));
       // Draft
    taskrmc.query(addQuery('active', true);
    ss.info(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.

    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    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);
        }
    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.
    
    })(current, previous);

    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, 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 a message containing list of errors;
    • As a normal case, an ID of the updated record returns.


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