Image Modified

udrAddError

Adds an error description message to the UDR, which will be visible when searching using the Data Veracity web interface or ECS Inspector, Error Code column. A UDR can have several error descriptions.

...

Removes all error descriptions, added to a UDR in Data Veracity or ECS. For ECS, this is useful when collecting UDRs for a new validation which may send them back to the ECS for another round of processing. Adding a new error description, if one already exists, will make it impossible to auto-assign the UDR to a reprocessing group when it arrives to the ECS.

...

Clones a UDR. It is used when having multiple routes leaving the agent, where any of the routes changes the content of a UDR. For complex UDR structures, this can be a heavy operation, and must be used with care.

...

Returns true if an error description has been added to the UDR.

...

Creates a new UDR of the specified type. All fields are included, except for the optional.

...

Decodes a bytearray into a list of UDRs, and returns an error message if the operation fails. To route the UDRs to a subsequent agent, loop through the resulting list routing each element individually.

...

list<drudr> myList = listCreate(drudr);

if (udrDecode("myFolder.myFormat.myDecoder", 
 myList, input) == null) {
 // Do something
} else {
 // Error handling
}

udrEncode

Encodes a UDR.

bytearray udrEncode
 ( string  encoderName ,
 drudr  myUDR  )

...

udrForceDecode

By default, a Decoder only evaluates record sizes and field termination marks. It does not read the field values to evaluate for validity. This is done for each field when it is actually accessed, either from a agent utilizing APL code, or from an Encoder.

...

udrGetErrorCodes

Returns a list of strings containing all error codes added to the UDR.

...

Returns a list of strings containing all error messages added to the UDR.

...

Returns a string containing all error information that has been added to the UDR.

...

udrGetFields

Returns a list of the field names and field information in a UDR.

...

Returns the value of fieldName in the myUDR.

...

Returns true if the UDR field is present.

...

if ( udrIsPresent( input.fieldA.fieldB.myField ) ) {
 // Some kind of operation.
}

The udrMass functions enable you to manage a decoder which purpose is to process large amounts of collected UDRs, while maintaining control over UDRs tailing bytes in between calls to consume .

...

• udrMassCreateDecoder

• udrMassClearBuffer

• udrMassDecode

• udrMassEOFCheck

• udrMassGetDataTail
   

udrMassCreateDecoder

Creates a decoder object.

...

any myDecoder;
initialize { 
 myDecoder = udrMassCreateDecoder("Default.ascii.asciiFile"); 
}
drain { 
 list<drudr> myList = listCreate(drudr); 
 string msg = udrMassEOFCheck(myDecoder, myList, false); 
 if (msg == null) {
 // Do something 
 } else { 
 // Error handling 
 } 
}
consume { 
 list<drudr> myList = listCreate(drudr); 
 string msg = udrMassDecode(myDecoder, myList, input, false); 
 if (msg == null) { 
 // Do something 
 } else { 
 // Error handling 
 } 
}

udrMassClearBuffer

The udrMassClearBuffer function clears the remaining buffer in the decoder.

...

The udrMassDecode function Decodes the bytearray input data by using the decoder, and generates it as a list.

...

udrMassEOFCheck

The udrMassEOFCheck function attempts to decode any remaining bytes that are left behind and stored in the decoder. If the function executes and decoding is successful, the procedure sends endBatch to the decoder, the returned string is empty, and the myList parameter contains the UDRs. Otherwise, an error message is generated.

...

The  udrMassGetDataTail function makes the decoder generate the remaining bytes that it holds. The bytes are still stored in the decoder.

...

The udrRoute function sends a UDR to a workflow route.

...

Sets the field named fieldName in the UDR myUDR to value .

...

In the output files the Encoder maps by default, null fields as present but empty. This can be avoided by clearing a flag, Is Present, using the udrUnsetPresent function.

...