Jobs
Each action performed in Workspaces generates a Job
. These allow analyzing the result of the executions carried out; for example, by checking the output of the execution of a microservice. Jobs
gather all the jobs performed in the organization, therefore also providing historic execution logs, which allows it to be used as an audit record.
List view
The jobs view consists of the following elements:
- Top options on the interface
- Job list view
Options at the top
- Refresh the job list and display updated values.
- Reset all settings applied to the job view.
- Filter jobs by age:
- Today (default filter)
- This week
- This month
- This quarter
- This year
- The
Cancel
button allows the cancellation of jobs in a pending state. - The
Notify
button allows subscribing to a specific job to receive an email notification upon completion. - 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 from the 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 of the job that has already been executed.
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.
- Cancelled by the user: when a user cancels the task.
- Completed with errors: when the task is 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 status will automatically change to Error
. However, this does not mean that the job will not be successfully completed, but that there is a timeout due to an activity block during the task execution.
Information available
In all cases, jobs include the following information:
- Change to perform (INFO)
- Status
- Creation 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:
Records
The logs tab allows consulting the data of each step in the execution; for example, when a microservice is executed on a device and the output of the script execution needs to be verified. 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 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 subscription to specific jobs that have not yet started or are in progress. The system will notify via email when they are completed.
To subscribe, select the jobs from the list and activate the Send notification
button.