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.

void udrAddError ( drudr myUDR, string errorCode, string myString )

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.

void udrClearErrors( drudr myUDR )

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.

drudr udrClone( drudr  myUDR  )

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

boolean udrContainsError( drudr  myUDR  )

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

drudr udrCreate( type  UDRType  )

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.

string udrDecode
 ( string  decoderName , 
 list<drudr>  UDRlist , 
 bytearray  indata , 
 boolean  fullDecode  ) //Optional

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.

The udrForceDecode function will decode each field within a UDR. If a field is not valid, the agent will abort. This function is equal to the Full Decode option in the Decoder window. Note that the function has a negative impact on performance, and must be used mainly for testing purposes.

string udrForceDecode
 ( drudr  myUDR ,
 boolean  abortOnFail  ) //Optional

udrGetErrorCodes

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

list <string> udrGetErrorCodes( drudr  myUDR  )

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

list <string> udrGetErrorMessages( drudr  myUDR  )

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

string udrGetErrorsAsString( drudr  myUDR  )

udrGetFields

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

list<UDRFieldInfo> udrGetFields 
 ( drudr myUDR )

UDRFieldInfo is the UDR that is populated with the field information of the UDR that contains a list of fields.

The following fields are included in UDRFieldInfo:

Returns the value of fieldName in the myUDR.

any udrGetValue
 ( drudr  myUDR ,
 string  fieldname  )

Returns true if the UDR field is present.

boolean udrIsPresent(identifier  field  )

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 .

The udrMass functions include:

• udrMassCreateDecoder

• udrMassClearBuffer

• udrMassDecode

• udrMassEOFCheck

• udrMassGetDataTail
   

udrMassCreateDecoder

Creates a decoder object.

any udrMassCreateDecoder(string  decoderName )

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.

void udrMassClearBuffer(any theDecoder)

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

string udrMassDecode(
 any  theDecoder ,
 list<drudr> myList ,
 bytearray  inputData ,
 boolean  forceDecode )

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.

string udrMassEOFCheck(
 any theDecoder, 
 list<drudr> myList, 
 boolean forceDecode)

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

bytearray udrMassGetDataTail(any  theDecoder )

The udrRoute function sends a UDR to a workflow route.

If no call to the route function is made, the agent will not have any outgoing routes in the Workflow Editor environment - it will not be possible to link to a subsequent agent.

The function routes a UDR to all the output routes, or a named output route. If the clone keyword is used, the UDR is cloned before output.

void udrRoute
 ( drudr  myUDR ,
 string  routeName , //Optional
  clone  ) //Optional

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

void udrSetValue
 ( drudr  myUDR ,
 string  fieldName ,
 any  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.

The field can be changed to Is Present again either via udrSetValue (see the section above, udrSetValue) or regular assignment of fields.

void udrUnsetPresent(identifier field )