Scheduled Script

You can schedule a script execution to perform them on a regular basis with a specified periodicity. 

To create a scheduled script job, complete the steps below:

1. Navigate to System Scheduler → Schedule Script.
2. Click New and fill in the fields.
3. Click Save or Save and Exit to apply changes.

Schedule script form fields

As an alternative to scheduled scripts, use system events. In the system event scripts, the planning of a future event and the execution of the main script (which is specified in the Script field of Schedule script) is performed. See the Events article to learn more.

Features of configuring schedule scripts

1. Before creating a script for changing/deleting configuration records, create a separate user in the User table and install the desired application.

   Example Expand source

   (function executeScheduleScript() {
     const ITSM_APPLICATION = '156950344216170038';
     const RUN_AS_USER_ID = '155964310500000026'; // Schedule script -> Run as -> ID
     const preference = new SimpleRecord('sys_user_preference');
     preference.addQuery('name', 'application');
     preference.addQuery('user_id', RUN_AS_USER_ID);
     preference.setLimit(1);
     preference.query();
     if (preference.next()) {
       preference.value = ITSM_APPLICATION;
       preference.update();
     } else {
       preference.user_id = RUN_AS_USER_ID;
       preference.name = 'application';
       preference.value = ITSM_APPLICATION;
       preference.insert();
     }
     // update/delete vcs enabled records ...
   })()

2. You cannot use the getAccessToken() method to get the token of the current user (specified in the Run as field) in the script body. ​​​​​​To get a token, use a sample:
   
   

   Example Expand source

   const tokenRec = new SimpleRecord('user_token');
   tokenRec.addQuery('user_id', '155964310500000026'); // Schedule script -> Run as -> ID
   tokenRec.orderByDesc('sys_created_at');
   tokenRec.setLimit(1);
   tokenRec.query();
   tokenRec.next();
   const tokenValue = tokenRec.token;

3. Create scheduled scripts in an inactive state. Once the script configuration is complete, change the activity via a script form.
4. Transfer scripts between instances in an inactive state.

Non-standard use cases of schedule scripts

When executing a server script with updating many records, the 504 message may occur. The error is related to the execution time limit for REST requests (Time Out).

Use a scheduled script for updating part of the records. The script example:

const MESSAGE_PREFIX = '[Update User Records]';
const TABLE_NAME = 'user';
const TABLE_QUERY_CONDITION = '(field_name!=field_value)'; // query condition
const QUERY_LIMIT = 500;
 
let lastRecord = '1';
const lastTwoMinutes = new SimpleDateTime();
lastTwoMinutes.addSeconds(-120); // 2 minutes
const logMessage = new SimpleRecord('sys_log');
logMessage.addQuery('level', 'debug');  // debug level
logMessage.addQuery('sys_created_at', '>', lastTwoMinutes.getValue());
logMessage.addQuery('message', 'startswith', MESSAGE_PREFIX);
logMessage.orderByDesc('sys_created_at');
logMessage.setLimit(1); // newest record
logMessage.selectAttributes('message');
logMessage.query();
if (logMessage.next()) {
  if (logMessage.message.match(/(?<=Last record: )(\d{18})/g)) {
    lastRecord = logMessage.message.match(/(?<=Last record: )(\d{18})/g)[0];
  }
}
ss.debug(`${MESSAGE_PREFIX}\nLast record: ${lastRecord}`);
 
const record = new SimpleRecord(TABLE_NAME);
record.orderBy('sys_id');
record.addQuery('sys_id', '>', lastRecord);
record.addEncodedQuery(TABLE_QUERY_CONDITION);
record.setLimit(QUERY_LIMIT);
record.query();
let updatedRecords = [];
while (record.next()) {
  lastRecord = record.sys_id;
  // record.field_name = 'field_value';
  const updatedRecordId = record.update();
  if (updatedRecordId) {
    updatedRecords.push(updatedRecordId);
  }
}
ss.debug(`Last record: ${lastRecord}`);
ss.info(`${updatedRecords.length} records updated:\n\n${JSON.stringify(updatedRecords, null, 2)}`);

• Instead of line 33 of the script, specify the setting of the values of the record in the TABLE_NAME table.
• Before setting the frequency of the scheduled script launches and setting the final QUERY_LIMIT sample size, it is necessary to determine the approximate duration of one update cycle.