Articles in this section

How do I view a task's history and its sub-jobs?

Avatar
Stuart Hill
  • Updated
Follow

To access task history

To view further details of a task's history and its sub-jobs

 

Task history displays details of when a job was run.

From Entuity v20.0 upwards, this table updates once every minute (in earlier versions of Entuity, it updates once every 5 minutes). Note, you can specify a custom table refresh rate by adding the following configuration management variable to the [webUI] section of entuity.cfg:

[webUI]
deviceConfigHistoryPageRefreshInterval=15

Where the value is the number of seconds after which the table will refresh/update.

 

history_1.png

 

A configuration management job might not appear for a couple of minutes on the Configuration Management page after first running, so you might need to wait a little while to see it.

 

To access task history:

You can access task history from three locations:

  • in Main Menu > Administration > Configuration Management > History. Each completed or running job is a separate row in the task history table. Select your preferred job and click Details to view a summary of each sub-job.

    history_3.png

  • After submitting a job, Entuity displays an information dialog at the top of the page that includes a link to the History tab. If you click on the link, it opens the History tab and displays only that newly submitted job.

    f_9.png

  • Under the Tasks tab and Schedule tab, click History to display a history of the tasks and scheduled jobs respectively.

    history_2.png

Under the History tab of the Configuration Management page are a set of filters for what is displayed in the task history table below.

  1. To change the filters, click on the hyperlinked value beside each filter.
  2. A selection window will open. Use the arrows to move selected parameters between Unselected Status and Selected Status.
The filters are as follows:
 
Filter Name Filter Description
Server server on which the task is defined.
From time when the job was dispatched to the Script Engine. The job may then be executed or it may be queued.
To time of the last update from a server processing a sub-job associated with this job. The progress of sub-jobs is checked every 5 minutes.
Category indicates how the job was called, either Manual or Scheduled.
Task filters all jobs associated with the selected task or tasks
Context filters on the target object of the task, i.e. Device, Port, All.
User user who ran the task. Select one or more usernames.
Status job status, i.e. Dispatching, In Progress, Failed, Succeeded.
 
You can sort the columns in the task history table for all tasks into ascending and descending order by clicking on the column heading. The columns are as follows:
 
Column Name Column Description
Dispatch Time time when the job was dispatched to the Script Engine. The job may then be executed or it may be queued.
Last Updated time of the last update from a server processing a sub-job associated with this job. The progress of sub-jobs is checked every 5 minutes.
Category indicates how the job was called, either Manual or Scheduled.
Task task name.
Job Summary additional information on the job status.
Context context against which the job is run, e.g. device or port.
Status job status, i.e. Dispatching, In Progress, Failed, Succeeded.
JobID unique identifier of the run job for that particular Entuity server.

Entuity retains the task history for all run jobs for 30 days. This can be edited through entuity.cfg.

 

To view further details of a task's history and its sub-jobs:

  1. Navigate to the task history table under the History tab on the Configuration Management page.
  2. Select the task that you want to view details for, and click Details at the top of the page (or via the Overflow Menu or right click Context Menu).

    c_9.png

  3. This will open the Details for Task page for the selected task.



    This page contains two tables:
    • The top table (Dispatched Jobs) contains a summary of the selected task.
    • The bottom table (Sub Jobs) a summary of a sub-jobs associated with the selected task.
The details in the Sub Jobs table are as follows:
 
Column Name Column Description
Target target against which the sub-job is run, e.g. device display name of the object against which the sub-job is run.
Started time the sub-job started.
Finished time the sub-job finished.
Last Updated time of the last update from a server processing a sub-job associated with this job. The progress of sub-jobs is checked every 5 minutes.
Server server on which the sub-job is run. A sub-job is run on the server that manages the target object, i.e. device or port.
Status status of the sub-job, i.e. In_Progress, Failed, Succeeded.
*Output the returned feedback from the interaction.
*Errors details of sub-job failure, e.g. an error in the Groovy Script or credentials.

 

*Note, to view Output and Errors, select the desired sub-job and click Details at the top of the page (or via the Overflow Menu or right click Context Menu).

 

c_11.png

 

The Details form will open, which displays these two fields.

 

 

 

You can also view Diagnostic Data for a sub job from this page, displayed in a form on the right of the page:

 

c_13.png

Related articles

Comments

0 comments

Please sign in to leave a comment.