Skip Headers

Oracle9iAS InterConnect Adapter for MQ Series Installation and User's Guide
Release 2 (9.0.2)
Part Number A95443-01
Go To Documentation Library
Home		 Go To Table Of Contents
Contents		 Go To Index
Index

Go to previous page Go to next page

2
Installation and Configuration

This chapter discusses the following topics:

Installing the MQ Series Adapter

This section contains these topics:

Preinstallation Tasks

The MQ Series adapter must be installed in one of the following Oracle homes:

Before installation, make sure that the MQ Series server and possibly the MQ Series client if the server is running on a remote host, are installed.

For IBM installation guides, see the following:

Verify that the MQ Series installation is working before commencing the installation of the MQ Series adapter.

See Also:

Verifying the Installation in all IBM guides.

Consult the Oracle9i Application Server Installation Guide before proceeding with MQ Series adapter installation. This guide includes information on:

Installation Tasks

To install the MQ Series adapter:

  1. Click Next on the Welcome page.

    The File Locations page displays.

  2. Enter the following information in the Destination fields:

  3. Click Next.

    The Installation Types page displays.

  4. Select Oracle9iAS InterConnect Adapters and click Next.

    The Available Product Components page displays.

  5. Select Oracle9iAS InterConnect MQ Series Adapter and click Next.

  6. If the MQ Series adapter is not being installed on the same computer as Oracle9iAS InterConnect and another adapter is not installed in the current Oracle home, the Oracle9iAS InterConnect Hub Database page displays. Enter the following information about the Oracle9iAS InterConnect Hub to use:

    • Host name--The hostname of the computer on which Oracle9iAS InterConnect is installed.

    • Port Number--The port number of the computer.

    • Database SID--The system identifier (SID) of the Oracle9iAS InterConnect Oracle9iAS Metadata Repository.

    • Password--The password for the Oracle9iAS Metadata Repository schema.

    The Oracle9iAS Metadata Repository stores metadata used by Oracle9iAS InterConnect to coordinate communication between components.

  7. Click Next.

    The Oracle9iAS InterConnect MQ Series Adapter Configuration page displays.

  8. Enter the name of the application associated with the MQ Series adapter. White spaces or blanks are not allowed. This is the same application name created or to be created in iStudio. The default value is myMQseriesApp.

  9. Click Next.

    The Oracle9iAS InterConnect MQ Series Adapter usage page displays.

  10. Select one of the following options and go to the step specified to enable the sending and/or receiving of messages from an external data source, such as an MQ Series server. You can change your selections later by editing parameter settings in the adapter.ini file.

    If You Select... Then Click Next and Go to Step...

    Configure for both sending and receiving messages

    11

    Configure for sending messages ONLY

    11

    Configure for receiving messages ONLY

    13

  11. Enter the following information in the Oracle9iAS InterConnect MQ Series Adapter Configuration - Configure sending endpoint information page:

    • MQ Series inbound queue--The URI of the MQ Series queue to which messages are sent.

    • MQ Series inbound log queue--The URI of the MQ Series queue which temporarily stores log records during sending transactions. This queue and the next can refer to the same physical MQ Series queue.

    • MQ Series inbound id queue--The URI of the MQ Series queue which is used to store and generate unique (sequential) transaction identifiers for the inbound or sending transactions.

  12. Click Next.

    The installation page that displays next is based on the selection you made in Step 10:

    If You Selected... Then Go to Step...

    Configure for both sending and receiving messages

    13

    Configure for sending messages ONLY

    14

  13. Enter the MQ Series outbound queue and topic information. This is a URI for the MQ Series queue or topic from which messages are receiving. It is used for listening to incoming messages from MQ Series or as JMS ReplyTo addresses when sending request messages to MQ Series.

  14. Enter the following information on the Oracle9iAS InterConnect MQ Series Adapter - Define MQ Series connection information page:

    • MQ Series Java installation path--This path specifies the root directory of the MQ Series Java (client) installation, which typically is /opt/mqm/java. At the startup time, the MQ Series Adapter will look in the lib subdirectory of this path to find the JAR files jms.jar, com.ibm.mqjms.jar, and com.ibm.mq.jar.

    • MQ Series Queue Manager--The name of the MQ Series queue manager to which to connect.

    • MQ Series Client Connection Type--From the drop down list, select the type of connection to make to the MQ Series queue manager. Select Remote to use a client connection (through an MQ Series channel), or select Local to bind to a queue manager running on the same machine as the adapter.

  15. Click Next.

    The installation page that displays next is based on the selection you made in Step 14:

    If You Selected... Then Go to Step...

    Remote

    16

    Local

    17

  16. Enter the following information on the Oracle9iAS InterConnect MQ Series Adapter - Specify MQ Series client connection parameters page:

    • Host Name--The DNS name of the host where the MQ Series queue manger resides.

    • Port Number--The port number to connect to on the MQ Server host. The default port number is 1414. This port is defined when starting the MQ Series listener via the command runmqlsr (for example, runmqlsr -m <qmqr> -t tcp -p 1415).

    • MQ Series Channel Name--The name of the MQ Series channel to use for the client connection.

  17. Click Next.

  18. Complete any other fields for other components selected for installation, such as other adapters.

    When finished, the Summary page displays.

  19. Click Install to install the MQ Series adapter. The adapter is installed in the following directory:

    Platform Directory

    Windows

    $ORACLE_HOME\oai\9.0.2\adapters\Application

    UNIX

    $ORACLE_HOME/oai/9.0.2/adapters/Application

    Application is the value you specified in Step 8 .

Configuring the MQ Series Adapter

Table 2-2, Table 2-3, and Table 2-4 describe executable files, configuration files, and directories. These files and directories are accessible from the directory shown in Table 2-1:

Table 2-1 MQ Series Adapter Directory

Platform Directory

UNIX

$ORACLE_HOME/oai/9.0.2/adapters/Application

Windows

%ORACLE_HOME%\oai\9.0.2\adapters\Application

Table 2-2 Executable Files

File Description

start.bat (Windows)
start (UNIX)

Takes no parameters, starts the adapter.

stop.bat (Windows)
stop (UNIX)

Takes no parameters; stops the adapter.

ignoreErrors.bat (Windows)
ignoreErrors (UNIX)

If an argument is specified, then the given error code will be ignored. If no argument is specified, than all error codes specified in the ErrorCodes.ini will be ignored.

Table 2-3 Configuration Files

File Description

ErrorCodes.ini (Windows and UNIX)

Should contain one error code per line.

adapter.ini (Windows and UNIX)

Consists of all the initialization parameters which the adapter reads at startup. Refer to Appendix A for a typical adapter.ini file.

d3l-file.xml

One or more D3L XML files that describe the mappings between MQ Series native/binary fixed-structure messages and Oracle9iAS InterConnect Application View messages.

Table 2-4 Directories

File Description

persistence

The messages are persisted in this directory. This directory or its contents should not be edited

logs

The logging of adapter activity is done in subdirectories of the log directory. Each new run of the adapter creates a new subdirectory in which logging is done in an oailog.txt file.

Using the Application Parameter

Adapters do not have integration logic. The MQ Series adapter has a generic transformation engine that processes metadata from the repository as runtime instructions to do transformations. The application defines for an adapter what its capabilities are. For example, it can define what messages it can publish, what messages it can subscribe to, and what are the transformations to perform. The application parameter allows the adapter to become smart in the context of the application to which it is connected. It allows the adapter to retrieve from the repository only that metadata that is relevant to the application. The application parameter must match the corresponding application that will be defined in iStudio under the Applications folder.

If you are using pre-packaged metadata, after importing the pre-packaged metadata into the repository, start up iStudio to find the corresponding application (under the Applications folder in iStudio) to use as the application for the adapter you are installing (unless the package you are using provides directions for what the application should be).

ini Files

Hub.ini

The MQ Series adapter connects to the hub database using parameters from the hub.ini file located in the hub directory. The following table lists the parameter name, a description for each parameter, the possible and default values, and an example.

Parameter Description Example

hub_username

The name of the hub database schema (or username). The possible value is a valid hub database username. The default value is NONE.

hub_username=myhub

hub_password

The password for the hub database user. The possible value is a the valid password for the hub database user. The default value is NONE.

hub_password=manager

hub_host

The name of the machine hosting the hub database. The possible value is a the valid machine name. The default is NONE.

hub_host=mpjoshipc

hub_instance

The valid SID of the hub database. The possible value is a valid SID. The default is NONE.

hub_instance=orcl

hub_port

The TNS listener port number for the HUB database instance. The possible value is a TNS listener port number. The default value is NONE.

hub_port=1521

repository_name

The name of the repository this adapter talks to. The possible value is a valid repository name. The default value is NONE.

repository_name=myrepo

Adapter.ini

The MQ Series adapter connects to the spoke application using parameters from the adapter.ini file. The following table lists the parameter name, a description for each parameter, the possible and default values, and an example.

Parameter Description Example

application

The name of the application to which this adapter connects. This must match with the name specified in iStudio during creating of metadata. Any alphanumeric string can be used. There is no default value.

application=mqapp

partition

The partition this adapter handles as specified in iStudio. Any alphanumeric string can be used. There is no default value.

partition=germany

instance_number

To have multiple adapter instances for the given application with the given partition, each adapter should have a unique instance number. Possible values are any integer greater than 1. There is no default value.

instance_number=1

agent_log_level

Specifies the amount of logging necessary. Possible values are:

0=errors only

1=status and errors

2=trace, status, and errors

The default value is 1.

agent_log_level=2

agent_subscriber_name

The subscriber name used when this adapter registers its subscription. The possible value is a valid Oracle Advanced Queueing subscriber name. There is no default value.

agent_subscriber_name=mqapp

agent_message_selector

Specifies conditions for message selection when registering its subscription with the hub. The possible value is a valid Oracle Advanced Queuing message selector string. There is no default value.

agent_message_selector=recipient_list like '%mqapp,%'

agent_reply_subscriber_name

The subscriber name is used when multiple adapter instances for the given application with the given partition are used. Optional if there is only one instance running. The possible value is application name (parameter: application) concatenated with instance number (parameter: instance_number). There is no default value.

If application=mqapp, instance_number=2, then, agent_reply_subscriber_name=mqapp2

agent_reply_message_selector

Used only if there are multiple adapter instances for the given application with the given partition. The possible value is a string built using concatenating application name (parameter:application) with instance number (parameter:instance_number). There is no default value.

If application=mqapp, instance_number=2, then agent_reply_message_selector=receipient_list like'%,mqapp2,%'

agent_tracking_enabled

Specifies if message tracking is enabled. Set to false to turn off all tracking of messages. Set to true to track messages with tracking fields set in iStudio. Possible values are true and false. The default value is true.

agent_tracking_enabled=true

agent_throughput_measurement_enabled

Specifies if throughput measurement is enabled. Set to true to turn on all throughput measurements. Possible values are true and false. The default value is true.

agent_throughput_measurement_enabled=true

agent_use_custom_hub_dtd

Specifies if a custom DTD should be used for the common view message when handing it to the hub. By default adapters use an Oracle9iAS InterConnect-specific DTD for all messages sent to the hub as other Oracle9iAS InterConnect adapters will be retrieving the messages from the hub and know how to interpret them. Set to true if for every message, the DTD imported for the message of the common view is to be used instead of the Oracle9iAS InterConnect DTD. Only set to true if a Oracle9iAS InterConnect adapter is not receiving the messages from the hub. Possible values are true and false. There is no default value.

agent_use_custom_hub_dtd=false

agent_metadata_caching

Specifies the metadata caching algorithm. Possible values are:

  • startup--Cache everything at startup. This may take a while if there are a lot of tables in the repository.

  • demand--Cache metadata as it is used.

  • none--No caching. This slows down performance.

The default value is demand.

agent_metadata_caching=demand

agent_dvm_table_caching

Specifies the DVM caching algorithm. Possible values are:

  • startup--Cache all DVM tables at startup. This may take a while if there are a lot of tables in the repository.

  • demand--Cache tables as they are used.

  • none--No caching. This slows down performance.

The default value is demand.

agent_dvm_table_caching=demand

agent_lookup_table_caching

Specifies the lookup table caching algorithm. Possible values are:

  • startup--Cache all lookup tables at startup. This may take a while if there are a lot of tables in the repository.

  • demand--Cache tables as they are used.

  • none--No caching. This slows down performance.

There default value demand.

agent_lookup_table_caching=demand

agent_delete_file_cache_at_startup

With any of the agent caching methods enabled, metadata from the repository is cached locally on the file system.

Set this parameter to true to delete all cached metadata on startup.

Note: After changing metadata or DVM tables for this adapter in iStudio, you must delete the cache to guarantee access to the new metadata or table information.

Possible values are true and false. There default value is false.

agent_delete_file_cache_at_startup=false

agent_max_ao_cache_size

Specifies the maximum number of application objects' metadata to cache. Possible values are any integer greater than 1. The default value 200.

agent_max_ao_cache_size=200

agent_max_co_cache_size

Specifies the maximum number of common objects' metadata to cache. Possible values are any integer greater than 1. The default value 100.

agent_max_co_cache_size=100

agent_max_message_metadata_cache_size

Specifies the maximum number of messages' metadata to cache (publish/subscribe and invoke/implement). Possible values are any integer greater than 1. The default value is 200.

agent_max_message_metadata_cache_size=200

agent_max_dvm_table_cache_size

Specifies the maximum number of DVM tables to cache. Possible values are any integer greater than 1. The default value is 200.

agent_max_dvm_table_cache_size=200

agent_max_lookup_table_cache_size

Specifies the maximum number of lookup tables to cache. Possible values are any integer greater than 1. The default value is 200.

agent_max_lookup_table_cache_size=200

agent_max_queue_size

Specifies the maximum size that internal Oracle9iAS InterConnect message queues can grow. Possible values are any integer greater than 1. The default value is 1000.

agent_max_queue_size=1000

agent_persistence_queue_size

Specifies the maximum size that internal Oracle9iAS InterConnect persistence queues can grow. Possible values are any integer greater than 1. The default value is 1000.

agent_persistence_queue_size=1000

agent_persistence_cleanup_interval

Specifies how often the persistence cleaner thread should run. Possible values are any integer greater than 30000. The default value is 60000.

agent_persistence_cleanup_interval=60000

agent_persistence_retry_interval

Specifies how often the persistence thread should retry when it fails to push a Oracle9iAS InterConnect message. Possible values are any integer greater than 5000. There default value is 60000.

agent_persistence_retry_interval=60000

service_path

Windows only. The value that the environment variable PATH should be set to the specified value before forking the Java VM. Typically, all directories containing all necessary DLLs should be listed here. Possible values are the valid path environment variable setting. There is no default value.

service_path=%JREHOME%\bin;D:\oracle\ora902\bin

service_classpath

The classpath used by the adapter Java VM. If a custom adapter is developed and as a result, the adapter is to be used to pick up any additional jars, add the jars to the existing set of jars being picked up. Possible values are the valid classpath. There is no default value.

service_classpath=D:\oracle\
ora902\oai\902\lib\
oai.jar;%JREHOME%\lib\i18n.jar;D:\oracle\ora902\jdbc\classes12.zip

service_class

The entry class for the Windows NT service. Possible values are oracle/oai/agent/service/AgentService. There is no default value.

service_class=oracle/oai/agent/service/AgentService

service_max_java_stack_size

Windows only. The maximum size to which the Java VM's stack can grow. Possible values are the valid Java VM maximum native stack size. The default value is the default for the Java VM.

service_max_java_stack_size=409600

service_max_native_stack_size

Windows only. The maximum size to which the Java VM's native stack can grow. Possible values are the valid Java VM maximum native stack size. The default value is the default for the Java VM.

service_max_native_size=131072

service_min_heap_size

Windows only. Specifies the minimum heap size for the adapter Java VM. Possible values are the valid Java VM heap sizes. The default value is the default Java VM heap size.

service_min_heap_size=536870912

service_max_heap_size

Windows only. Specifies the maximum heap size for the adapter Java VM. Possible values are any valid Java VM heap sizes. The default value is 536870912.

service_max_heap_size=536870912

service_num_vm_args

Windows only. The number of service_vm_arg<number> parameters specified. Possible values are the number of service_vm_arg<number> parameters. There is no default value.

service_num_vm_args=1

service_vm_arg<number>

Windows only. Specifies any additional arguments to the Java VM. For example, to get line numbers in any of the stack traces, set service_vm_arg1=java.compiler=NONE. If there is a list of arguments to specify, use multiple parameters as shown in the example by incrementing the last digit starting with 1. Be sure to set the service_num_vm_args correctly. Possible values are any valid Java VM arguments. There is no default value.

service_vm_arg1=java.compiler= NONE

service_vm_arg2=oai.adapter=.mq

MQ Series Adapter Parameters

The following table lists the parameters specific to the MQ Series adapter.

Parameter Description Example

bridge_class

Indicates the entry class for the MQ Series adapter. Do not modify this value. The only possible value is oracle.oai.agent.adapter.mqseries.MQBridge. There is no default value.

bridge_class=oracle.oai.agent.adapter.mq.MQBridge

ota.type

This defines the message type that the Oracle9iAS InterConnect Technology Adapter will handle for both incoming and outgoing messages. Possible values are XML and D3L. The default value is XML.

ota.type=D3L

mq.default.sender. destination.uri

A URI for the MQ Series inbound queue to which messages will be sent from Oracle9iAS InterConnect. The syntax for the URI is described in the MQ Series Using Java guide. Possible values are any valid JMS queue URIs. There is no default value.

mq.default.sender. destination.uri=queue: ///INBOUND.QUEUE?priority=1

mq.default.sender.log_queue.uri

URI for the MQ Series log queue used during send transactions. Possible values are any valid JMS queue URIs. There is no default value.

mq.default.sender.log_queue.uri=queue:///OAI.LOG.QUEUE

mq.default. sender.seq_queue.uri

URI for the MQ Series transaction id (sequence generator) queue used during send transactions. It can refer to the same queue as mq.default.sender.log_queue.uri. Possible values are any valid JMS queue URIs. There is no default value.

mq.default.sender.log_queue.uri=queue:///OIA.SEQ.QUEUE

mq.default.receiver. destination.uri

A URI for the MQ Series outbound queue or topic from which messages will be received. Used for listening to incoming messages or as a ReplyTo address when sending request messages to MQ Series. Possible values are any valid JMS queue URIs. There is no default value.

mq.default.receiver. destination.uri=topic: //SAP/Events/HR/ newEmployee

mq.default.receiver. selector

JMS selector expression applied while dequeueing from the receiver destination. Possible values are any valid JMS selector expressions. There is no default value.

mq.default.receiver. selector=JMS_IBM_Format <> 'MQSTR' AND JMSXUserID = 'scott'

mq.default. receiver.transacted

Specifies whether or not the JMS sessions for the receive URI should be transacted. The JMS session for the sender URI is always transacted. The possible value are Y and N. The default value is N.

mq.default.receiver. transacted=Y

mq.default. receiver.durable

If the receiver.destination.uri parameter specifies a JMS topic, then this parameter defines whether or not a durable subscriber should be used to subscribe to the topic. The possible values are Y and N. The default value is N.

mq.default.receiver. durable=Y

mq.default.receiver.exception.uri

A URI for a MQ Series queue to which unparsable outbound (native) messages will be enqueued. Possible values are any valid JMS queue URIs. The default value is blank.

mq.default.receiver.exception.uri= queue:///EXCEPTION.QUEUE

mq.default.queue_manager

The name of the MQ Series queue manager to connect to. The possible value is any MQ Series queue manager name. There is no default value.

mq.default.queue_manager=mars.queue.manager

mq.default. connection_type

The type of connection to make to an MQ Series queue manager. The possible values are bind (local) or client (remote). There is no default value.

mq.default.connection_type=client

mq.default.channel

The name of the MQ Series channel to use for the client connection. The possible value is any valid MQ Series channel name. The default value is blank.

mq.default.channel=SYSTEM.DEF.SVRCONN

mq.default.hostname

The DNS name of the host where the queue manager resides. The possible value is a valid hostname that can be reached over the network from the MQ Series adapter. The default value is blank.

mq.default.hostname= mqsvrhost1.acme.com

mq.default.port

The port to connect to on the MQ Server host (IBM's default is 1414). The possible value is a valid port number for the MQ Series listener. The default value is blank.

mq.default.port=1414

mq.default.user

MQ Series user ID when connecting to the queue manager. Equivalent to the MQ Series environment variable MQ_USER_ID. The value may be used to verify the identity of the MQ Series adapter. The possible value is a valid MQ Series username. The default value is blank.

mq.default.user=mqm

Encrypted_mq.default. password

MQ Series (encrypted) password when connecting to the queue manager. Equivalent to the MQ Series environment variable MQ_PASSWORD. The value may be used to verify the identity of the MQ Series adapter.

Encrypted_mq.default.password=112411071071106510801094108410731070107110811069

mq.default.receive_exit

Fully qualified class name of the receive exit being used. The possible value is the classname of a Java class that implements com.ibm.mq.MQReveiveExit. The default value is blank.

mq.default.receive_exit=mypackage. myReceiveExit

mq.default.send_exit

Fully qualified class name of the send exit being used. The possible value is the classname of a Java class that implements com.ibm.mq.MQSendExit. The default value is blank.

mq.default.send_exit=mypackage.mySendExit

mq.default.security_exit

Fully qualified class name of the security exit being used. The possible value is the classname of a Java class that implements com.ibm.mq.MQSecurityExit. The default value is blank.

mq.default.security_exit=mypackage.MySecurityExit

mq.default.ccsid

The coded-character-set-ID in use on connections instead of the default. For possible values, see table 16 in the MQ Series Using Java Guide. The default value is blank (~819).

mq.default.ccsid=1208

mq.default.polling_interval

The number of milliseconds between attempts to receive a message. Possible values are 0-java.lang.Long.MAX_VALUE. The default value is 5000.

mq.default.polling_interval=5000

mq.default.trans_id_expiry

The number of milliseconds before an idle transaction identifier will expire. Possible values are 0-java.lang.Long.MAX_VALUE. The default value is 60000.

mq.default.trans_id_expiry=360000

mq.default.event. name

Should be used if the bridge will only handle one single fixed event name for outbound messages (from MQ Series) and none of the other options below are feasible to use. This parameter requires only one D3L file defined below, with an event name exactly matching this hardcoded event name. The possible value is a valid Oracle9iAS InterConnect event name. The default value is blank.

mq.default.event.name= Price.update

mq.default.event.use_mq_fmt

If this parameter value is Y, the bridge uses the IBM MQ Series Message Format field as the name of the Oracle9iAS InterConnect event. This message field or property is often referred to as:

  • (C)--MQMD Format field (MQFMT)

  • (Java)--com.ibm.mq.jms.JMSC.FORMAT_PROPERTY

The possible values are Y and N. The default value is N.

mq.default.event.use_mq_fmt=Y

mq.default.event. property

If the sending external application is able to specify the event name as a message property value, use this parameter to define the name of the message property that will carry the message event name. The possible value is a valid JMS message property name. The default value is blank.

mq.default.event.property=MyApp_OAIEventProperty

mq.default.event.exit

Allows a custom Java class to be defined to determine which event name the native MQ Series message corresponds to. It is invoked by the bridge, which provides the received JMS message as input, expecting the event name in return (as a String). This Java class must implement the oracle.oai.agent.adapter.mqseries.MQEventExit interface. The possible value is the Java class name of a class that implements the oracle.oai.agent.adapter.mqseries.MQEventExit interface. The default value is blank.

mq.default.event.exit= mypackage.myMqEventExit

Go to previous page Go to next page
Oracle
Copyright © 2002 Oracle Corporation.
All Rights Reserved.
Go To Documentation Library
Home		 Go To Table Of Contents
Contents		 Go To Index
Index