Document Mapper/Variable Mapper

Operation name

Document Mapper
- Mapping
Variable Mapper
- Variable Substitution

Function overview

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

See "Basic Functions (Document Mapper/Variable Mapper)" for details.

Properties(Property Inspector)

Basic settings

Item name	Required / Optional	Use of Variables	Description	Remarks
Name	Required	Not available	Specify the name to be used in the script canvas.
Input data	Required	Not available	Specify a component from which data is supplied to the mapper	This property is not shown for variable Mapper .

Comment

Item name	Required / Optional	Use of Variables	Description	Remarks
Comment	Optional	Not available	You can write a short description of this mapper.

Mass data processing

Document Mapper performs Mass data processing, if and only if, the input component supplying data to the mapper is performing the Mass data processing, and both input and output schema are table data model schema.
Where as the Variable Mapper performs Mass data processing, if the input component supplying the data to the mapper is performing Mass data processing and the input schema is a table data model type.

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

In order to handle large volume of input data and output data, it is necessary to adjust heap size of DataSpiderServista if PSP is not employed.

See lax file for how DataSpiderServer heap size can be changed.

Input Output Schema

Mapper displays schemas used for both input source and target output. For a one-to-one correspondence between source and target fields, the map can be created just by simply connecting fields of the input and the output schema.
For some components it is created automatically, but for others it needs to be created manually.

See "Schema of adapter" for further details.

PSP Usage

PSP is supported.

For details on PSP, refer to "Parallel Stream Processing".

Available component variables

Component variable name	Description	Remarks
message_category	Stroes the category to which corresponding message code belongs to, when an error occurs.	The value defaults to null.
message_code	Stores its corresponding message code of occured error.	The value defaults to null.
message_level	Stores the severity of the corresponding message code of the occured error.	The value defaults to null.
error_type	Returns the error type when error occurred.	The value defaults to null. Error is represented in the format depicted below. Example:java.io.FileNotFoundException The message may vary depending on DataSpider Servista version.
error_message	Return the error message when error occurred.	The value defaults to null. The message may vary depending on DataSpider Servista version.
error_trace	Return trace information when error occurred.	The value defaults to null. The message may vary depending on DataSpider Servista version or the client application used.

Specification Limits

Assignments to script variables are performed only once before writing into the output destination component.

Even if loop logic is used in input schema, only the first row will be assigned to the script variable.

Table model type data such as CSV, variable length, or a database data which includes xml unsupported characters, therefore not convertible to XML documents, cannot be processed by mappers.

A component variable whose name contains '&' cannot be mapped to XML output schema.
Refer to"Restrictions on characters used in DataSpider Servista", for any further details regarding restrictions on the usage of characters.

Variable Mapper does not support transactions,therefore any variable assignment performed within a transaction cannot be rolled back even if the transaction fails to commit.

Mapper does not support transactions. Action of Mapper in transaction is as follows.
- Any variable assignment performed cannot be rolled back even if the transaction fails to commit.
- The contents of database and file changed in the process before Mapper are not able to be refered.
Value assignment made from an XML data model schema field to a script variable performs inferior to the value assignment made from a table model data type filed.

Modifications made to the schemas of the source and target components connected to a mapper are notified to reflect the changes to the mapper's input and output schema only if the data flow lines are drawn from/to the components.

For example, if the input source to a mapper is a Loop by Number of Data Operation, changing the data source to which the Loop by Number of Data Operation is performed on will not affect the Mapper's input schema. Therefore schema needs to be manually loaded.
Therefore schema needs to be manually loaded.

While having the Mapper which has several output destinations open, even if you load input schema to one of the output Mappers, the condition will not be copied to the other output Mappers. To apply the same condition to all the output Mappers, reopen the project, load input schema again while the source Mapper closed.

If you set a script variable in XML type to the output destination of the Document Mapper, and then change the script variable name by Project Explorer, it will not affect to the output schema. To reflect the changes, reopen the project.

If you set a component with an editable schema to the output destination of the Document Mapper, and then change the Document Mapper schema by Variable Mapper, it will not affect to the output schema of the Document Mapper. To reflect the changes, go to the output schema of the Document Mapper.

If you load a different schema with attributes while a schema is defined, the order of the elements may not be maintained. In this case, please edit manually or reload the schema.

There are cases where you cannot cut, copy or paste logic icons by shortcut key on a Mapping canvas. Please try the right-click menu or the Designer menu.

When selecting several logic icons on a Mapping canvas and move those to a different place, there are cases where logic icons are placed offscreen. If so please check "Select All" to logic icons and move them on the screen.

Notes

If multiple Mapper editors are running simultaneously, navigating between their tabs may not reflect the corresponding real time view.
Refocusing the mapper in the script canvas will give the expected result.

An error occurs when you map the component variables which have no process flow.

Newlines included in output data of Document Mapper
- For converting engines for Table Model Type
  A newline depends on the newline of DataSpiderServer running OS.
- For others
  A newline is "LF".
For more details on the data model, refer to "Data Model".