Setting | Description |
---|---|
Name | Unique name for the step. |
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. |
Error Handling | Select any of the following: • Abort Process - All the steps after the current step are skipped or the entire process is aborted (depending on how you have set the error logging options) if this step aborts due to an error. • 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. |
Select Aggregator | Select an aggregator instance. These instances are displayed when you add an aggregator message component in the Configuration tab. For more information, see Adding Message Components in Configuring Processes. |
Action | Select the action for the aggregator instance. |
Parameters | Parameters for the selected action. Specify the values for the parameters. |
Properties | Properties for the selected action. Specify the values for the properties. |
Property Name | Description |
---|---|
BuilderFile | Location and file name, where the aggregator component assembles the pieces of the EDI file. |
Action | Description |
---|---|
Connect | Opens a persistent connection to the component source. |
Disconnect | Break the connection with the component source. |
PutMessage | Sends the data contained in a DJMessage object to the database. The maximum size limit for DJMessage is 512 MB. |
Action | Parameter | Description |
---|---|---|
PutMessage | Message | Message string |
Property Name | Description |
---|---|
BuilderDirectory | Name of the directory that the aggregator must use as a temporary directory when processing message objects. |
NotifyDirectory | Location where the aggregator generates notification files. |
Action | Description |
---|---|
Connect | Opens a persistent connection to the component source. |
Disconnect | Break the connection with the component source. |
PutMessage | Sends the data contained in a DJMessage Object to the aggregator. The maximum size limit for DJMessage is 512 MB. |
Action | Parameter | Parameter Description |
---|---|---|
Connect | - | - |
Disconnect | - | - |
PutMessage | Message | When the PutMessage action is called for an aggregator, the aggregator uses the body and/or properties of the Message parameter to add to the final output file that it is creating. |
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 | Description |
---|---|
Log File Location | Log file location where the transaction status for the entire session is written. |
Driver | JDBC driver to load. For example, com.domain.jdbc.v2.Driver |
Host URL | URL connection to the data base. For example, jdbc:domain://myuser/demodata |
User ID | User name for the database session. Note: Provide the user name and password for the database session only if it is configured for your database. |
Password | Password for the database session. Note: Provide the user name and password for the database session only if it is configured for your database. |
Jar Location | Location of the folder that contains the JAR files that are required to load the JDBC driver. JDBC WebRowSet Aggregator loads the drivers based on this location. Note: You cannot append multiple paths to the value. All the driver JAR files must be located in the same folder. For example, for PSQL, you must load the pvjdbc2.jar and pvjdbc2x.jar files. Caution! Always use the latest .jar files for a particular database version. |
Global Transaction | Select this option to set the aggregator instance as global. |
Action | Description |
---|---|
PutMessage | Sends the WebRowSet XML data contained in a DJMessage Object to the database. The maximum size limit for DJMessage is 512 MB. During a database session, the WebRowSet XML is sent to the specified database that is associated with the step. The WebRowSet XML document contains the following: • The primary key • The data to insert, update, or delete in the specified table in the WebRowSet • The SQL SELECT statement to specify the table |
GetMessage | Returns the log contents of the previously executed PutMessage action. This is optional. |
Connect | Opens a persistent connection to the database |
Disconnect | Closes an existing database connection and performs cleanup actions. Tip: Call Connect and Disconnect explicitly in your process flow. |
BeginTransaction | Starts an implicit transaction for the session that can be committed or rolled back. You must specify the session to associate with the BeginTransaction action. |
CommitTransaction | Commits any SQL statements that have been sent for insert/update/delete operations made on the database using the WebRowSet XML data. |
RollBackTransaction | Rolls back any SQL statements that have been sent to the database using the WebRowSet XML format. You must specify the session to associate with the RollBackTransaction action. |
Action | Parameter | Parameter Description |
---|---|---|
PutMessage | Message | Name of the message to put. |
GetMessage | Message | Name of the message to get. |
Connect | - | - |
Disconnect | - | - |
BeginTransaction | - | - |
CommitTransaction | - | - |
RollBackTransaction | - | - |
Action | Property | Property Description |
---|---|---|
PutMessage | Ignore Update Errors | Indicates whether the batch update operations must be stopped on the occurrence of the first error. The options are: • True - Batch update operations continue regardless of the SQL errors that may occur during the current batch request. • False - Batch update operations stop at the occurrence of the first error during the batch request. The default value is False. Note: This option applies only to the errors or SQL exceptions that occur while running JDBC statements. |
GetMessage | - | |
Connect | - | - |
Disconnect | - | - |
BeginTransaction | - | - |
CommitTransaction | - | - |
RollBackTransaction | - | - |
Code | Name | Description | Reason |
---|---|---|---|
8 | ERR_WRITERR | Error during the execution of the SQL statements | ERR_WRITERR is returned when Ignore Update Errors= false and an exception (StopOnErrorException) occurred when running the SQL statements. This error code denotes the error that occurred during the execution of the SQL statements constructed out of a WebRowSet batch request. This error code is also returned when there is an exception at the time of writing the batch response log to the log file. The methods returning this error code are GetMessage, Connect, Disconnect, and PutMessage. |
99 | COMPLETED_WITH_ERROR | Error when a batch request failed | COMPLETED_WITH_ERROR is returned when Ignore Update Errors="true" and an exception occurred when running a SQL statement. This error indicates that the particular batch request has failed. The PutMessage method returns this error code. |
27 | ERR_CLOSERR | Error when disconnecting from the database | ERR_CLOSERR is returned when an exception is encountered at the time of disconnecting from the given database. The Disconnect method returns this error code. |
19 | ERR_OPENERR | Error when connecting to the database | ERR_OPENERR is returned when an exception is encountered while connecting to the target database. The Connect method returns this error. |
98 | ERR_TRANSACT | Error during transaction sequence | ERR_TRANSACT is returned when an exception occurs while the beginTransaction, CommitTransaction, or RollbackTransaction methods are run by JDBC WebRowSet Aggregator component. |
34 | ERR_INVALID | Error while parsing the WebRowSet XML document | ERR_INVALID is returned when an exception occurs while parsing of the WebRowSet XML document. Possible causes: • Invalid XML element • Invalid formats. Examples: • Specify a date value in a format other than yyyy-mm-dd. • Enter an alphanumeric value for an integer value. Use this error code to either commit or rollback that particular transaction depending on your requirements. The PutMessage method returns this error code. The batch response log file contains all the records leading up to (but not including) the record that returned ERR_INVALID. |
96 | ERR_PK_UNDEFINED | Error when a primary key is not defined in the WebRowSet XML document | ERR_PK_UNDEFINED is returned when there are no primary keys defined in the WebRowSet XML request. The PrimaryKeyNotDefinedException is thrown in this case. The PutMessage method returns this error code. |
44 | ERR_NOTSUP | Error when the WebRowSet XML request contains unsupported data types | ERR_NOTSUP is returned when the WebRowSet XML request contains unsupported data types like binary data. The UnSupportedDataTypeException is thrown in this case. JDBC WebRowSet Aggregator checks the column type present in the metadata section to confirm if the data type is binary. The PutMessage method returns this error code. |
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 |