Installation and usage
This section discusses the following:
Installing
PeopleSoftODA
To install PeopleSoftODA, use Installer for IBM WebSphere
Business Integration Adapters. Follow the instructions in the Implementation Guide for MQ Integrator,
or, for InterChange System (ICS), the System Installation Guide for UNIX or for Windows. When
the installation is complete, the following files are installed
in the product directory on your system:
- ODA\PeopleSoft\PeopleSoftODA.jar
- ODA\messages\PeopleSoftODAAgent.txt
- ODA\messages\PeopleSoftODAAgent_ll_TT.txt
files (message files specific to a language (_ll)
and a country or territory (_TT))
- ODA\PeopleSoft\start_PeopleSoftODA.bat (Windows only)
- ODA/PeopleSoft/start_PeopleSoftODA.sh (UNIX only)
Note:
Except as otherwise noted, this document uses backslashes
(\) as the convention for directory paths. For UNIX installations,
substitute slashes (/) for backslashes. All product pathnames are
relative to the directory where product is installed on your system.
Before using PeopleSoftODA
Before you run PeopleSoftODA, verify that your system
has the required files and that the variables are correctly set
in the script or batch file that runs the ODA. This chapter assumes
that you have already followed the instructions for installing the connector.
As part of the connector's installation, you should have
followed instructions in the following sections:
Therefore, you should find the following files in the connectors\PeopleSoft\dependencies directory below the product directory:
- psjoa.jar--Downloaded from \web\PSJOA in the PS_HOME directory. PeopleSoftODA uses this file to synchronously
send Component Interfaces and their information through the Jolt
portion of the PeopleSoft Application Server.
- PSFTCI.jar--Created from Component Interface definitions in
the Application Designer. You must compile the Component Interface
API files after you generate them in PeopleSoft. PeopleSoftODA uses
this file to generate business object definitions. For more information,
see Generating APIs.
Important:
It is recommended that you regenerate and recompile all
component interfaces prior to running PeopleSoftODA to assure consistency.
If the component interfaces are not in a jar file, or if either
of the above jar files are not in the correct directory, modify
the start script or batch file to locate them.
Open for editing the shell or batch file and confirm that the
values described in Table 7 are correct.
Table 7. Shell and batch file configuration variables
Variable |
Explanation |
Example |
set AGENTNAME |
Name of the ODA |
set AGENTNAME = PeopleSoftODA |
set AGENT |
Name of the ODA's jar file |
UNIX:
set AGENT = ${ProductDirS}/ODA/PeopleSoft/PeopleSoftODA.jarWINDOWS:
set AGENT = %ProductDirS%\ODA\PeopleSoft\PeopleSoftODA.jar |
Note:
If you register PeopleSoftODA as a CORBA object
or with an Object Activation Daemon (OAD), you can modify the class
path for the PeopleSoft driver through the object discovery agent
registration wizard. For information on registering the ODA, see
the System Installation Guide for Unix or for Windows.
After installing the PeopleSoft driver and setting configuration
values in the shell or batch file, you must do the following to
generate business objects:
- Launch the ODA.
- Launch Business Object Designer.
- Follow a six-step process in Business Object Designer to configure
and run the ODA.
The following sections describe these steps in detail.
Launching
PeopleSoftODA
Launch the PeopleSoftODA with the appropriate script:
-
UNIX
End of UNIX
Windows
End of Windows
You configure and run PeopleSoftODA using Business Object Designer.
Business Object Designer locates each ODA by the name specified
in the AGENTNAME variable of each script or batch file. The default ODA name
for this connector is PeopleSoftODA. During installation, if you register the ODA with an Object
Activation Daemon, the wizard automatically prefixes the hostname
to the AGENTNAME value to make it unique.
Running multiple instances
of PeopleSoftODA
It is recommended that you change the name of the ODA
when you run multiple instances of it. To create additional uniquely
named instances of PeopleSoftODA:
- Create a separate script or batch file for each instance.
- Specify a unique name in the AGENTNAME variable of each script or batch file.
It is recommended that you prefix each name with the name of
the host machine when you run ODA instances on different machines.
If you registered the ODA with an Object Activation Daemon, you
can use an ORB finder (osfind) to locate existing CORBA object names on your network.
Figure 10 illustrates the window in
Business Object Designer from which you select the ODA to run.
Note:
The connection properties must be the same for each
particular ODA instance. Each additional ODA instance must to connect
to application server instance to which it first connected.
Working with error and trace message
files
Error and trace message files (the default is PeopleSoftODAAgent.txt) are located in \ODA\messages\, which is under the product directory. These files use the
following naming convention:
AgentNameAgent.txt
If you create multiple instances of the ODA script or batch file
and provide a unique name for each represented ODA, you can have
a message file for each ODA instance. Alternatively, you can have
differently named ODAs use the same message file. There are two
ways to specify a valid message file:
- If you change the name of an ODA and do not create a message
file for it, you must change the name of the message file in Business
Object Designer as part of ODA configuration. Business Object Designer
provides a name for the message file but does not actually create
the file. If the file displayed as part of ODA configuration does
not exist, change the value to point to an existing file.
- You can copy the existing message file for a specific ODA, and
modify it as required. Business Object Designer assumes you name
each file according to the naming convention. For example, if the
AGENTNAME variable specifies PeopleSoftODA1, the tool assumes that the name of the associated message
file is PeopleSoftODA1Agent.txt. Therefore, when Business Object Designer provides the filename
for verification as part of ODA configuration, the filename is based on
the ODA name. Verify that the default message file is named correctly,
and correct it as necessary.
Important:
Failing to correctly specify the message file's
name when you configure the ODA causes it to run without messages.
For more information on specifying the message file name, see
Configure initialization properties.
During the configuration process, you specify:
- The name of the file into which PeopleSoftODA writes error and
trace information
- The level of tracing, which ranges from 0 to 5.
Table 8 describes these values.
Table 8. Tracing levels
Trace Level |
Description |
0 |
Logs all errors |
1 |
Traces all entering and exiting messages for
method |
2 |
Traces the ODA's properties and their
values |
3 |
Traces the names of all business objects |
4 |
Traces details of all spawned threads |
5 |
* Indicates the ODA initialization values
for all of its properties * Traces a detailed status of
each thread that PeopleSoftODA spawned * Traces the business
object definition dump |
For information on where you configure these values, see Configure initialization properties.
