0% found this document useful (0 votes)

392 views

Oracle Adapter R3 Implementation Guide

CA PROVIDES THIS DOCUMENTATION "as IS" WITHOUT WARRANTY OF ANY KIND. This Documentation is confidential and proprietary information of CA. Licensed users may print a reasonable number of copies of the documentation for their own internal use.

Uploaded by

FJAutosysuser

Available Formats

Download as PDF, TXT or read online on Scribd

0% found this document useful (0 votes)

392 views

Oracle Adapter R3 Implementation Guide

Uploaded by

FJAutosysuser

Available Formats

Download as PDF, TXT or read online on Scribd

You are on page 1/ 80

Unicenter Job Management

Adapter for Oracle Applications

Implementation Guide
r3
This documentation and any related computer software help programs (hereinafter referred to as the
“Documentation”) is for the end user’s informational purposes only and is subject to change or withdrawal by CA at
any time.

This Documentation may not be copied, transferred, reproduced, disclosed, modified or duplicated, in whole or in
part, without the prior written consent of CA. This Documentation is confidential and proprietary information of CA
and protected by the copyright laws of the United States and international treaties.

Notwithstanding the foregoing, licensed users may print a reasonable number of copies of the documentation for
their own internal use, and may make one copy of the related software as reasonably required for back-up and
disaster recovery purposes, provided that all CA copyright notices and legends are affixed to each reproduced copy.
Only authorized employees, consultants, or agents of the user who are bound by the provisions of the license for
the product are permitted to have access to such copies.

The right to print copies of the documentation and to make a copy of the related software is limited to the period
during which the applicable license for the Product remains in full force and effect. Should the license terminate for
any reason, it shall be the user’s responsibility to certify in writing to CA that all copies and partial copies of the
Documentation have been returned to CA or destroyed.

EXCEPT AS OTHERWISE STATED IN THE APPLICABLE LICENSE AGREEMENT, TO THE EXTENT PERMITTED BY
APPLICABLE LAW, CA PROVIDES THIS DOCUMENTATION “AS IS” WITHOUT WARRANTY OF ANY KIND, INCLUDING
WITHOUT LIMITATION, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE
OR NONINFRINGEMENT. IN NO EVENT WILL CA BE LIABLE TO THE END USER OR ANY THIRD PARTY FOR ANY
LOSS OR DAMAGE, DIRECT OR INDIRECT, FROM THE USE OF THIS DOCUMENTATION, INCLUDING WITHOUT
LIMITATION, LOST PROFITS, BUSINESS INTERRUPTION, GOODWILL, OR LOST DATA, EVEN IF CA IS EXPRESSLY
ADVISED OF SUCH LOSS OR DAMAGE.

The use of any product referenced in the Documentation is governed by the end user’s applicable license
agreement.

The manufacturer of this Documentation is CA.

Provided with “Restricted Rights.” Use, duplication or disclosure by the United States Government is subject to the
restrictions set forth in FAR Sections 12.212, 52.227-14, and 52.227-19(c)(1) - (2) and DFARS Section 252.227-
7014(b)(3), as applicable, or their successors.

All trademarks, trade names, service marks, and logos referenced herein belong to their respective companies.

Copyright © 2006 CA. All rights reserved.

CA Product References
This document references the following CA products:
Unicenter® AutoSys® Job Management (Unicenter AutoSys JM)
Unicenter® Job Management Adapter for Oracle Applications (Unicenter JM
Adapter for Oracle Applications)
Unicenter® CA-7™ Job Management (Unicenter CA-7)
Unicenter® CA-Jobtrac® Job Management (CA-Jobtrac)
Unicenter® Network and Systems Management (Unicenter NSM)

Contact Technical Support

For online technical assistance and a complete list of locations, primary service
hours, and telephone numbers, contact Technical Support at
http://ca.com/support
Contents

Chapter 1: Introduction 7
The Purpose of This Guide ...................................................................... 7
Overview ..................................................................................... 8
Supported Oracle Versions ..................................................................... 8

Chapter 2: Windows Installation 9

Preparing for Installation on Windows Systems .................................................. 9
Install the Adapter on a Windows System ...................................................... 10
Post-Installation Tasks for Windows Systems ................................................... 12
Configuring the Oracle Service Name ....................................................... 13
Verify the Oracle Service Name ............................................................ 13
Set Up and Run an Unattended Installation on a Windows System ............................... 14

Chapter 3: UNIX Installation 17

Preparing for Installation on UNIX Systems ..................................................... 17
Upgrading a Unicenter AutoSys Adapter for OAP Installation ..................................... 18
Install the Adapter on a UNIX System .......................................................... 18
Post-Installation Tasks for UNIX Systems ...................................................... 22
Configuring TNS_ADMIN .................................................................. 22
Verify the Oracle Service Name ............................................................ 23
How to Verify the Location of the tnsnames.ora File ......................................... 23
Connecting to Oracle in AIX Operating Environments ........................................ 23
Set Up and Run an Unattended Installation on a UNIX System ................................... 24
Reinstalling the Adapter on a UNIX System ..................................................... 25

Chapter 4: Using the Adapter 27

Integrating the Adapter with Your CA Job Management Environment ............................. 27
ca_oap11 Command Syntax ................................................................... 28
Overriding ca_oap11 Parameters from the Command Line ....................................... 32
Running a ca_oap11 job ...................................................................... 33
ca_oap11 Single Request Examples ............................................................ 33
ca_oap11 Request Set Examples .............................................................. 36

Contents v
Appendix A: Windows Adapter Configuration After Installation 39
Access ConfigOapAdp to Configure the Adapter ................................................. 39
Create an Oracle Configuration ................................................................ 40
Edit an Oracle Configuration ................................................................... 42
Delete an Oracle Configuration ................................................................ 42
Create a New Oracle Access ID ................................................................ 43

Appendix B: UNIX Adapter Configuration After Installation 45

Access ConfigOapAdp to Configure the Adapter ................................................. 45
Create an Oracle Configuration ................................................................ 46
Edit an Oracle Configuration ................................................................... 48
Delete an Oracle Configuration ................................................................ 50

Appendix C: ca_oap11 Job Status and Exit Codes 51

Informational Exit Codes ...................................................................... 51
Warning Messages ............................................................................ 53
Error Codes .................................................................................. 59
Information Codes ............................................................................ 75

Index 79

vi Implementation Guide
Chapter 1: Introduction
This section contains the following topics:

The Purpose of This Guide (see page 7)

Overview (see page 8)
Supported Oracle Versions (see page 8)

The Purpose of This Guide

The Unicenter JM Adapter for Oracle Applications lets you
schedule and monitor Oracle Application jobs using the
sophisticated and reliable job scheduling capabilities of any of
CA's workload automation engines. Using the adapter, you can
schedule the start of Oracle Concurrent Programs, monitor job
progress, record Oracle Application phases and statuses, and
stop the job, if desired.

This guide introduces Unicenter JM Adapter for Oracle

Applications to you. When you finish reading this guide, you
will have an overview of the product and its usage will be
familiar to you.

Introduction 7
Overview

Overview
Unicenter JM Adapter for Oracle Applications acts as an
intermediary between a job management engine and Oracle
Applications. When the job runs, it connects to the Oracle
database and collects the data needed to define the task.

An adapter is a program that you integrate with your job

stream through a job management command job definition.
You can apply standard job attributes to the adapter job
definition from the job management engine. These command
job attributes let you do the following:
Control when the job starts and how many restart
attempts to make if system problems prevent the job from
running.
Define downstream job dependencies—jobs with starting
conditions that rely on the completion of the adapter job.
Define alarm notifications to alert others if the adapter job
fails. Notification can be conveyed in ways such as dialing
a pager or issuing email.
Monitor the status of the adapter job in the Unicenter
AutoSys JM Operator Console.
Report about current and historical adapter job runs using
standard scheduler tools.
Use additional Unicenter AutoSys JM-specific events with
the sendevent command, if started by Unicenter AutoSys
JM.

Unicenter JM adapters enhance the scheduling capabilities of a

number of popular products; contact your CA sales
representative for a complete list of available products.

Supported Oracle Versions

The Unicenter JM Adapter for Oracle Applications supports
Oracle Applications versions 11.0 and 11i.

8 Implementation Guide
Chapter 2: Windows Installation
This section contains the following topics:

Preparing for Installation on Windows Systems (see page 9)

Install the Adapter on a Windows System (see page 10)
Post-Installation Tasks for Windows Systems (see page 12)
Set Up and Run an Unattended Installation on a Windows System (see page
14)

Preparing for Installation on Windows Systems

Before you install the Unicenter JM Adapter for Oracle Applications, you must
make sure your system meets or exceeds the minimum hardware and
software requirements documented in the readme file.

In addition, you must have installed one of CA's job management engines or a
job management agent, set the environment variables, and sourced the
environment.

Job Management Engine

Any CA job scheduler, such as Unicenter AutoSys JM, Unicenter CA-7, CA-
JobTrac, or Unicenter Job Management Option.

Job Management Agent

Any CA job scheduler agent.

You must also install an Oracle Client before installing the adapter.

More information:

UNIX Installation (see page 17)

Windows Installation 9
Install the Adapter on a Windows System

Install the Adapter on a Windows System

You must install Unicenter JM Adapter for Oracle Applications before you can
use CA job management engines or job management agents to schedule and
monitor Oracle Application jobs.

To install the adapter on a Windows system

1. Insert the installation media in the drive and mount it.

If autorun is enabled, the installation starts automatically. If autorun is

disabled, run setup.exe from the installation media to start the Unicenter
JM Adapter for Oracle Applications installation.

The installation wizard Welcome page opens.

2. Click Next.

The License Agreement page opens.

Note: You can click Cancel at any time to quit the installation. If you click
Cancel, the Exit Setup page opens. Click Yes to quit the installation or No
to continue the installation. If the installation is terminated, no software is
installed on the computer.

3. Accept the terms of the license agreement, and click Next.

The Installation Type page opens.

Note: If you do not accept the license agreement, the installation is

terminated and no software is installed on the computer.

4. Select one of the following installation types and click Next:

Express

Installs Unicenter JM Adapter for Oracle Applications with minimal user

input and configuration.

Custom

Lets you selectively install and configure Unicenter JM Adapter for

Oracle Applications.

The Components to Install page opens.

Note: If you selected the Express installation, some of the following steps
will not apply to your installation.

10 Implementation Guide
Install the Adapter on a Windows System

5. Select whether to install the following components, and click Next:

Documentation

Installs the documentation set.

Unicenter JM Adapter for Oracle Applications

Installs Unicenter JM Adapter for Oracle Applications, which schedules

and monitors Oracle Application jobs from workload schedulers.

The Installation Location page opens.

6. Enter the installation location for Unicenter JM Adapter for Oracle

Applications, and click Next.

If you do not know the directory location, click Browse to browse for and
select a directory.

The default installation location for Unicenter JM Adapter for Oracle

Applications is C:\Program Files\CA\UnicenterJMAOracleApps

The Unicenter JM Adapter for Oracle Applications Configuration page

opens.

7. Complete the following fields, and click Next:

Oracle Service Name

Defines the service name used to name the configuration created from
this installation.

Oracle Home Directory

Defines the path of the Oracle home directory, as known to Oracle.

Oracle Access ID

Defines the user ID used to connect to the Oracle database.

Oracle Access Password

Defines the password associated with the specified Oracle Access ID.

Password verify

Confirms the password entered in the Oracle Access Password field.

An additional Unicenter JM Adapter for Oracle Applications Configuration

page opens.

Note: After installation, you can run ConfigOapAdp to maintain the

product's configuration information.

Windows Installation 11
Post-Installation Tasks for Windows Systems

8. Complete the following fields, and click Next:

Responsibility

Defines the responsibility of the user.

Default: System Administrator

Responsibility App. Short Name

Defines the application short name

Default: SYSADMIN

Oracle App. User ID

Defines the Oracle Applications user ID.

Default: SYSADMIN

The Setup Summary page opens.

9. Verify that the installation information is correct, and click Finish.

The selected components are installed.

When the installation completes, you must restart your system before
proceeding.

More information:

Set Up and Run an Unattended Installation on a Windows System (see page

14)

Post-Installation Tasks for Windows Systems

Before using the adapter after installation, make sure you have performed the
appropriate post-installation tasks.

More information:

Configuring the Oracle Service Name (see page 13)

Verify the Oracle Service Name (see page 13)
Windows Adapter Configuration After Installation (see page 39)

12 Implementation Guide
Post-Installation Tasks for Windows Systems

Configuring the Oracle Service Name

To successfully run an adapter job after installation, you must do the

following:
Make sure a valid configuration was created during installation or with the
configuration utility.

The configuration name must match a valid database name.

Use the Oracle Enterprise Manager console in Oracle to define the
database name for the Unicenter JM Adapter for Oracle Applications to use
to connect to the Oracle database service.

Verify the Oracle Service Name

If sqlplus is available on your system, you can use it to verify the Oracle
service name. To verify the service name, run sqlplus as follows:

sqlplus oracle_id/password@database_name

oracle_id

Defines the user name used to log on to the Oracle database.

password

Defines the password associated with the specified Oracle ID.

database_name

Defines the TNS name of the database server.

Windows Installation 13
Set Up and Run an Unattended Installation on a Windows System

Set Up and Run an Unattended Installation on a Windows

System
To run an unattended installation of Unicenter JM Adapter for Oracle
Applications, you must create a response file and run it on each computer on
which you want to install the adapter.

To set up and run an unattended installation on a Windows system

1. Insert the installation media in the drive and mount it.

Note: If autorun is enabled, the installation starts automatically. Click

cancel to exit the installation wizard.

2. Close all windows and open a command prompt.

3. Change to the drive in which you inserted the installation media and enter
the following command at the command prompt to record the response file
for unattended installation:

setup /r /f1”path_to_response_file\silent.iss”

path_to_response_file

Defines the location at which to write the unattended installation file.

Note: Do not include a space between f1 and the response file path or the
installation will fail.

The installation wizard Welcome page opens.

4. Proceed with the Unicenter JM Adapter for Oracle Applications installation

as if you were running a typical installation.

The setup program creates the response file at the specified location.

5. Copy the response file to the computer on which to install Unicenter JM

Adapter for Oracle Applications.

6. Insert the installation media in the drive and mount it.

Note: If autorun is enabled, the installation starts automatically. Click

cancel to exit the installation wizard.

14 Implementation Guide
Set Up and Run an Unattended Installation on a Windows System

7. Close all windows and open a command prompt.

8. Change to the drive in which you inserted the installation media, and enter
the following command to run the previously recorded response file:

setup /s /f1”path_to_response_file\silent.iss”

path_to_response_file

Defines the location at which the unattended installation file resides.

Note: Do not include a space between f1 and the response file path or the
installation will fail.

Unicenter JM Adapter for Oracle Applications is installed.

When the installation completes, you must restart your system before
proceeding.

More information:

Install the Adapter on a Windows System (see page 10)

Windows Installation 15
Chapter 3: UNIX Installation
This section contains the following topics:

Preparing for Installation on UNIX Systems (see page 17)

Upgrading a Unicenter AutoSys Adapter for OAP Installation (see page 18)
Install the Adapter on a UNIX System (see page 18)
Post-Installation Tasks for UNIX Systems (see page 22)
Set Up and Run an Unattended Installation on a UNIX System (see page 24)
Reinstalling the Adapter on a UNIX System (see page 25)

Preparing for Installation on UNIX Systems

Before you install the Unicenter JM Adapter for Oracle Applications, you must
make sure your system meets or exceeds the minimum hardware and
software requirements documented in the readme file.

In addition, you must have installed one of CA's job management engines or a
job management agent, set the environment variables, and sourced the
environment.

Job Management Engine

Any CA job scheduler, such as Unicenter AutoSys JM, Unicenter CA-7, CA-
JobTrac, or Unicenter Job Management Option.

Job Management Agent

Any CA job scheduler agent.

You must also install an Oracle Client before installing the adapter.

If you will use Unicenter JM Adapter for Oracle Applications with Unicenter
AutoSys JM, you must make sure the system is properly configured before you
install the adapter.

Note: For more information about verifying your Unicenter AutoSys JM

configuration, see the documentation for that product.

UNIX Installation 17
Upgrading a Unicenter AutoSys Adapter for OAP Installation

Upgrading a Unicenter AutoSys Adapter for OAP Installation

Unicenter JM Adapter for Oracle Applications 3.0 is a new installation, not an
upgrade.

If you previously installed Unicenter AutoSys Adapter for OAP, the Unicenter
JM for Oracle Applications post-installation process replaces the current
auto_oap11 executable file with a symbolic link to the new auto_oap11
executable file. Existing job definitions will run without modification after the
new installation.

Install the Adapter on a UNIX System

You must install Unicenter JM Adapter for Oracle Applications before you can
use CA job management engines or job management agents to schedule and
monitor Oracle Application jobs.

To install the adapter on a UNIX system:

1. Mount the installation media, and issue the following command:

oap_setup.sh [-t trace_file] [-p log_file] [-r response_file] [-s] [-F] [-x]
[-v] [-a output_response_file]

-t trace_file

Indicates to write trace information to the specified file during

installation. If you do not specify a path with the file name, the trace
file is created in the installation directory. The trace function is useful
in debugging.

-p log_file

Indicates to redirect installation output to the specified file. If you do

not specify a path with the file name, the log file is created in the
installation directory.

-r response_file

Indicates the response file to use when running an unattended (silent)

installation.

Note: To run an unattended installation, specify the -r and -s

parameters. The response file specification must include the full path
(for example, /usr/tmp/OAP.resp) if the file is not specified in the
system path. If you specify the -a parameter when running
oap_setup.sh, the product is not installed.

-s

Indicates to perform an unattended (that is, silent) installation. When

you specify this parameter, the input of the unattended installation is
the response file defined in the -r parameter.

18 Implementation Guide
Install the Adapter on a UNIX System

-F

Indicates to perform a forced installation without a product backup.

For example, you might specify this parameter if an installation was

corrupted and the update installation failed because it could not
successfully run the automatic backup procedure. When you specify
the -F parameter, the product installs without a making a backup.

-x

Indicates to create a self-extracting installation package.

-v

Indicates to display the version of the CA Software Management

Installer used to create the product installation.

-a output_response_file

Indicates to create a response file with the specified name to use when
running an unattended (silent) installation.

Note: When you specify the -a parameter when running oap_setup.sh,

the product is not installed. To run an unattended installation, specify
the -r and -s parameters. The response file specification must include
the full path (for example, /usr/tmp/OAP.resp).

The installation wizard Welcome page opens.

Note: If Java Runtime Environment (JRE) 1.4 is installed, the Unicenter JM

Adapter for Oracle Applications installation Java GUI opens. Otherwise, a
VT100-based installation GUI opens.

2. Click Next.

The License Agreement page opens.

3. Accept the terms of the license agreement, and click Next. You must scroll
to the end of the license agreement to enable the I Agree button.

The Installation Location page opens. If you did not accept the license
agreement, the installation is terminated and no software is installed on
the computer.

4. Enter the installation location for the Unicenter JM Adapter for Oracle
Applications, and click Next.

The default installation location for Unicenter JM Adapter for Oracle

Applications is:

/opt/CA/UnicenterJMAOracleApps

The Owner and Group Settings page opens.

UNIX Installation 19
Install the Adapter on a UNIX System

5. Select the owner and group names for the Unicenter JM Adapter for Oracle
Applications files, and click Next.

Owner

Defines the user who "owns" Unicenter JM Adapter for Oracle

Applications files.

Default: root

Group

Defines the user group of which the specified owner is a member.

Default: sys

If the owner or group is not defined in the system, select the Create the
owner or group account if they are not defined in the system check box,
thereby creating a new owner or group account.

The Unicenter JM Adapter for Oracle Applications Configuration page

opens.

6. Complete the following fields, and click Next:

Oracle Service Name

Defines the service name used to name the configuration created from
this installation.

TNS_ADMIN Directory

Defines the directory path of the tnsnames.ora file. This value is set as
the TNS_ADMIN setting for the run-time environment.

Oracle App. Access ID

Defines the ID used to connect to the Oracle database.

Oracle App. Access Password

Defines the password associated with the specified Oracle App. Access
ID.

Password verify

Confirms the password entered in the Oracle App. Access Password

field.

An additional Unicenter JM Adapter for Oracle Applications Configuration

page opens.

Note: After installation, you can run ConfigOapAdp to maintain the

product's configuration information.

20 Implementation Guide
Install the Adapter on a UNIX System

7. Complete the following fields, and click Next:

Responsibility

Defines the responsibility of the user.

Default: System Administrator

Responsibility App. Short Name

Defines the application short name

Default: SYSADMIN

Oracle App. User ID

Defines the Oracle Applications user ID.

Default: SYSADMIN

The Setup Summary page opens.

8. Verify that the installation information is correct, and click Install Product.

The selected components are installed.

When the installation completes, you must close all sessions before
proceeding.

More information:

Set Up and Run an Unattended Installation on a UNIX System (see page 24)

UNIX Installation 21
Post-Installation Tasks for UNIX Systems

Post-Installation Tasks for UNIX Systems

Before using the adapter after installation, make sure you have taken the
appropriate post-installation action for your job management engine or agent:

Unicenter AutoSys JM

Close all dialogs and open a new session.

Workload agent

Restart the workload agent.

Unicenter CA-7 and CA-JobTrac

Define the OAPDIR and TNS_ADMIN.

You should also perform other appropriate post-installation tasks.

More information:

Configuring TNS_ADMIN (see page 22)

How to Verify the Location of the tnsnames.ora File (see page 23)
UNIX Adapter Configuration After Installation (see page 45)
Verify the Oracle Service Name (see page 23)

Configuring TNS_ADMIN

To successfully run an adapter job after installation, the following

requirements must be met:
Make sure a valid configuration was created during installation or with the
configuration utility.

The configuration name must match a valid service name.

In the tnsnames.ora file, define the service name to connect to the Oracle
database service for Unicenter JM Adapter for Oracle Applications.
Set TNS_ADMIN to the directory that contains the tnsnames.ora file.

22 Implementation Guide
Post-Installation Tasks for UNIX Systems

Verify the Oracle Service Name

If sqlplus is available on your system, you can use it to verify the Oracle
service name. To verify the service name, run sqlplus as follows:

sqlplus oracle_id/password@service_name

oracle_id

Defines the user name used to log on to the Oracle database.

password

Defines the password associated with the specified Oracle ID.

service_name

Defines the TNS name of the database server.

How to Verify the Location of the tnsnames.ora File

To properly assign TNS_ADMIN to the directory that contains the

tnsnames.ora file, you must confirm its location. Use the following process to
verify the location of the tnsnames.ora file:

1. Run a job with the env command.

2. Search the job output for TNS_ADMIN.

3. At a command line, change to the TNS_ADMIN directory specified in the

job output and verify existence of the tnsnames.ora file.

Connecting to Oracle in AIX Operating Environments

When you use the Unicenter JM Adapter for Oracle in AIX operating
environments, you must define the NLS33 directory and the timezone.dat file.
In general, you can fulfill these requirements in either of the following ways:
Set the ORACLE_HOME environment variable to point to an Oracle 9.0 or
higher instance. The adapter will search this directory for the appropriate
NLS33 and timezone.dat files.
Explicitly set the ORA_NLS33 environment variable to point to an NLS33
directory and set the ORA_TZFILE environment variable to point to a
timezone.dat file.

Note: Depending on whether the ORACLE_HOME environment variable is set,

you may need to change the service_name in the tnsnames.ora file. If it is set,
the adapter factors in the name conventions as defined in the sqlnet.ora file
when looking for the service name in the tnsnames.ora file.

UNIX Installation 23
Set Up and Run an Unattended Installation on a UNIX System

Set Up and Run an Unattended Installation on a UNIX System

To run an unattended installation of Unicenter JM Adapter for Oracle
Applications, you must create a response file and run it on each computer on
which you want to install the adapter.

To set up and run an unattended installation on a UNIX system:

1. Mount the installation media, and issue the following command at the
command prompt to record the response file for unattended installation:

oap_setup.sh -a output_response_file

-a output_response_file

Specifies a switch, which indicates you are executing oap_setup.sh in

ask mode, thereby creating a response file.

The installation wizard Welcome page opens.

Note: If Java Runtime Environment (JRE) 1.4 is installed, the Unicenter JM

Adapter for Oracle Applications installation Java GUI opens. Otherwise, a
VT100-based installation GUI opens.

2. Proceed with the Unicenter JM Adapter for Oracle Applications installation

as if you were running a typical installation.

oap_setup.sh creates the response file at the specified location.

3. Copy the response file to the computer on which to install Unicenter JM

Adapter for Oracle Applications, and issue the following command at a
command prompt on that computer:

oap_setup.sh -s -r response_file

-r response_file

Indicates the response file from which to install the adapter.

Note: The response file specification must include the full path (for
example, /usr/tmp/OAP.resp) if the file is not specified in the system
path.

Unicenter JM Adapter for Oracle Applications is installed.

When the installation completes, you must close all sessions before
proceeding.

More information:

Install the Adapter on a UNIX System (see page 18)

24 Implementation Guide
Reinstalling the Adapter on a UNIX System

Reinstalling the Adapter on a UNIX System

If necessary, you can reinstall Unicenter JM Adapter for Oracle Applications on
a UNIX System from your original installation media or a response file. The
only change from the original installation is the welcome page of the
installation GUI, which lets you reinstall the product.

During reinstallation, you cannot change the installation directories from those
specified during the original installation.

UNIX Installation 25
Chapter 4: Using the Adapter
This section contains the following topics:

Integrating the Adapter with Your CA Job Management Environment (see

page 27)
ca_oap11 Command Syntax (see page 28)
Overriding ca_oap11 Parameters from the Command Line (see page 32)
Running a ca_oap11 job (see page 33)
ca_oap11 Single Request Examples (see page 33)
ca_oap11 Request Set Examples (see page 36)

Integrating the Adapter with Your CA Job Management

Environment
You can use the ca_oap11 command to integrate Oracle Applications jobs into
your CA job management engine environment. With the ca_oap11 command,
you can submit a concurrent request, submit a request set, and monitor the
run status of the request.

To define the job, create a command job with your CA job management engine
and include ca_oap11 and its parameters in the command attribute. You can
schedule a CA job management engine to start based on a variety of criteria,
including the completion of one or more jobs, the occurrence of a specified
date and time, or any combination of the above.

Note: For more information about scheduling criteria, see the appropriate CA
job management engine documentation.

Unicenter AutoSys Job Management Only: When the starting conditions

for the Oracle Applications job are met, Unicenter AutoSys JM's remote agent
initiates the job and associates a job request ID with it.

If the adapter cannot start a request, or if the job fails for another reason, use
the appropriate attribute in the job definition if you want the job management
engine to submit the job again.

After the job is submitted to Oracle Applications, the adapter will not exit until
the Oracle Applications job either completes successfully or terminates. By
default, the adapter polls the Oracle Applications database every 30 seconds
to check the job status.

Using the Adapter 27

ca_oap11 Command Syntax

The ca_oap11 command integrates Oracle Applications jobs into the CA job
management engine environment. Using the ca_oap11 command, you can
submit a concurrent request or a request set, and monitor the run status of
the request.

This command has the following syntax for a single request:

[-D] [-L] [-l] [-P seconds] [-H intervals] -S service_name [-i oracle_id] [-u
user] [-r responsibility] [-a application] [-M errors] [-p printer] [-s
printstyle] [-n copies] ApplicationShortName ProgramShortName [prog_args]

This command has the following syntax for a request set:

[-D] [-L] [-l] [-P seconds] [-H intervals] -S service_name [-i oracle_id] [-u
user] [-r responsibility] [-a application] [-M errors] [-p printer] [-s
printstyle] [-n copies] [-b]
-j ApplicationShortName RequestShortName [-R [-p printer] [-s printstyle] [-n
copies] stage_name sequence_no [prog_args]]

-D

Indicates to use debugging when the job runs.

-L

Indicates to log information about the job to the Event Processor log.

Limits: This parameter is only valid for Unicenter AutoSys JM.

-l

Indicates to append the request log file produced by the Oracle

Applications Concurrent Manager to the log written to standard output.

Limits: If the Unicenter Job Manager Agent and Unicenter JM Adapter are
not running on the same machine as the Concurrent Manager, Unicenter
JM Adapter may be unable to locate the request log.

-P seconds

Defines the interval, in seconds, at which the system checks the status of
the task.

Default: 30

Limits: This value must be greater than 0.

-H intervals

Defines the number of poll intervals between heartbeat signals.

Default: 4

Limits: This parameter is only valid for Unicenter AutoSys JM.

This value must be greater than 0.

28 Implementation Guide
ca_oap11 Command Syntax

-S service_name

Defines the TNS name of the database server.

Limits: If you specify -S and -i in the same command, -S takes

precedence and @serviceName in -i is ignored.

-i oracle_id

Defines the user name and password of the ORACLE ID under which the
concurrent program is to run.

Default: apps

Limits: This value must be in the form

user_name/password@servicename, and cannot contain spaces.

Each user/password combination is valid in a domain.

If you specify -S and -i in the same command, -S takes precedence and

@serviceName in -i is ignored.

-u user

Defines the name of the Oracle Application Object Library user.

Default: SYSADMIN

-r responsibility

Defines the Oracle responsibility name for the user.

Default: System Administrator

Limits: You must enclose responsibility in quotation marks when its value
contains spaces.

-a application

Defines the short name for Oracle Applications.

Default: SYSADMIN

-M errors
Defines the maximum number of database connection errors that can
occur before the adapter terminates.

If the adapter fails to get a status back from the Oracle Applications job
after attempting the specified number of times, it exits with "Exceeded
maximum number of stat failures". Setting this parameter to a low number
quickly alerts you to problems communicating with the Oracle database.

Default: 50

-p printer

Defines a printer to which the Oracle Applications job can print.

Using the Adapter 29

ca_oap11 Command Syntax

-s printstyle

Defines the printing orientation

Default: PORTRAIT

Limits: You can set this parameter to any value from the
FND_PRINTER_STYLES table (for example, PORTRAIT or LANDSCAPE).

-n copies

Defines the number of copies to print.

-j ApplicationShortName

Defines the short name of the application for the concurrent program. This
name, with the concurrent program name, uniquely identifies the
concurrent program for your concurrent request.

ProgramShortName

Defines the name of the concurrent program. This name, with the
concurrent program application short name, uniquely identifies the
concurrent program for your concurrent request.

RequestShortName

Defines the name of an Oracle concurrent request set. This name, with the
concurrent program application short name, uniquely identifies the
concurrent request set for your concurrent request.

The print parameters (-p, -s, and -n) specified for a request set apply to
all the concurrent programs in a request set. Individual parameters
specified in a concurrent program that is part of a request set override the
print parameters specified for the request set.

-R

Indicates to override an individual print parameter or a program argument

for a specific concurrent program in a request set. The Stage_name and
Sequence_no values identify the specific program.

When it encounters the -R parameter, ca_oap11 flags all following

parameters as individual concurrent program overrides. The global print
parameter specification and the individual program arguments may be
overridden.

After the -R parameter, you can use the same syntax as for the global
print parameters to override the print parameters. After specifying the
optional print parameters, you must specify the unique concurrent
program to which these overrides pertain. This is specified by supplying
the Stage_name and Sequence_no values of the concurrent program in
the stage. After you identify the specific concurrent program, you can
specify individual concurrent program argument overrides.

Limits: You can specify or override up to 100 arguments, but the

maximum command line length of the job management engine might limit
the specified number of arguments.

30 Implementation Guide
ca_oap11 Command Syntax

Stage_name
Defines the stage name of the concurrent program that the -R option
preceded. The stage name and the sequence number uniquely identify the
concurrent program defined in the request set.

Sequence_no

Defines the sequence number of the concurrent program in the request

set. The stage name and the sequence number uniquely identify the
concurrent program defined in the request set.

prog_args

Defines optional arguments for the concurrent program.

Limits: You can define up to 100 arguments.

Using the Adapter 31

Overriding ca_oap11 Parameters from the Command Line

You can override default ca_oap11 parameter values from the command line in
the following ways:

Position

The first parameters on the command line after the ca_oap11 program
name replace any default parameter in the same position.

For example:

ca_oap11 ... FND FNDABCD arg1 arg2

Note: Any following methods used to override the arguments will forego
the position method. Once used on the job definition command line for an
Oracle Applications program, any following argument cannot use the
Position method again until the end of the arguments specification of the
current program.

Explicit Position Overrides

To replace parameters in a non-linear sequence, specify the position to

override by using @position=value, where position is relative to 1.

For example:

ca_oap11 ... FND FNDABCD @2=arg2 @1=arg1

Explicit Column Sequence

Column sequence might be different than positional numbers (for example,

10, 20, 30 instead of 1, 2, 3). Specify these by preceding the column
sequence number with a percent sign (%).

For example:

ca_oap11 ... FND FNDABCD arg1 @3=arg3 %2=arg2

Column Name

Precede the column name with a percent sign (%). For example:

ca_oap11 ... FND FNDABCD arg1 @3=arg3 %2=arg2 %dept=Accounting

Note: If the argument contains embedded spaces, you must enclose the
entire specification in quotation marks. For example,

“%Dept Name=Accounting” or “@4=a b c d”

32 Implementation Guide
Running a ca_oap11 job

Running a ca_oap11 job

Unicenter JM Adapter for Oracle Applications works like any typical command
line program. The adapter detects the Unicenter JM agent's run-time
environment and acts on it.

You can define the Unicenter JM Adapter for Oracle Applications job as you
would a typical command line program or utility. The job management agent
on the computer on which the adapter is installed invokes Unicenter JM
Adapter for Oracle Applications and returns the run status of the adapter to its
scheduler.

Note: For more information about running a ca_oap11 job, see the
appropriate documentation for your CA job management engine.

ca_oap11 Single Request Examples

This section presents Unicenter JM Adapter for Oracle Applications syntax
examples for single requests.

Note: The examples in this section are generic and are intended as an aid to
correct command line syntax. See the appropriate documentation for specific
examples for using your job management engine.

Example: ca_oap11 Single Request Example 1

This example shows a job definition that uses the Default Oracle Access ID and
password defined in the configuration VIS, which is defined during installation
or with the configuration utility.

ca_oap11 -S VIS FND FNDSCARU

-S VIS

Defines the service name that identifies the Oracle Applications server.

FND

Defines the application short name.

FNDSCARU

Defines the program short name.

Using the Adapter 33

ca_oap11 Single Request Examples

Example: ca_oap11 Single Request Example 2

This example shows a job definition that sets the global print options for the
program FNDSCRUR to use printer Print1 to print two copies of every report. It
also uses explicit position and explicit column sequence overrides to override
two arguments in the specified program.

ca_oap11 -i apps@VIS -p Print1 -n 2 FND FNDSCRUR “Oracle Purchasing” Buyer

-i apps@VIS

Defines the Oracle Access ID apps and service name VIS.

-p Print1

Defines the printer name.

-n 2

Defines the number of copies to make.

FND

Defines the application short name.

FNDSCRUR

Defines the program short name.

“Oracle Purchasing”

Defines the first positional argument for FNDSCRUR.

Buyer

Defines the next positional argument for FNDSCRUR.

34 Implementation Guide
ca_oap11 Single Request Examples

Example: ca_oap11 Single Request Example 3

This example shows a job definition that runs in debug mode and sets the
global print options for the program FNDSCRUR to use printer Print1 to print
one copy of every report. It also uses explicit position and explicit column
sequence overrides to override two arguments in the specified program.

ca_oap11 -D -i apps -S VIS -p Print1 -n 1 FND FNDSCRUR @2=Buyer %1=”Oracle

Purchasing”

-D

Specifies to run the job in debug mode.

-i apps

Defines the Oracle Access ID apps.

-S VIS

Defines the name of the service that defines the Oracle Applications
server.

-p Print1

Defines the printer name.

-n 1

Defines the number of copies to make.

FND

Defines the application short name.

FNDSCRUR

Defines the program short name.

@2=Buyer

Defines an explicit position override for the second argument.

%1=”Oracle Purchasing”

Defines an explicit column sequence override for the argument.

More information:

Overriding ca_oap11 Parameters from the Command Line (see page 32)

Using the Adapter 35

ca_oap11 Request Set Examples

This section presents Unicenter JM Adapter for Oracle Applications syntax
examples for request sets.

Note: The examples in this section are generic. See the appropriate
documentation for specific examples for using your job management engine.

Example: ca_oap11 Request Set Example 1

This example shows a job definition that uses the Default Oracle Access ID and
password defined in the configuration VIS, which is defined during installation
or with the configuration utility.

ca_oap11 -S VIS -j FND FNDRSSUB727

-S VIS

Defines the service name that identifies the Oracle Applications server.

-j

Specifies that this is a request set job.

FND

Defines the Application Short Name.

FNDRSSUB727

Defines the Request Set Short Name.

36 Implementation Guide
ca_oap11 Request Set Examples

Example: ca_oap11 Request Set Example 2

This example sets the global print options for request set FNDRSSUB727 to
printer Print1 and prints one copy of every printable report in the request set.
It also overrides the arguments for the reports defined in the request set by
specifying the stage and sequence number.

ca_oap11 -S VIS -p Print1 -n 1 -j FND FNDRSSUB727 -R Stage10 10 Both “” “” -R

Stage20 10 “” SYSADMIN FND “System Administrator”

-S VIS

Defines the service name that defines the Oracle Applications server.

-p Print1

Defines the printer name.

-n 1

Defines the number of copies to make.

-j

Specifies that this is a request set job.

FND

Defines the Application Short Name.

FNDRSSUB727

Defines the Request Set Short Name.

-R Stage10 10 Both “” “”

Defines a positional argument override for the report defined in

stage=Stage10 and sequence number=10.

-R Stage20 10 “” SYSADMIN FND “System Administrator”

Defines a positional argument override for the report defined in

Stage=Stage20 and sequence number=10.

Using the Adapter 37

ca_oap11 Request Set Examples

Example: ca_oap11 Request Set Example 3

This example prints two copies of report stage Stage20, sequence 10 on

printer peach. One copy of other printable reports in this request set will print
on printer Print1.

ca_oap11 -S VIS -p Print1 -n 1 -j FND FNDRSSRB727 -R Stage10 10 Both “” “” 1 -R -

p peach -n 2 Stage20 10 “” SYSADMIN FND “System Administrator”

-S VIS

Defines the service name that defines the Oracle Applications server.

-p Print1

Defines the printer name.

-n 1

Defines the number of copies to make.

-j

Specifies that this is a request set job.

FND

Defines the Application Short Name.

FNDRSSUB727

Defines the Request Set Short Name.

-R Stage10 10

Defines the report defined in stage=Stage10 and sequence number=10.

-p peach

Defines a printer override.

-n 2

Defines a copy override.

-R Stage20 10 “” SYSADMIN FND “System Administrator”

Defines a positional argument override for the report defined in

Stage=Stage20 sequence number=10.

38 Implementation Guide
Appendix A: Windows Adapter
Configuration After Installation
This section contains the following topics:

Access ConfigOapAdp to Configure the Adapter (see page 39)

Create an Oracle Configuration (see page 40)
Edit an Oracle Configuration (see page 42)
Delete an Oracle Configuration (see page 42)
Create a New Oracle Access ID (see page 43)

Access ConfigOapAdp to Configure the Adapter

If you need to alter the Unicenter JM Adapter for Oracle Applications
configuration after you install the adapter, you can use the ConfigOapAdp
utility provided with the installation. This utility provides an interactive
interface for creating, editing, and deleting configurations.

The ConfigOapAdp utility for Windows is a GUI for configuring Unicenter JM

Adapter for Oracle Applications. To access ConfigOapAdp for Windows, do one
of the following:
Issue the following command from a command prompt:

ConfigOapAdp.exe

Select Start, Programs, Computer Associates, Unicenter, JM Adapter for

Oracle Applications, Configuration Utility

Windows Adapter Configuration After Installation 39

Create an Oracle Configuration

You must create an Oracle configuration before you can use Unicenter JM
Adapter for Oracle Applications to schedule and monitor Oracle Application
jobs with one of CA's workload automation engines.

To create an Oracle configuration

1. Access ConfigOapAdp for Windows.

The Available Configurations List dialog opens.

2. Click New.

The Oracle Home Directory dialog opens.

3. Enter the path to the Oracle home directory on the client computer, and
click Next.

ConfigOapAdp verifies the validity of the directory you entered, and the
Create a New Configuration dialog opens.

Note: If you do not know the location of the Oracle home directory, click
the button next to the Oracle Home Directory field to browse for and select
the directory.

4. Select a database connection from the Configuration Name list, and click
Add ID.

Note: The Configuration Name list is populated from database connections

defined in the Oracle Enterprise Manager Console. To add a new
configuration, you must first define the connection in the Oracle Enterprise
Manager Console.

The Create a New ID dialog opens.

5. Complete the fields on the Create a New ID dialog as appropriate, and

click OK.

Note: You can create multiple Oracle access IDs.

The Create a New ID dialog closes and the Create a New Configuration
dialog refreshes to include the new Oracle access ID in the Oracle Access
ID List box.

6. Select an Oracle access ID to use as the default for this configuration from
the Oracle Access ID List, and click Set As Default.

The Oracle Access ID box refreshes to display the selected ID.

40 Implementation Guide
Create an Oracle Configuration

7. Complete the remaining fields on the Create a New Configuration dialog as

appropriate, and click OK.

Oracle Applications User ID

Defines the default Oracle Applications User ID to use for applications

that use this configuration.

Default: SYSADMIN (if you did not change this value during
installation).

Responsibility

Defines the default responsibility for the user identified in the Oracle
Access ID box.

Default: System Administrator (if you did not change this value
during installation).

Responsibility App. Short Name

Defines the default application short name.

Default: SYSADMIN (if you did not change this value during
installation).

ConfigOapAdp saves your configuration settings, and the Create a New

Configuration dialog closes.

More information:

Access ConfigOapAdp to Configure the Adapter (see page 39)

Create a New Oracle Access ID (see page 43)

Windows Adapter Configuration After Installation 41

Edit an Oracle Configuration

You must edit an Oracle configuration if any of the information used to define
it changes.

To edit an Oracle configuration

1. Access ConfigOapAdp for Windows.

The Available Configurations List dialog opens.

2. Select a configuration from the Available Configurations List area, and click
Edit.

The selected configuration opens in the Edit Configuration dialog.

3. Update the fields on the Edit Configuration dialog as appropriate, and click
OK.

To create a new Oracle access ID, click Add ID in the Oracle Access ID
List area.

To change an Oracle access ID or its associated password, select the

ID from the Oracle Access ID List area and click Edit ID.

To delete an Oracle access ID, select the ID from the Oracle Access ID
List area and click Delete ID.

To set a different ID as the default Oracle Access ID, select the ID

from the Oracle Access ID List area and click Set As Default.

ConfigOapAdp saves your configuration settings, and the Edit

Configuration dialog closes.

More information:

Create a New Oracle Access ID (see page 43)

Delete an Oracle Configuration

You can delete an Oracle configuration if it is no longer used.

To delete an Oracle configuration

1. Access ConfigOapAdp for Windows.

The Available Configurations List dialog opens.

2. Select a configuration from the Available Configurations List area, and click
Delete.

ConfigOapAdp deletes the selected configuration, and the delete

Configuration dialog closes.

42 Implementation Guide
Create a New Oracle Access ID

Create a New Oracle Access ID

If the Oracle Access ID List area of the Create a New Configuration or Edit
Configuration dialog does not contain an appropriate Oracle access ID, you
must create one.

To create a new Oracle access ID

1. Click Add ID on the Create a New Configuration dialog or the Edit

Configuration dialog.

The Create a New ID dialog appears.

2. Complete the fields on the Create a New ID dialog as appropriate, and

click OK.

Defines the ID used to access the Oracle database.

Password

Defines the password associated with the specified ID. ConfigOapAdp

encrypts the specified password and stores it in the registry.

Confirm Password

Verifies the spelling of the specified password.

ConfigOapAdp saves the new ID, the Create a New ID dialog closes, and
the Oracle Access ID List area of the Create a New Configuration or the
Edit Configuration dialog refreshes.

Windows Adapter Configuration After Installation 43

Appendix B: UNIX Adapter
Configuration After Installation
This section contains the following topics:

Access ConfigOapAdp to Configure the Adapter (see page 45)

Create an Oracle Configuration (see page 46)
Edit an Oracle Configuration (see page 48)
Delete an Oracle Configuration (see page 50)

Access ConfigOapAdp to Configure the Adapter

If you need to alter the Unicenter JM Adapter for Oracle Applications
configuration after you install the adapter, you can use the ConfigOapAdp
utility provided with the installation. ConfigOapAdp provides an interactive
interface for updating the Unicenter JM Adapter for Oracle Applications
configuration.

The ConfigOapAdp utility for UNIX is an interactive utility for configuring

Unicenter JM Adapter for Oracle Applications. To access ConfigOapAdp, issue
the ConfigOapAdp command from a new session window.

UNIX Adapter Configuration After Installation 45

Create an Oracle Configuration

You must create an Oracle configuration before you can use Unicenter JM
Adapter for Oracle Applications to schedule and monitor Oracle Application
jobs with one of CA's workload automation engines.

To create an Oracle configuration

1. Access ConfigOapAdp without specifying any parameters.

The Main menu appears.

Main Menu:
0. Exit.
1. Create a new configuration.
2. Edit a configuration.
3. Delete a configuration.
4. List defined configuration name.
5. Show a configuration.
6. Save the configuration.
Please select one action ( 0-6 ) :

2. Select option 1. Create a new configuration, and press Enter.

The utility prompts you to enter the name of the new configuration.

3. Enter a name for the configuration, and press Enter.

The utility prompts you to enter the Oracle client's home directory.

4. Enter the path to the Oracle home directory on the client computer, and
press Enter.

ConfigOapAdp verifies the validity of the directory you entered, and the
Create New Configuration menu appears.

Create New Configuration [configuration name] Menu:

0. Exit.
1. Set default Oracle access ID.
2. Set default OAP application user ID.
3. Set default Responsibility.
4. Set default Responsibility Application Short Name.
5. Add new ID.
6. Show current settings.
7. Save new configuration.
Please select one action ( 0-7 ):

5. Select option 1. Set default Oracle access ID, and press Enter.

The utility prompts you to enter an Oracle access ID.

Note: If necessary, you can select option 5. Add new ID to create a new
Oracle access ID.

46 Implementation Guide
Create an Oracle Configuration

6. Enter an Oracle access ID to use as the default for this configuration, and
press Enter.

The Create New Configuration menu appears.

7. Select option 2. Set default OAP application user I, and press Enter.

The utility prompts you to enter the default Oracle Applications user ID to
use for applications that use this configuration.

8. Enter an Oracle Applications user ID to use as the default for this

configuration, and press Enter.

The Create New Configuration menu appears.

Note: If you do not enter a value and you did not change this value during
installation, the default Oracle Applications user ID is set to SYSADMIN.

9. Select option 3. Set default Responsibilit, and press Enter.

The utility prompts you to enter the default responsibility for the user
identified by the Oracle Access ID.

10. Enter a responsibility to use as the default for this configuration, and press
Enter.

The Create New Configuration menu appears.

Note: If you do not enter a value and you did not change this value during
installation, the default responsibility is set to System Administrator.

11. Select option 4. Set default Responsibility Application Short Name, and
press Enter.

The utility prompts you to enter the default responsibility application short
name.

12. Enter a responsibility application short name to use as the default for this
configuration, and press Enter.

The Create New Configuration menu appears.

Note: If you do not enter a value and you did not change this value during
installation, the default responsibility application short name is set to
SYSADMIN.

13. Select option 6. Show current settings, and press Enter.

The utility displays a summary of your settings for the configuration.

14. Select option 7. Save new configuration, and press Enter.

ConfigOapAdp saves your configuration settings, and the Main menu

appears.

15. Select option 0. Exit, and press Enter.

The ConfigOapAdp utility closes.

UNIX Adapter Configuration After Installation 47

Edit an Oracle Configuration

You must edit an Oracle configuration if any of the information used to define
it changes.

To edit an Oracle configuration

1. Access ConfigOapAdp without specifying any parameters.

The Main menu appears.

2. Select option 2. Edit a configuration, and press Enter.

The utility prompts you to enter the name of the configuration to edit.

Note: If necessary, you can select option 4. List defined configuration

name to display a list of all configuration names currently defined.

3. Enter the name of the configuration to edit, and press Enter.

The Edit Configuration menu appears.

Edit Configuration [<Configuration name>] Menu:

0. Exit.
1. Set default Oracle access ID.
2. Set default OAP application user ID.
3. Set default Responsibility.
4. Set default Responsibility Application Short Name.
5. Add new ID.
6. Edit an ID.
7. Delete an ID.
8. Change Oracle Home setting.
9. Show current settings.
10. Save edit configuration.
Please select one action ( 0-10 ):

48 Implementation Guide
Edit an Oracle Configuration

4. Update the values in the Edit Configuration menu as appropriate, select

option 9. Show current settings, and press Enter when you finish.

To set a different ID as the default Oracle Access ID, select option 1.

Set default Oracle access ID.

To set a different Oracle Applications User ID to use as the default for

applications that use this configuration, select option 2. Set default
OAP application user ID.

To set a different default responsibility for the user identified by the

Oracle access ID, select option 3. Set default Responsibility.

To set a different default application short name, select option 4. Set

default Responsibility Application Short Name

To create a new Oracle access ID, select option 5. Add new ID, and
press Enter.

To change an Oracle access ID or its associated password, select

option 6. Edit an ID, and press Enter.

To delete an Oracle access ID, select option 7. Delete an ID, and press
Enter.

To change the path to the Oracle home directory on the client

computer, select option 8. Change Oracle Home Setting.

The utility displays a summary of your settings for the configuration.

5. Select option 10. Save edit configuration, and press Enter.

ConfigOapAdp saves your configuration settings, and the Main menu

appears.

6. Select option 0. Exit, and press Enter.

The ConfigOapAdp utility closes.

UNIX Adapter Configuration After Installation 49

Delete an Oracle Configuration

You can delete an Oracle configuration if it is no longer used.

To delete an Oracle configuration

1. Access ConfigOapAdp without specifying any parameters.

The Main menu appears.

2. Select option 3. Delete a configuration, and press Enter.

The utility prompts you to enter the name of the configuration to delete.

Note: If necessary, you can select option 4. List defined configuration

name to display a list of all configuration names currently defined.

3. Enter the name of the configuration to delete, and press Enter.

The utility prompts you that the configuration has been deleted, and the
Main menu appears.

4. Select option 4. List defined configuration name, and press Enter.

The utility displays a list of all configuration names currently defined so

you can verify deletion. The Main menu appears.

5. Select option 0. Exit, and press Enter.

The ConfigOapAdp utility closes.

50 Implementation Guide
Appendix C: ca_oap11 Job Status and
Exit Codes
This section contains the following topics:

Informational Exit Codes (see page 51)

Warning Messages (see page 53)
Error Codes (see page 59)
Information Codes (see page 75)

Informational Exit Codes

When ca_oap11 submits a job to Oracle Applications, Unicenter JM Adapter for
Oracle Applications tracks the following phases:
INACTIVE
PENDING
RUNNING
COMPLETED

An Oracle Applications job in the COMPLETED phase can be mapped to the

following exit codes:

UNKNOWN means the job completed with a status other than NORMAL,
WARNING, ERROR, CANCELLED, or TERMINATED.

ca_oap11 tracks job phases and statuses in Unicenter AutoSys JM only. If you
use the -L argument, this information is printed as a comment to the Event
Processor log. For example:

Phase: PENDING Status: NORMAL

Phase: PENDING Status: NORMAL
Phase: PENDING Status: NORMAL
Phase: COMPLETE Status: NORMAL

ca_oap11 Job Status and Exit Codes 51

Informational Exit Codes

You can use the max_exit_success job attribute to determine what exit codes
the job management engine maps to success.
NORMAL 0
WARNING 8
ERROR 16
CANCELLED 32
TERMINATED 64
UNKNOWN 128

The following additional job statuses are valid for Unicenter JM Adapter for
Oracle Applications:

MAX # STAT CHECK FAILURES 252

The adapter checked for the status of the job the specified number of
times and failed to get a status.

FAILED TO SUBMIT 253

The adapter could not submit the Oracle Applications job.

INVOCATION ERROR 254

The ca_oap11 command contained invalid arguments.

ca_oap11 jobs can return the following exit codes:

200 Adapter license expired.

201 Cannot find a valid line.

202 Missing environment variable.

203 Missing environment variable.

ca_oap11 Job Status and Exit Codes 53

Warning Messages

982 pid = %d, exitstatus =%d.

Reason:

This message is informational only.

Action:

None.

986 Unable to obtain routine address for EmEvt_wto; error code=%d. Unicenter Event Logging
disabled.

Reason:

(Windows only) CCS or Unicenter NSM is not installed or is not configured

correctly.

Action:

Install and configure the missing components.

54 Implementation Guide
Warning Messages

987 Unable to load CAUEVT.DLL; error code=%d. Unicenter Event Logging disabled.

Reason:

(Windows only) CCS or Unicenter NSM is not installed or is not configured

correctly.

Unicenter JM Adapter for Oracle Applications adapter is disconnected.

Action:

Reestablish the connection to the Oracle Applications database server.

ca_oap11 Job Status and Exit Codes 55

Warning Messages

991 Failed to get request log.

Reason:

Unicenter JM Adapter for Oracle Applications could not locate the Oracle
Applications log file.

Action:

Remove the -l parameter from the job definition, or meet the requirements to
use the -l parameter. The -l parameter is only available when Unicenter JM
Adapter for Oracle Applications is running on the same computer as the Oracle
Applications server.

992 Request terminated with unknown status.

Reason:

This warning can have various causes.

Action:

Check the system log on the Oracle Applications server or the host computer
to determine the specific cause and action.

993 Failed to send status to scheduler.

Reason:

Communication between the scheduler and Unicenter JM Adapter for Oracle

Applications is disconnected.

Action:

See the documentation for your specific job scheduling engine.

994 Unable to set sql_trace to true.

Reason:

The OCI DDL command failed to set sql trace mode to "on."

Action:

Verify that the owner of the Unicenter JM Adapter for Oracle Applications job
has rights to turn on trace mode on the Oracle database server.

56 Implementation Guide
Warning Messages

995 The default Application Short Name is not set. “SYSADMIN” is used instead.

Reason:

No default Application Short Name is set.

Action:

Set a default Application Short Name, either with the -a parameter or through
the configuration utility.

996 The Default Responsibility Name is not set. “System Administrator” is used instead.

Reason:

No default Responsibility Name is set.

Action:

Set a default Responsibility Name, either with the -r parameter or through the
configuration utility.

997 The default user name is not set. “SYSADMIN” is used instead.

Reason:

No default Oracle Application User ID is set.

Action:

Set a default Oracle Application User ID, either with the -u parameter or
through the configuration utility.

998 Failed to log comment. (Unicenter AutoSys JM only)

Reason:

-L is not working.

Action:

(Unicenter AutoSys JM only) Verify that the Unicenter AutoSys JM sendevent

comment function is working in the Unicenter JM Adapter for Oracle
Applications run-time environment.

ca_oap11 Job Status and Exit Codes 57

Warning Messages

999 Option -b is ignored when request is not a request set.

Reason:

The -b parameter is defined, but the job is not defined as a request set job.

Action:

Remove the -b parameter from the job definition if the job is not a request set
job or define appropriate additional parameters to define a request set job.

58 Implementation Guide
Error Codes

Error Codes
This section describes error codes, and provides descriptions and required
actions for each instance.

001 Exec failed for <adp_binary_name>: <err_msg>.

Reason:

(UNIX only) Unable to run the adapter.

Action:

Check the system status.

002 adapter_create_process-> CreateProcess failed(<%d>): <err_msg>(Windows), unable to

store program_name <cmd> for pid <%d>.

Reason:

(UNIX only) Unable to create a new process for Unicenter JM Adapter for
Oracle Applications.

Action:

Check the system status.

003 fork failed: %s.

Reason:

(UNIX only) Unable to run fork request.

Action:
Check the system status.

004 malloc failed.

Reason:

Dynamic memory allocation failed.

Action:

Check the system status.

ca_oap11 Job Status and Exit Codes 59

Check the connection between Unicenter JM Adapter for Oracle Applications

Check the system status.

205 adapter_stat -> <%s> is not <%s>.

Reason:

The specified path or file name does not match the specified file status mode.

Action:

Specify the correct path or file name of the file status mode.

Action:

Check the job definition and remove any invalid command line switches.

62 Implementation Guide
Error Codes

210 Option -%c is missing argument.

Reason:

Option -%c is missing a valid argument; -%c will be replaced by an option

character. You must provide a valid argument for the option.

Unicenter AutoSys JM.

214 <EventName> ->autopid = <%d>.

Reason:

(Unicenter AutoSys JM for Windows only) Heartbeat run-time error; pp_pid

has a negative integer.

Action:

None.

ca_oap11 Job Status and Exit Codes 63

The install path is not available in the configuration file.

definition.

Action:

Specify a valid Oracle service name for the Oracle connection by using -S
service name or -i user/password@service name, and recheck the validity of
the command line options.

ca_oap11 Job Status and Exit Codes 65

Error Codes

223 insufficient arguments: %s [opts] -j <app_short_name> <request_set_name>.

Reason:

Either application short name or request set name is not specified in the job
definition.

Action:

Specify both application short name and request set short name in the job
definition.

224 insufficient arguments: %s [opts] -j <app_short_name> <conc_prog_name>.

Reason:

Either application short name or program short name is not specified in the job
definition.

Action:

Specify both application short name and program short name in the job
definition.

225 invalid syntax: %s [opts] -j <app_short_name> <request_set_name_ [-R [Prog opts]...], {Prog
opts] part has syntax error.

Reason:

Invalid syntax; -R [prog opts] has syntax error.

Action:

Specify the program options in the job definition and make sure they meet the
requirements of the program.

226 invalid syntax: %s [opts] -j <app_short_name> <request_set_name_ [-R [Prog opts]...], -R is

missing.

Reason:

Invalid syntax; -R is missing.

Action:

Specify -R for program options specified in the request set job.

Action:
Windows: Make sure the Unicenter JM Adapter for Oracle Applications
registry setting is intact. You must run the installation program to repair any
problems.

UNIX: Make sure the configuration file is intact through the configuration
utility. If the configuration file is intact, check your system memory usage
status.

230 log_EMConsole -> Error Calling Unicenter Event Management - EmEvt_wto rc=%s(%d).

Reason:

Information-only run-time error from EmEvt_wto function call.

Action:

Check the system status.

ca_oap11 Job Status and Exit Codes 67

Error Codes

231 Unable to open log file. Please check the permission of <INSTALL_PATH/log directory or
available Disk space. Error fopen(%s).

Reason:

Unable to open log file; error from fopen function call.

Failed to set printer options for an Oracle report; either the printer is not
defined or the printing style is not defined.

Action:

Make sure the printer is defined on the host system and the Oracle instance,
then check that the printing style is available for the specified printer.

68 Implementation Guide
Error Codes

Action:

Complete the request set definition on the Oracle Applications instance.

240 Job definition has unassigned command line options for request set <%s>.

Reason:

Command line syntax error; either the stage code or sequence number for the
overridden program is wrong. Unicenter JM Adapter for Oracle Applications
cannot locate the program specified in the job definition from the request set
definition.

Action:

Make sure the stage code and sequence number following the -R parameter
correctly specify the program in the request set.

241 truncated additional_where_clause, length = %d.

Reason:

Unable to use the flex_value_set_id value to access fnd_flex_validation_tables

to generate a SQL statement to get the ID value meaning of $flex$.optName.

Action:

Check the Oracle applications instance's database consistency.

242 Failed to initialize request. Cause: %s(<error code>). In method: %s.

Reason:

A Unicenter JM Adapter for Oracle Applications run-time error; unable to

initialize the base class, possibly caused by low system resources or memory.

Action:

Check the Unicenter JM Adapter for Oracle Applications computer's resource

status. For assistance, contact Technical Support at http://ca.com/support.

70 Implementation Guide
Error Codes

243 Failed to launch request <%s>. Cause: %s(<error code>).

Reason:

Failure to launch request set due to reason specified in log.

Action:

Correct the problems listed in the Unicenter JM Adapter for Oracle Applications
job definition according to the cause, or check the system status.

244 Failed to abort request <%s>. Cause: %s(<error code>) in method: %s.

Reason:

Failure to abort the request in the Oracle Applications instance due to the
reason stated in the log.

Action:

Check communication between Unicenter JM Adapter for Oracle Applications

machine and the Oracle Applications instance, and verify the system resource
status.

245 Failed to obtain set id for flex value = %s.

Reason:

Unable to obtain set ID for a flex value.

Action:

Check the Oracle Applications instance's database consistency.

246 Failed to obtain application table name for flex value set id = %ld.

Reason:

Failed to obtain application table name for flex value set ID.

Action:

Check the Oracle Applications instance's database consistency.

ca_oap11 Job Status and Exit Codes 71

Error Codes

247 Failed to get job status.

Reason:

Unable to obtain request status from Oracle Applications instance, with an OCI
run-time error; the communication channel may be temporarily lost.

Action:

If the problem persists, check communication between the adapter machine

and Oracle Applications server.

248 src_mem_err

Reason:

Unable to acquire memory for an OCI function call with an OCI run-time error.

Action:

Check the system status and reference the Oracle documentation.

249 Cursor run-time error

Reason:

OCI run-time error

Action:

Check the system status and reference the Oracle documentation.

250 Invalid program/request set short name %s.

Reason:

Invalid program or request set short name with the specified application short
name.

Action:

Make sure both application short name and program or request set short name
are correctly specified in the job definition.

72 Implementation Guide
Error Codes

251 Authentication failure. configurationname = <%s>, ID = <%s>.

Reason:

The ID is not defined in the configuration or the password supplied for the ID
is incorrect.

Action:

Use a valid ID for the configuration name or make sure you are using the
correct password. The configuration name is specified in the job definition with
the -i option or defined in the configuration file.

None.

76 Implementation Guide
Information Codes

403 Stage - <STAGE DESCR> (<SEQ %d>) of <REQUEST ID> is completed. Status: <STATUS>.

Index
installation, Windows
A adapter configuration after installation • 39
adapter installation procedure • 10
installing • 9, 17 Oracle service name • 13
integrating with CA job management post-installation tasks • 12
engines • 27 pre-installation considerations • 9
overview • 8 unattended installation • 14
reconfiguring after installation • 39, 45
J
reinstalling • 25
using • 27 job management engines, integrating the
adapter • 27
C
O
ca_oap11 command
error codes • 59 Oracle configuration
information codes • 75 creating • 40, 46
informational exit codes • 51 deleting • 42, 50
overriding parameters • 32 editing • 42, 48
request set examples • 36 Oracle access ID, creating • 43
running a job • 33 Oracle service name • 13
single request examples • 33 Oracle service name
syntax • 28 configuring • 13
warning messages • 53 verifying • 13
contacting technical support • iii overview • 8
customer support, contacting • iii
P
E
post-installation tasks
error codes, ca_oap11 command • 59 adapter configuration after installation • 39,
45
I UNIX • 22
information codes, ca_oap11 command • 75 Windows • 12
informational exit codes, ca_oap11 command • pre-installation considerations
51 UNIX • 17
installation, UNIX Windows • 9
adapter configuration after installation • 45
R
installation procedure • 18
post-installation considerations • 22 reinstallation, UNIX • 25
pre-installation considerations • 17
reinstallation procedure • 25 S
service name, verifying • 13 service name, verifying • 13
TNS_ADMIN, configuring • 22 silent installation
tnsnames.ora file, verifying location • 23 UNIX • 24
unattended installation • 24 Windows • 14
Unicenter AutoSys Adapter for OAP, support, contacting • iii
upgrading • 18 supported versions • 8
supported versions, Oracle • 8

Index 79
T
technical support, contacting • iii
TNS_ADMIN, configuring • 22
tnsnames.ora file, verifying location • 23

U
unattended installation
UNIX • 24
Windows • 14
UNIX installation
adapter configuration after installation • 45
installation procedure • 18
post-installation considerations • 22
pre-installation considerations • 17
reinstallation procedure • 25
service name, verifying • 13
TNS_ADMIN, verifying • 22
tnsnames.ora file, verifying location • 23
unattended installation • 24
Unicenter AutoSys Adapter for OAP,
upgrading • 18
upgrading • 18

W
warning messages, ca_oap11 command • 53
Windows installation
adapter configuration after installation • 39
installation procedure • 10
Oracle service name • 13
post-installation tasks • 12
pre-installation considerations • 9
unattended installation • 14

80 Implementation Guide