Jobs
Each action undertaken in Workspaces generates a job; jobs allow for the analysis of the outcomes of completed executions, for example, by consulting the output of a microservice execution. At the same time, the Jobs
section collects all the jobs carried out in the organization, thus providing historical records of executions, which allows it to be used as an audit log.
List view
The jobs view consists of the following elements:
- Options at the top of the interface.
- Job list view.
Options at the top
- Update the Job list and display the updated values.
- Reset all the adjustments made for the "jobs" view.
- Filter jobs by age:
- Today (default filter)
- This week.
- This month.
- This quarter.
- This year.
- The
Cancel
button allows you to cancel Jobs in Pending status. - The
Notify
button allows subscribing to a specific Job to receive an email notification when the job is completed. - The
Export to
button allows exporting in the selected type. - The
My Filters
button allows you to access pre-defined or user-created Filters. - Jobs can be filtered by any parameter in the Job list in the
Search
box.
Jobs list
The job list, like all Workspace list views, allows multiple filtering and customization options, defined in Filter options in the listings
Detail view
The detail view includes a progress bar indicating the percentage that has already been completed.
States
A job can have four states:
- Pending: the task is awaiting to be started.
- In progress: the task has started and is still in process.
- Completed: the task has finished.
- Error: the task did not finish correctly or finished with errors.
- Canceled by User: when a user cancels the task.
- Completed with errors: When the task has been completed, but at least one step failed with non-critical errors.
Suppose a Job takes too long in the "in progress" state without logging any information. In that case, its status will automatically change to Error. However, this does not mean that the job will not be completed successfully. It means there is a timeout due to an activity block during the task execution.
Information available
In all cases, jobs include the following information:
- The change to be made (INFO)
- The state
- Creation date
- Start date
- End date
- The user who made the change (OWNER)
At the bottom of the screen, depending on the type of job, the following tabs may appear:
Records
The logs tab allows consulting the data for each step in the execution, for example when a microservice is run on a device and you want to verify the output of the script execution, this information is saved in the corresponding step (log line in list).
To improve the visibility of script outputs, it is recommended, in the case of PowerShell scripts, to use the "Write-Output" command instead of "Write-Host"; more information in Considerations on the code to use
Workspaces
The Workspaces
tab allows easily viewing information about the devices that executed the job in the case of multiple executions.
Job Subscription
This feature allows subscribing to specific jobs, meaning that the system will notify you by email when they are completed.
It is only possible to subscribe to jobs that have not yet started or are in progress.
To subscribe, you must select the job or jobs from the list and activate the Send notification
button.