2 Installation and Configuration

hub_host

The name of the computer hosting the hub database. There is no default value. The value is set during installation.

hub_host=mpscottpc

hub_instance

The SID of the hub database. There is no default value. The value is set during installation.

hub_instance=orcl

hub_port

The TNS listener port number for the hub database instance. There is no default value. The value is set during installation.

hub_port=1521

hub_username

The name of the hub database schema (or user name). The default value is ichub.

hub_username=ichub

repository_name

The name of the repository that communicates with the adapter. The default value is InterConnectRepository.

repository_name=InterConnectRepository

hub_hostx

The host where the Real Application Clusters database is installed.

hub_host2=dscott13

hub_instancex

The instance on the respective node.

hub_instance2=orcl2

hub_num_nodes

The number of nodes in a cluster.

hub_num_nodes=4

hub_portx

The port where the TNS listener is listening.

hub_port2=1521

agent_admin_port

Specifies the port through which the adapter can be accessed through firewalls.

Possible value: A valid port number

Default value: None

agent_admin_port=1059

agent_delete_file_cache_at_startup

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 true to delete all cached metadata on startup.

Possible values: true or false

Default value: false

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.

agent_delete_file_cache_at_startup=false

agent_dvm_table_caching

Specifies the Domain Value Mapping (DVM) table caching algorithm.

Possible values:

• startup: Cache all DVM tables at startup. This may be time-consuming if there are many tables in the repository.

• demand: Cache tables as they are used.

• none: No caching. This slows down performance.

Default value: demand

agent_dvm_table_caching=demand

agent_log_level

Specifies the amount of logging necessary.

Possible values:

0=errors only

1=status and errors

2=trace, status, and errors

Default value: 1

agent_log_level=2

agent_lookup_table_caching

Specifies the lookup table caching algorithm.

Possible values:

• startup: Cache all lookup tables at startup. This may be time-consuming if there are many tables in the repository.

• demand: Cache tables as they are used.

• none: No caching. This slows down performance.

Default value: demand

agent_lookup_table_caching=demand

agent_max_ao_cache_size

Specifies the maximum number of application object metadata to cache.

Possible value: An integer greater than or equal to 1

Default value: 200

agent_max_ao_cache_size=200

agent_max_co_cache_size

Specifies the maximum number of common object metadata to cache.

Possible value: An integer greater than or equal to 1

Default value: 100

agent_max_co_cache_size=100

agent_max_dvm_table_cache_size

Specifies the maximum number of DVM tables to cache.

Possible value: An integer greater than or equal to 1

Default value: 200

agent_max_dvm_table_cache_size=200

agent_max_lookup_table_cache_size

Specifies the maximum number of lookup tables to cache.

Possible value: Any integer greater than or equal to 1

Default value: 200

agent_max_lookup_table_cache_size=200

agent_max_message_metadata_cache_size

Specifies the maximum number of message metadata (publish/subscribe and invoke/implement) to cache.

Possible value: An integer greater than or equal to 1

Default value: 200

agent_max_message_metadata_cache_size=200

agent_max_queue_size

Specifies the maximum size to which internal OracleAS Integration InterConnect message queues can grow.

Possible value: An integer greater than or equal to 1

Default value: 1000

agent_max_queue_size=1000

agent_message_selector

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'%,aqapp,%').

Default value: None

agent_message_selector=%,aqapp,%

agent_metadata_caching

Specifies the metadata caching algorithm.

Possible values:

• startup: Cache everything at startup. This may be time-consuming if there are many tables in the repository.

• demand: Cache metadata as it is used.

• none: No caching. This slows down performance.

Default value: demand

agent_metadata_caching=demand

agent_persistence_cleanup_interval

Specifies how often to run the persistence cleaner thread in milliseconds.

Possible value: An integer greater than or equal to 30000 milliseconds.

Default value: 60000.

agent_persistence_cleanup_interval=60000

agent_persistence_queue_size

Specifies the maximum size of internal OracleAS Integration InterConnect persistence queues.

Possible value: An integer greater than or equal to 1

Default value: 1000

agent_persistence_queue_size=1000

agent_persistence_retry_interval

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 5000 milliseconds.

Default value: 60000

agent_persistence_retry_interval=60000

agent_pipeline_from_hub

Specifies whether to activate the pipeline for messages from the hub to the bridge. If you set the pipeline to false, then the file persistence is not used in that direction.

Possible value: true, false

Default value: false

agent_pipeline_from_hub=false

agent_pipeline_to_hub

Specifies whether to activate the pipeline for messages from the bridge to the hub. If you set the pipeline to false, then the file persistence is not used in that direction.

Possible value: true, false.

Default value: false

agent_pipeline_to_hub=false

agent_reply_message_selector

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 (parameter:application) concatenated with the instance number (parameter:instance_number)

Default value: None

If application=aqapp, instance_number=2, then agent_reply_message_selector=recipient_list like '%,aqapp2,%'

agent_reply_subscriber_name

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 (parameter:application) concatenated with the instance number (parameter:instance_number)

Default value: None

If application=mpapp and instance_number=2, then agent_reply_subscriber_name=mqapp2

agent_subscriber_name

Specifies the subscriber name used when this adapter registers its subscription.

Possible value: A valid Oracle Advanced Queue subscriber name

Default value: None

agent_subscriber_name=mqapp

agent_throughput_measurement_enabled

Specifies if the throughput measurement is enabled. Set this parameter to true to activate throughput measurements.

Default value: true

agent_throughput_measurement_enabled=true

agent_tracking_enabled

Specifies if message tracking is enabled. Set this parameter to false to turn off tracking of messages. Set this parameter to true to track messages with tracking fields set in iStudio.

Default value: true

agent_tracking_enabled=true

agent_use_custom_hub_dtd

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 true to have the adapter use the DTD imported for the message of the common view instead of the OracleAS Integration InterConnect DTD.

Default value: None

agent_use_custom_hub_dtd=false

application

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

application=mqapp

encoding

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: UTF-8

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.

encoding=Shift_JIS

external_dtd_base_url

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 URLDefault value: The URL of the current user directory

external_dtd_base_url=file://C:\ORACLEHOME\Integration\InterConnect10_1_2\adapters\MQApp\

instance_number

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 1

Default value: None

instance_number=1

nls_country

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 http://www.chemie.fu-berlin.de/diverse/doc/ISO_3166.html

Default value: US

Note: This parameter specifies date format and is applicable only for the date format.

nls_country=US

nls_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: EEE MMM dd HHmmss zzz yyyy

Date format pattern dd/MMM/yyyy can represent 01/01/2003.

nls_date_format=dd-MMM-yy

Multiple date formats can be specified as num_nls_formats=2

nls_date_format1=dd-MMM-yy

nls_date_format2=dd/MMM/yy

nls_language

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 http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt

Default value: en

Note: This parameter specifies date format and is applicable only for the date format.

nls_language=en

partition

Specifies the partition this adapter handles as specified in iStudio.

Possible value: An alphanumeric string

Default value: None

partition=germany

service_class

Specifies the entry class for the Windows service.

Possible value: oracle/oai/agent/service/AgentService

Default value: None

service_class=oracle/oai/agent/service/AgentService

service_classpath

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 PATH setting

Default value: None

This parameter is only for Microsoft Windows.

service_classpath=D:\oracle\oraic\integration\interconnect\lib\oai.jar; D:\oracle\oraic\jdbc\classes12.zip

service_jdk_dll

Specifies the Dynamic Link Library (DLL) that the adapter JVM should use.

Possible value: A valid jvm.dll

Default value: jvm.dll

This parameter is only for Microsoft Windows.

service_jdk_dll=jvm.dll

service_jdk_version

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.

service_jdk_version=1.4

service_max_heap_size

Specifies the maximum heap size for the adapter JVM.

Possible value: A valid JVM heap size

Default value: 536870912

This parameter is only for Microsoft Windows.

service_max_heap_size=536870912

service_max_java_stack_size

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.

service_max_java_stack_size=409600

service_max_native_stack_size

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.

service_max_native_size=131072

service_min_heap_size

Specifies the minimum heap size for the adapter JVM.

Possible value: A valid JVM heap size

Default value: 536870912

This parameter is only for Microsoft Windows.

service_min_heap_size=536870912

service_num_vm_args

Specifies the number of service_vm_argnumber parameters specified in JVM.

Possible value: The number of service_vm_argnumber parameters

Default value: None

This parameter is only for Microsoft Windows.

service_num_vm_args=1

service_path

Specifies the environment variable PATH. The PATH variable is set before starting the Java Virtual Machine (JVM). Typically, list all directories that contain necessary DLLs.

Possible value: A valid PATH environment variable setting

Default value: None

This parameter is only for Microsoft Windows.

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

service_vm_argnumber

Specifies any additional arguments to the JVM. For example, to retrieve line numbers in any stack traces, set service_vm_arg1=java.compiler=NONE. If a list of arguments exists, then use multiple parameters as shown in the example, by incrementing the last digit by 1.

Possible value: Valid JVM arguments

Default value: None

This parameter is only for Microsoft Windows.

service_vm_arg1=java.compiler= NONE

service_vm_arg2=oai.adapter=.aq

bridge_class

Specifies the entry class for the WebSphere MQ adapter. A value must be specified and cannot be modified later.

Possible value: oracle.oai.agent.adapter.technology.TechBridge.

Default value: None

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

Encrypted_mq.default. password

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

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.

Encrypted_mq.default.password=112411071071106510801094108410731070107110811069

mq.default. connection_type

Specifies the type of connection to make to an WebSphere MQ queue manager.

Possible values: bind (local) or client (remote)

Default value: None

mq.default.connection_type=client

mq.default. receiver.durable

Defines whether or not a durable subscriber should be used to subscribe to the topic. This is used only if the receiver.destination.uri parameter specifies a JMS topic.

Possible value: Y or N

Default value is N

mq.default.receiver. durable=Y

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.

Possible value: Y or N

Default value: N

mq.default.receiver. transacted=Y

mq.default. sender.seq_queue.uri

Specifies a URI for the WebSphere MQ 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: A JMS queue URI

Default value: None

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

mq.default.ccsid

Specifies the coded-character-set-ID in use on connections instead of the default.

Possible values: Refer to table 16 in the WebSphere MQ Using Java Guide

Default value: blank (~819)

mq.default.ccsid=1208

mq.default.channel

Specifies the name of the WebSphere MQ channel to use for the client connection.

Possible value: Any valid WebSphere MQ channel name

Default value: None

mq.default.channel=SYSTEM.DEF.SVRCONN

mq.default.event.name

Specifies the default event name. This parameter should be used if the bridge will only handle one single fixed event name for outbound messages (from WebSphere MQ) and none of the other options are feasible to use. This parameter requires only one D3L file defined, with an event name exactly matching this hardcoded event name.

Possible value: A valid OracleAS Integration InterConnect event name

Default value: None

mq.default.event.name= Price.update

mq.default.event.property

Defines the default event property. If the sending external application is able to specify the event name as a message property value, then use this parameter to define the name of the message property that will carry the message event name.

Possible value: A valid JMS message property name

Default value: None

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 WebSphere MQ 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.

Possible value: The Java class name of a class that implements the oracle.oai.agent.adapter.mqseries.MQEventExit interface.

Default value: None

mq.default.event.exit= mypackage.myMqEventExit

mq.default.event.use_mq_fmt

Specifies the usage of the IBM WebSphere MQ Message Format field. If this parameter value is Y, then the bridge uses the IBM WebSphere MQ Message Format field as the name of the OracleAS Integration 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

Possible values: Y or N

Default value: N

mq.default.event.use_mq_fmt=Y

mq.default.hostname

Specifies the DNS name of the host where the queue manager resides.

Possible value: A valid hostname that can be reached over the network from the WebSphere MQ adapter.

Default value: None

mq.default.hostname= mqsvrhost1.acme.com

mq.default.polling_interval

Specifies the number of milliseconds between attempts to receive a message.

Possible value: 0-java.lang.Long.MAX_VALUE

Default value: 5000

mq.default.polling_interval=5000

mq.default.port

Specifies the port to connect to on the WebSphere MQ Server host (IBM's default is 1414).

Possible value: A valid port number for the WebSphere MQ listener

Default value: None

mq.default.port=1414

mq.default.queue_manager

Specifies the name of the WebSphere MQ queue manager to connect to.

Possible value: Any WebSphere MQ queue manager name

Default value: None

mq.default.queue_manager=mars.queue.manager

mq.default.receive_exit

Specifies the fully qualified class name of the receive exit being used.

Possible value: The classname of a Java class that implements com.ibm.mq.MQReveiveExit

Default value: None

mq.default.receive_exit=mypackage. myReceiveExit

mq.default.receiver. destination.uri

Specifies a URI for the WebSphere MQ 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 WebSphere MQ.

Possible values: A JMS queue URI

Default value: None

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

mq.default.receiver. selector

Specifies the JMS selector expression applied while dequeueing from the receiver destination.

Possible values: A JMS selector expression

Default value: None

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

mq.default.receiver.exception.uri

Specifies a URI for an WebSphere MQ queue where faulty native messages will be placed.

Default value: None.

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

mq.default.security_exit

Specifies the fully qualified class name of the security exit being used.

Possible value: The classname of a Java class that implements com.ibm.mq.MQSecurityExit

Default value: None

mq.default.security_exit=mypackage.MySecurityExit

mq.default.send_exit

Specifies the fully qualified class name of the send exit being used.

Possible value: The classname of a Java class that implements com.ibm.mq.MQSendExit

Default value: None

mq.default.send_exit=mypackage.mySendExit

mq.default.sender. destination.uri

Specifies the URI for the WebSphere MQ inbound queue to which messages will be sent from OracleAS Integration InterConnect.

Possible values: A JMS queue URI

Default value: None

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

mq.default.sender.log_queue.uri

Specifies a URI for the WebSphere MQ log queue used during send transactions.

Possible values: A JMS queue URI

Default value: None

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

mq.default.sender.mqfmt

Supresses the JMS specific header information. The WebSphere MQ adapter will normally read and write JMS messages from and to WebSphere MQ queues, which include a JMS specific header section. To suppress this header when interacting with external non-JMS clients (C or non-JMS Java applications), define this property. It will also defines the message MQMD Format field of each message being sent by the adapter. If the value is set to MQFMT_STRING, then it will cause all messages to be sent as Text messages, even in D3L mode. Normally, D3L mode will cause the adapter to send only Bytes messages.

Default value: None

mq.default.sender.mqfmt=MQFMT_STRING

mq.default.trans_id_expiry

Specifies the number of milliseconds before an idle transaction identifier will expire.

Possible value: 0-java.lang.Long.MAX_VALUE

Default value: 60000

mq.default.trans_id_expiry=360000

mq.default.user

Specifies the WebSphere MQ user ID when connecting to the queue manager. Equivalent to the WebSphere MQ environment variable MQ_USER_ID. The value may be used to verify the identity of the WebSphere MQ adapter.

Possible value: A valid WebSphere MQ user name

Default value: None

mq.default.user=mqm

ota.type

Defines the type of payload this adapter handles.

Possible values: XML and D3L

Default value: XML

ota.type=D3L