Searching the ECS(3.0)

Owned by Former user (Deleted)
Last updated: Apr 20, 2023 by Jenni Wallin
4 min read

The Search ECS dialog allows the user to filter out and locate erroneous UDRs and batches in the ECS. Any search settings you make can also be saved as filters that you can use for future searches. The Search ECS dialog is displayed when the  Search...  option is selected in the ECS Inspector. Select  UDRs  or  Batches  to display UDR or batch specific options.

Search Options

The entries in ECS can be either UDRs or batches. Depending on the selected type, different search options are available.

Common Search Options

The following search options are available for both UDRs and batches in ECS:


Search OptionDescription

Saved filters

This field contains any saved filters you may have created. For more information about how to create a filter, see the section below, Saving Search Settings as a Filter.

Workflow

The name of the workflow that sent the entry to ECS.

Agent

The name of the agent that sent the entry to ECS.

Error Code

An Error Code that has been defined in ECS Inspector. See ECS Error Codes(3.0) for further information.

Error Case

A list displaying the Error Cases associated with the selected Error Code. If the entry is too long to fit in the field, the field can be expanded by enlarging the ECS Inspector in order to display the entire error case text.

An Error Case is a string, associated with a defined Error Code. Error Cases can only be appended via APL code:

udrAddError( <UDR>, 
    <Error Code>, 
    <Error Case> );

Note!

When  Batch  is selected, the  <UDR>  parameter is the error UDR.

MIM

It is possible to configure a workflow to send descriptive MIM values with the actual data (in the Workflow Properties window). This could be used to refine the search in ECS.

Insert Period

Use this Search option to search for UDRs or batches that were inserted into ECS during a specific time period, either by specifying a start and end time, or by using any of the predefined intervals, such as last hour, today, this week.

Reprocessing Group

Contains a list of all reprocessing groups.

Having it listed as Unassigned (UDR) or Unassigned (Batch) will list all entries not associated with any reprocessing group.

Reprocessing State

The entry state, which can be New, or Reprocessed. Only entries in state New may be collected.

Search Options for Batches

The following search options are also available when searching for Batches in ECS, along with the common search options above :


Search OptionDescription

Cancel Agent

The name of the agent that cancelled the batch.

Cancel Message

The error message that was sent as an argument with the cancelBatch function.

Error UDR Type

The type of Error UDR that can optionally be sent with a batch, containing important MIM information (or any other desired information when the UDR is populated via APL).

Search Options for UDRs

The following search options are only available when searching for UDRs in ECS, along with the common search options above :


Search OptionDescription

UDR Type

The type of UDR you want to search for.

Tag

If you have tagged any UDRs, this option can be used for displaying only UDRs with the stated tag.

Reprocessing State Change Period

Use this Search option to search for UDRs that last changed state during a specific time period, either by specifying a start and end time, or by using any of the predefined intervals, e g today, this week, etc.

Search Fields

If you select this check box, you can enter specific values for different UDR labels that you have configured, see Configuring Searchable Fields in the ECS(3.0). Only UDRs containing the specified values will then be displayed in the ECS Inspector.

Wild cards and intervals can also be used when entering the values for the fields; "*" can be used for matching any or no characters, and intervals can be set by using brackets "[ ]".

When using the * or [ ], the following rules apply:

  • Only one wild card and one interval can be used per value.

  • An interval is defined with a start value and an end value.

  • If the interval consists of the same number of digits in the start and end value, the match will be made on that number of digits, e g (a[001-002]) will match a001 but not a01.

  • If the interval consists of different number of digits in the start and end value, the match will be made on an appropriate numberof digits in the UDR, e g (a[1-20]) will match a1 and a20 but not a01 or a020.

  • Only one interval can be stated within the "[ ]".

  • The start and end values have to consist of numbers.

  • The start value cannot be larger than the end value.

  • The start value cannot have a larger amount of numbers than the end value, e g [0001-3].

If a setting for a value is not correct, an error message will be displayed as a tooltip.

In order for a UDR to pass the filter, all the defined values have to match.

Saving Search Settings as a Filter

When the search settings have been made, you can select to save these settings as a filter.

Warning!

If you have included search criteria that refers to parameters that have been defined in your system, such as error codes, tags and search fields. These filters will not work properly if you delete any of the defined parameters.


To save a filter:

  1. Set the search options you want to have and click on the Save... button.

  2. Enter a name in the ECS Filter Name field and click OK.

    The dialog will close and the new filter will appear in the Saved Filters field.

The next time you want to use the same search settings, click on the filter name in the Saved Filters field and the saved search settings will be displayed.

Hint!

Any saved filters can be renamed or deleted by selecting the filter and then clicking on the Rename or Delete buttons.