IRecord Interface

1-based sequential cluster number (on intake it is 0 (undetermined), unless assigned in case of XML intake); the actual number is assigned at clustering block.

Number of items contained in the record

A set of key value pairs that are common to all records and clusters throughout the process execution. Elements of global cache are defined via the GlobalCacheElements seting. Global cache also allows signals to synchronize thread of Data Conveyer processing.

A value of an item at a specified index position. (attempt to set a value of a non-existing item has no effect)

A value of an item for a specified key. (attempt to set a value of a non-existing item has no effect)

A collection of items contained in the record.

A collection of keys contained in the record.

The property bin associated with the record. Property bin is a dictionary containing arbitrary set of key value pairs that can be added and removed throughout of DataConveyer processing. In order to have records contain property bin objects, the PropertyBinEntities setting must contain the Records flag; otherwise the property bin will be null.

Sequence number of the record on intake (1 based). This number remains unchanged throughout the processing; for example in case of record cloning, the clone will inherit RecNo from the original record.

Index number of the intake source that supplied the record (1 based). This number remains unchanged throughout the processing; for example in case of record cloning, the clone will inherit SourceNo from the original record.

Index number of the output target that the record is sent to (1 based). Before output phase (ClusterRouter function), the value is 0, which means not yet determined.

The trace bin object associated with the record. It can be set up in the RecordInitiator function. Trace bin is a dictionary intended to contain key value pairs collected during processing of preceding records on intake. Note that for efficiency empty trace bin objects are not attached; in such cases, TraceBin values are null.

Add an item for a given key and value at the end of the record.

Include the item in the record by either adding it or replacing existing item with the same key.

Verify if the record contains an item with a given key.

Return an empty X12 segment for a given name and number of elements.

Return an X12 segment based on provided contents.

Return a copy (deep clone) of the record. The cloned record will have the same characteristics (e.g. RecNo and also TraceBin and PropertyBin) as the current record.

Obtain an item at a specified index position.

Obtain an item for a specified key.

Obtain a clone of a given item with a new value.

Return processing status of a given phase.

Remove item for a specified key.

Replace an existing item with a new one.