X12Reader

Short Description

X12Reader reads data in X12 format. All X12 versions from 003030 to 007040 are supported.

X12Reader is currently only available is only available in certain plans. To find out more about licensing requirements, please contact [email protected].

COMPONENT	DATA SOURCE	INPUT PORTS	OUTPUT PORTS	EACH TO ALL INPUTS	DIFFERENT TO DIFFERENT OUTPUTS	TRANSFORMATION	TRANSF. REQ.	JAVA	CTL	AUTO-PROPAGATED METADATA
X12Reader	X12 file	0-1	1-n	x	✓	x	x	x	x	x

Ports

PORT TYPE	NUMBER	REQUIRED	DESCRIPTION	METADATA
Input	0	x	For port reading. See Reading from Input Port at this page.	One field (`byte, cbyte, string`) for specifying an input of the component.
Output	0	✓	For correct data records	Any ck:
	1-N	[bl	For correct data records	Any ck: (each port can have different metadata).

[1] Metadata on each output port does not need to be the same. Each metadata can use Autofilling Functions.
[2] Other output ports are required if the mapping requires it.

Metadata

X12Reader does not propagate metadata.
X12Reader has a metadata template on its output port available.
Metadata on optional input port must contain string, byte or cbyte field.
Metadata on each output port does not need to be the same.
Each metadata can use Autofilling Functions.

X12Reader Attributes

ATTRIBUTE	REQ.	DESCRIPTION	POSSIBLE VALUES
Basic
File URL	Yes	Attribute specifying what data source(s) will be read (X12 file, input port, dictionary). See Supported File URL Formats for Readers.
X12 version		Attribute specifying version of X12 transaction set.
X12 transaction set		Attribute specifying type of X12 transaction set. Possible values depend on selected X12 version.
Mapping	(*)	Mapping of the input X12 structure to output ports. For more information, see XMLExtract Mapping Definition.
Mapping URL	(*)	Name of an external file, including its path which defines mapping of the input X12 structure to output ports. For more information, see XMLExtract Mapping Definition.
Advanced
Strict validation		Enables strict validation of the incoming values, their sizes and data types. Also checks that composite elements are not present in places where only simple elements are allowed. Produces error if any validation check finds a problem.	true (default) \| false

(*) One of these must be specified if X12 version and X12 transaction set are used. If both are specified, Mapping URL has higher priority.

Details

X12Reader reads data from X12 files using SAX technology.
X12Reader can read individual values or entire subtrees of the X12 structure. Individual values can be converted to any field type. Subtrees can be converted to variant fields. When reading into variant fields, all data types in the field will be string type.
Using X12Reader is very similar to XMLExtract. Attributes X12 version and X12 transaction set define the expected structure (schema) of the input data. The schema is generated automatically.
Specifying X12 version and X12 transaction set is optional. You can leave both attributes empty, in which case X12Reader will read entire input data into a single variant field on first output port. Defining a mapping is not possible in this case.

X12Reader Mapping Editor and Transaction Set Schema

X12Reader Mapping Editor serves to define mapping from X12 transaction set structure to one or more output ports by drag and drop.
To be able to use the editor you have to specify X12 version and X12 transaction set. The schema is created internally and cannot be modified.
Any other operations to set up mapping are described in above mentioned XMLExtract.
In X12Reader, you can map input fields to the output in the same way as you map transaction set fields. The input field mapping works in all three processing modes.

Examples

Mapping parts of X12 transaction set onto output metadata. It is possible to map a whole transaction set or its part onto variant field or to map individual values to fields of other data types.