Skip to main content

xSuite Interface Windows Prism 5.x – Online Help

  • xSuite Interface Windows Prism 5.x – Online Help
  • Web Applications
  • The Status Monitor

The Status Monitor

The Status Monitor is a web-based user interface that you can use to monitor the current processing status of the data that is read into xSuite Interface.

Calling up the Status Monitor

Notice

To use the Status Monitor, the status web service must be activated in global configuration.

The address for calling up the Status Monitor always ends with the fixed URL path /Status. The formulation of the base address and the base path depends on the configuration at hand (see Web Services):

{base address}/{base path}/Status

The following URL parameters can also be specified in the address:

Parameter

Description

ExpertMode

Activates expert mode when set to true.

The expert mode allows both read and edit access to the data.

This mode primarily serves the purposes of development and error analysis.

Develop

Activates "Develop" mode when set to true.

This mode primarily serves the purposes of development and error analysis.

Filter

Transfers a search filter for the batches to be displayed.

Syntactically, only simple expressions in the form {Property}{Operator}{Value} are supported at this point.

  • {Property}: technical name of the field in the database

  • {Operator}: an equals sign (=) by default or alternatively for number and date fields > or < for the lower or upper limits of a range search

  • {Value}: the same form as for manual input via the user interface (i.e., date values having the syntax yyyy-MM-dd or yyyy-MM-dd HH:mm:ss, for example)

To specify a combination of search filters, reiterate the Filter parameter. All sub-filters that refer to different batch properties are implicitly AND-linked. The same applies to upper and lower limit specifications for the same property. In the case of selection lists whose individual list values are also to be transferred as separate Filter parameters, however, these values are OR-linked. With an expression such as ?Filter=Status=Error&Filter=Status=Suspended, for example, you can search for batches with the status "Error" OR "Suspended."

OnlyErrors

If set to true, activates a mode displaying only those batches with an error status or containing documents with errors.

Alternatively, this mode can also be activated in the user interface in the Batches area (ButtonAddFilter.png button → Errors only).

FieldFilter

Transfers a search filter at field level.

This kind of search filter can be used to display only batches that contain documents with a certain value in a field of their field catalog.

To search in a specific field, use the syntax {field name}={value}. To search in all fields, specify the value only. The syntax of the value corresponds to the syntax of a literal (constant value).

A call with additional parameters might look like the following example:

.../Status?ExpertMode=true&Filter=Scenario=Testscenario

Tenant Selection

A selection list of tenants is available in the title bar of the Status Monitor. With this selection list, the user can switch from one tenant-specific database to another. When a database is selected, its contents will be displayed in the Status Monitor. As a prerequisite for this, multiple tenants will be managed in accordance with the configuration on the server side.

beschriftung_interface_statusmonitor_mandantenauswahl.png

Depending on the configuration, the Global entry will be available for selection in multi-tenant mode. If the user selects this entry, only those log entries that are global and independent of tenant will be displayed in the Status Monitor.

In this section: