Schedulers
Create, update, delete, and query schedulers.
Table Specific Information
Select
You can query the Schedulers table using any criteria in the WHERE clause. The add-in will use the SuiteCRM API to filter the results.
SELECT * FROM Schedulers WHERE [Last Successful Run] > '2017-07-16'
Insert
Create a Scheduler by specifying any writable column.
INSERT INTO Schedulers ([Job Name], Interval, [Date Time Start], [Date Time End]) VALUES ('Test Account', '0::0::*::*::*', '2017-06-16', '2017-08-16')
Update
You can update any Scheduler column that is writable, by specifying the Id.
UPDATE Schedulers SET [Active From] = '09:00', [Active To] = '15:00' WHERE Id = 'Test123'
Delete
Remove a Scheduler by specifying the Id.
DELETE FROM Schedulers WHERE Id = 10003
Columns
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
The unique identifier of the scheduler. |
| ActiveFrom | String | False |
The time the scheduler begins to be active per day. |
| ActiveTo | String | False |
Time the scheduler stops being active per day. |
| AdvancedOptions | Bool | True |
Whether there are advanced options for the interval. |
| CreatedById | String | True |
The Id of the user who created the record. |
| CreatedByName | String | True |
The name of the user who created the record. |
| DateTimeEnd | Datetime | False |
The end date and time. |
| DateTimeStart | Datetime | False |
The start date and time. |
| DateCreated | Datetime | True |
The date the record was created. |
| DateModified | Datetime | True |
The date the record was last modified. |
| Deleted | Bool | False |
The record deletion indicator. |
| ExecuteIfMissed | Bool | False |
Whether the scheduler will catch up. |
| Interval | String | False |
The job interval expressed in standard crontab notation |
| Job | String | False |
The job. |
| JobFunction | String | True |
The job function. |
| JobName | String | False |
The name of the scheduler. |
| JobURL | String | True |
The job URL. |
| LastSuccessfulRun | Datetime | False |
The last run time of the scheduler. |
| ModifiedById | String | True |
The Id of the user who last modified the record. |
| ModifiedByName | String | True |
The name of the user who last modified the record. |
| Status | String | False |
The status of the scheduler. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| Rows@Next | String |
Identifier for the next page of results. Do not set this value manually. |