In this section: |
The following topics describe how to create, edit, or delete a channel for your iWay Event. All defined event ports must be associated with a channel.
The channel (or listener) you configure depends on your .Net application. For example, your .Net application must be written or modified to publish an event. This event can take the form of writing to a file, inserting into a database, or posting to an HTTP or TCP port. Depending on your NET application, you would select the appropriate channel listener.
The following channels are available:
Note: MSMQ will be supported as a channel option in a future release.
The following procedure describes how to create a channel using iWay Explorer.
To create an MQSeries channel:
The iWay Events window opens. The iWay adapters that appear in the left pane support events.
The ports and channels nodes appear in the left pane.
The Add a new DOTNET channel dialog box opens in the right pane and contains fields to enter a name, description, and channel type.
The following image shows the MQSeries information that appears in the right pane.
The following table lists and describes the parameters for the MQSeries channel.
Parameter |
Description |
---|---|
Queue manager name |
Name of the queue manager to which the server must connect. |
MQ server host for MQClient operation |
Host on which the MQ server is located (for the MQ Client only). |
MQ server port for MQClient operation |
Number to connect to an MQ server queue manager (for the MQ client only). |
MQ server channel for MQClient operation |
Case-sensitive name of the channel that connects with the remote MQ server queue manager (for the MQ client only). SYSTEM.DEF.SVRCONN is the default channel name for MQSeries. |
Document type XML |
Leave the default selection. |
Request queue name |
Queue where the message is routed and where request documents are received. The name of the queue is case-sensitive and conforms to the following format: Host\queue type$\qName where:
|
Sync type |
Choose from three options:
|
Message wait interval (ms) |
Interval (in milliseconds) when to check for new input. Optional. The default is 3 seconds. |
Mode of operation |
Choose threaded or sequential.
|
Thread limit |
If you selected threaded processing, indicate the maximum number of requests that can be processed simultaneously. The default is 3. |
The Select Ports dialog box opens in the right pane and may include lists of available and current ports with arrow buttons to enable you to move ports from one list to the other.
The following image shows that summary information appears in the right pane.
The summary information provides the channel description, channel status, and current ports. All the information is associated with the channel you created.
The following image shows that the channel also appears under the channels node in the left pane. An X over the icon indicates that the channel is currently disconnected.
You must start the channel to activate your event configuration.
To create an HTTP channel:
The iWay Events window opens. The iWay adapters that appear in the left pane support events.
The ports and channels nodes appear in the left pane.
The following image shows the Edit channels information that opens in the right pane.
The following table lists and describes the parameters required for creating an HTTP channel.
Parameter |
Description |
---|---|
Listener port |
Port on which to listen for .Net event data. |
Https |
Use Https (HTTP over SSL). This is not selected by default. |
Synchronization Type |
|
The Select Ports dialog box opens in the right pane and may include lists of available and current ports with arrow buttons to enable you to move ports from one list to the other.
The following image shows that summary information appears in the right pane.
The summary information provides the channel description, channel status, and current ports. All the information is associated with the channel you created.
The following image shows that the channel also appears under the channels node in the left pane. An X over the icon indicates that the channel is currently disconnected.
You must start the channel to activate your event configuration.
To create a JMSQ channel:
The iWay Events window opens. The iWay adapters that appear in the left pane support events.
The ports and channels nodes appear in the left pane.
The Add a new DOTNET channel information appears in the right pane.
The Edit channels information for the JMS Listener channel appears in the right pane and includes the Request, Response, and Advance tabs.
The following table lists and describes the parameters for the JMS Listener.
Parameter |
Description |
---|---|
JNDI context factory |
Is JNDI context. INITIAL_CONTEXT_FACTORY is provided by the JNDI service provider. |
JMS context factory |
Resource that contains information about the JMS Server. |
Queue to put documents in |
JNDI name of a queue to which events are emitted. |
URL to reach the JNDI server |
URL to use to contact the JNDI provider. The syntax of this URL depends on the JNDI provider being used. This value corresponds to the standard JNDI property, java.naming.provider.url. |
Synchronization type |
Choose from three options:
|
Poll interval (msec) |
Interval (in milliseconds) when to check for new input. Optional. The default is 3 seconds. |
Processing Mode |
Choose threaded or sequential.
|
Thread limit (0 for unlimited) |
If you selected threaded processing, indicate the maximum number of requests that can be processed simultaneously. The default is 3. |
The Select Ports dialog box opens in the right pane and may include lists of available and current ports with arrow buttons to enable you to move ports from one list to the other.
The following image shows that summary information appears in the right pane.
The summary information provides the channel description, channel status, and current ports. All the information is associated with the channel you created.
The following image shows that the channel also appears under the channels node in the left pane. An X over the icon indicates that the channel is currently disconnected.
You must start the channel to activate your event configuration.
To create a Table channel:
The iWay Events window opens. The iWay adapters that appear in the left pane support events.
The ports and channels nodes appear in the left pane.
The Add a new DOTNET channel dialog box opens in the right pane and contains fields to enter a name, description, and channel type.
The Table Listener configuration properties appears in the right pane. The following image shows the Table listener properties that must be configured, depending on the type of Table you want to create.
The following table lists and describes the parameters needed to define a Table Listener.
Parameter |
Description |
---|---|
Host |
Name or URL of the machine where the database is installed. |
Port |
Port on which the Host database is listening. |
Database Name
SID
Data Source
|
|
User |
Database user ID to access the table. |
Password |
Database password associated with the user ID. |
Polling Interval |
Interval, in milliseconds, at which to check for new input. |
SQL Query |
SQL SELECT statement that the listener issues to poll the table. If the SQL statement includes a date column or long text column, you must provide a value for the SQL Post-query parameter. The value you provide must not contain a date column or a long text column. This applies whether you provide an SQL statement here or rely upon the default. For example, the following SELECT statement retrieves all unprocessed records from the DISCRETE_JOBS table: SELECT * FROM WIP_DISCRETE_JOBS D WHERE DJ.WIP_ENTITY_ID > (SELECT WIP_ENTITY_ID FROM WIP.TEMP_NEW_WORK_ORDER_ENTITY_ID) Important: When a SQL Query joins two or more tables, a SQL Post Query must be used. Also, do not use a semicolon at the end of a SQL statement for a SQL Query or a SQL Post Query. |
Post Query |
A SQL statement that is executed after each new record has been read from the table. This is case sensitive: the case used to specify the column names must match the case used in the SELECT statement that polled the table. If the SQL Query property was omitted so that a default SELECT statement polled the table, the case used to specify the column names must match the case used to define the columns in the DBMS's native schema. If you do not specify a value for SQL Post-query, each record read from the table will be deleted after it has been read. How this happens depends on whether you specify the Delete Keys property. If you:
You can choose to retain the table's data once it has been read by specifying a value for this parameter, as shown in the examples that follow. Note that the SQL Post-query and Delete Keys parameters are mutually exclusive, as Delete Keys applies to the default DELETE statement, and SQL Post-query overrides the default DELETE statement. You can provide a value for one or the other, but not for both. There are two field operators, ? and ^, that you can use in a post-query SQL statement; for more information, see The Post-query Parameter Operators. Important: When a SQL Query joins two or more tables, a SQL Post Query must be used. Also, do not use a semicolon at the end of a SQL statement for a SQL Query or a SQL Post Query. |
Delete Keys |
Comma-separated list of key columns to be used in the default DELETE statement. DELETE operates on keys, so specify the table's key columns. This is case sensitive: the case used to specify the column names must match the case used in the SELECT statement that polled the table. If the SQL Query property was omitted so that a default SELECT statement polled the table, the case used to specify the column names must match the case used to define the columns in the DBMS's native schema. Note that the Delete Keys and SQL Post Query parameters are mutually exclusive, as Delete Keys applies to the default DELETE statement, and SQL Post Query overrides the default DELETE statement. You can provide a value for one or the other, but not for both. For more information, see the description of the SQL Post-query parameter in this table. |
The Select Ports dialog box opens in the right pane and may include lists of available and current ports with arrow buttons to enable you to move ports from one list to the other.
The following image shows that summary information appears in the right pane.
The summary information provides the channel description, channel status, and current ports. All the information is associated with the channel you created.
The following image shows that the channel also appears under the channels node in the left pane. An X over the icon indicates that the channel is currently disconnected.
You must start the channel to activate your event configuration.
To create a TCP Channel:
The iWay Events window opens. The iWay adapters that appear in the left pane support events.
The ports and channels nodes appear in the left pane.
The Add a new DOTNET channel dialog box opens in the right pane.
The Edit channels information appears in the right pane.
The following table lists and describes the parameters for the TCP Listener.
Parameter |
Description |
---|---|
Host |
Host name of the application server. |
Port Number |
For TCP/IP, specify port number. |
Synchronization Type |
Choose from three options:
|
Is Length Prefix |
For .Net events that send data back that is not in XML format. The TCP/IP event application must prefix the data with a 4-byte binary length field when writing the data to the TCP/IP port. |
Is XML |
For .Net events that send data back in XML format. No preparser is required. |
Is Keep Alive |
Maintains continuous communication between the event transaction and the channel. |
The Select Ports dialog box opens in the right pane and may include lists of available and current ports with arrow buttons to enable you to move ports from one list to the other.
The following image shows that summary information appears in the right pane.
The summary information provides the channel description, channel status, and current ports. All the information is associated with the channel you created.
The following image shows that the channel also appears under the channels node in the left pane. An X over the icon indicates that the channel is currently disconnected.
You must start the channel to activate your event configuration.
The iWay Events window opens. The iWay adapters that appear in the left pane support events.
The ports and channels nodes appear in the left pane.
The Add a new DOTNET channel dialog box opens in the right pane and contains fields to enter a name, description, and channel type.
The Edit channels information for the File channel appears in the right pane, showing a Request tab, a Response tab, and an Advanced tab.
A table that lists parameters and their definitions for each channel type follows the image.
The following table lists and describes the parameters for the File Listener.
Parameter |
Description |
---|---|
Polling Location |
The target file system location for the .Net XML file. |
File Mask |
The file name to be used for the output file generated as a result of this operation. |
Synchronization Type |
Choose from three options:
|
Response/Ack Directory |
The target file system location for the .Net XML file. |
Error Directory |
Directory to which documents with errors are written. |
Poll interval (msec) |
Interval (in milliseconds) when to check for new input. Optional. The default is 3 seconds. |
Processing Mode |
Choose threaded or sequential.
|
Thread limit |
If you selected threaded processing, indicate the maximum number of requests that can be processed simultaneously. The default is 3. |
The Select Ports dialog box opens in the right pane and may include lists of available and current ports with arrow buttons to enable you to move ports from one list to the other.
The following image shows that summary information appears in the right pane.
The summary information provides the channel description, channel status, and current ports. All the information is associated with the channel you created.
The following image shows that the channel also appears under the channels node in the left pane. An X over the icon indicates that the channel is currently disconnected.
You must start the channel to activate your event configuration.
The channel becomes active and the X over the icon disappears.
The following procedures describe how to edit and delete a channel.
The Edit channels dialog box opens.
A confirmation dialog box opens.
The channel disappears from the list in the left pane.
iWay Software |