9.24.4.6 ECS Error Codes

With the Error Codes option, errors can be specified in the ECS and associated with both UDRs and batches. A reprocessing group can also be assigned an Error Code, and when an entity is inserted in the ECS it will thereby automatically be available for collection by the ECS Collection agent.

There are two predefined Error Codes within the system, AGGR_UNMATCHED_UDR and DUPLICATE_UDR, which are automatically set by the Aggregation and Duplicate UDR Detection agents when the corresponding error condition is detected. All other Error Codes are defined by the user.

Apart from being accessible in the ECS Inspector, the error codes will also be used in ECS Statistics, see 9.24.5 ECS Statistics, and 4.3.22 ECS Statistics Event.

Note!

Several Error Codes can be attached to the same UDR. This will affect the ECS Statistics output. For further information, see Error Code Search 9.24.5 ECS Statistics.


To create an Error Code, select Error Codes... from the Edit menu. This will display the ECS Error Code dialog.

ECS Error Code dialog


Selecting Add will open the Add ECS Error Code dialog. This is where assignments of new Error Codes are made.

ECS Error Code dialog


SettingDescription

Error Code

The Error Code that will be attached to UDRs or batches.

Description

A description of the error code.

RP Group

The reprocessing group that the Error Code will be assigned to.

A user may send optional information to the ECS from an Analysis or an Aggregation agent, as long as an Error Code has been defined. To this Error Code, any information may be appended using APL. See the example below.


Example - Error case appended using APL

An Error Case can be appended using APL code.

udrAddError( input, "CALL ID ERROR",  
     "The callId: " 
     + input.callId 
     + ", Calling number: " 
     + input.anum
    );

In this example the "CALL ID ERROR" is defined in the ECS Error Code dialog, found in the Edit menu in the ECS Inspector.

Note!

To clear the errors for a UDR the udrClearErrors function should be used. For further information, see the example, Reassigning to a Different Reprocessing Group, in 9.24.6.2 ECS Collection Workflow.