Skip to main content

xSuite Interface Windows Prism 5.x – Online Help

The "Batches" Tab

The Batches tab lists the batches that are available in the administrative database. Each row represents a batch. The individual properties of the batches are displayed in the columns.

Expert Mode

Expert mode is only available to users who have the necessary authorizations. Expert mode can be activated or deactivated using the Expert mode button.

beschriftung_interface_statusmonitor_expertenmodus.png

With activated expert mode, you have 2 additional buttons at your disposal. The ButtonResetStatus.png button allows batches to be reset, and the ButtonJson.png button displays the raw JSON data (see Buttons).

Buttons

The following buttons are available in the menu bar of the Batches area:

Button

Description

ButtonRefresh.png

Refreshes the batch view. The batch information is reloaded from the database.

interface_statusmonitor_aktualisierungszeit.png

Hovering over the button with the mouse will open a window in which the checkbox Auto-reload batch list every 30 seconds can be activated. When you have activated the automatic refresh, you can use the slider to specify the refresh interval. This automatic refresh will only apply until you have executed an action in the table.

ButtonResetStatus.png

Resets batch status for batches that have the status "Error."

To use the reset function, first select the batches that that have the "Error" status, by ticking the checkboxes in the first column of the table. A renewed attempt will then be made to process these batches.

There are two different ways that a batch is reset:

  • A batch-related processing error has occurred. The status of the batch is reset.

    This only applies to those steps in which the batch is processed in its entirety (i.e., the "Input" step and the "Backup" step).

  • One or more document-related processing errors have occurred. The status of all faulty documents within the batch is reset.

    In this case, you as the user can restart document processing either in the "Process" step or in the "Output" step. Processing can only be started in the "Output" step if the documents have already passed through the "Process" step. If you choose to restart processing in the "Output" step, you must also specify whether it is started in the first sub-step or in the step in which processing was aborted.

    Notice

    Depending on the respective processing scenario, a restart in the first step of the "Process" step can lead to the creation of a duplicate in the target system. This is the case if the first step has already been successfully completed in the previous run.

Notice

This button is only available in expert mode.

ButtonDelete.png

Deletes the selected batches from the database.

Optionally, the associated file attachments can also be removed from temporary storage.

Notice

When deleting batches, the associated file attachments should be removed from temporary storage.

ButtonClearFilter.png

Removes all filters set.

After removing the filters, all existing data records will be displayed in the batch view.

ButtonAddFilter.png

Activates a filter.

The following filters are available:

interface_statusmonitor_filter.png

  • Errors only: in the batch view, only those batches with an error status or containing documents with errors will be displayed.

  • Field content: in the batch view, only those batches will be displayed that contain documents with a specific value in a specific field of the field catalog. If no field name is specified, the search will span all fields. If, before setting this filter, you have selected a batch, then a selection list will appear, showing the fields available for this batch.

These filters can be used in combination with column filters. All active filters will be displayed in the toolbar.

beschriftung_interface_statusmonitor_aktive_filter.png

To display the value of a Field content filter set, click the IconFieldFilter.png button.

ButtonJson.png

Opens data in batch view in JSON format.

The display of the raw JSON data enables a view of the internal structure of a document object as it is stored in MongoDB as an administrative database.

Notice

This button is only available in expert mode.

The following buttons always refer to a single data record and are displayed in the final column of the table:

Button

Description

ButtonViewDoc.png

Displays a detail view of the batch to the right of the table.

You can also access the detailed view by clicking on the batch data record.

ButtonViewProtocol.png

Displays the log table.

This implicitly sets a filter for selecting the data records connected to the respective batch.

ButtonDelete.png

Deletes a batch.

ButtonResetStatus.png

Resets a faulty batch.

Detail View

The detailed view (ButtonViewDoc.png button) is a tree structure displaying documents in a batch. For each document, you can see the index fields, the file attachments, and the processing history.

For index fields, you can see the header data fields and the item data fields. For file attachments, you can see original attachments from an input interface and attachments that were extracted or generated during downstream processing.

The following buttons are available in the detailed view of a batch:

Button

Description

ButtonRefresh.png

Updates the data in the detailed view.

ButtonExpandAll.png

Expands the entire tree and remembers this setting for subsequent open batch trees.

ButtonExpand.png

Expands all elements in the detailed view.

ButtonCollapse.png

Collapses all elements in the detailed view.

ButtonClose.png

Closes the detailed view.

In this section: