ECS Inspector Table(3.3)

Owned by Jenni Wallin
Oct 02, 2023
4 min read

Once the search is performed and matches are found the table in the ECS Inspector will be populated. Each row represents one UDR or one batch.

Note!

The ECS Inspector caches the result when the user populates a list (for instance the Error Codes). This is done to avoid unnecessary population of workflow names, agent names and error codes since it is costly in terms of performance. You have to click on the Refresh button in order to repopulate the search window.

Columns

The following columns are available in the ECS Inspector Table:


ColumnDescription

#

The table sequence number.

Db ID

A sequence number, automatically assigned to an entry.

Insert Time

Date and time when the entry was inserted in the ECS.

Workflow

Name of the workflow from which the data was sent.

Agent

Name of the agent that sent the entry to ECS. For UDRs, this will be the ECS forwarding agent and for batches a collection agent.

UDR Type

This column is only available when you have selected to view UDRs and displays the UDR type.

Cancel Agent

This column is only available when you have selected to view batches and displays the name of the agent that issued the cancelBatch request.

Cancel Message

This column is only available when you have selected to view batches and displays the message sent with the cancel request. The following example shows a user defined request, defined with APL using an Analysis agent:


Example - A user defined request, defined using APL

cancelBatch("undefined_number_prefixes.");

Error Code

The Error Code as defined in ECS.

Error UDR

This column is only available when you have selected to view batches and displays the type of the Error UDR associated with the batch. If you double-click on a table cell in this column, information about the whole Error UDR will be shown. The Error UDR is populated either from the Workflow Properties dialog (see the figure below, Workflow Properties dialog, Error tab), or from an agent using APL (see the figure, ECS collection configuration dialog, in ECS Collection Agent Configuration(3.3)). It can contain useful information which is needed in a workflow reprocessing a batch. The fields of the Error UDR will automatically appear as MIM values in the reprocessing workflow.



Example - ErrorUDR

myErrorUDR eUDR = udrCreate( myErrorUDR );
eUDR.noOfUDRs = (long)mimGet( 
   "IN", "Outbound UDRs" );
udrAddError( eUDR, 
             "nokSOURCE", 
             "Switch not found." );
cancelBatch( "Incorrect source.", eUDR );
The error UDR format is defined as any other format from the Ultra Format Editor.
internal myErrorUDR{
    long noOfUDRs;
};

RP Group

Shows the reprocessing group that the entry is assigned to, if any. Assignments can be made both manually and automatically. In the latter case, an Error Code must be mapped to a reprocessing group.

RP State

Initially, an entry has the reprocessing state, New, that is the entry has not been reprocessed. In order for it to be collectible, it has to be assigned to a reprocessing group. When collected by an ECS collection agent, the state is changed to Reprocessed.

Note!

Only entries in state New may be collected by the ECS collection agent. The state can manually be changed back to New if this is necessary. Only entries set to Reprocessed can be removed.

MIM Values

Double-clicking this field will display a new dialog, listing the MIM values. MIM values to be associated with the entry are configured differently for the two types of entries:

  • Batch - From the Workflow Properties dialog.

  • UDR - From the ECS forwarding agent.

Tags

This column is only available when viewing UDRs and will display any tags that have been set on the UDRs.

Last RP State Change

This column displays the timestamp for when the reprocessing state was last changed. The first time a UDR is sent to ECS, it will be in reprocessing state New, and this column will display the timestamp for when the UDR was inserted into ECS. When the UDR is collected for reprocessing or if the state is changed manually in the ECS Inspector, this column will be updated with the current timestamp.

<search field label(s)>

The labels for any search fields you may have configured will be displayed as individual columns. These will only be available when viewing UDRs.

See Configuring Searchable Fields in the ECS(3.3) for further information about configuring searchable fields.

Tagging UDR

When having made a search for UDRs, you can select specific UDRs that are of interest, tag them and then save a filter based on the tag, which will display only the tagged UDRs whenever the filter is used.

Warning!

If you remove the tag that you have stated in the filter, the filter will not work properly.


To tag UDRs and save as a filter:


  1. After having populated the ECS Inspector, select the UDRs you want to tag, click on the UDR menu and select the Set Tag on UDR(s)... option.

  2. Enter the tag name in the Tag Name field and click OK.

    The selected UDRs are now tagged.

    Hint!

    If you change your mind, the set tags can be removed by selecting the option Clear Tag(s) on UDR(s) in the right click menu.

  3. Open the Search ECS dialog by clicking on the Search... button.
     

  4. Select the Tag check box and enter the tag you want to search for in the field to the right of the check box.
     

  5. Click on the Save As... button beneath the Saved Filters field.

    A dialog opens asking you to enter a name for the filter.

    Enter a name in the Saved 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 view the tagged UDRs, select the saved filter setting when making your search and only the tagged UDRs will be displayed in the ECS Inspector.