Skip to main content

Jobs

Each action performed in Workspaces generates a job. The jobs allow analyzing the outcome of the executions performed, for example by checking the output of a microservice execution, while the Jobs section collects all jobs performed in the organization, thus also providing historical records of executions, which can be used as an audit log.

List view​

jobs The jobs view consists of the following elements:

  • Options in the top part of the interface.
  • Jobs list view.

Options at the top​

  • Refresh the Jobs list to display updated values.
  • Reset 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 that are in the Pending state.
  • 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 access to predefined or user-created Filters.
  • Jobs can be filtered by any parameter in the Jobs list in the Search box.

Jobs list​

The jobs list, like all Workspaces list views, allows multiple filtering and customization options, defined in Filtering options in the listings

Detail view​

jobdetail The detail view includes a progress bar that indicates the percentage of completion.

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 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 logging any information. In that case, its state will automatically change to Error. However, this does not mean that the job will not be successfully completed. It means there is a timeout due to activity blocking 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 records tab allows consulting data for each step of the execution, for example, when a microservice is executed on a device and one wants to verify the execution output of the script, this information is stored in the corresponding step (log entry in the list).

To improve the visibility of script output, it is recommended to use the "Write-Output" command instead of "Write-Host" for PowerShell scripts, more information in Considerations about 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(s) from the list and activate the Send notification button.