This server class provides methods to operate database records.
SimpleRecord(tableName)
This method instantiates a SimpleRecord class object for a particular table.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|
tableName | String | Y | N |
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | SimpleRecord |
---|
linenumbers | true |
---|
|
const taskRecord = new SimpleRecord('task'); |
addOrCondition(property, operator, value)
This method appends a 2-or-3 parameter OR condition to an existing query. It works in conjunction with any of the addQuery() methods. In this method, you can use any preferred operator from the Condition Operators list, specified either in lowercase or in uppercase. Please notice that you need to use system name of the operator in your scripts.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|
property | String | Y | N |
operator | String (refer to the Condition Operators article for more information) | N | N |
value | Integer or String or Boolean or Array | Y | N |
Return:
Type | Description |
---|
SimpleRecord | The query containing OR condition added to the SimpleRecord object. |
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | addOrCondition |
---|
linenumbers | true |
---|
|
const record = new SimpleRecord('task');
record.addQuery('subject', 'like', 'not work')
record.addOrCondition('description', 'like', 'not work');
ss.info('Condition query: ' + record.getConditionQuery());
// Info: Condition query: (subjectLIKEnot work)^OR(descriptionLIKEnot work) |
addQuery(property, operator, value)
This method adds a condition to make a selection of records from the database. In this method, you can use any preferred operator from the Condition Operators list, specified either in lowercase or in uppercase. Please notice that you need to use system name of the operator in your scripts.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|
property | String | Y | N |
operator | String (refer to the Condition Operators article for more information) | N | N |
value | Integer or String or Boolean or Array | Y | N |
Return:
Type | Description |
---|
SimpleRecord | The query condition added to the SimpleRecord object. |
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | addQuery |
---|
linenumbers | true |
---|
|
const task = new SimpleRecord('task');
task.addQuery('active', true);
task.addQuery('subject', 'like', 'email');
task.addQuery('sys_created_at', '<', '2019-04-01 00:00:00');
task.query();
ss.info('Count: ' + task.getRowCount());
// Info: Count: 0 |
addEncodedQuery(condition)
This method adds encoded query and applies it to the current query method.
Parameter(s)
Name | Type | Mandatory | Default Value |
---|
condition | String | Y | N |
Return:
Type | Description |
---|
Void | This method does not return a value. |
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | addEncodedQuery |
---|
linenumbers | true |
---|
|
const employee = new SimpleRecord('employee');
employee.addEncodedQuery('%28locked_out%3D0%29%5EmanagerISEMPTY');
ss.info('Decoded condition: ' + employee.getConditionQuery());
// Info: Decoded condition: ((locked_out=0)^managerISEMPTY) |
canCreate()
This method checks whether inserting new records in this table satisfies the Access Control Rule.
Also, you can use this method in your UI Actions to adjust its visibility more precisely.
Return:
Type | Description |
---|
Boolean | The method returns 'true' if this operation is permitted; otherwise it returns 'false'. |
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | canCreate |
---|
linenumbers | true |
---|
|
current.canCreate(); |
canDelete()
This method checks whether deleting records in this table satisfies the Access Control Rule.
Also, you can use this method in your UI Actions to adjust its visibility more precisely.
Return:
Type | Description |
---|
Boolean | The method returns 'true' if this operation is permitted; otherwise it returns 'false'. |
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | canDelete |
---|
linenumbers | true |
---|
|
current.canDelete(); |
canRead()
This method checks whether reading records in this table satisfies the Access Control Rule.
Also, you can use this method in your UI Actions to adjust its visibility more precisely.
Return:
Type | Description |
---|
Boolean | The method returns 'true' if this operation is permitted; otherwise it returns 'false'. |
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | canRead |
---|
linenumbers | true |
---|
|
current.canRead(); |
canUpdate()
This method checks whether updating records in this table satisfies the Access Control Rule.
Also, you can use this method in your UI Actions to adjust its visibility more precisely.
Return:
Type | Description |
---|
Boolean | The method returns 'true' if this operation is permitted; otherwise it returns 'false'. |
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | canUpdate |
---|
linenumbers | true |
---|
|
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:
Type | Description |
---|
Boolean | This method returns 'true' if records are deleted successfully; otherwise, it returns 'false'. |
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | deleteMultiple |
---|
linenumbers | true |
---|
|
const record = new SimpleRecord('sys_activity_feed_item');
record.addQuery('content', 'isempty');
record.query();
ss.info(record.getRowCount());
// Info: 0 |
deleteRecord()
This method deletes the current record.
Return:
Type | Description |
---|
Boolean | This method returns 'true' if the record is deleted successfully; otherwise it returns 'false'. |
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | deleteRecord |
---|
linenumbers | true |
---|
|
const task = new SimpleRecord('task');
task.get('155931135900000000');
const isDeleted = task.deleteRecord();
if (isDeleted) {
ss.info('Task with ID ' + task.sys_id + ' was deleted!');
} else {
ss.error('Errors: ' + task.getErrors());
} |
get(propertyOrValue, value)
This method loads an object from a database by the field value, or, in a specific case, by the sys_id.
Parameter(s):
Name | Type | Mandatory | Default 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 will cause an exception looking alike: "Argument 1 passed to "get()" must not be empty". |
| Y | N |
value | String | N | NULL |
Return:
Type | Description |
---|
SimpleRecord object | This method returns the SimpleRecord object from the table specified in the query. |
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | get |
---|
linenumbers | true |
---|
|
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);
} |
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | get using REM |
---|
linenumbers | true |
---|
|
const record = new SimpleRecord('task');
record.get('160638931615274614'); // Example record ID supposing to be extended with RE attributes
// record.rem_attr - an object containing information about RE attributes
ss.info(record.rem_attr.description); // In there, we have called the RE attribute as a property |
getAttributes()
This method returns an object with current record properties as keys and properties values as key values.
Return:
Type | Description |
---|
Object | The array containing attributes. |
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | getAttributes |
---|
linenumbers | true |
---|
|
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, then returns name.
Return:
Type | Description |
---|
String | Title or name. |
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | getClassDisplayValue |
---|
linenumbers | true |
---|
|
const current = new SimpleRecord('task');
current.get('163663310116371174');
ss.info(current.getClassDisplayValue());
// Info: Task |
getConditionQuery()
This method returns current query condition.
Return:
Type | Description |
---|
String | The query condition. |
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | getConditionQuery |
---|
linenumbers | true |
---|
|
const task = new SimpleRecord('task');
const condition = task.addQuery('state', '7');
condition.addOrCondition('priority', '<', '3');
ss.info('Condition before query: ' + task.getConditionQuery());
task.query();
ss.info('Condition after query: ' + task.getConditionQuery());
// Info: Condition before query: (state=7)^OR(priority<3)
// Info: Condition after query: |
getDisplayValue(property)
This method returns the displayed field value (the display_by_ref field) or record value. For example, for the reference field the entity name will be returned, but not the ID.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|
Property | String | N | NULL |
Return:
Type | Description |
---|
String | A field or record value. |
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | getDisplayValue |
---|
linenumbers | true |
---|
|
const current = new SimpleRecord('task');
current.get('163663310116371174');
ss.info(current.getDisplayValue('caller'));
ss.info(current.getValue('caller'));
// Info: John Doe
// Info: 155931135900000001 |
getErrors()
If the record creating, updating or deleting fails, then this method will display error message.
Use this method for control purposes if there any validation errors within your scripts.
Warning |
---|
Some validation errors may not be displayed within the debug process, so it is highly recommended to use this method. For example, errors in condition queries passed by methods like addEncodedQuery(condition) or similar methods can be displayed by calling this method. |
Return:
Type | Description |
---|
Array | The error value. |
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | getErrors |
---|
linenumbers | true |
---|
|
const record = new SimpleRecord('user');
const insertedRecordId = record.insert();
if (insertedRecordId == 0) {
ss.info(record.getErrors());
}
// Info: ["The \"\"First Name\" [first_name]\" field is mandatory. (record id: )",... |
getLabel(property)
This method gets the field title.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|
property | String | Y | N |
Return:
Type | Description |
---|
String | The field name. |
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | getLabel |
---|
linenumbers | true |
---|
|
const current = ss.getUser();
const fieldLabel = current.getLabel('username');
ss.addErrorMessage('Field "' + fieldLabel + '" cannot be blank');
// Field "Login" cannot be blank |
getRowCount()
This method gets the amount of items in a row.
Returns:
Type | Description |
---|
Integer | Items amount in a row specified. |
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | getRowCount |
---|
linenumbers | true |
---|
|
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:
Type | Description |
---|
String | The current table name. |
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | getTableName |
---|
linenumbers | true |
---|
|
const current = ss.getUser();
ss.info('/list/' + current.getTableName() + '/' + current.sys_id);
// Info: /list/user/155931135900000001 |
getValue(property)
This method returns the value of the object property based on its name.
If the field is of the Reference or List types, then its sys_id value returns.
Note |
---|
To speed up the script execution, use this method to get values of the fields of the Reference type instead of Dot-walking. As an example, it is preferable to use the current.getValue('reference_field') structure instead of current.reference_field.sys_id one. |
Parameter(s):
Name | Type | Mandatory | Default Value |
---|
property | String | Y | N |
Return:
Type | Description |
---|
Mixed | The string value of the object property. |
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | getValue |
---|
linenumbers | true |
---|
|
const current = ss.getUser();
const user = new SimpleRecord('user');
user.addQuery('timezone_id', current.getValue('timezone_id'));
user.query();
ss.info('Same timezone for: ' + user.getRowCount() + ' users');
// Info: Same timezone for: 36 users |
hasAttachment()
This method checks whether the record specified has an attachment or not.
Return:
Type | Description |
---|
Boolean | Method returns 'true' if the record has an attachment; otherwise, it returns 'false'. |
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | hasAttachment |
---|
linenumbers | true |
---|
|
const current = new SimpleRecord('task');
current.get('163663310116371174');
const hasAttach = current.hasAttachment();
if (!hasAttach) {
ss.addErrorMessage('File should be attached');
return;
}
current.state = '2'; // Open
current.update(); |
initialize()
This method populates all active empty fields with their predefined default values.
It works only for new records that were never saved and cannot be called repeatedly.
This method is called automatically and implicitly at the first set operation (also known as "the setter").
Return:
Type | Description |
---|
Void | This method does not return a value. |
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | initialize |
---|
linenumbers | true |
---|
|
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 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:
Type | Description |
---|
Integer | - If record was not inserted, then method returns '0' and you can get a message containing list of errors.
- As a normal case, a unique ID of the inserted record returns.
|
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | insert |
---|
linenumbers | true |
---|
|
const newTask = new SimpleRecord('task');
newTask.subject = 'Subtask';
const inserterTaskID = newTask.insert();
ss.info(`/record/task/${inserterTaskID}`);
// Info: /record/task/163675231910113745 |
isTableVcsEnabled()
This method checks whether the VCS enabled attribute is enabled against the specified table or not.
Return:
Type | Description |
---|
Boolean | This method returns the value of the is_vcs_enabled attribute of record table. |
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | isTableVcsEnabled |
---|
linenumbers | true |
---|
|
const table = new SimpleRecord('sys_db_table');
ss.info(table.isTableVcsEnabled());
// Info: true |
matchesCondition(condition)
This method checks whether the current record meets the condition in the current state.
Name | Type | Mandatory | Default Value |
---|
condition | String | N | '' |
Return:
Type | Description |
---|
Boolean | This method returns 'true' if the record meets the condition specified; otherwise; it returns 'false'. |
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | matchesCondition |
---|
linenumbers | true |
---|
|
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:
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | next |
---|
linenumbers | true |
---|
|
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 |
---|
| 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):
Name | Type | Mandatory | Default Value |
---|
column | String | Y | N |
Return:
Type | Description |
---|
Void | This method does not return a value. |
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | orderBy |
---|
linenumbers | true |
---|
|
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):
Name | Type | Mandatory | Default Value |
---|
column | String | Y | N |
Return:
Type | Description |
---|
Void | This method does not return a value. |
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | orderByDesc |
---|
linenumbers | true |
---|
|
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 from a database, based on the $this→query. After this, it fills in the record set.
Return:
Type | Description |
---|
Void | This method does not return a value. |
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | query |
---|
|
const tasks = new SimpleRecord('task');
tasks.addQuery('sys_created_at', '>', '2020-01-01');
tasks.orderBy('sys_created_at');
tasks.setLimit(5);
tasks.query();
while(tasks.next()){
ss.info('Tasks numbers: ' + tasks.number);
}
// RQTSK0000001, CHG0000004, CHG0000006, CHG0000007, CHG0000008 |
selectAttributes(attributes)
This method is intended to optimize database queries. Sometimes, it is necessary to obtain only several object fields, not the whole object. Therefore, this method was added.
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 can't save incomplete record. |
|
Name | Type | Mandatory | Default Value |
---|
attributes | String or Array | Y | N |
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:
Type | Description |
---|
SimpleRecord object | This method returns a SimpleRecord object containing attributes and values. Note |
---|
Regardless of the initial attribute set content, the returned object always contains the sys_id attribute. See code examples below for more clarity. |
|
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | selectAttributes (String) |
---|
linenumbers | true |
---|
|
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 |
---|
language | js |
---|
theme | Eclipse |
---|
title | selectAttributes (Array) |
---|
linenumbers | true |
---|
|
const record = new SimpleRecord('user');
record.selectAttributes(['email', 'username']);
record.query();
record.next();
ss.info(record.getAttributes());
// Info: {"email":"john.doe@email.com","username":"john.doe","sys_id":"162423321917274937"} |
setAbortAction(flag)
This method is used in business rules and sets a flag, indicating that the current operation (insert/update/delete) will be interrupted.
Note |
---|
Please note that the code will not be executed if it is typed after calling this method in the script body. |
Note |
---|
It is not recommended to use thismethod with async business rules. It may cause unpredictable system behavior. |
Parameter(s):
Name | Type | Mandatory | Default Value |
---|
flag | Boolean | Y | N |
Return:
Type | Description |
---|
Void | This method does not return a value. |
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | setAbortAction |
---|
linenumbers | true |
---|
|
const current = new SimpleRecord('task');
current.get('163663310116371174');
const hasAttach = current.hasAttachment();
current.setAbortAction(!hasAttach); // same as return;
current.state = '2'; // Open
current.update(); |
setLimit(maxNumRecords)
This method limits the number of records selected by SimpleRecord query methods.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|
maxNumRecords | Integer | Y | N |
Return:
Type | Description |
---|
Void | This method does not return a value. |
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | setLimit |
---|
linenumbers | true |
---|
|
const record = new SimpleRecord('user');
record.setLimit(3);
record.query();
ss.info(record.getRowCount());
// Info: 3 |
setMultipleValue(property,value)
This method sets the properties values for every entry in the current selection.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|
property | String | Y | N |
value | String | Y | N |
Return:
Type | Description |
---|
Void | This method does not return a value. |
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | setMultipleValue |
---|
linenumbers | true |
---|
|
const task = new SimpleRecord('task');
task.addQuery('state', '7'); // Draft
task.query();
ss.info(task.getRowCount());
task.setMultipleValue('state', '2'); // Open
// task.updateMultiple(); |
setValue(property, value)
This method sets the value of the field in the current record.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|
property | String | Y | N |
value | String | Y | N |
Return:
Type | Description |
---|
Void | This property does not return a value. |
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | setValue |
---|
linenumbers | true |
---|
|
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.
Name | Type | Mandatory | Default Value |
---|
enable | Boolean | N | true |
Type | Description |
---|
Void | This property does not return a value. |
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | silentMode |
---|
linenumbers | true |
---|
|
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. If the record existed before, the changes are applied. If the record did not exist before, it is inserted.
Return:
Type | Description |
---|
Integer | - 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 |
---|
language | js |
---|
theme | Eclipse |
---|
title | update |
---|
linenumbers | true |
---|
|
const current = new SimpleRecord('task');
current.get('undefined');
current.subject = 'Test';
ss.info(current.update());
ss.info(current.getErrors())
// Info: 0
// Info: ["Invalid condition query: Use only digits","Unable to update new record. Use `insert()` instead. (record id: )"] |
updateMultiple()
This method updates all the selection entries.
Return:
Type | Description |
---|
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 |
---|
language | js |
---|
theme | Eclipse |
---|
title | updateMultiple |
---|
linenumbers | true |
---|
|
const task = new SimpleRecord('task');
task.addQuery('state', '0'); // Open
task.query();
ss.info(task.getRowCount());
task.setMultipleValue('state', '10'); // Canceled
// task.updateMultiple(); |