Scheduled Job
This context lets you access and manage a single scheduled job.
Unique Actions
Configure Scheduled Job
This action is used to edit Scheduled Job properties.
 | Changing Name field during this operation will cause renaming of current context. This may lead to malfunctioning of other system components that use context name/path as a primary identifier. |
Action Type: |
Execute Scheduler Job
This forces Iotellect Server to perform immediate single execution of a scheduled job in non-interactive mode.
Action Type: | |
Action Name: | execute |
Permissions: | Accessible at Manager permission level |
Common Actions
Delete, Make Copy, Replicate, Edit Context Permissions, Monitor Related Events, View Status
Context States and Icons
Icon | Code | State |
| 0 | Job is enabled |
| 1 | Job is disabled |
Advanced Information |
Context Information
Context Type: job
Context Name: provided by user
Context Description: provided by user
Context Path: users.USER_NAME.jobs.SCHEDULED_JOB_NAME
Context Mask: users.*.jobs.*
Context Permissions
Level | Description |
None | No access allowed. |
Observer | Basic event monitoring. Status browsing. |
Operator | Configuration browsing. |
Manager | Job configuration and removal. Forced job execution. |
Engineer | Same as Manager. |
Administrator | Same as Manager. |
Public Variables (Properties)
Common Variables: groupMembership (Group Membership), activeAlerts (Active Alerts)
Scheduled Job Properties
See description of the variable and its fields here.
Variable Name: | jobDetailsView |
Records: | 1 |
Permissions: | Readable at Observer permission level, writable at Manager permission level |
Record Format:
Field Name | Field Type | Notes |
name | String | 1 - 50 characters |
description | String | 1 - 50 characters |
enabled | Boolean | |
mask | String | |
action | String | |
input | Data Table | |
executeMissed | Boolean |
Simple Schedule
See description of the variable and its fields here.
Variable Name: | triggersView |
Records: | 0...unlimited |
Permissions: | Readable at Observer permission level, writable at Manager permission level |
Record Format:
Field Name | Field Type | Notes |
startTime | Date | |
endTime | Date | |
repeatCount | Integer | |
repeatInterval | Long |
Advanced Schedule
See description of the variable and its fields here.
Variable Name: | cronTriggersView |
Records: | 0...unlimited |
Permissions: | Readable at Observer permission level, writable at Manager permission level |
Record Format:
Field Name | Field Type | Notes |
dayOfMonth | Data Table | |
month | Data Table | |
dayOfWeek | Data Table | |
year | String | |
time | Date | Time-only editor is used |
startTime | Date | |
endTime | Date |
Job Status
The variable provides scheduled job status data. It is shown by View Status action.
Variable Name: | status |
Records: | 1 |
Permissions: | Readable at Observer permission level |
Record Format:
Field Name | Field Type | Notes |
previousFireTime | Date | Time elapsed since previous job execution or NULL if it was not executed yet. |
nextFireTime | Date | Time to next job execution or NULL if the job won't execute anymore. |
Public Functions
This context has no public functions.
Execute
This forces Iotellect Server to perform immediate single execution of a scheduled job in non-interactive mode. The function is synchronous, i.e. it won't exit until the job has finished execution.
Function Name: | execute |
Permissions: | Accessible at Manager permission level |
Input Records: | 0 |
Input Format: | None. |
Output Records: | 0 |
Output Format: | None. |
Public Events
Common Events: info (Information), contextStatusChanged (Status Changed)
Was this page helpful?