Oracle® Application Server Integration InterConnect Adapter for DB Installation and User's Guide
10g Release 2 (10.1.2) B14076-02 |
|
Previous |
Next |
This chapter describes how to install and configure the Database adapter. It contains the following topics:
The Database adapter must be installed in an existing Oracle home Middle Tier for OracleAS Integration InterConnect 10g Release 2 (10.1.2).
This section describes the following topics:
Refer to the following guides before installing the Database adapter:
Oracle Application Server Installation Guide for information about Oracle Universal Installer startup.
Oracle Application Server InterConnect Installation Guide for information about software, hardware, and system requirements for OracleAS Integration InterConnect.
To install the Database adapter, start the installer and complete the following steps:
In the Available Product Components screen of the OracleAS Integration InterConnect installation, select OracleAS Integration InterConnect Adapter For Database 10.1.2.0.2, and click Next.
The Set Oracle Wallet Password screen is displayed. Enter and confirm the password on the screen, which will be used to administer OracleAS Integration InterConnect installation. Click Next.
Go to step 3, if installing the Database 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 4, if installing the Database 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 password for the hub database user.
Click Next. The Specify Database Adapter Name screen is displayed.
Enter the application name. Blank spaces are not permitted. The default value is myDBApp
.
Note: You can change the application name in iStudio after installation. In such a 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 Database Connection Information screen is displayed. Enter information in the following fields:
Host Name: The name of the computer where the application database is installed.
Port Number: The database TNS listener port.
Database SID: The SID for the application database.
Sys Password: The password of the sys user in the spoke database.
The information on this page is for the database on the application side from which the adapter will deliver or receive messages. This is not the information for the hub database.
Click Next. The Spoke Application Database Username page is displayed. Enter information in the following fields:
Schema Name: The user name of the user in the Spoke Database.
Password: The password for the user name.
Click Next. The Set Bridge Schema Password screen is displayed.
Enter and confirm the password for the bridge schema on the screen.
Click Next. The Summary screen is displayed.
Click Install to install the Database adapter and other selected components. The Database adapter is installed in the following directory:
Platform | Directory |
---|---|
UNIX | ORACLE_HOME /integration/interconnect/adapters/ Application
|
Windows | ORACLE_HOME \integration\interconnect\adapters\ Application
|
Application
is the value you specified in Step 5.
When completing the post installation steps, no errors should occur. If there are errors, then verify that in the specified database, the application using the oai
schema is the only occurrence. Errors can occur if a Database adapter from previous version installation is talking to this same database.
To install multiple instances of the Database 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 Database adapter with name myDBApp
installed on a computer. To install another instance of the Database adapter with name myDBApp1
in the same Oracle home, use the following command:
copyAdapter myDBApp myDBApp1
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 Database adapter myDBApp1
by using the copyAdapter
script. To manage the myDBApp1
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="myDBApp1" module-id="adapter" working-dir="$ORACLE_ HOME/integration/interconnect/adapters/myDBApp1" status="enabled"> <start timeout="600" retry="2"/> <stop timeout="120"/> <port id="icadapter_dmsport_range" range="15701-15800"/> <process-set id="myDBApp1" 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="myDBApp" module-id="adapter" working-dir="$ORACLE _HOME/integration/interconnect/adapters/myDBApp" status="enabled"> <start timeout="600" retry="2"/> <stop timeout="120"/> <port id="icadapter_dmsport_range" range="15701-15800"/> <process-set id="myDBApp" 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="myDBApp1" module-id="adapter" working-dir="$ORACLE _HOME/integration/interconnect/adapters/myDBApp1" status="enabled"> <start timeout="600" retry="2"/> <stop timeout="120"/> <port id="icadapter_dmsport_range" range="15701-15800"/> <process-set id="myDBApp1" 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 myDBApp1
adapter by using the following command
opmnctl startproc ias-component="InterConnect" process-type="myDBApp1"
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" |
After an Database adapter installation, you can configure it 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 Oracle9i Database Server Adapter Directory
Platform | Directory |
---|---|
UNIX |
|
Windows |
|
Table 2-2 describes the various executable files available for the Database 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 Database adapter configuration files.
Table 2-3 Configuration Files
File | Description |
---|---|
|
Consists of all the initialization parameters, which the adapter reads at startup. |
|
Consists of all the initialization parameters, which the adapter reads at startup. |
Table 2-4 describes the directories used by the Database 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 Database adapter has a generic transformation engine that uses 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 name that will be defined in iStudio under the Applications folder.
If you use prepackaged 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 Database adapter:
The Database adapter connects to the hub database by using parameters in the hub.ini
file located in the hub
directory. Table 2-5 gives a descriptions and an example of 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 default value is ichub. |
|
|
The name of the repository that communicates with the adapter. The default value is |
|
Oracle Real Application Clusters hub.ini Parameters
When a hub is 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. The number is between 2 and the number of nodes. For example, if the cluster contains 4 nodes, then x
can be a value between 2 and 4.
Table 2-6 Oracle Real Application Clusters hub.ini Parameters
Parameter | Description | Example |
---|---|---|
The host where the Real Application Clusters database is installed. |
|
|
The instance on the respective node |
|
|
The number of nodes in a cluster. |
|
|
The port where the TNS listener is listening.. |
|
The Database adapter connects to the spoke application using parameters in the adapter.ini
file. Table 2-7 gives a descriptions and an example of 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 startup. 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 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 |
If |
|
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 |
If |
|
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 Default value: |
|
|
Specifies if message tracking is enabled. Set this parameter to 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 will be used to explicitly specify the encoding of the published message. This parameter will be 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. Default value: |
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 as specified 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 Java Virtual Machine(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: A 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: A 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: Valid JVM arguments 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 |
|
Database Adapter-Specific Parameters
Table 2-9 lists parameters specific to the Database adapter.
Table 2-9 Database Adapter-specific Parameters
Parameter | Description | Example |
---|---|---|
|
Indicates the entry class for the Database adapter. Do not modify this value. Default value: |
|
|
The SID of the database instance. Default value: None |
|
|
The number of alternate schemas that this database adapter will fail over to. Possible values: An integer greater than 0 Default value: |
|
|
The name of the computer hosting the database instance specified by the Default value: None |
|
|
The SID of the database instance. Possible value: A valid SID Default value: None |
|
|
The number of database readers corresponding to the schema number. This is the same as the number of reader threads; each thread has its own database session. Possible value: An integer greater than 0 Default value: None |
|
The number of database writers corresponding to the schema number. This is same as the number of writer threads; each thread has its own database session. Possible values: An integer greater than 0 Default value: None |
|
|
The password for the user specified in the Possible value: The password for the corresponding database user Default value: None |
|
|
The port where the TNS listener is running for the database instance specified by Possible value: A valid TNS listener port number Default value: None |
|
|
The user name for the schema number schema#. The possible values for the schema number are 1 through db_bridge_num_schemas. This value should not be modified. Possible value: A valid database user name Default value: None |
|
|
The password corresponding to the database user specified in Oracle Wallet by the Possible values: A valid password. 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. |
|
|
Specifies whether to use Oracle Objects, available in Oracle database version 8.x and later releases. Set this to true unless using an Oracle database version 7.x. Possible values: Default value: |
|
|
The user name to be used by this writer to log on to the database as specified by the Possible values: A valid database user. Default value: None |
|
|
Used to enable or disable the SQL trace facility for all reader and writer database sessions. Setting this to true results in the SQL query Possible values: Default value: |
|
|
Indicates whether to use a thin JDBC driver when talking to the database. Possible values: Default value: |
|
Real Application Clusters adapter.ini Parameters for the Database Adapter
When the Database 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 number of nodes in RAC cluster. |
|
|
Indicates host for the node x. |
|
|
Indicates instance on node x. |
|
|
Indicates port for node x. |
|
To uninstall the Database adapter, perform the following:
Navigate to the MiddleTier
\opmn\bin
directory.
Run the following command to check the adapter status.
opmnctl status
If the Database adapter instance that you want to remove is running, stop it by using the the following command:
opmnctl stopproc ias-component="InterConnect" process-type="DBApp"
where HTTPApp
is the name of the Database adapter instance.
Navigate to the MiddleTier
\bin
directory and run the following command to stop the Enterprise Manager:
emctl stop iasconsole
Carefully, remove the adapter process-type entry from the opmn.xml
file located in the MiddleTier
\opmn\conf
directory. For example, to remove an Database adapter instance DBApp1
, delete the following information specific to the adapter instance:
<process-type id="DBApp1" module-id="adapter" working-dir="$ORACLE_HOME/integration/interconnect/adapters/DBApp1" status="enabled"> <start timeout="600" retry="2"/> <stop timeout="120"/> <port id="icadapter_dmsport_range" range="15701-15800"/> <process-set id="DBApp1" 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
Navigate to the ORACLE_HOME
\integration\interconnect\adapters
directory and delete the folder that was created for the removed adapter instance.
Navigate to the MiddleTier
\bin
directory and run the following command to start the Enterprise Manager:
emctl start iasconsole