Jobs
Each action performed in Workspaces generates a Job
. These allow analyzing the results of the executions performed; for example, by checking the output of a microservice execution. Jobs
gathers all the jobs performed in the organization, so it also provides historical execution records, 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
Top options
- Refresh the job list and show updated values.
- Resets all settings made for the jobs view.
- Filter jobs by age:
- Today (default filter)
- This week
- This month
- This quarter
- This year
- The
Cancel
button allows canceling jobs in pending status. - The
Notify
button allows you to subscribe to a specific job to receive an email notification when it is completed. - The
Export to
button allows exporting in the selected type. - The
My filters
button allows access toPredefined filters
or user-created filters. - Jobs can be filtered by any parameter in the list in the
Search
box.
Jobs list
The job list, like all list views in Workspaces, allows multiple filtering and customization options as defined in Filtering Options in Listings.
Detail view
The detail view includes a progress bar indicating the percentage of the job that has already been executed.
Statuses
A job can have four statuses:
- Pending: the task is pending to start.
- In progress: the task has started and is still in process.
- Completed: the task has finished.
- Error: the task did not finish correctly or ended with errors.
- Canceled by the 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 recording any information. In that case, its state will automatically change to Error
. However, this does not mean that the job will not be completed successfully, but there is a timeout due to an activity block during the task execution.
Available information
In all cases, jobs include the following information:
- Change to be made (INFO)
- State
- Created date
- Start Date
- End Date
- User who made the change (OWNER)
At the bottom of the screen, depending on the type of job, the following tabs may appear:
Logs
The logs tab allows consulting the data of each step in the execution; for example, when a microservice is executed on a device and you want to check the script execution output. 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 ofWrite-Host
. More information at Considerations about the code to use.
Workspaces
The Workspaces
tab allows you to easily see the information of the devices that executed the job, in case of multiple executions.
Job subscription
This feature allows subscribing to specific jobs, that have not yet started or are in progress. The system will notify by email when they are completed.
To subscribe, select the jobs from the list and activate the Send notification
button.