Batch jobs report

The batch jobs report displays:

In the report you can view the status of the batch job and pause, cancel, or view the details of the job.

Only the last 7 queued days is visible. Users can view only the jobs they have added to the batch queue unless they have an administrator role. Administrators see all batch jobs.

To use the batch jobs report

  1. Do one of the following:
  • In the FDA, click the Batch jobs icon Batch job report icon.
  • In the Web Client, go to Administration > Full Administration Menu > Administration reports > Batch jobs.
  1. The following batch job information is displayed:

Column

Description

Batch ID

The batch number.

Queued time

The date and time the documents were submitted for batch processing.

Start time

The date and time the documents started to be processed.

Status

Statuses include:

  • Queued – Job is added to queue
  • Paused – Job has been postponed by user
  • In progress – Job is being currently processed
  • User action pending – Job processing is done but waiting for user actions to be performed such as view document in FileHold viewer
  • Complete – Job processing is done and there are no user actions to perform
  • Cancelled – Job has been cancelled by user
  • Error – An error occurred during job processing

User name

The user who submitted the batch job to the queue.

Batch job name

One of the following:

End time

The date and time the batch processing completed.

  1. To view the batch job details, double-click on the row.
  2. In the Manage batch job screen, the following information is displayed:
Row Description
Job status
  • Queued – Job is added to queue
  • Paused – Job has been postponed by user
  • In progress – Job is being currently processed
  • User action pending – Job processing is done but waiting for user actions to be performed such as view document in FileHold viewer
  • Batch complete – Job processing is done and there are no user actions to perform
  • Cancelled – Job has been cancelled by user
  • Error – An error occurred during job processing
Queued time The date and time the documents were submitted for batch processing.
Start time The date and time the documents started to be processed.
Complete time The date and time the batch processing completed.
Batch job name

One of the following:

User name The user who submitted the batch job to the queue.
  1. To cancel the batch job, click Cancel job.
  2. To pause the batch job, click Pause job. To resume a paused job, click Resume.
  3. To review the job settings, click Details.
  • For document assembly jobs, the job details are shown. For more information see Assembling documents.
  • For move file jobs, the following job details are shown:
Heading Description
Source The name of the location from which the documents were moved.
Destination group The name of the group to which the files were moved.
Number of files to move The number of files in the queue or were moved.
Volume of files to move The size of the files moved.
Remaining files The number of files that are still in the queue and have not yet been moved.
Remaining volume The size of the files that are still in the queue and have not yet been moved.
Actual performance How long it took to move the files to a new group.
  • For export scripts jobs, the following information is shown:
Heading Description
Export script The name of the export script.
Workflow The GUID of the workflow in which the script was executed.
Activity The activity number in the workflow that the script was executed.
Method name The method defined in the dll.
Method name The method defined in the dll.
Script parameters The parameters defined in the export script.
Workflow GUID The GUID of the workflow in which the script was executed.
Main documents The name of the main document used in the workflow.
Execution time The time that it took for the export script to execute.
  1. To view the document in the FileHold viewer (if the option was enabled for Assemble documents), click Complete User Action.
  2. To close the window, click Close.

How to manipulate the Batch Job report view

The batch jobs report can be modified to add or remove columns, resize or change the order of the columns, sort ascending or descending, filter the results, and save these different views. The displayed information can be exported out of the system in order to do further analysis on user accounts.

Function

Description

Sort ascending/descending

Click on the column header to sort ascending or descending.

Alternatively, click Column header menu icon in the column header and select Sort Ascending or Sort Descending.

An up or down arrow shows in the column header indicating the sort order.

Add or remove columns

Click Column header menu icon in the column header and select Columns. Select the check boxes for the columns to be displayed. Clear the check boxes to remove the header.

Resize columns

Hover the cursor between the column headers to resize a column.

Image
Resize column header icon

Filter

Click Column header menu icon in the column header and select Filter. Select the filter options and click Filter. The filter options available depend on what type of column is selected.

A white filter icon Column filter icon is shown in the header if the column is being filtered.

To clear the filter, go to Filter and click Clear.

Change column position

Drag and drop columns to the desired position.

Group by a column

Drag and drop a column header to top blue bar that says “Drag a column header and drop it here to group by that column”.

To remove the grouping, click the X next to the header name in the blue bar.

Image
Batch jobs report group by columns

Scroll through pages

In the bottom left corner, use the scroll settings to:

  • Go to first page
  • Go to previous page
  • Go to next page
  • Go to last page

Adjust the number of items per page: 15, 30, 60

Image
Page manipulation on report page

Refresh screen

Click Refresh in the bottom right corner.

Image
Refresh report icon