This server class provides methods to operate the database records.
SimpleRecord(tableName)
Use the constructor to instantiate an object of the SimpleRecord class for a particular table.
Parameter(s):
Name | Type | Mandatory | Default value |
---|---|---|---|
tableName | String | Y | N |
Example:
const taskRecord = new SimpleRecord('task');
REM attribute object
The SimpleRecord class has a special object for Record Extended Models – rem_attr that contains information about the REM attributes. Use it to read and edit REM attribute values of the current record with the methods as shown below.
rem_attr has a number of methods similar to the methods of the SimpleRecord:
Example:
record.rem_attr.getValue('my_rem_attribute');
Example:
const record = new SimpleRecord('task'); record.get('160638931615274614'); if (record.getReModelId()) { ss.info(record.rem_attr.description); }
SimpleReference object
When you call the fields of the Reference type, the response contains a special SimpleReference object. This object allows you to access the fields of the record in the Reference field with dot-walking.
SimpleReference object has a number of methods similar to the methods of the SimpleRecord:
Example:
let record = new SimpleRecord('task'); record.setLimit(1); record.query(); record.next(); ss.info(record.caller.getValue('username'));
addOrCondition(property, operator, value)
Use the method to add the OR condition to an existing query. It works in conjunction with the addQuery() method. In this method, you can use any necessary operator from the condition operators list, specified in lower- or uppercase. Use the system names of the operators 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.
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):
Name | Type | Mandatory | Default value |
---|---|---|---|
property | String | Y | N 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. |
operator | String | N | = |
value | Integer/String/Boolean/Array/SimpleReference object | Y | N |
Return:
Type | Description |
---|---|
SimpleRecord object | This method returns the instance where the method was called. |
Examples:
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)
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)
It is possible to pass the Reference field value as current.{reference_field_name} instead of the record ID as the addOrCondition() method value. The script example:
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)
Use this method to add a condition to make a selection of records from the database. In this method, you can use any required operator from the condition operators list, specified in lower- or uppercase. Use the system names of the operators 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.
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):
Name | Type | Mandatory | Default value |
---|---|---|---|
property | String | Y | N For the REM attributes use the following pattern: '<sys_id>:<attr_name>' where sys_id is the ID of the model that contain the attribute, and attr_name is the system name of the REM attribute. |
operator | String | N | = |
value | Integer/String/Boolean/Array/SimpleReference object | Y | N |
Return:
Type | Description |
---|---|
SimpleRecord object | This method returns the instance where the method was called. |
Examples:
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
let record = new SimpleRecord('task'); record.addQuery('166972638116358001:description', 'not work'); record.query(); ss.info("Total rows: " + record.getRowCount()); // Info: Total rows: 1
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:
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)
Use this method to add an encoded query to select records from the database. You can also use a decoded query.
You can also specify a RE model attribute of a specific table. To filter records, use the operators corresponding to the attribute type.
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.
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):
Name | Type | Mandatory | Default value |
---|---|---|---|
condition | String | Y | N For the REM attributes use the following pattern: '<sys_id>:<attr_name>' where sys_id is the ID of the model that contains the attribute, and attr_name is the system name of the REM attribute. |
Return:
Type | Description |
---|---|
Void | This method does not return a value. |
Examples:
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))
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()
Use this method to check whether the current user can create records in the specified table according to the Access Control Rule (ACL).
Return:
Type | Description |
---|---|
Boolean | The method returns true if this operation is permitted; otherwise, it returns false. |
Example:
current.canCreate();
canDelete()
Use the method to check whether the current user can delete records in the specified table according to the Access Control Rule (ACL).
Return:
Type | Description |
---|---|
Boolean | The method returns true if this operation is permitted; otherwise, it returns false. |
Example:
current.canDelete();
canRead()
Use the method to check whether the current user can read records in the specified table according to the Access Control Rule (ACL).
Return:
Type | Description |
---|---|
Boolean | The method returns true if this operation is permitted; otherwise, it returns false. |
Example:
current.canRead();
canUpdate()
Use this method to check whether the current user can edit records in the specified table according to the Access Control Rule (ACL).
Return:
Type | Description |
---|---|
Boolean | The method returns true if this operation is permitted; otherwise, it returns false. |
Example:
current.canUpdate();
deleteMultiple()
Use this method to delete multiple records form the selection. The attachments of the deleted records are not deleted.
Do not use this method for the tables that have dependencies. Always delete each record separately.
Return:
Type | Description |
---|---|
Boolean | This method returns true if records are deleted successfully; otherwise, it returns false. |
Example:
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)
Use this method to delete a record.
When the method is called in a selection of records with the parameter set, the record with a specific ID is deleted. If id in not specified in the parameter, the method deletes the current record.
Parameter:
Name | Type | Mandatory | Default value |
---|---|---|---|
id | String | N | N |
Return:
Type | Description |
---|---|
Boolean | This method returns true if the record is deleted successfully; otherwise it returns false. |
Example:
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)
Use this method to load an object from a database by the field value, or, in a specific case, by the ID. The propertyOrValue parameter is the ID value of the record or the property name. If the value is the property name, the value parameter is mandatory.
When you pass the null value or an empty string in the propertyOrValue parameter, the system throws an exception:
Argument 1 passed to "get()" must not be empty.
Parameter(s):
Name | Type | Mandatory | Default value |
---|---|---|---|
propertyOrValue | String | Y | N |
value | String | N | null |
Return:
Type | Description |
---|---|
SimpleRecord object | This method returns a SimpleRecord object from the table specified in the query. |
Example:
const current = new SimpleRecord('task'); current.get('163663310116371174');
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:
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()
Use the method to return an object with the current record attributes as the keys and key values.
Return:
Type | Description |
---|---|
Object | This method returns аn object with the record's attributes and their values. |
Example:
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()
Use this method to return the title of the current table.
Return:
Type | Description |
---|---|
String | This method returns a title of the record table. |
Example:
const current = new SimpleRecord('task'); current.get('163663310116371174'); ss.info(current.getClassDisplayValue()); // Info: Task
getConditionQuery()
Use this method to return the current query condition.
Return:
Type | Description |
---|---|
String | This method returns the query condition. |
Example:
const task = new SimpleRecord('task'); const condition = task.addQuery('state', '7'); condition.addOrCondition('priority', '<', '3'); ss.info('Condition before query: ' + task.getConditionQuery()); task.query(); ss.info('Condition after query: ' + task.getConditionQuery()); // Info: Condition before query: (state=7)^OR(priority<3) // Info: Condition after query:
getDisplayValue(property)
Use this method to return the displayed value of the record parameter. For example, for the Reference field the record name is returned, not the ID.
With no parameter specified, the method returns the display value of the record from the field with the Display by ref checkbox selected.
Find the values represented in the server scripts according to the field types in the table.
Parameter(s):
Name | Type | Mandatory | Default value |
---|---|---|---|
property | String | N | null |
Return:
Type | Description |
---|---|
String | This method returns the display value of the record or field. |
Example:
const current = new SimpleRecord('task'); current.get('163663310116371174'); ss.info(current.getDisplayValue('caller')); ss.info(current.getValue('caller')); // Info: John Doe // Info: 155931135900000001
getErrors()
Use this method to get an error message in case of failure of a record creating, updating or deleting.
Use this method to control the execution of an operation with a record in a script.
It is highly recommended to use this method as some validation errors may not be displayed within the debug process.
For example, errors in the condition queries passed using the addEncodedQuery(condition) or similar methods can be retrieved by calling getErrors.
Return:
Type | Description |
---|---|
Array of Strings | This method returns the error values. |
Example:
const record = new SimpleRecord('user'); const insertedRecordId = record.insert(); if (insertedRecordId == 0) { ss.info(record.getErrors()); } // Info: ["The \"\"Login\" [username]\" field is mandatory. (record id: )",...
getLabel(property)
Use this method to get the field title.
The getLabel() method cannot be used with the REM attributes. Instead, use the getTitle() method.
Parameter(s):
Name | Type | Mandatory | Default value |
---|---|---|---|
property | String | Y | N |
Return:
Type | Description |
---|---|
String | This method returns a field name. |
Example:
const current = ss.getUser(); const fieldLabel = current.getLabel('username'); ss.addErrorMessage('Field "' + fieldLabel + '" cannot be blank'); // Field "Login" cannot be blank
getReModelId()
Use this method to retrieve the ID of the RE model related to the current record. To set a new model ID use the setReModelId method.
Return:
Type | Description |
---|---|
String | The method returns the ID of the model. If the model is not found, the method returns null. |
Example:
(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()
Use this method to get the number of the items in a selection.
Returns:
Type | Description |
---|---|
Integer | The method returns a number of the items in a selection. |
Example:
const task = new SimpleRecord('task'); task.query(); ss.addInfoMessage('All Tasks Count: ' + task.getRowCount()); // All Tasks Count: 2
getTableName()
Use this method to get the name of the current table.
Return:
Type | Description |
---|---|
String | The method returns the system name of the current table. |
Example:
const current = ss.getUser(); ss.info('/list/' + current.getTableName() + '/' + current.sys_id); // Info: /list/user/155931135900000001
getTitle(attribute)
Use this method to get the title of the defined RE attribute.
Parameter:
Name | Type | Mandatory | Default value |
---|---|---|---|
column | String | Y | N |
Return:
Type | Description |
---|---|
String | This method returns the title of the REM attribute. |
Example:
const current = new SimpleRecord('task'); current.get('163638951512716126'); if (current.sys_id) { ss.info(current.rem_attr.getTitle('reviewed')); } // Info: Review completed const current = new SimpleRecord('task'); current.get('163638951512716126'); if (current.sys_id) { ss.info(current.rem_attr.getTitle('reviewed')); } // Info: Review completed
To return the columns, the titles of which are not a part of REM, use the getLabel() method.
getValue(property)
Use this method to return the value of the specified object attribute.
If the field is of the Reference or List types, the method returns its ID value.
Find the values represented in the server scripts according to the other field types in the table.
Use this method to get values of the Reference type fields instead of dot-walking.
For example, use the current.getValue('reference_field') structure instead of the current.reference_field.sys_id one.
Parameter(s):
Name | Type | Mandatory | Default value |
---|---|---|---|
property | String | Y | N |
Return:
Type | Description |
---|---|
Any | This method returns the value of the specified object attribute. |
Example:
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
You can also directly interact with the value of a reference field using the context processing with the '$$' operator. It allows you to check for additional fields and get their values. See the Dot-walking in Scripts article to learn more.
hasAttachment()
Use this method to check whether the specified record has an attachment or not.
Return:
Type | Description |
---|---|
Boolean | The method returns true if the record has an attachment; otherwise, it returns false. |
Example:
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()
Use this method to populate all available fields with their predefined default values.
This method is applicable only for the new records that have never been saved.
This method is called automatically when a record is created.
Return:
Type | Description |
---|---|
Void | This method does not return a value. |
Example:
const taskRecord = new SimpleRecord('task'); ss.info(taskRecord.getAttributes().caller); taskRecord.initialize(); ss.info(taskRecord.getAttributes().caller); // Info: // Info: 155931135900000001
insert()
Use this method to create a new record with the field values of an object.
If a record is not created, method returns '0' (zero) and generates an error message, which you can get with the getErrors() method.
Return:
Type | Description |
---|---|
String |
|
Example:
const newTask = new SimpleRecord('task'); newTask.subject = 'Subtask'; const insertedTaskID = newTask.insert(); ss.info(`/record/task/${insertedTaskID}`); // Info: /record/task/163675231910113745
isTableVcsEnabled()
Use this method to verify whether the Is VCS enabled checkbox is selected in the specified table.
Return:
Type | Description |
---|---|
Boolean | This method returns the value of the Is vcs enabled attribute of the table record. |
Example:
const current = new SimpleRecord('user'); ss.info(current.isTableVcsEnabled()); // Info: false
matchesCondition(condition)
Use this method to verify whether the current record meets the specified condition.
Parameter(s):
Name | Type | Mandatory | Default value |
---|---|---|---|
condition | String | N | '' |
Return:
Type | Description |
---|---|
Boolean | This method returns true if the record meets the specified condition; otherwise; it returns false. |
Example:
const task = new SimpleRecord('task'); task.description = 'emaio'; ss.info(task.matchesCondition('descriptionLIKEemail')); // false task.description = 'email'; ss.info(task.matchesCondition('descriptionLIKEemail')); // true
next()
Use this method to get the next record in the query.
Return:
Type | Description |
---|---|
SimpleRecord object or Boolean | If this is the first call, this method returns the first record in the query. If the query is empty, this method returns false. |
Example:
const user = new SimpleRecord('user'); user.setLimit(1); user.query(); user.next(); ss.info(user.sys_id); // Info: 100000000000000000
orderBy(column)
Use this method to sort the records in the ascending order.
Call this method several times to order by multiple columns.
Parameter(s):
Name | Type | Mandatory | Default value |
---|---|---|---|
column | String | Y | N |
Return:
Type | Description |
---|---|
Void | This method does not return a value. |
Example:
const firstLog = new SimpleRecord('sys_log'); firstLog.orderBy('sys_created_at'); // oldest record first firstLog.addQuery('message', 'like', 'Connection'); firstLog.setLimit(1); firstLog.selectAttributes(['message', 'sys_created_at']); firstLog.query(); firstLog.next(); ss.info(firstLog.sys_created_at + ' - ' + firstLog.message); // Info: 2021-06-03 06:34:02 - IMAP IMAP (Default): Connection error: ...
orderByDesc(column)
Use this method to sort the records in the descending order.
Call this method several times to order by multiple columns.
Parameter(s):
Name | Type | Mandatory | Default value |
---|---|---|---|
column | String | Y | N |
Return:
Type | Description |
---|---|
Void | This method does not return a value. |
Example:
const lastComment = new SimpleRecord('sys_activities_stream_field'); lastComment.orderByDesc('sys_created_at'); // newest record first lastComment.setLimit(1); lastComment.selectAttributes(['value', 'sys_created_by']); lastComment.query(); lastComment.next(); ss.info(lastComment.sys_created_by.display_name + ': ' + lastComment.value); // Info: John Doe: Test comment
query()
Use this method to apply a query to retrieve a selection from a database. The selection will be stored in the object for which this method was called.
Return:
Type | Description |
---|---|
Void | This method does not return a value. |
Example:
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 to optimize the database queries, especially when it is necessary to get only several object fields, not the whole object.
Do not use this method to select records that can be updated or deleted after the selection. Otherwise the system throws an exception:
You cannot update the record with the set of shortened attributes. Remove the selectAttributes method call and update again.
Parameter(s):
Name | Type | Mandatory | Default value |
---|---|---|---|
attributes | String/Array | Y | N |
Pass a single attribute name as a string. If you need to pass more than one attribute names, use the Array type as shown in code example below.
Return:
Type | Description |
---|---|
SimpleRecord object | This method returns a SimpleRecord object containing attributes and values. Regardless of the initial attribute set content, the returned object always contains the ID attribute. See the code examples below. |
Examples:
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"}
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 to interrupt the current operation.
- Note that the script is not executed if it is written after calling this method in the script body.
- It is not recommended to use this method with the async business rules as it may cause unpredictable system behavior.
Parameter(s):
Name | Type | Mandatory | Default value |
---|---|---|---|
flag | Boolean | Y | N |
message | String | N | N |
Return:
Type | Description |
---|---|
Void | This method does not return a value. |
Example:
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)
Use this method to limit the number of the records in a selection done according to a condition.
Parameter(s):
Name | Type | Mandatory | Default value |
---|---|---|---|
maxNumRecords | Integer | Y | N |
Return:
Type | Description |
---|---|
Void | This method does not return a value. |
Example:
const record = new SimpleRecord('user'); record.setLimit(3); record.query(); ss.info(record.getRowCount()); // Info: 3
setMultipleValue(property,value)
Use this method to set the field values for each record in the current selection.
Parameter(s):
Name | Type | Mandatory | Default value |
---|---|---|---|
property | String | Y | N |
value | Any | Y | N |
Return:
Type | Description |
---|---|
Void | This method does not return a value. |
Example:
const task = new SimpleRecord('task'); task.addQuery('state', '7'); // Draft task.query(); ss.info(task.getRowCount()); task.setMultipleValue('state', '2'); // Open // task.updateMultiple();
setReModelId(reModelId)
Use this method to specify the ID of a particular RE model. To get the model ID, use the getReModelId method.
Parameter(s):
Name | Type | Mandatory | Default value |
---|---|---|---|
reModelId | String | Y | N |
If the reModelId parameter is set to null, the REM related to the record will be detached.
Return:
Type | Description |
---|---|
Void | This method does not return a value. |
Example:
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();
- 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:
(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);
setValue(property, value)
Use this method to set a field value of the current record.
Parameter(s):
Name | Type | Mandatory | Default value |
---|---|---|---|
property | String | Y | N |
value | Any | Y | N |
Return:
Type | Description |
---|---|
Void | This property does not return a value. |
Example:
const task = new SimpleRecord('task'); task.setValue('subject', 'mail'); task.insert();
silentMode(enable)
Use this method to update a record without executing related business logic that is implemented with the business rules, notifications, workflows and others.
Name | Type | Mandatory | Default value |
---|---|---|---|
enable | Boolean | N | true |
Return:
Type | Description |
---|---|
Void | This property does not return a value. |
Example:
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()
Use this method to update a record in the database.
Use this method for existing records.
- If the record exists, the changes are applied.
- If the record does not exist, the getErrors() method will return the error:
"Unable to update new record. Use `insert()` instead. (record id: )"
Return:
Type | Description |
---|---|
String |
|
Example:
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()
Use this method to update all the records in the selection.
Return:
Type | Description |
---|---|
Boolean |
|
Example:
const task = new SimpleRecord('task'); task.addQuery('state', '0'); // Open task.query(); ss.info(task.getRowCount()); task.setMultipleValue('state', '10'); // Canceled // task.updateMultiple();