Syntax:

com.ibi.preparsers.XDAppend

Description:

The Append preparser is used to append text to an existing flat file. This preparser should not be the last in the chain before a route is called. You can use the En Tag preparser to enclose the flat appended text into an XML structure or use iWay Transformer to convert a flat file to XML format.

In a use case scenario, the Append preparser is useful when two flat files need to be appended. However, to convert to XML, an additional preparser, such as En Tag ,should be used in order to process the flat file through the channel.

Parameters:

Syntax:

com.ibi.preparsers.CCharFilter

Description:

The C Char filter preparser is used to remove control characters from an incoming message.

In a use case scenario, the C Char filter preparser can be used when an incoming message is unformatted and contains carriage returns. The C Char filter preparser can remove the carriage return and tab fields before sending it to a message flow for further processing.

Parameters:

Syntax:

com.ibi.preparsers.XDCharRepl

Description:

The Char Repl preparser is used to perform character replacements in an incoming document.

In a use case scenario, if a name is misspelled in an incoming document as Rom instead of Tom, then the character R could be replaced with T in this document. It is analogous to the find and replace function that can be found in most word processing applications.

Parameters:

Syntax:

com.ibi.preparsers.XDEDIFACTPreParser

Description:

After a batch of EDIFACT messages are split, the EDIFACTPreParser converts each EDIFACT message into XML format. For more information on how to configure the EDIFACTPreParser, see the iWay Integration Solution for UN/EDIFACT User's Guide.

Syntax:

com.ibi.preparsers.XDEDIpreParser

Description:

After a batch of EDI messages is split, the EDIX12PreParser converts each EDI message into XML format.

Note: The EDIX12PrePreparser is deprecated. As an alternative it is recommended to use the EDIX12SplitterPreParser (EDISplitPP)/

Syntax:

com.ibi.preparsers.XDXMLEDIValidator

Description:

The EDIX12 XML Validator preparser takes EDI XML as input and returns that input with the structural errors section added to be processed by the appropriate rule.

Syntax:

com.ibi.preparsers.XDEnTag

Description:

The En Tag preparser surrounds the incoming message with a designated tag. Optionally, it passes on the incoming message as CDATA to the tag. Additional features allow configuration of attributes including source, message ID, and correlation ID.

In a use case scenario, the En Tag preparser can be used when a flat file needs to be converted into an XML file without changing the format of the flat file (using the entire content of the flat file as is). For instance, if a flat file contained a list of names separated by carriage returns, this preparser can be used to convert the file to XML format.

Parameters:

Syntax:

com.ibi.preparsers.ErrorFilter

Description:

The Error Filter preparser operates on iWay error documents. Error documents are a standard by which iWay Service Manager reports errors back to the user. These documents contain the complete incoming message associated with an error. The preparser extracts the original message and passes it into the system for processing. Messages that are identified as not being error documents are passed along without any modifications.

In a use case scenario, the Error Filter preparser can be used to obtain the original document from an error document if the user needs to retest a component, but does not have the original document.

Example:

1. Select Error Filter (com.ibi.preparsers.ErrorFilter) from the Type drop-down list and click Next.

   The configuration parameters pane opens.

2. Enter a name (for example, XDErrorFilter) and an optional description.
3. Click Finish.
4. Construct an inlet, for example, PreparseInlet, which is associated with a file listener and the new preparser (XDErrorFilter).
5. Define a simple move route and a default outlet for the channel.
6. Build, deploy, and start the channel.
7. Create an input document, which contains the following:

   <?xml version="1.0" encoding="ISO-8859-1" ?>
   <eda>
     <error timestamp="2009-05-07T20:55:30Z" source="com.ibi.agents.XDSQLAgent" 
        stage="AGENT">com.microsoft.sqlserver.jdbc.SQLServerException: Invalid 
        column name &apos;ragv&apos;.
          <data type="xml">&lt;?xml version=&quot;1.0&quot;
             encoding=&quot;ISO-8859-1&quot;?&gt;&lt;test&gt;
             This is a detag preemitter test &lt;/test&gt;
          </data>
     </error>
   </eda>

   When this input document is processed by the channel, the following XML output document is generated:

   <?xml version="1.0" encoding="ISO-8859-1" ?><test>This is a detag preemitter test </test>

Syntax:

com.ibi.preparsers.XDExcelpreParser

Description:

The Excel preparser transforms an Excel worksheet into an XML formatted document. If required, this preparser uses the header row in the Excel worksheet as XML tags for the data elements.

In a use case scenario, the Excel preparser is useful when data in Excel must be transformed into XML.

Note: When using the Excel preparser to convert an Excel document to XML, it changes the dates from mm/dd/yyyy to mm/dd/yy. For example, if the Excel document has a cell format of Date *03/14/2001 (with an asterisk), the date will convert to 03/14/01. If the cell format is Date 03/14/2001 (without an asterisk), it will convert to the proper format of 03/14/2001 . The image below shows the date selection that will not keep the original format and the date selection that will keep the original format.

Parameters:

1. Select EXCELPreParser (com.ibi.preparsers.XDExcelpreParser) from the Type drop-down list and click Next.

   The configuration parameters pane opens.

2. Select true from the hasheaders drop-down list.
3. Click Next.

   The name and description pane opens.

4. Enter a name (for example, ExcelPreparser) and an optional description.
5. Click Finish.
6. Construct an inlet, for example, PreparseInlet, which is associated with a file listener, and the new preparser (ExcelPreparser).
7. Define a simple move route and a default outlet for the channel.
8. Build, deploy, and start the channel.
9. Create a sample Excel document (for example, document2.xls) with the following data:

   Character Use Return type Example	Use	Example
   y	year	yyyy=2006, yy=06
   M	Month of year	MM=06, MMM=Jun, MMMM=June
   w	Week in year	26
   W	Week in month	26
   h	Day in year (Julian)	26
   h	Day in month	26
   h	Day of week	26
   h	Day of week in month	26

   The output document [document_out]*.xml will have the following format:

   <?xml version="1.0" encoding="ISO-8859-1" ?>
   <workbook>
     <ism.pdf>
        <row>
           <RowNumber>2</RowNumber>
           

   <Character_Use_Return_type_Example>y</Character_Use_Return_type_Example>
           <Use_>year</Use_>
           <Example>yyyy=2006,yy=06</Example>
        </row>
        <row>
           <RowNumber>3</RowNumber>
           

   <Character_Use_Return_type_Example>M</Character_Use_Return_type_Example>
           <Use_>Month of year</Use_>
           <Example>MM=06, MMM=Jun, MMMM=June</Example>
        </row>
        <row>
           <RowNumber>4</RowNumber>
           

   <Character_Use_Return_type_Example>w</Character_Use_Return_type_Example>
           <Use_>Week in year</Use_>
           <Example>26</Example>
        </row>
        <row>
           <RowNumber>5</RowNumber>
          

   <Character_Use_Return_type_Example>W</Character_Use_Return_type_Example>
           <Use_>Week in month</Use_>
           <Example>26</Example>
        </row>
        <row>
           <RowNumber>6</RowNumber>
           

   <Character_Use_Return_type_Example>h</Character_Use_Return_type_Example>
           <Use_>Day in year (Julian)</Use_>
           <Example>26</Example>
        </row>
        <row>
           <RowNumber>7</RowNumber>
           

   <Character_Use_Return_type_Example>h</Character_Use_Return_type_Example>
           <Use_>Day in month</Use_>
           <Example>26</Example>
        </row>
        <row>
           <RowNumber>8</RowNumber>
           

   <Character_Use_Return_type_Example>h</Character_Use_Return_type_Example>
           <Use_>Day of week</Use_>
           <Example>26</Example>
        </row>
        <row>
            <RowNumber>9</RowNumber>
            

   <Character_Use_Return_type_Example>h</Character_Use_Return_type_Example>
            <Use_>Day of week in month</Use_>
            <Example>26</Example>
        </row>
     </ism.pdf>
   </workbook>

Syntax:

com.ibi.preparsers.XDEDIFACTPreParser

Description:

The HIPAAPreParser transforms a HIPAA document into a HIPAA XML document.

Note: The HIPAAPreParser is deprecated. As an alternative, it is recommended to use the HIPAASplitterPreParser (HIPAASplitPP)

Syntax:

com.ibi.preparsers.XDHTTPpreParser

Description:

The HTTP preparser transforms a key=value query string into an XML string with the GET action as the root. This preparser can be used to construct an XML document with the HTTP parameters that are being passed as a query string. The HTTP preparser can only be used with an HTTP listener.

In a use case scenario, if you need to generate an XML document with the HTTP request parameters, the HTTP preparser can be used to transform the HTTP GET request for a web application.

Example:

1. Select the HTTP (com.ibi.preparsers.XDHTTPpreParser) preparser from the Type drop-down list and click Next.

   The configuration parameters pane opens.

2. Enter a name (for example, HttpPreparser) and an optional description.
3. Click Finish.
4. Configure an HTTP listener (for example, http) that is listening on port 9984.
5. Construct a simple index.html page. For example:

   <html xmlns="urn:schemas-microsoft-com:xslt">
   <head>
   <title>Posting a File</title>
   </head>
   <body>
   <form id ="f" action="http://TestMachine:8080/newproject/postfile60.html" enctype="multipart/form-data">
   <input type="file" name="fdata"/>
   </form>
   </body>
   </html>

6. In the Document Root field for the HTTP listener, specify the base directory from which the sample index.html page is served.
7. Construct an inlet, for example, HttpPreparseInlet, which is associated with the HTTP listener (for example, http) and the new preparser (HttpPreparser).
8. Define a simple move route and a default outlet for the channel.
9. Build, deploy, and start the channel.
10. Invoke the following URL from a web browser:

    http://informat-2a8d8e:9984/index.html?value1=4&value2=two

    The following output is obtained:

    <?xml version="1.0" encoding="ISO-8859-1" ?>
    <post>
    <value1>2</value1>
    <value2>two</value2>
    </post>

Syntax:

com.ibi.preparsers.XDInflate

Description:

The Inflate preparser inflates data produced by the Deflate preemitter.

An example where the Deflate preemitter could be used is when a large file (for example, 5 MB in size) must be sent by email using an Email emitter. In this scenario, the destination email server does not accept messages that are greater than 3 MB in size. The Deflate preemitter could be used before the Email emitter to send the message in an email. The Inflate preparser could be used once the email is read through an Email listener and subsequently picked up by the Inflate preparser in the channel.

Example:

1. Select the Inflate (com.ibi.preparsers.XDInflate) preparser from the Type drop-down list and click Next.

   The configuration parameters pane opens.

2. Enter a name (for example, InflatePreparser) and an optional description.
3. Click Finish.
4. Define a simple move route and a default outlet for the channel.
5. Construct an inlet, for example, PreparseInlet, which is associated with a file listener and the new preparser (InflatePreparser) to enclose each split flat file into an XML file.
6. Construct a channel (for example, Inflate).
7. Build, deploy, and start the Inflate channel.

   The input file for this channel must be a deflated (compressed) document.

Syntax:

com.ibi.preparsers.XDJMSObjectPreParser

Description:

The XDJMSObjectPreParser is used to convert a JMS ObjectMessage to a suitable iSM message. While the server can deal with most message type automatically, it needs application programming assistance to deal with the generic ObjectMessage. This preparser or an extension of it must be invoked by the channel to manage the ObjectMessage retrieved from the JMS Queue or Topic.

Parameters:

Syntax:

com.ibi.preparsers.LegacyRecordPreparser

Description:

Converts an incoming legacy flat file (copybook) into an XML file. For more information, see the iWay Transaction Adapter for CICS User's Guide.

Parameters:

Syntax:

com.ibi.preparsers.XDMultiPart

Description:

The Multipart preparser divides multipart documents for later use. This preparser must be last in the chain. When used, the multipart message is divided so that the body of the message is part 0 and subsequent attachments are 1 to n. The multipart object is carried in the XML document (XDDocument) and can be retrieved and interrogated by your own business service to obtain the individual parts for processing. If the body is a MIME type of _/XML, it is parsed and carried as an XML document.

In a use case scenario, an incoming document can consist of an email where specific information from the email message must be extracted, such as the attachment headers and the attachment file name. The Multipart preparser can transform the message into a multipart format that can be used to call functions on the email, such as _attcnt() (attachment count).

Example:

1. Select the Multi Part (com.ibi.preparsers.XDMultiPartpreparser) preparser from the Type drop-down list and click Next.

   The configuration parameters pane opens.

2. Enter a name (for example, iwMULTIPART) and an optional description.
3. Click Finish.
4. Construct an inlet, for example, AttInlet, which is associated with a file listener and the new preparser (iwMULTIPART).
5. Define a simple move route for the channel.
6. Test with COND to test the attachment header in the multipart document. Let the COND be:

   COND(_atthdr(2,'Content-Id','mydata'),eq, 'mydata1')

7. Define an outlet, which is associated with a file emitter that emits an output document (for example, a#.txt) to a specified output directory.
8. Build, deploy, and start the channel.
9. Create a multipart input document, which is generated from an email attachment. For example:

   content-type: multipart/mixed; 
   boundary="----=_Part_5_23514719.1234266657921"
   content-length: 571
   mime-version: 1.0
   message-id: <17237217.1234266657984.JavaMail.ksugauchi@kmaruyama>
   ------=_Part_5_23514719.1234266657921
   Content-Type: application/xml
   Content-Transfer-Encoding: 7bit
   Content-Disposition: attachment; filename=a.xml
   <a>a</a>
   ------=_Part_5_23514719.1234266657921
   Content-Type: text/document
   Content-Transfer-Encoding: 7bit
   Content-Disposition: attachment; filename=b.xml
   Content-Id: mydata1
   <b>b</b>
   ------=_Part_5_23514719.1234266657921
   Content-Type: text/document
   Content-Transfer-Encoding: 7bit
   Content-Disposition: attachment; filename=c.xml
   Content-Id: mydata2
   <c>c</c>
   ------=_Part_5_23514719.1234266657921-

   When this multipart input document is processed by the channel, an output XML document (a#.txt) is generated with the following contents:

   <?xml version="1.0" encoding="ISO-8859-1" ?>

Syntax:

com.ibi.preparsers.XDMultiPartForNHTTP

Description:

The Multipart for nHTTP preparser divides multipart documents into body and attachments. This preparser can also be used with a nHTTP listener. This preparser must be last in the chain. When used, the multipart message is broken up so that the body of the multipart message is part 0 and subsequent attachments are 1 to n.

In a use case scenario, the Multipart for nHTTP preparser is useful when the incoming message is a multipart document and the headers and attachment portions of the document need to be extracted from the document for additional message processing.

Parameters:

Syntax:

com.ibi.preparsers.PGPDecrypt

Description:

The PGP Decrypt preparser decrypts an incoming message on the channel into the original unencrypted format. For more information on how to configure the PGP Decrypt preparser, see the iWay Service Manager Extensions User's Guide.

Syntax:

com.ibi.preparsers.XDSOAPPreParser

Description:

The SOAP preparser accepts a SOAP message from any JMS listener and removes the SOAP portion from the envelope. The preparser then parses the SOAP body by iterating through all child nodes and constructs an XML document (XDDocument), which is used to pass between components in a process flow. For more information on how to configure the SOAP preparser, see the iWay Service Manager Extensions User's Guide.

Syntax:

com.ibi.preparsers.XDSREGPreparser

Description:

The SREG preparser sets one or more special registers of a given type.

In a use case scenario, the SREG preparser is useful when the incoming message has variables associated with it and if changes need to be made to the special registers set at a global level, application level, or server level.

Parameters:

com.ibi.preparsers.SwiftBPP

Syntax:

com.ibi.preparsers.SwiftPreParser

Description:

The SWIFTPreParser converts an incoming SWIFT message to XML format. If you require a SWIFT Validation Report, the SWIFTPreParser must be used. If you do not require a SWIFT Validation Report, the SWIFTPreParser or XDSWIFTPreParser can be used. When the SWIFTPreParser is used, an Ebix must be attached to the iSM channel. For more information on how to configure the SWIFTPreParser, see iWay Integration Solution for SWIFT User's Guide.

Syntax:

com.ibi.preparsers.XDSWIFTSysMsgPreParser

Description:

The XDSWIFTSysMsgPreParser Transforms SWIFT User-to-System and System-to-User FIN Format Messages to XML formatted documents. For more information on how to configure the XDSWIFTSysMsgPreParser, see the iWay Integration Solution for SWIFT User's Guide.

Syntax:

com.ibi.preparsers.XDSWIFTpreParser

Description:

The XDSWIFTPreParser converts an incoming SWIFT message to XML format. Use the XDSWIFTPreParser only if you do not require a SWIFT Validation Report. When the XDSWIFTPreParser is used, an Ebix must be attached to the iSM channel. For more information on how to configure the XDSWIFTPreParser, see the iWay Integration Solution for SWIFT User's Guide.