Oracle® Application Server Integration InterConnect Adapter for AQ Installation and User's Guide
10g Release 2 (10.1.2) B14077-02 |
|
Previous |
Next |
This chapter describes how to install and configure the AQ adapter. It contains the following topics:
The AQ adapter must be installed in an existing Oracle home Middle Tier for Oracle Application Server Integration InterConnect 10g Release 2 (10.1.2).
This section describes the following topics:
Refer the following guides before installing the AQ adapter:
Oracle Application Server Installation Guide for information about Oracle Universal Installer (OUI) startup.
Oracle Application Server InterConnect Installation Guide for information on software, hardware, and system requirements for OracleAS Integration InterConnect.
To install the AQ adapter:
Select OracleAS Integration InterConnect Adapter for AQ 10.1.2.0.2 in the Available Product Components screen of the OracleAS Integration InterConnect installation wizard.
Click Next. The Set Oracle Wallet Password screen is displayed.
Enter and confirm the password on the screen, which will be used to manage OracleAS Integration InterConnect installation.
Click Next.
Go to step 5 if installing the AQ adapter in an OracleAS Middle Tier Oracle home that does not have an InterConnect component already installed. Ensure that the OracleAS Integration InterConnect hub has been installed.
Go to step 6 if installing the AQ adapter in an OracleAS Middle Tier Oracle home that has an existing InterConnect component. Ensure that it is a home directory to an OracleAS Integration InterConnect component.
The Specify Hub Database Connection screen is displayed. Enter information in the following fields:
Host Name: The host name of the computer where the hub database is installed.
Port Number: The TNS listener port for the hub database.
Database SID: The System Identifier (SID) for the hub database.
Password: The user password for the hub database user.
Click Next. The Specify AQ Adapter Name screen is displayed.
Enter the application name. Blank spaces are not permitted. The default value is myAQApp
.
Note: You can change the application name in iStudio after installation. In such case, you need to specify the password corresponding to new application name in the Oracle Wallet.For more informtion, refer to the following sections in Appendix A, "Frequently Asked Questions": |
Click Next. The Specify Spoke Application Database Connection screen is displayed. This screen configures the information for the spoke application database. Enter information in the following fields:
Host Name: The name of the computer where the spoke application database is installed.
Port Number: The TNS listener port for the spoke application database.
The information on this screen is for Advanced Queues, from which the adapter will deliver or receive messages.
Click Next. The Spoke Application Database AQ Username screen is displayed. Enter information in the following fields:
User Name: The name the AQ adapter uses to connect to the database.
Password: The password for the user name.
Consumer Name: The consumer name used by the application that writes to the queue. The consumer name indicates that OracleAS Integration InterConnect should pick up a message. Alternatively, the AQ adapter may have a subscriber configured to which the AQ adapter corresponds.
Leave this field blank if the queues that the AQ adapter will connect to on the application database side are single consumer queues. However, if any of the queues are multiconsumer queues, then specify a consumer name.
Use one of the following methods to determine the consumer name to use:
If the code that will write a message to the queue is already available, then look at the code or the documentation that comes with it to determine the consumer name.
If the code that will write a message to the queue is not written, then enter a string as the consumer name. When the code is built, ensure that the consumer names match. Alternatively, if the queue has a subscriber configured, then use the database's Advanced Queuing APIs to find the name.
Click Next. The Summary screen is displayed.
Click Install to install the AQ adapter and other selected components. The AQ adapter is installed in the following directory:
Platform | Directory |
---|---|
Windows | ORACLE_HOME \integration\interconnect\ adapters\Application
|
UNIX | ORACLE_HOME /integration/interconnect/adapters/ Application
|
Application
is the value specified in Step 7.
Click Exit on the Installation screen to exit the AQ adapter installation.
To install multiple instances of the AQ adapter in same Oracle home, use the copyAdapter
script located in the ORACLE_HOME
/integration/interconnect/bin
directory.
Usage: copyAdapter
app1 app2
For example, you have one instance of AQ adapter with name myAQApp
installed on a computer. To install another instance of the AQ adapter with name myAQApp1
in the same Oracle home, use the following command:
copyAdapter myAQApp myAQApp1
The copyAdapter
script is copied to the following bin
directory only during Hub installation:
UNIX: ORACLE_HOME/integration/interconnect/bin
Windows: ORACLE_HOME\integration\interconnect\bin
If you need to use this script to create multiple adapters on a spoke computer, then copy the script to the bin
directory on the spoke computer, and edit the script to reflect the new Oracle home.
After running the copyAdapter
script, If you want to manage or monitor the newly installed adapter through Oracle Enterprise Manager 10g Application Server Control Console, then you need to modify the opmn.xml
file by adding information about the new instance. For example, you have created a new instance of the AQ adapter myAQApp1
by using the copyAdapter
script. To manage the myAQApp1
adapter through Enterprise Manager, perform the following:
Navigate to the MiddleTier
\bin
directory and run the following command to stop the Enterprise Manager:
emctl stop iasconsole
Next, specify the information about this new instance in the opmn.xml
file located in the ORACLEMIDDLETIER_HOME
/opmn/conf
directory as follows:
<process-type id="myAQApp1" module-id="adapter" working-dir="$ORACLE_ HOME/integration/interconnect/adapters/myAQApp1" status="enabled"> <start timeout="600" retry="2"/> <stop timeout="120"/> <port id="icadapter_dmsport_range" range="15701-15800"/> <process-set id="myAQApp1" restart-on-death="true" numprocs="1"> <module-data> <category id="start-parameters"> <data id="java-parameters" value="-Xms8M"/> <data id="class-name" value="oracle.oai.agent.service.AgentService"/> </category> <category id="stop-parameters"> <data id="java-parameters" value="-mx64m"/> <data id="class-name" value="oracle.oai.agent.proxy.ShutdownAgent"/> <data id="application-parameters" value="persistence/Agent.ior"/> </category> </module-data> </process-set> </process-type>
The opmn.xml
file would appear like this:
<process-type id="myAQApp" module-id="adapter" working-dir="$ORACLE _HOME/integration/interconnect/adapters/myAQApp" status="enabled"> <start timeout="600" retry="2"/> <stop timeout="120"/> <port id="icadapter_dmsport_range" range="15701-15800"/> <process-set id="myAQApp" restart-on-death="true" numprocs="1"> <module-data> <category id="start-parameters"> <data id="java-parameters" value="-Xms8M"/> <data id="class-name" value="oracle.oai.agent.service.AgentService"/> </category> <category id="stop-parameters"> <data id="java-parameters" value="-mx64m"/> <data id="class-name" value="oracle.oai.agent.proxy.ShutdownAgent"/> <data id="application-parameters" value="persistence/Agent.ior"/> </category> </module-data> </process-set> </process-type> <process-type id="myAQApp1" module-id="adapter" working-dir="$ORACLE _HOME/integration/interconnect/adapters/myAQApp1" status="enabled"> <start timeout="600" retry="2"/> <stop timeout="120"/> <port id="icadapter_dmsport_range" range="15701-15800"/> <process-set id="myAQApp1" restart-on-death="true" numprocs="1"> <module-data> <category id="start-parameters"> <data id="java-parameters" value="-Xms8M"/> <data id="class-name" value="oracle.oai.agent.service.AgentService"/> </category> <category id="stop-parameters"> <data id="java-parameters" value="-mx64m"/> <data id="class-name" value="oracle.oai.agent.proxy.ShutdownAgent"/> <data id="application-parameters" value="persistence/Agent.ior"/> </category> </module-data> </process-set> </process-type>
Save the opmn.xml
file.
Navigate to the MiddleTier
\opmn\bin
directory and run the following command to reload the OPMN:
opmnctl reload
You can start the myAQApp1
adapter by using the following command
opmnctl startproc ias-component="InterConnect" process-type="myAQApp1"
Navigate to the MiddleTier
\bin
directory and run the following command to start the Enterprise Manager:
emctl start iasconsole
Login to the Oracle Enterprise Manager 10g Application Server Control Console to view and manage the newly installed or copied adapter. For information about how to use Oracle Enterprise Manager 10g Application Server Control Console , refer to the Oracle Application Server Integration InterConnect User's Guide
Note: While installing multiple adapters in the same computer, the copyadapter script does not create entries for the new adapter's password in the Oracle Wallet. You need to manually create a password for this new adapter using the Oracle Wallet Manager. To store the password in Oracle Wallet, use the following format:ApplicationName/password The number of entries is dependent on the type of adapter. For example, Database adapter needs two entries whereas AQ adapter needs only one entry. For more information about how to manage your passwords in Oracle Wallet, refer to AppendixA, "How do I secure my passwords?"in Appendix A, "Frequently Asked Questions" |
You can configure the AQ adapter according to your requirements. The following tables describe the location and details of the configuration files.
Table 2-1 describes the location where the adapter is installed:
Table 2-1 AQ Adapter Directory
Platform | Directory |
---|---|
UNIX |
|
Windows |
|
Table 2-2 describes the various executable files of the AQ adapter.
Table 2-2 Executable Files
File | Description |
---|---|
|
Does not use parameters; starts the adapter. |
|
Does not use parameters; starts the adapter. |
|
Does not use parameters; stops the adapter. |
|
Does not use parameters; stops the adapter. |
Table 2-3 describes the AQ adapter configuration files.
Table 2-3 Configuration Files
File | Description |
---|---|
|
Contains all the initialization parameters, which the adapter reads at startup. |
|
Contains all the initialization parameters, which the adapter reads at startup. |
Table 2-4 describes the directories used by the AQ adapter.
Table 2-4 Directories
File | Description |
---|---|
|
The adapter activity is logged in subdirectories of the |
|
The messages are persisted in this directory. Do not edit this directory or its files. |
Adapters do not have integration logic. The AQ adapter has a generic transformation engine that processes metadata from the repository as run-time instructions to perform transformations. The application parameter defines the capabilities of an adapter, such as the messages to be published and subscribed, and the transformations to be performed. The application parameter allows the adapter to retrieve only the relevant metadata from the repository. The application parameter must match the corresponding application that will be defined in iStudio, under the Applications folder.
If you use pre-packaged metadata, then import it into the repository and start iStudio to find the corresponding application under the Applications folder. You can use this as the application name for the adapter you are installing.
The following .ini
files are used to configure the AQ adapter:
The AQ adapter connects to the hub database using parameters in the hub.ini
file located in the hub
directory. Table 2-5 lists the description and an example for each parameter.
Table 2-5 hub.ini Parameters
Parameters | Description | Example |
---|---|---|
|
The name of the computer hosting the hub database. There is no default value. The value is set during installation. |
|
|
The SID of the hub database. There is no default value. The value is set during installation. |
|
|
The TNS listener port number for the hub database instance. There is no default value. The value is set during installation. |
|
|
The name of the hub database schema (or user name). There is no default value. |
|
|
The name of the repository that communicates with the adapter. The default value is |
|
Oracle Real Application Clusters hub.ini Parameters
For a hub installed on an Oracle Real Application Clusters database, the parameters listed in Table 2-6 represent information on additional nodes used for connection and configuration. These parameters are in addition to the default parameters for the primary node. In Table 2-6, x
represents the node number which can range from 2 to the total number of nodes in a cluster. For example, if the cluster contains 4 nodes, then x
can be a value between 2 and 4.
Table 2-6 Real Application Clusters hub.ini Parameters
Parameter | Description | Example |
---|---|---|
The host where the Real Application Clusters database is installed. |
|
|
The instance on the respective nod |
|
|
The number of nodes in a cluster. |
|
|
|
The port where the TNS listener is listening. |
|
The AQ adapter connects to the spoke application using parameters from the adapter.ini
file. Table 2-7 lists the parameters, their description, and an example for each parameter.
Table 2-7 adapter.ini Parameters
Parameter | Description | Example |
---|---|---|
Specifies the port through which the adapter can be accessed through firewalls. Possible value: A valid port number Default value: None |
|
|
Specifies whether to delete the cached metadata during start up. If any agent caching method is enabled, then metadata from the repository is cached locally on the file system. Set the parameter to Possible values: Default value: Note: After changing metadata or DVM tables for the adapter in iStudio, you must delete the cache to guarantee access to new metadata or table information. |
|
|
Specifies the Domain Value Mapping (DVM) table caching algorithm. Possible values:
Default value: |
|
|
Specifies the amount of logging necessary. Possible values:
Default value: 1 |
|
|
Specifies the lookup table caching algorithm. Possible values:
Default value: |
|
|
Specifies the maximum number of application object metadata to cache. Possible value: An integer greater than or equal to Default value: |
|
|
Specifies the maximum number of common object metadata to cache. Possible value: An integer greater than or equal to Default value: |
|
|
Specifies the maximum number of DVM tables to cache. Possible value: An integer greater than or equal to Default value: |
|
|
Specifies the maximum number of lookup tables to cache. Possible value: Any integer greater than or equal to Default value: |
|
|
Specifies the maximum number of message metadata (publish/subscribe and invoke/implement) to cache. Possible value: An integer greater than or equal to Default value: |
|
|
Specifies the maximum size to which the internal OracleAS Integration InterConnect message queues can grow. Possible value: An integer greater than or equal to Default value: |
|
|
Specifies conditions for message selection when the adapter registers its subscription with the hub. Possible value: A valid Oracle Advanced Queue message selector string (such as Default value: None |
|
|
Specifies the metadata caching algorithm. Possible values:
Default value: |
|
|
Specifies how often to run the persistence cleaner thread, in milliseconds. Possible value: An integer greater than or equal to Default value: |
|
|
Specifies the maximum size of internal OracleAS Integration InterConnect persistence queues. Possible value: An integer greater than or equal to Default value: |
|
|
Specifies how often the persistence thread retries when it fails to send an OracleAS Integration InterConnect message. Possible value: An integer greater than or equal to Default value: |
|
|
Specifies whether to activate the pipeline for messages from the hub to the bridge. If you set the pipeline to Possible value: Default value: |
|
|
Specifies whether to activate the pipeline for messages from the bridge to the hub. If you set the pipeline to Possible value: Default value: |
|
|
Specifies the application instance to which the reply must be sent. This parameter is used if multiple adapter instances exist for the given application and given partition. Possible value: A string built using the application name ( Default value: None |
|
|
Specifies the subscriber name used when multiple adapter instances are used for the given application and given partition. This parameter is optional if only one instance is running. Possible value: The application name ( Default value: None |
|
|
Specifies the subscriber name used when this adapter registers its subscription. Possible value: A valid Oracle Advanced Queue subscriber name Default value: None |
|
|
Specifies if the throughput measurement is enabled. Set this parameter to Possible value: Default value: |
|
|
Specifies if message tracking is enabled. Set this parameter to Possible value: Default value: |
|
|
Specifies whether to use a custom DTD for the common view message when handing it to the hub. By default, adapters use a specific OracleAS Integration InterConnect DTD for all messages sent to the hub. Set this parameter to Default value: None |
|
|
Specifies the name of the application to which this adapter connects. This must match the name specified in iStudio while creating metadata. Possible value: An alphanumeric string Default value: None |
|
|
Specifies the character encoding for published messages. The adapter uses this parameter to generate encoding information for the encoding tag of transformed OracleAS Integration InterConnect messages. OracleAS Integration InterConnect represents messages internally as XML documents. Possible value: A valid character encoding Default value: When there is no existing encoding in the subscribed message, this parameter is used to explicitly specify the encoding of the published message. This parameter is ignored when the encoding already exists in the subscribed message. |
|
|
|
Specify the base URL for loading external enitites and DTDs. This specifies to the XML parser to resolve the external entities in the instance document using the given URL. Possible value: A URL Default value: The URL of the current user directory |
|
Specifies the instance number to which this adapter corresponds. Specify a value only if you have multiple adapter instances for the given application with the given partition. Possible value: An integer greater than or equal to Default value: None |
|
|
Specifies the ISO country code. The codes are defined by ISO-3166. Possible value: A valid code. A full list of the codes is available at Default value: Note: This parameter specifies date format and is applicable only for the date format. |
|
|
Specifies the format for a date field expressed as a string. Possible value: A valid date format pattern as shown in Table 2-8 for the definitions of the format characters. |
Date format pattern
Multiple date formats can be specified as
|
|
Specifies the ISO language code. The codes are defined by ISO-639. Possible value: A valid code. A full list of these codes is available at Default value: Note: This parameter specifies date format and is applicable only for the date format. |
|
|
Specifies the partition this adapter handles in iStudio. Possible value: An alphanumeric string Default value: None |
|
|
Specifies the entry class for the Windows service. Possible value: Default value: None |
|
|
Specifies the class path used by the adapter JVM. If a custom adapter is developed and the adapter is to pick up any additional jar files, then add the files to the existing set of jar files. Possible value: A valid Default value: None This parameter is only for Microsoft Windows. |
|
|
Specifies the Dynamic Link Library(DLL) that the adapter JVM should use. Possible value: A valid Default value: This parameter is only for Microsoft Windows. |
|
|
|
Specifies the JDK version that the adapter JVM should use. Possible value: A valid JDK version number Default value: 1.4 This parameter is only for Microsoft Windows. |
|
Specifies the maximum heap size for the adapter JVM. Possible value: A valid JVM heap size Default value: This parameter is only for Microsoft Windows. |
|
|
Specifies the maximum size to which the JVM stack can grow. Possible value: A valid JVM maximum stack size Default value: Default value for the JVM This parameter is only for Microsoft Windows. |
|
|
Specifies the maximum size to which the JVM native stack can grow. Possible value: The valid JVM maximum native stack size Default value: Default value for the JVM This parameter is only for Microsoft Windows. |
|
|
Specifies the minimum heap size for the adapter JVM. Possible value: The valid JVM heap size Default value: This parameter is only for Microsoft Windows. |
|
|
Specifies the number of Possible value: The number of Default value: None This parameter is only for Microsoft Windows. |
|
|
Specifies the environment variable Possible value: The valid Default value: None This parameter is only for Microsoft Windows. |
|
|
Specifies any additional arguments to the JVM. For example, to retrieve line numbers in any stack traces, set Possible value: A valid JVM argument Default value: None This parameter is only for Microsoft Windows. |
|
Table 2-8 shows the reserved characters used to specify the value of the nls_date_format
parameter. Use the characters, to define date formats.
Table 2-8 Reserved Characters for the value of the nls_date_format Parameter
Letter | Description | Example |
---|---|---|
|
Era designator |
|
|
Year |
|
|
Month in year |
|
|
Week in year |
|
|
Week in month |
|
|
Day in year |
|
|
Day in month |
|
|
Day of week in month |
|
|
Day in week |
|
|
a.m./p.m. marker |
|
|
Hour in day (0-23) |
|
|
Hour in day (1-24) |
|
|
Hour in a.m./p.m. (0-11) |
|
|
Hour in a.m./p.m. (1-12) |
|
|
Minute in hour |
|
|
Second in minute |
|
|
Millisecond |
|
Advanced Queuing Adapter-Specific Parameters
Table 2-9 lists the parameters specific to the AQ adapter.
Table 2-9 AQ Adapter-Specific Parameters
Parameter | Description | Example |
---|---|---|
If all the queues that this adapter will connect to on the application database side are single consumer queues, then this can be left blank. If, however, any of the queues is a multiconsumer queue, then specify a consumer name. Possible value: Default value: None Note: If you are integrating B2B with OracleAS Integration InterConnect, then set the parameter |
|
|
Name of the computer hosting the database instance specified by Default value: None |
|
|
The SID of the database instance. Default value: None |
|
|
The owner of the advanced queue. Possible value: Default value: None |
|
|
The password corresponding to the Possible value: Default value: None Note: All passwords are stored in Oracle Wallet. Refer to AppendixA, "How do I secure my passwords?"in Appendix A, "Frequently Asked Questions" for more details on how to modify and retrieve the password using Oracle Wallet. |
|
|
The port where the TNS listener is running for the database instance specified by Possible value: A TNS listener number Default value: None |
|
|
|
This indicates whether to use thin JDBC when talking to the database. Default value: |
|
The schema user name that the bridge should connect to which dequeus or enqueues messages from a queue in order to publish or subscribe to events defined using iStudio. Possible value: Default value: None |
|
|
Specifies the entry class for the AQ adapter. Once set, the value cannot be modified. Default value: None |
|
Oracle Real Application Clusters adapter.ini Parameters for the Advanced Queuing Adapter
When the AQ adapter is servicing a Real Application Clusters database as the spoke database, parameters listed in Table 2-10 represent information on connection and configuration.
Table 2-10 Real Application Clusters adapter.ini Parameters
Parameter | Description | Example |
---|---|---|
Indicates the host for node x. |
|
|
Indicates the instance on node x. |
|
|
Indicates the number of nodes in a cluster. |
|
|
Indicates the port for node x. |
|