Available Transformation Module Types
In this page you may see the list of the available eiConsole Transformation Module Types:
- CSV Transformer
- Database SQL Transformation Module
- Delimited and Fixed-Width File Transformation Module
- EDI Transformation Module
- Microsoft Excel Transformer Transformation Module
- Name/Value Transformer Transformation Module
- No Transformation Transformation Module
Transformer to convert CSV input streams to and from XML. This component does not support graphical configuration.
Database SQL Transformation Module
Database SQL Transformation Module Transformation Module interprets SQL-XML as SQL database queries.
On the Basic configuration tab you have an Input file selection. Typically this is unused. Note that network paths are not evaluated in the eiConsole.
On the Connection tab you can specify connection information for the relational database that you wish to update. Enter in the User name and Password that are used to connect to that database. Specify the Type of connection to be used via the Type configuration item. The connection type may either be a raw JDBC connection or a DataSource. When DataSource is selected, you will be prompted to provide the DataSource name. This name is a Java JNDI name where the DataSource is located. Typically, this is configured within an application server. When JDBC Connection is configured you will be prompted to provide the JDBC driver and the JDBC URL. The JDBC driver is the name of the Java class used to connect to the database, where as the JDBC URL is the JDBC compliant URL string used to specify the details of that connection. This typically includes the server and database name. Once the connection is fully configured, the Test Connection button can be used to ensure the credentials are correct.
On the Advanced tab, the Keep Connection configuration item allows you to specify whether the JDBC connection should be held between invocations of this Transformation. A Timeout can also be specified for queries. The CallBack Listener configuration item is used when the Transformation will end with some query, and that query will return results which will be passed to another interface for processing. When you configure the CallBack Listener, data input into this text area should match the name of a programmatic or triggerable Listener contained within another route. Restrict Metadata To Catalog, Schema or Table(s) restrict the amount of metadata retrieved to a given Catalog pattern, Schema or Table(s) to improve performance.
On the JDBC Props tab you can specify properties to be set on the JDBC connection.
Delimited and Fixed-Width File Transformation Module
The Flat File Transformation Module is capable of transforming fixed-width and delimited files into XML, and vice-versa. It can support files of any complexity, as well as perform data and format conversions right before or after the transformation. It is configured through the use of a File Format Specification file. You can ﬁnd more information about it at Online Help – File Spec Editor and PilotFish Products Online Resource Center in the eiConsole eiConsole Tutorials (Foundation) and Transformation/File Specification sections.
EDI Transformation Module
This is the component that facilitates transformations between EDI and XML formats.
There’s not a lot of configuration required here, but we’ll cover each item below:
- Use Friendly Names. This specifies if the resulting XML element / tag names should be named according to the intuitive or documentative names provided in the EDI standard. For example, instead of getting a tag name like “NM108”, you’ll be provided with “NM108_IdentificationCodeQualifier.” This can produce more verbose XML results, but can be very useful for mapping as well as for debugging.
- Validate Message. This will attempt to validate the EDI data against its detected format definition.
- Throw Exception on Invalid Message. If “Validate Message” is also checked, this will cause the component to fail if an EDI message does not match the format definition. The error message will provide validation details.
- Use Custom Metadata. This, in conjunction with the Custom Metadata File option, will enable you to provide an alternate format definition in an XSD format. This is not required or recommended for most users.
- Expected Message Type. This allows you to specify what message type (such as “837”) is expected by the transformation.
- Custom Metadata File. This is the location for the Use Custom Metadata option.
You can ﬁnd more information about it at PilotFish Products Online Resource Center in the eiConsole Tutorials (Advanced) section.
Microsoft Excel Transformer Transformation Module
Microsoft Excel Transformer Transformation Module converts Microsoft Excel Worksheet input streams to and from XML.
This Transormation Module Configuration has 3 tabs: Basic, XML to Excel and Excel to XML.
On Basic tab you can specify:
XML Encoding Type: Specifies the XML character encoding.
Excel Version: Specifies the version of Excel to transform to. It can be Excel 97 or Excel 2007.
On XML to Excel tab you can specify:
Add Header: Specifies whether or not a header is expected.
First Column is Row Descriptor: When true, the value of the first column in each row will define the outer tag, rather than the default .
On Excel to XML tab you can specify:
Column Header Row: The row index (1-based) to use for column names.
Error on Invalid Data Type: Specifies whether or not invalid data types, i/e formulas, should throw an exception.
Suppress Empty Rows: Specifies whether rows with no content are kept or not.
Suppress Empty Columns in Rows: Specifies whether columns without data in rows should create empty tags or not.
Convert all Sheets: When true, all sheets in the incoming Excel Workbook are converted.
Legacy Format: When true, only the first sheet is converted, and the root node is different.
Convert Sheet Numbers: Comma-delimited list of sheet numbers, indexed from 0.
Format Date: When true, dates are outputted in the Excel-specified date format.
Date Format: Specifies the date format to be output.
Sheet Name Attribute: Specifies the name of the attribute to store sheet names in in the output XML.
Replace Smart Characters: Replace “smart” characters such as curved quotes with regular characters.
Use Simple Mode: Load a spreadsheet as simple rows and columns and don’t process formulas.
On Basic tab you can specify:
Name from Value Delimiter: The character separating field names from field values.
Pair Delimiter: The character separating name/value pairs.
No Transformation Transformation Module
This Transformation Module does nothing. It should be used when the source or target format is already some form of XML, and no conversion is required. This module is used by default if no Transformation Module is specified in a Format configuration.
This module requires no configuration.