Name | Description |
---|---|
Name | Unique name for the step. You can use alphabets, numbers, and special characters such as -, _. . , and #. |
Description | Description of the step (optional). |
Enabled | Select this option to enable the step for execution. If it is not enabled, then the step on the canvas is greyed-out. This option is useful when troubleshooting a process, especially when there are numerous steps in the process. You can also enable or disable the step using the right-click menu options. If the step is enabled, then to disable the step, right-click on the step and select Disable Step. If the step is disabled, then to enable the step, right-click on the step and select Enable Step. |
Error Handling | Select either of the following: • Ignore Error - The remaining steps in the current process are executed even if this step aborts due to an error. This is selected by default. • Abort Process - All the steps after the current step are skipped or the entire process is aborted (depending on how you have the error logging options set) if this step aborts due to an error. |
Select Iterator | Select an Iterator instance. These instances are displayed when you add message components in the Configuration tab. For more information, see Adding Message Components in Configuring Processes. |
Action | Select an action for the iterator instance. |
Parameters | Parameters for the selected action. Specify values for the parameters. |
Properties | Properties for the selected action. Specify values for the properties. |
Property Name | Description |
---|---|
SourceName | Path and file name of the source. |
Unicode | Indicates whether source file is Unicode. Default value is False. |
Action | Description |
---|---|
Connect | Opens a persistent connection to the component source. |
Disconnect | Break the connection with the component source. |
GetMessage | Returns data from the Iterator in a djmessage object. The maximum size limit for DJMessage is 512 MB. |
Action | Parameter | Description |
---|---|---|
Connect | Database | Name of the database. |
GetMessage | Message | Type the message. |
Property Name | Description |
---|---|
SourceName | Path and file name of the source. |
Unicode | Indicates whether source file is Unicode. Default value is False. |
Action | Description |
---|---|
Connect | Opens a persistent connection to the component source. |
Disconnect | Break the connection with the component source. |
GetMessage | Returns data from the Iterator in a djmessage object. The maximum size limit for DJMessage is 512 MB. |
Action | Parameter | Description |
---|---|---|
Connect | Database | Name of the database. |
GetMessage | Message | Message string. |
Property Name | Description |
---|---|
SourceName | Path and file name of the source. |
Action | Description |
---|---|
Connect | Opens a persistent connection to the component source. |
Disconnect | Break the connection with the component source. |
GetMessage | Returns data from the Iterator in a djmessage object. The maximum size limit for DJMessage is 512 MB. |
Action | Parameter | Description |
---|---|---|
Connect | Database | Name of the database. |
GetMessage | Message | Message string. |
Property Name | Default Value | Description |
---|---|---|
TransferUnitType | Bytes | Type of unit to use when splitting the file into pieces. This option is used along with the TransferUnitCount option to determine the size of the pieces to split the file into. The options available are: • Bytes • Records |
TransferUnitCount | 0 | Number of units each piece of the file contains. This option is used in conjunction with the TransferUnitType option to determine the size of the pieces to split the file into. For example, if the TranferUnitType is Records and the TransferUnitCount is 10, then each message object contains 10 records from the source file. |
SourceName | Path and file name of file that is split into pieces. | |
Encoding | ENC_OEM or 0 | Character set of the source data. This indicates using the default character set for the system. The ENC_ names can be used in expressions for setting the encoding value. Allowable values for supported character sets are listed under Encoding Tips. |
RecordSeparator | The record separator to use when dividing the source into groups of records. This should be Unicode characters. Default is none. Some allowable values are: • \r\n (CR-LF) • \n (LF) • \r (CR) • \n\r (LF-CR) • \x2028 (Unicode line separator) • \x2029 (Unicode paragraph separator) • \f (Form feed) • \r\n\r\n (Windows empty line) • \n\n (Unix empty line) Note: The actual characters (or escape sequences) must be used, that is, using 'CR-LF' will not work, you must use '\r\n'. | |
RecordLength | If records are separated by a record separator, this property must be set to 0. If the records are fixed-length (no separator), then this should be the actual record length. Any time this property has a value other than 0, the RecordSeparator property will be ignored. | |
TargetName | Name that is given to the file when it is reassembled. The TargetName option includes the path and file name. | |
TargetHost | Name of the host where the target file is reassembled. This option is used by the File Transfer Aggregator to verify that the file is being reassembled on the correct host. | |
BinaryIndicator | False | Indicates whether the file being read should be opened in binary mode. |
Action | Description |
---|---|
Connect | Opens a persistent connection to the component source. |
Disconnect | Break the connection with the component source. |
GetMessage | Returns data from the Iterator in a djmessage object. The maximum size limit for DJMessage is 512 MB. |
Action | Parameter | Description |
---|---|---|
Connect | Database | Name of the database. |
GetMessage | Message | When the GetMessage action is called for an Iterator, the Iterator advances to the next element in the Iterator source and returns it in the message body of the specified DJMessage object. The maximum size limit for DJMessage is 512 MB. |
Property | Description |
---|---|
SourceName | The name of the source file. |
TranferUnitType | Indicates how to divide the source file into pieces. Allowable values are Bytes and Records. |
TransferUnitCount | The number of bytes of number or records to include in each piece. |
RecordLength | The number of characters to include in a record. |
SourceRecordSeparator | The record separator to use when splitting the source. Default None. |
SourceEncoding | The character set of the source data. The default is ENC_OEM (0). |
TargetHostSystem | The name of the target host system. |
TargetName | The name of the target file. |
TargetExpiration | The time period for the transfer. The time expires when the current time equals the start transfer time plus the target expiration value. |
TargetExpirationType | The type of the target expiration value. Allowable values Years, Months, Days, Hours, Minutes, Seconds. |
TargetMode | Indicates whether to replace or append to the target. Allowable values are Replace and Append. |
TargetRecordSeparator | The record separator to use when assembling the target. If not set, the SourceRecordSeparator value is used. |
TargetEncoding | The character set of the target data. If not set, the SourceEncoding value is used. |
Parameter | Description |
---|---|
TransferId | Uniquely identifies each transfer. It is a hash of the source name, target host, target name and transfer start time. |
PieceNumber | Indicates the sequential order of the piece. |
PieceSize | Indicates the size of the message body in bytes. |
Priority | The priority of the piece. Default 0. The last message has a priority of 1. |
TotalPieceCount | The total number of pieces. |
StartTime | The date/time the transfer started. |
Property | Default Value | Description |
---|---|---|
Transfer Batch Size | 1000 | Number of records returned per rowset. Decimal values are rounded off to the nearest integer. Note: If you specify the value as 0, then XPath returns all the records in the rowset. For example, if you set 500 as the Transfer Batch Size for a 1000 record rowset, then the number of WebRowSet XML responses returned is 2. |
Null Support | None | Handles null and empty string values. If you set Null Support to None, then empty strings and null values are written as <columnValue></columnValue>. If you set Null Support to "null tag", then the following actions apply: • Null values are written as <columnValue><null/></columnValue> • Empty strings are written as <columnValue><emptyString/></columnValue> If you set Null Support to "nil attribute", then the following actions apply: • Null values are written as <columnValue xsi:nil='true'></columnValue> • Empty strings are written as <columnValue></columnValue> |
Driver | Name of JDBC driver to load For example: com.ibm.db2.jcc.DB2Driver | |
Host URL | URL connection to the database For example: jdbc:db2://localhost/mydbname | |
User ID | User name for the database session For example: db2user Note: Specify the user name and password for the database session only if it is configured for your database. | |
Password | Password for the database session For example: mydb2pwd | |
Jar Location | Location of the folder that contains the JAR files that are required to load the JDBC driver. Note: You cannot append multiple paths to the value. All the driver JAR files must be located in the same folder. For example: For DB2, you must load the db2cc.jar (type 4 driver). Caution! Always use the latest .jar files for a particular database version. |
Action | Description |
---|---|
Connect | Opens a persistent connection to the database. Tip: Call Connect explicitly in your process flow. |
Disconnect | Closes an existing database connection and performs any clean up actions if required. Tip: Call Disconnect explicitly in your process flow. |
GetMessage | Iterates through the records in the result set, and returns the specified number of records (Transfer Batch Size) in the WebRowSet XML format. The GetMessage requires the DJMessage object that holds the WebRowSet XML output. Call GetMessage immediately after PutMessage to iterate over the record set. The maximum size limit for DJMessage is 512 MB. |
PutMessage | Runs the SQL Select statements, processes the values, and stores the result set. The Put Message requires the DJMessage object that holds the SQL SELECT statement. The maximum size limit for DJMessage is 512 MB. |
Action | Parameter | Description |
---|---|---|
GetMessage PutMessage | Message | Message string. |
Error Code | Error Name | Description | Reason |
4 | ERR_READERR | Error while reading messages from a DJMessage body or iterating through the result set | ERR_READERR is returned in the following cases: • Problem reading messages from a DJMessage body • Problem iterating through the result set |
8 | ERR_WRITERR | Error while writing messages to a DJMessage body or when running the SELECT query | ERR_WRITERR is returned in the following cases: • Problem writing messages to a DJMessage body • Problem running the SELECT query |
19 | ERR_OPENERR | Error while connecting to the database | Exception is encountered when connecting to the specified database. |
27 | ERR_CLOSERR | Error while disconnecting from the database | Exception is encountered when disconnecting from the specified database |
86 | ERR_MSG_END | Error indicating the end of a given set of messages | Returned when there are no more messages to be returned by the "getMessage" method |
Database | Data Types |
---|---|
DB2 | • bigint • character • clob • date • decimal • double • integer • real • smallint • time • timestamp • varchar |
PSQL v9 | • bfloat4 • bfloat8 • bigint • bit • char • currency • date • decimal • double • float • identity • integer • longvarchar • money • numeric • numericsa • numericsts • real • smallidentity • smallint • time • timestamp • tinyint • ubigint • uinteger • usmallint • utinyint • varchar |
SQL Server 2000 | • bigint • bit • char • datetime • decimal • float • int • money • nchar • ntext • numeric • nvarchar • real • smalldatetime • smallint • smallmoney • sql_variant • text • tinyint • uniqueidentifier • varchar |
Oracle 9i | • Varchar2 • Char • Number • Integer • Date • Long • NVarchar2 • RowId • NChar • Clob (Use the latest drivers) • Nclob (Use the latest drivers) • Float • Char Varying • Character • Character varying • Decimal • Double Precision • Int • National char • National char varying • National character • National character varying • Nchar varying • Numeric • Real • SmallInt • Varchar |
Database | Data Type |
Oracle | • Long Raw (Binary) • Raw (Binary) • MLSLabel • Blob (Binary) • BFile • URowId • URIType |
DB2 | • BLOB (Binary) |
SQLServer | • Binary • Image (Binary) • VarBinary |
PSQL | • Binary • LongVarBinary |
Property | Description |
---|---|
Dynamic XPath or XML Source Document | Dynamic XPath or Dynamic XML source. |
Source XML Document | Path to XML document. |
Action | Description |
---|---|
PutMessage | Extracts data from an XML source document (based on the XPath expression provided) and prepares the result set. PutMessage lists an optional source message parameter containing either an XPath expression or an XML source (URL). The PutMessage action contains two step properties: XML source and XPath expression. You can pass the XML source or XPath expression at design time or through Source Message at run time. |
GetMessage | Iterates through the result set. This action should be called after the PutMessage action. The GetMessage action requires a target DJMessage object. The maximum size limit for DJMessage is 512 MB. |
Action | Parameter | Description |
---|---|---|
GetMessage PutMessage | Message | Message string. |
Action | Property | Description |
---|---|---|
PutMessage | XML Source | Source message |
PutMessage | XPath Expression | Source message |
XML Source | XPath Expression | Description | Example |
---|---|---|---|
Combination of Design and Run Time | |||
Source Message (Content) | Expression | Provide XML content at run time | srcMsg.body=fileread("C:\people.xml") |
Provide XPath expression at design time | //Person[@title="doctor"] | ||
Source Message (URL) | Expression | Provide URL to the XML file at run time | srcMsg.Body = "C:\people.xml" |
Provide XPath expression at design time | //Person[@title="doctor"] | ||
URL | Source Message (Expression) | Provide XML content at design time | C:\people.xml |
Provide XPath expression at run time | srcMsg.Body="//Person[@title="doctor"]" | ||
Design Time | |||
URL | Expression | Provide URL to the XML file at design time | C:\people.xml |
Provide XPath expression at design time | //Person[@title="doctor"] |
Code | Name | Description | Reason |
---|---|---|---|
1 | ERR_EOF | End of file reached | No more items to return |
4 | ERR_READERR | Component not initialized | XPath is not initialized. ERR_READERR occurs when GetMessage is called before PutMessage. |
34 | ERR_INVALID | Invalid XPath expression or XML source file | Error occurred while processing XPath expression or loading XML source Possible reasons: • Invalid XPath expression or XML source • Empty field value |
50 | ERR_UNSPECIFIED | Unknown error | Unknown error identified by the component |