Skip Headers

Oracle9iAS InterConnect Adapter for PeopleSoft 7.5x Installation and User's Guide
Release 2 (9.0.2)

Part Number A95436-01
Go To Documentation Library
Home
Go To Table Of Contents
Contents
Go To Index
Index

Go to previous page Go to next page

2
Installation and Configuration

The PeopleSoft adapter, specifically the Message Server, requires a modification to the PeopleSoft panel. You must customize this panel and make it available through the Oracle9iAS InterConnect Message Server API, psmsrv75 (for PeopleSoft 7.5.6).

This chapter discusses the following topics:

Installing the PeopleSoft Adapter

This section contains these topics:

Preinstallation Tasks

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

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

Installation Tasks

To install the PeopleSoft adapter:

  1. Click Next on the Welcome page.

    The File Locations page displays.

  2. Enter the following information in the Destination fields:

  3. Click Next.

    The Installation Types page displays.

  4. Select Oracle9iAS InterConnect Adapters and click Next.

    The Available Product Components page displays.

  5. Select Oracle9iAS InterConnect PeopleSoft Adapter and click Next.

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

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

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

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

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

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

  7. Click Next. The 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 myPSApp.

  8. Click Next. The installation page that displays next is based on performing this installation on UNIX or Windows NT:

    On... Then Go to Step...

    UNIX

    9

    Windows NT

    10

  9. Enter information in the following fields on the Specify PeopleSoft and Tuxedo Install Locations page:

    • PeopleSoft Installation Path--The root directory for the PeopleSoft installation. The default is /opt/PeopleSoft.

    • Tuxedo Installation Path--The root directory for the Tuxedo installation. The default is /opt/tuxedo.

  10. Enter the clicnet binaries location on the Specify PeopleSoft Client Binaries Location page. The default is <HomeDrive>:/Program F.

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

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

    Platform Directory

    Windows

    %ORACLE_HOME%\oai\9.0.2\adapters\Application

    UNIX

    $ORACLE_HOME/oai/9.0.2/adapters/Application

PeopleSoft 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 PeopleSoft Adapter Directory

On... Go to...

UNIX

$ORACLE_HOME/oai/9.0.2/adapters/Application

Windows

%ORACLE_HOME%\oai\9.0.2\adapters\Application

Table 2-2 Executable Files

File Description

start.bat (Windows)

Takes no parameters, starts the adapter.

start (UNIX)

stop.bat (Windows)

Takes no parameters, stops the adapter.

stop (UNIX)

ignoreErrors.bat (Windows)

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

ignoreErrors (UNIX)

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 PeopleSoft 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.ni Initialization Parameter File Settings

This section contains these topics:

Hub.ini

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

Parameter Description Example

hub_username

The name of the hub database schema (or username). Possible values are valid hub database username. There is no default value.

hub_username=myhub

hub_password

The password for the hub database user. Possible values are the valid password for the hub database user. There is no default value.

hub_password=manager

hub_host

The name of the machine hosting the hub database. Possible values are the valid machine name. There is no default value.

hub_host=mpjoshipc

hub_instance

The valid SID of the hub database. There is no default value.

hub_instance=orcl

hub_port

The TNS listener port number for the HUB database instance. There is no default value.

hub_port=1521

repository_name

The valid name of the repository this adapter talks to. There is no default value.

repository_name=myrepo

Agent Connection Parameters

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

Parameter Description Example

application

The name of the application 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 Oracle9iAS InterConnect-specific DTD for all messages sent to the hub as other Oracle9iAS InterConnect adapters will be retrieving the messages from the hub and know how to interpret them. Set to true if for every message, the DTD imported for the message of the common view is to be used instead of the Oracle9iAS InterConnect DTD. Only set to true if a Oracle9iAS InterConnect adapter is not receiving the messages from the hub. Possible values are true 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 is 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 Oracle9iAS InterConnect message queues can grow. Possible values are any integer greater than 1. The default value is 1000.

agent_max_queue_size=1000

agent_persistence_queue_size

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

agent_persistence_queue_size=1000

agent_persistence_cleanup_interval

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

agent_persistence_cleanup_interval=60000

agent_persistence_retry_interval

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

agent_persistence_retry_interval=60000

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\ora902\bin

service_classpath

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

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

service_class

The entry class for the Windows NT service. 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.3.1.

service_jdk_version=1.3.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

PeopleSoft Adapter Parameters

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

Parameter Description Example

bridge_class

This indicates the entry class for the PeopleSoft. Do not modify this value. A possible value is com.actional.oai.Agent. There is no default value.

bridge_class=com.actional.oai.Agent

Starting the PeopleSoft Adapter

Start the PeopleSoft adapter using the start script in the directory named after the PeopleSoft adapter on Windows NT, UNIX, or HP.

On Windows NT or Windows 2000, start the PeopleSoft adapter from the Service 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 OracleHome9iASInterConnectAdapter-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 PeopleSoft adapter, in turn, automatically starts the publishing engine, a tool for notifying foreign applications of additions, deletions, or updates to the native application (in this case, PeopleSoft objects and databases).

See Also:

Oracle9iAS InterConnect Adapter Publishing Engine User's Guide


Go to previous page Go to next page
Oracle
Copyright © 2002 Oracle Corporation.

All Rights Reserved.
Go To Documentation Library
Home
Go To Table Of Contents
Contents
Go To Index
Index