Official |[Mapper]Document Mapper/Variable Mapper (Details)

Operation name

Document Mapper
- Mapping
Variable Mapper
- Assign Variables

Function overview

Document Mapper
- Performs conversion on input data.
Variable Mapper
- Performs variable assignment.

= Remarks =

For details, refer to Document Mapper/Variable Mapper (Basic).

Properties (Property inspector)

Basic settings

Item name	Required/Optional	Use of variables	Description	Remarks
Name	Required	Not available	Enter a name that is used on the script canvas.
Input data	Required	Not available	Specify a component from which data is supplied to the mapper.	Note This property is not shown for Variable Mapper.

Comment

Item name	Required/Optional	Use of variables	Description	Remarks
Comment	Optional	Not available	You can add any comments.

Mass data processing

Document Mapper performs mass data processing only if the component performing the mass data processing is the input source and the schema structure of the input schema and output schema is the table model type.

Variable Mapper performs mass data processing only if the component performing the mass data processing is the input source and the input schema is the table model type.

= Hint =

XML type with the schema structure of a table model type expressed as <table><row><column> is considered a table model type.

Input schema and output schema

Mapper displays the schema of components connected by a data flow under the input source or the output target. Connecting schema elements with mapping links enables data to be transferred.

For some components a schema is created automatically, but for others it needs to be created manually.

= Remarks =

For details, refer to Schema of connector.

Parallel Stream Processing

PSP is supported with Document Mapper.

PSP is not supported with Variable Mapper.

= Remarks =

For details on PSP, refer to Parallel Stream Processing.

Available component variables

Component variable name	Description	Remarks
message_category	When an error occurs, the category of the message code corresponding to the error is stored.	The default value is null.
message_code	When an error occurs, the code of the message code corresponding to the error is stored.	The default value is null.
message_level	When an error occurs, the severity of the message code corresponding to the error is stored.	The default value is null.
error_type	When an error occurs, the error type is stored.	The default value is null. The format of the error type is as follows. Example: java.io.FileNotFoundException
error_message	When an error occurs, the error message is stored.	The default value is null.
error_trace	When an error occurs, the trace information for the error is stored.	The default value is null.

Specification limits

Assignments to script variables are performed only once before writing into the output destination component.
Even if a loop logic is used in an input schema, only the first row will be assigned to the script variable.
Table model type data such as CSV, variable length, or database data which includes unsupported XML characters such as control codes can't be converted to XML type data.
A component variable whose name contains '&' can't be mapped to the XML type of output schema.

= Remarks =
Refer to HULFT Square restricted characters for more details on character constraints.
Mapper doesn't support transactions. Action of Mapper in transaction is as follows:
- Any variable assignment performed can't be rolled back even if the transaction fails to commit.
- The contents of database and file changed in the process before Mapper aren't able to be referred.
Value assignment made from an XML data model schema field to a script variable degrades compared to the value assignment made from a table model data type field.
Mapper receives notifications of change of schema only for components that are connected to the data flow directly when synchronizing the schema.

For a Mapper whose input source is a Loop by Number of Data operation, even if you change the schema of the component that is the input source of the Loop by Number of Data operation by selecting another table, the input schema of the Mapper isn't synchronized.

Therefore the schema needs to be manually loaded.
When a Mapper which has several Mappers as output destinations (hereafter source Mapper) is open, even if you load the input schema on one of the target Mappers, the other target Mappers will not be notified. In this case, reopen the project and load the input schema with the source Mapper closed.
If you set an XML type of script variable to the output destination of Document Mapper, and then change the script variable name by the Project Explorer, it doesn't affect the output schema. To reflect the changes, reopen the project.
If you set a component with an editable schema to the output destination of Document Mapper, and then change the schema of Document Mapper using Variable Mapper, it doesn't affect the output schema of Document Mapper. In this case, change the output schema of Document Mapper.
When the schema is defined, if you load a different schema with attributes, the order of the elements may not be maintained. In this case, edit the schema manually or reload it.
There are cases where you can't cut, copy, or paste logic icons by shortcut keys on a mapping canvas. In this case, use the right-click menu or the Designer menu.
When you select several logic icons on a mapping canvas and move them to a different place, there are cases where the logic icons are placed offscreen. In this case, select all logic icons on the mapping canvas and then move them on the screen.

Notes

If multiple Mapper editors are running simultaneously, switching between their tabs may not reflect the view of real-time execution.

On the script canvas, select the Mapper icon for real-time execution to focus on it.

An error occurs during execution when you map component variables of a component which has no process flow.
Newlines included in output data of Document Mapper
- The newline code is "LF".
= Remarks =
For more details on the data model, refer to Data models .