2
Installation and Configuration

This chapter describes installation and configuration of the SAP adapter. This chapter discusses the following topics:

• Installing the SAP Adapter Adapter

• SAP Adapter Configuration

• Starting the SAP Adapter

• Stopping the SAP Adapter

Installing the SAP Adapter Adapter

This section contains these topics:

• Preinstallation Tasks

• Installation Tasks

• Post Installation Tasks

Preinstallation Tasks

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

• An existing Oracle Application Server InterConnect (OracleAS InterConnect) Oracle home for this release

• A new Oracle home (the installer creates this for you)

Consult the following guides before proceeding with SAP adapter installation:

• Oracle Application Server InterConnect Installation Guide, which includes information on:
  • CD-ROM mounting

  • Oracle Universal Installer startup

  • OracleAS InterConnect software, hardware, and system requirements

  • OracleAS InterConnect installation

    Note: OracleAS InterConnect Hub is installable through the OracleAS InterConnect Hub installation type. You must install the OracleAS InterConnect Hub before proceeding with the SAP adapter installation.

Installation Tasks

To install the SAP adapter:

1. On the Available Product Components page of the OracleAS InterConnect installation, select SAP adapter, then select Next.

   Consider the following scenarios:

   • If installing the SAP adapter in an independent Oracle home, please make sure that the OracleAS InterConnect Hub has been installed, not necessarily in the same Oracle home. Continue to step 2.

   • If installing the SAP adapter in an existing Oracle home, please make sure that it is a home directory to one of the OracleAS InterConnect component. Continue to step 3.

     Note: The hub database information, such as the SID, host, port, and username/password from the Hub installation is needed for step 2.

2. If installing OracleAS InterConnect for the first time on this machine, complete the following steps to enter the hub database information:
   1. On the Welcome page, select Next. The Database Configuration page displays. Enter information in the following fields:
      • Host Name--The host name of the machine where the hub database is installed.

      • Port Number--The TNS listener port for the hub database.

      • Database SID--The SID for the hub database.

   2. Click Next. The Database User Configuration page displays. Enter information in the following fields:
      • User Name--The hub database user name. Make sure the OracleAS InterConnect Hub is installed. If the Hub is not installed, complete the installation and note the user name and password.

      • Password--The password for the hub database user.

3. Click Next. The Adapter Configuration page displays. Enter the application to be defined or already defined in iStudio in the Application Name field. White spaces or blank spaces are not permitted. The default value is mySAPApp.

4. Click Next. Complete the fields for any other components selected for installation, such as other adapters. When finished, the Summary page displays.

5. Click Install to install the SAP adapter and other selected components. The SAP adapter is installed in the following directory:

   Platform	Directory
   Windows	%ORACLE_HOME%\oai\9.0.4\adapters\Application
   UNIX	$ORACLE_HOME/oai/9.0.4/adapters/Application

   Application is the value you specified in Step 3 .

6. Click Exit at the End of Installation page to exit the SAP adapter installation.

Post Installation Tasks

Enabling iStudio

After installing the SAP adapter and the iStudio, complete the following iStudio post installation steps to fully enable the SAP adapter.

See Also: Oracle Application Server InterConnect Installation Guide for information on installing iStudio along with OracleAS InterConnect Development Kit

1. Update the PATH environment variable to include the following directory:

   On Windows: ORACLE_HOME\oai\9.0.4\bin

   On UNIX: ORACLE_HOME/oai/9.0.4/bin

   This procedure is required to run the utilities in this directory.

2. The SAP adapter requires the librfc32.dll SAP library for browsing the SAP system in iStudio and for run time. If the SAP graphical interface is installed on a machine, the librfc32.dll can be found in the following directories:

   <SAP install directory>SAPpc\SapGui\RFCSDK\lib
   <SAP install directory>SAPpc\SapGui\RFCSDK\bin
   
   

   The version information for the library is librfc32.dll 4640.5.734.3319. Copy this library file to the following directory:

   On Windows: ORACLE_HOME\oai\9.0.4\bin

   On UNIX: ORACLE_HOME/oai/9.0.4/bin

   If you do not have the library available at your site, please refer to R/3 note number 0413708. In this note you can find the information regarding procurement of the libraries.

3. To enable dynamic access to IDocs and enhanced use of RFCs, use the files provided in the following directory and upload the source code on to the SAP server:

   On Windows: ORACLE_HOME\oai\9.0.4\bin

   On UNIX: ORACLE_HOME/oai/9.0.4/bin

   This directory has the following folders:

   • a. ale_files--The files in this folder are used on the SAP server to enable dynamic access to IDocs at both design time and runtime. Without uploading the source code in these files, you will not be able to dynamically access IDocs. In that case you need to manually download the IDoc definitions from the SAP server.

     See Also: File IdocBrow.txt for instructions on accessing IDocs

   • b. rfc_files--The files in this folder are used on the SAP server or enhanced access to RFCs at both design time and runtime. RFC browsing and runtime calls will be slower if the source code in these files are not uploaded to the SAP server.

     See Also: File rfcbrows.txt for instructions on accessing RFCs

• Set the configuration settings for the SAP adapter using the Configuration Editor before using the SAP adapter for runtime. The Configuration Editor is a Java application and is launched by running the configeditor.bat file in the ORACLE_HOME/oai/9.0.4/config/ directory:

  On Windows:ORACLE_HOME\oai\9.0.4\config

  On UNIX: ORACLE_HOME/oai/9.0.4/config

Registering the License for the SAP Adapter (Windows only)

Before using the SAP adapter, or if using the browser in iStudio, you need to register the license using the license registration tool. This tool uses the following files:

• licreg.exe--Located in the ORACLE_HOME\oai\9.0.4\bin directory.

• acboai.lic--The license file located in the ORACLE_HOME\oai\9.0.4\config directory.

To register the license, complete the following:

1. Update the PATH environment variable to include the ORACLE_HOME\oai\9.0.4\bin directory. This is required for running the utilities in this directory.

2. Double click on licreg.exe to display the License Manager dialog.

3. Navigate to the ORACLE_HOME\oai\9.0.4\config directory.

4. Select acboai.lic and click OK.

Licreg.exe silently registers the license. To verify the registration, from a command prompt, launch logdump.exe located in ORACLE_HOME\oai\9.0.4\bin directory. This prints the log messages regarding license registration.

SAP Adapter Configuration

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 Advanced Queuing Adapter Directory

On...	Go to...
UNIX	$ORACLE_HOME/oai/9.0.4/adapters/Application
Windows	%ORACLE_HOME%\oai\9.0.4\adapters\Application

Table 2-2 Executable Files

File	Description
start.bat (Windows)	Takes no parameters, starts the adapter.
start (UNIX)	Takes no parameters, starts the adapter.
stop.bat (Windows)	Takes no parameters; stops the adapter.
stop (UNIX)	Takes no parameters; stops the adapter.
ignoreErrors.bat (Windows)	If an argument is specified, then the given error code will be ignored. If no argument is specified, then all error codes specified in the ErrorCodes.ini will be ignored.
ignoreErrors (UNIX)	If an argument is specified, then the given error code will be ignored. If no argument is specified, then all error codes specified in the ErrorCodes.ini will be ignored.

Note: Running stop.sh on UNIX does not stop the SAP adapter. Use <CTRL>C to stop the SAP adapter.

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.

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 SAP 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).

Adapter.ini Initialization Parameter File

This section contains these topics:

• Hub.ini Parameters

• Real Application Clusters-specific Hub.ini Parameters

• Agent Connection Parameters

• SAP Adapter Adapter-Specific Parameters

Hub.ini Parameters

The SAP 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.

Table 2-5 Hub.ini Parameters

Parameter	Description	Example
hub_username	The name of the hub database schema (or username). The default value is oaihub904.	hub_username=oaihub904
hub_password	The password for the hub database user. There is no default value. You input the hub_password value during installation.	hub_password=manager
hub_host	The name of the machine hosting the hub database. There is no default value. You input the hub_host value during installation.	hub_host=mpmypc
hub_instance	The system identification number (SID) of the hub database. There is no default value. You input the hub_instance value during installation.	hub_instance=orcl
hub_port	The transparent network services (TNS) listener port number for the HUB database instance. There is no default value. You input the hub_port value during installation.	hub_port=1521
repository_name	The valid name of the repository this adapter talks to. The default value is InterConnectRepository.	repository_name=InterConnectRepository

Real Application Clusters-specific Hub.ini Parameters

When a hub is installed on a Real Application Clusters (RAC) database, parameters listed in Table 2-6 represent information on additional nodes used for connection and configuration. These parameters are added on top of the default parameters which represent the primary node. In Table 2-6, x represent the node number, which varies between 2 and the number of nodes. For example, if the Real Application Clusters setup contains 4 nodes, x can take a value between 2 and 4.

Table 2-6 Real Application Cluster-specific hub.ini Parameters

Parameter	Description	Example
hub_num_nodes	Number of nodes in Real Application Clusters.	hub_num_nodes=4
hub_hostx	The host where the Real Application Clusters database is installed.	hub_host2=dsunram13
hub_instancex	The instance on the respective node.	hub_instance2=orcl2
hub_portx	The port on which the listener is listening.	hub_port2=1521

Agent Connection Parameters

The SAP adapter connects to the spoke application using parameters from the adapter.ini file. Table 2-7 lists the parameter name, description, the possible and default values, and example of each parameter.

Table 2-7 Adapter.ino Parameters

Parameter	Description	Example
application	The name of the application this adapter connects to. 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=aqapp
partition	The partition this adapter handles as specified in iStudio. Any alphanumeric string is a possible value. 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 Queuing subscriber name and there is no default value.	agent_subscriber_name=aqapp
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 '%aqapp,%'
agent_reply_subscriber_name	The subscriber name 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=aqapp, instance_number=2, then, agent_reply_subscriber_name=aqapp2
agent_reply_message_selector	Used only if 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=aqapp, instance_number=2, then agent_reply_message_selector=receipient_list like '%,aqapp2,%'
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 or 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 or 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 OracleAS InterConnect-specific DTD for all messages sent to the hub as other OracleAS 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 OracleAS InterConnect DTD. Only set to true if a OracleAS InterConnect adapter is not receiving the messages from the hub. Possible values are true or 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. The 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 or false. The 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 is 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 is 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 OracleAS 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 OracleAS 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 milliseconds. 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 milliseconds. The default value is 60000.	agent_persistence_retry_interval=60000
agent_pipeline_to_hub	Specifies how to turn on or off the pipeline for messages from the Bridge towards the hub. If you set the pipeline to false, the file persistence is not used in that direction.	agent_pipeline_to_hub=false
agent_pipeline_from_hub	Specifies how to turn on or off the pipeline for messages from the hub towards the Bridge. If you set the pipeline to false, the file persistence is not used in that direction.	agent_pipeline_from_hub=false
service_path	Windows only. The value that the environment variable PATH should be set to. Path is 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\ora904\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\ ora904\oai\904\lib\ oai.jar; %JREHOME%\lib\i18n.jar D:\oracle\ora904\jdbc\classes12.zip
service_class	The entry class for the Windows service. The possible value is 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=.aq
service_jdk_version	Windows only. The JDK version the adapter Java VM should use. The default value is 1.4.1.	service_jdk_version=1.4.1
service_jdk_dll	Windows only. The dll the adapter Java VM should use. The default value is jvm.dll.	service_jdk_dll=jvm.dll
nls_date_format	Format for date fields expressed as string. The following pattern letters are defined. All other characters from A to Z and from a to z are reserved. Letter  Date or Time                    Component Examples G          Era designator                  AD y           Year                                   1996; 96 M          Month in year                    July; Jul; 07 w          Week in year                     27 W          Week in month                  2 D           Day in year                        189 d           Day in month                     10 F           Day of week in month       Number 2 E           Day in week                        Tuesday; Tue a           A.M./P.M. marker              P.M. H           Hour in day (0-23)              0 k           Hour in day (1-24)              24 K           Hour in A.M/P.M. (0-11)   0 h           Hour in A.M./P.M. (1-12)  12 m           Minute in hour                    30 s           Second in minute                55 S           Millisecond                           978 z           Time zone                              Pacific The default date format is EEE MMM dd HH:mm:ss zzz yyyy. Note: This parameter specifies date format. It is applicable for the date format only.	Date format pattern dd/MMM/yyyy can represent 01/01/2003. nls_date_format=dd-MMM-yy Multiple date format can be specified as num_nls_formats=2 nls_date_format1=dd-MMM-yy nls_date_format2=dd/MMM/yy
nls_country	This parameter is a valid ISO Country Code. These upper-case and two-letter codes are defined by ISO-3166. You can find a full list of these codes at a Web site, such as, http://www.chemie.fu-berlin.de/diverse/doc/ISO_3166.html The default Country code is US. Note: This parameter specifies date format. It is applicable for the date format only.	US
nls_language	This parameter is a valid ISO Language Code. These lower-case and two-letter codes are defined by ISO-639. You can find a full list of these codes at a Web site, such as, http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt The default language code is en. Note: This parameter specifies date format. It is applicable for the date format only.	nls_language=en
encoding	Character encoding for published messages. The adapter uses this parameter to generate encoding information in encoding tag of transformed OracleAS InterConnect message. OracleAS InterConnect represents messages internally as an XML document. The default encoding of the XML document is UTF-8. However, this encoding can be configured using this parameter, which is typically used when the OracleAS InterConnect message consists of characters not supported by UTF-8 and when the XMLParser is unable to handle them.	encoding=JA16SJIS
corba_port_number	The CORBA port number on which the adapter CORBA service listens. Generally, this port is allocated dynamically. However, it can be configured to enable access across firewall.	corba_port_number=14000

SAP Adapter Adapter-Specific Parameters

The following table lists the parameters specific to the SAP adapter.

Parameter	Description	Example
bridge_class	This indicates the entry class for the SAP adapter. Do not modify this value. A possible value is com.actional.oai.TxAgent. There is no default value.	bridge_class=com.actional.oai.TxAgent

Starting the SAP Adapter

On UNIX, start the SAP adapter using the start script in the following directory:

$ORACLE_HOME/oai/9.0.4/adapters/Application

Type start, then press Enter.

On Windows, start the adapter from the Services window available from the Start menu.

1. Access the Services window from the Start menu:

   On...	Choose...
   Windows NT	Start > Settings > Control Panel > Services
   Windows 2000	Start > Settings > Control Panel > Administrative Tools > Services

   The Services window displays.

2. Select the OracleHomeOracleASInterConnectAdapter-Application service.

3. Start the service based on your operating system:

   On...	Choose...
   Windows NT	Choose Start.
   Windows 2000	Right click the service and choose Start from the menu that displays.

The SAP adapter, in turn, automatically starts the publishing engine, a tool for notifying foreign applications of additions, deletions, or updates to the native application.

See Also: Oracle Application Server InterConnect Adapter Publishing Engine User's Guide

On Windows only, If you are using the SAP adapter or your browser in iStudio, but you fail to initialize the SAP adapter, you may not have the keys for JavaHome and RuntimeLib, or these keys do not point to the correct JDK. In this case, the iStudio browser will not display or the data from the backend system cannot be imported.

To created these keys, use the Windows regedit tool. To access the regedit tool:

1. Click Start and select Run.

2. Enter regedit and click OK.

The following example displays the values for these keys when the SAP adapter is installed under the C:\Oracle\Ora90 directory:

[HKEY_LOCAL_MACHINE\SOFTWARE\JavaSoft\Java Runtime Environment]

[HKEY_LOCAL_MACHINE\SOFTWARE\JavaSoft\Java Runtime Environment\1.3]
"CurrentVersion"="1.3"

[HKEY_LOCAL_MACHINE\SOFTWARE\JavaSoft\Java Runtime Environment\1.3]
"JavaHome"="c:\\oracle\\ora90\\jdk\\jre"
"MicroVersion"="1"
"RuntimeLib"="C:\\Oracle\\Ora90\\jdk\\jre\\bin\\hotspot"

Stopping the SAP Adapter

On UNIX, stop the SAP adapter using the stop script in the following directory:

$ORACLE_HOME/oai/9.0.4/adapters/Application

Type stop, then press Enter.

On Windows, stop the adapter from the Services window available from the Start menu.

1. Access the Services window from the Start menu:

   On...	Choose...
   Windows NT	Start > Settings > Control Panel > Services
   Windows 2000	Start > Settings > Control Panel > Administrative Tools > Services

   The Services window displays.

2. Select the OracleHomeOracleASInterConnectAdapter-Application service.

3. Stop the service based on your operating system:

   On...	Choose...
   Windows NT	Choose Stop.
   Windows 2000	Right click the service and choose Stop from the menu that displays.

You may verify the stop status by viewing the oailog.txt files in the appropriate time stamped subdirectory of the log directory within the adapter directory.