Monitoring Processing Jobs

This article provides guidance on monitoring processing jobs within the Environment Module. It covers key actions such as refreshing the processing job list, navigating the processing environment, managing job statuses, and reviewing job errors.

1. Refresh – To see any Processing Job value in the Environment Module update to its most current status, click the Refresh button.

2. Environment Module Navigation – The Environment Module Navigation consists of four scoping mechanisms, which are explained below. When selected the Processing Jobs that are contained within the scope will be displayed within the Processing Jobs tab.

   • IN PROGRESS – Click the IN PROGRESS scope to see a list of all Processing Jobs that are currently being distributed out to the Discovery Agents. This is the default view of the Environment Module.

   • PENDING – Click the PENDING scope to see a list of all Processing Jobs that are waiting to be distributed to the Discovery Agents.

   • PAUSED – Click the PAUSED scope to see a list of all Processing Jobs that have been paused. A Processing Job might be paused while in progress to make way for higher priority Processing Jobs. Paused jobs can be resumed at any time and will pick back up at the location from where the job was paused.

   • ERRORED – Click the ERRORED scope to see a list of all Processing Jobs that errored when distributed to the Discovery Agents.

   • SUCCESS – Click the SUCCESS scope to see a list of all Processing Jobs that have been successfully completed.

     Note

     If a Processing Job is ERRORED, it is recommended to delete the job by clicking the Delete Job button. If the job is an Analytics Job, the values for the Analytics will need to be deleted from the project within the Analytics Module, and a new Analytics Job will need to be created for all applicable scopes again.

3. Processing Jobs Table – The Processing Jobs tab displays a table listing Processing Jobs according to the scope that is chosen within the Environment Module Navigation Section. The Processing Jobs table consists of thirteen columns explained below. To add or remove columns from the Processing Jobs tab, right click on a column header in the table and choose Column Chooser; column headings may be dragged between the table and the Chooser box to add or remove display columns. To update the values in this table to the latest values, click the Refresh button. To see the Discovery Agents that are currently allocated to Processing Jobs select the Processing Machines tab next to the Processing Jobs tab and a list of all allocated Discovery Agents will be displayed.

   • Job ID – The ID of the Processing Job.

   • Client Name – The client under which the Processing Job was created.

   • Project Name – The project under which the Processing Job was created.

   • Job Type – The Job Type of the Processing Job.

   • Status – The status of a Processing Job can be any one of the following five values reflected in the Environment Module Navigation, which may be used to filter the display of all statuses.

     • IN PROGRESS

     • PENDING

     • PAUSED

     • ERRORED

     • SUCCESS

   • Status Message – Any further information on the status of the Processing job; an Export job, for example, might say SUCCESS.

   • Job Name – The verbose name of the Processing Job in the format Type:Name.

   • Total Docs – The total number of files within the Processing Job.

   • Start Time – The start time of the Processing Job.

   • Stop Time – The stop time of the Processing Job.

   • Allocated Docs – The total number of files currently assigned to the Discovery Agents.

   • Created Time – The time the Processing Job was created. This will differ from the Start Time when a Processing Job cannot be immediately distributed to the Discovery Agents and thus has spent a period within the pending status.

   • ProjectID – The ID of the project.

4. Pause Job – To pause a Processing Job that is currently in progress and move it to status pending, click the checkbox   next to the Processing Job and click the Pause Job button in the Environment Ribbon.

5. Resume Job – To resume a paused job, click the PENDING scope, click the checkbox   next to the Processing Job, and click the Resume Job button in the Environment Ribbon.

6. Delete Job – To delete a Processing Job, click the checkbox to choose the Processing Job and click the Delete Job button.

   Note

   Certain jobs cannot be deleted here, for example Analytics Jobs. If the Processing Job cannot be deleted, and it is an Analytics Job, the values for the Analytics will need to be deleted from the project within the Analytics Module, and a new Analytics Job will need to be created for all applicable scopes again.

7. Job Status Chart – This auto-refreshing chart will provide more details about the status of the Processing Job, when the Processing Job is selected.

8. Processing Job Error Table – If a Processing Job has any logged errors, the error(s) will be displayed in this table.