Oracle AQ JMS Queue Adapter
The Oracle AQ JMS Queue adapter sends and receives messages from a remote Oracle AQ JMS queue.
The following table provides an overview of the Oracle® AQ JMS Queue adapter:
Category | Description |
---|---|
System name | Oracle AQ JMS Queue Adapter |
Graphical Process Modeler (GPM) category | All, Queuing |
Description | Sends messages to and receives messages from a remote Oracle AQ JMS queue. Use this adapter when you want to exchange messages with a remote Oracle AQ JMS Queue server as part of a business process within Sterling B2B Integrator. |
Preconfigured? | No |
Requires third-party files? | Yes. aqapi.jar, and, if not already installed, the correct driver for your Oracle database version. |
Platform availability | All supported Sterling B2B Integrator platforms |
Related services | Oracle AQ JMS Topic adapter |
Application requirements | No |
Initiates business processes? | Yes. See How the Oracle AQ JMS Queue Adapter Works. |
Invocation | Runs as part of a business process. |
How the Oracle AQ JMS Queue Adapter Works
The following steps summarize how the Oracle AQ JMS Queue adapter works within a business process when you send or receive messages.
When Sending Messages to a Remote Oracle AQ JMS Queue
- The Oracle AQ JMS Queue adapter connects to the remote Oracle AQ JMS Queue server and sends a message.
- Sterling B2B Integrator proceeds with the next step in the business process.
When Receiving Messages from a Remote Oracle AQ JMS Queue
- The Oracle AQ JMS Queue adapter connects to the remote Oracle AQ JMS Queue server and checks for and receives any available data.
- The Oracle AQ JMS Queue adapter initiates the appropriate business process (the business process you specified when you configured the adapter).
- Sterling B2B Integrator proceeds
with the next step in the business process.Note: The Oracle AQ API does not allow for a timeout. The Oracle AQ adapter may have threads open waiting on a response from the Oracle AQ Server for an unknown time period. If this occurs and if you see open Oracle AQ processes in Sterling B2B Integrator not responding for a long time, break the connections on the AQ server to force AQ to close connections with Sterling B2B Integrator and release the threads. If this is a consistent problem in your Oracle environment, review the Sterling B2B Integrator Performance and Tuning documentation for instructions on how to manage thread resources and queues.
Implementing the Oracle AQ JMS Queue Adapter
To implement the Oracle
AQ JMS Queue adapter, complete the following tasks:
- Activate your license for the Oracle AQ JMS Queue adapter. For information, see An Overview of Implementing Services.
- Verify that you have Sterling B2B Integrator and Oracle installed.
- If it is running, stop Sterling B2B Integrator.
- From the bin directory where Sterling B2B Integrator is installed, install the
necessary third-party files (aqapi.jar and classes12.zip) using the install3rdParty script included
with Sterling B2B Integrator. Use the Oracle
version number and the absolute path to the files to enter commands similar to the following examples:
- On a UNIX or Linux system, enter:
./install3rdParty.sh Oracle 10_1 -d
absolutePath/aqapi.jar
./install3rdParty.sh Oracle 10_1 -d
absolutePath/classes12.zip
- On a Windows system, enter:
install3rdParty.cmd Oracle 10_1 -d
absolutePath/aqapi.jar
install3rdParty.cmd Oracle 10_1 -d
absolutePath/classes12.zip
- On a UNIX or Linux system, enter:
- Restart Sterling B2B Integrator.
- Set up a queue in Oracle AQ. For information, see your Oracle AQ documentation.
- Create an Oracle AQ JMS Queue adapter configuration. For information, see Managing Services and Adapters.
- Configure the Oracle AQ JMS Queue adapter. For information, see Configuring the Oracle AQ JMS Queue Adapter.
- Use the Oracle AQ JMS Queue adapter in a business process.
Configuring the Oracle AQ JMS Queue Adapter
To configure the Oracle AQ JMS Queue Adapter, you must specify settings for the following fields in Sterling B2B Integrator:
Note: The
field names in parentheses represent the corresponding field names
in the GPM. This information is provided for your reference.
Field | Description |
---|---|
Name | Unique, meaningful name for the adapter configuration. Required. |
Description | Meaningful description for the adapter configuration, for reference purposes. Required. |
Select a Group | Select one of the options:
Note: For more information about groups, see Managing Services
and Adapters.
|
System ID (sid) | Name of the Oracle AQ system. |
Host(host) | Host address of the Oracle AQ system. |
Port(port) | Port number of the Oracle AQ system. |
Driver(driver) | Driver name used to access the Oracle AQ system. |
User Name(userName) | User name used to access the Oracle AQ system. |
Password(passWord) | Password associated with the user name used to access the Oracle AQ system. |
Schema Name(queueSchema) | Schema name associated with the queue. |
Queue Name(queueName) | Name of the queue to access. |
Queue Type(Action) | Type of queue to access. Valid values are:
|
Message Type(payload) | Type of message to send. Valid values are:
|
Buffer Size | Size of the buffer when receiving data. Enables you to fine-tune the performance of the adapter according to data expectations. |
Filename(filename) | File name to assign, if any, and the file name extension. A unique file name generator placeholder, %^, can be used to generate a sequence in the form yyyymmddhhmmsslll. |
Business process(initialWorkFlowId) | Business process you want the Oracle AQ JMS Queue adapter to start, if any. Required only if the Oracle AQ JMS Queue adapter starts a business process. |
Do not use schedule | If field is selected, this service does not start a business process and does not run on a schedule. |
Run service based on timer every | Valid values are the hour and minutes at which to run the service. Indicate whether you want the service to run at startup. |
Run service daily at | Valid values are the hour and minutes at which to run the service, daily. Indicate whether you want the service to run at startup. |
Run service weekly on | Valid values are the day of the week, the hour, and the minutes at which to run the service. Indicate whether you want the service to run at startup. |