Setting Up a PeopleSoft Client for PeopleSoft 7.5

While you set up PeopleSoft, have your PeopleSoft Administrator work with you.

The instructions in this section are for the PeopleSoft 3.6 driver, which supports PeopleTools 7.57 or higher. For the lab implementation, you will set up a PeopleSoft client that can communicate with your PeopleSoft database and with the DirXML engine. You will install the PeopleSoft Service Agent (PSA) and the DirXML Remote Loader on the PeopleSoft client.

NOTE:  Details about driver architecture and driver/application relationships are discussed in the driver implementation guides. You can find driver implementation guides on the Novell Documentation Web Site.

To prepare a lab workstation to provision PeopleSoft users, complete the following sections:


Prerequisites

The computer where you will install the Remote Loader and the driver must be running the following software:


Collecting Configuration Information

You'll need to provide a number of system-specific details when you install and configure Novell Nsure Resources for PeopleSoft. Some of these details can be collected before you complete the following procedures, and others will be defined during the process.

Print and complete the Import Driver Form for PeopleSoft 4.0, which mirrors the actual form you will fill out in iManager, or print the following table and record information there.

System      Value

 

IP Address and Port for PeopleSoft Application Server

(Ask your PeopleSoft Administrator.)

 

IP Address and Port for PeopleSoft Event Server

(Ask your PeopleSoft Administrator.)

 

PeopleSoft User ID and Password

(Ask your PeopleSoft Administrator.)

 

IP Address and Port Number for the Remote Loader

(See Configuring the Remote Loader for the Driver .)

 

Remote Loader Password

(See Configuring the Remote Loader for the Driver .)

 

Driver Object Password

(See Configuring the Remote Loader for the Driver .)

 

Installing Configuration Files

The files necessary for installing a sample project and for installing the Remote Loader are available on the Novell Nsure Resources CD.

  1. At your PeopleSoft client computer, insert the Novell Nsure Resources CD.

  2. At the Welcome page, click Next.

  3. Read the License Agreement, then click I Accept.

  4. Select the following items, then click Next.

  5. Accept the default installation path for the Remote Loader, then click Next.

  6. Mark the following items, then click Next.

  7. Select Application Components, then click Next.

  8. Select Install Components for PeopleSoft, then click Next.

  9. Accept the default directory location for the PeopleSoft components, then click Next.

  10. Review the Product Summary, then click Finish.

    The files you need to complete the next sections are now available.

  11. When prompted, click Yes to create a desktop shortcut for the Remote Loader.

  12. Continue with the next section, Installing the PeopleSoft Service Agent .


Installing the PeopleSoft Service Agent

NOTE:  Any references to specific paths in these sections represent the defaults indicated during the installation procedures. Apply the necessary changes if applicable.

Complete the following tasks to install the PSA on PeopleSoft 7.5:


Extracting the PSA Files

The PSA project comes as a self-extracting project. To extract the project:

  1. From the location you specified when you installed the components for PeopleSoft, run DIRXML_DRIVER_36.EXE. The default location is Novell\NDS\PS.

  2. Click Next, select the destination directory, then click Next to begin extracting the PSA files.

  3. Click Finish to close the extraction process.

    The PSA is now ready to be installed into your PeopleSoft environment.


Installing the PeopleSoft Service Agent

Before you can install and configure the PeopleSoft objects, you need access to a PeopleSoft user ID and password with Administrator or appropriate developer rights.You can create a unique user ID and password for implementing these objects.

To apply the delivered PSA set of objects, follow the steps below or use PeopleSoft's standard upgrade procedures. For information on PeopleSoft upgrade procedures, refer to PeopleSoft documentation.


Installing the PSA for PeopleSoft 7.5

Data Mover is an application tool used to import external PeopleSoft objects into an existing PeopleSoft 7.5 database. Using the standard PeopleSoft upgrade process, you use Data Mover to move the DirXML for PeopleSoft projects into an organization's PeopleSoft environment.

A Data Mover script (DMS) is provided with the driver. This script imports new and modified objects into the data dictionary tables. You should only run this script on a refreshed Application Update Database (AUD). Refreshing the database resolves any conflicts between the delivered objects and any objects that already exist in the AUD database.

WARNING:  If the DMS is run against a database other than the AUD, it should fail or overwrite existing data. If you run the script directly against the PeopleSoft development database, it will corrupt the database.

To ensure that the DMS files were copied during the component installation, check the C:\PSA directory. This is the default directory that the installation program uses. If you altered this setting during the installation, check the directory that you entered. The following are default steps to import the external PeopleSoft objects:

  1. From the Start menu, click Programs > PeopleSoft > Data Mover.

  2. Log in to the AUD database in 2-tier mode.

  3. Select File > Open.

  4. Browse to the appropriate file for your installation > select the DMS script with the appropriate release number. (For example, DIRXML_DRIVER_PSA_36IMP.DMS.)

  5. In the Data Mover syntax dialog box, verify that the input and log files are pointing to the directory containing the data (.DAT) files on the local drive.

    The following is an example of the delivered syntax:

    SET OUTPUT c:\PSA\PSA-PS75\AU_CHECK.DAT;

    SET INPUT c:\PSA\PSA-PS75\DIRXML_DRIVER_PSA_36IMP.DAT;

    SET LOG c:\PSA\PSA-PS75\DIRXML_DRIVER_PSA_36IMP.LOG;

    SET NO TRACE;

    SET IGNORE_DUPS;

    EXPORT AU_CHECK;

    IMPORT *;

  6. Select File > Run Script.

    From the report in the bottom status panel, verify the import was successful. If the import fails, make sure the input and output paths point the proper directories.

  7. Close Data Mover.


Copying the Novell Integration Project into a Target Database

Your target database contains the system catalog, data dictionary structures, and sample application data. When moving from an AUD database to the target database, objects from the data dictionary in the AUD are copied to the data dictionary of the target database.

After the copy is complete, you must build the database. The build creates the physical tables or views in the underlying database so that the objects are accessible. You should be logged in as an administration user when completing these procedures.

We recommend the following:

To copy the project into a target database:

  1. From the Start menu, click Programs > PeopleSoft > PeopleTools.

  2. Log in to the AUD database in two-tier mode.

  3. Click Go > PeopleTools > Application Designer.

  4. Click File > Open.

  5. Click Object Type, then click Project.

  6. Click Selection Criteria, Name, then type DIRXML_DRIVER_PSA_36, then click Select.

  7. Click the project, then click Select.

  8. Click Tools > Upgrade > Copy.

  9. Type the target database name (the project will be copied to this database), operator ID, and password, then click OK.

    Be sure to select all objects with the project, including the project itself.

  10. Check the Export Project box to export the objects to the target database, then click Copy.

    All objects are copied from the AUD to the target database.

  11. Close the Application Designer window.


Building Project Record Definitions

After you have imported the project into the PeopleSoft database, you should build project record definitions and then build project views.

  1. From the Start menu, click Programs > PeopleSoft > PeopleTools.

  2. Log in to the target database using an administrator username that has administrative and development rights.

  3. In the Application Designer, click File, then click Open.

  4. Select the DIRXML_DRIVER_PSA_36 project, and click Select.

  5. Click Build > Project.

  6. From Build Options, click Create Tables and Execute SQL Now.

  7. Click Build to create sample project tables. After project tables are created, click Close to close the Build Progress window.

    NOTE:  You must create project tables before creating the views. Views are created using information from table fields.

  8. From the Application Designer, select Build > Project.

  9. From Build Options, click Create Views and Execute SQL Now.

  10. Click Build to create the sample project views. After views are created, click Close to close the Build Progress window.

You should now assign security rights to the new objects (see Establishing Roles and Initiating Workflow ).


Establishing Roles and Initiating Workflow

A role is a class of users who perform the same type of work. Business rules typically determine what role performs what activity. The eDirectory administrator has been designated as the role performing the ADD, UPD, and DIS events. This means that workflow must be activated and a role user must be assigned to the eDirectory administrator role. To activate a workflow, complete the following:

  1. Click Go > PeopleTools > Workflow Administrator.

  2. Click Use > Workflow System Defaults > Defaults.

  3. Check the Worklist Active box.

  4. If you are using e-mail and other electronic forms, check the applicable boxes.

  5. Ensure that a default role user, typically WF Admin, is also assigned, and click Save. If workflow is not currently being used by other processes, change this to the role of eDirectory Administrator.

You should now assign security rights to the new objects (see Establishing Security to PSA Objects in PeopleSoft 7.5 ).


Establishing Security to PSA Objects in PeopleSoft 7.5

You can assign security rights to all new panels and pages that have been added to a project. Use an administrator-type account to establish security.


Applying Security for the New PSA Objects

  1. Click Go > PeopleTools > Security Administrator.

  2. Click File > Open. Select the ALLPANLS Operator Class, then click OK.

  3. Click the Menu Items icon from the left pane.

  4. Click Insert > Menu Name.

  5. Double-click DirXML_Administrator_36, click Select All, then click OK.

  6. Click Select All, then click OK.

  7. Save. After you save, you can exit the Security Administrator interface.


Verifying Access to PSA Object

After you have applied security to the new PSA objects, you should use the sample application to verify that you can access, change, and save data.

You can test to ensure that transactions are created by entering a new person using the PeopleSoft DirXML sample application. This example uses Departments, so you will need to create a sample department, and then add a person (assigning him or her to that department) to validate that the application works.

To test sample PeopleSoft applications:

  1. Connect to the PeopleSoft database as administrator.

  2. From the Application Designer, select Go > DirXML Administrator 36 EP.

  3. Select Use > DirXML Sample Department.

  4. Click an empty Department field row to add sample department and description. The DirXML DN is used for mapping to the eDirectory account system.

  5. Click Save to add the Department.

  6. Select Use > DirXML Sample People > Add.

  7. Enter an ID number for the new person and click OK.

  8. Enter data into the various fields for this ID and click Save.

    (The required fields include first name, last name, birth date, status, title, and department ID.)

  9. To validate that an ADD transaction was created, access the eDirectory Worklist Maintenance menu. Click Use > eDirectory Worklist Maintenance > eDirectory Worklist. You can then search for the ID you just created.

  10. Click the Search button.

  11. Double-click the event you created. Look at the panels and verify that the data you entered exists.

  12. Close the PeopleSoft Client.


Running the Message Agent Test Program

You can test the following PeopleSoft Message Agents:


Testing the DIRXML_TRANS01 PeopleSoft Message Agent

DIRXML_TRANS01.IST verifies that the Message Agent is receiving events from the worklist.

  1. Click the C:\PSA\PSA-P75\ directory.

  2. Copy PSMTST32v75.EXE, the test program for a message agent, to the {PS_HOME}\BIN\CLIENT\WINX86 directory.

  3. Create a shortcut on the desktop to the Message Agent Test program.

  4. View the program's properties, and validate that the .IST file is not set to read-only.

  5. Double-click the test program.

  6. Click File > Open.

  7. Click the DIRXML_TRANS01.IST file > Open.

  8. Ensure that the appropriate connect string, operator ID, and password are listed for connecting to the application server.

  9. Click Execute!.

    If the Message Agent is working properly, a list of processing key fields will be populated.

    The following is a sample script:

    Connect 137.65.147.162:7000,PS,PS;
    StartMessage DIRXML_TRANS01,DIRXML_TRANS01;
    ProcessMessage;
    GetOutPutall;
    Disconnect;

    In this script the connect string is 137.65.147.162:7000. The User ID is PS, and the password is PS.

You can now close the DIRXML_TRANS01 window. Do not close the Message Agent Test program, as you will use it in the following steps.


Testing the DIRXML_SCHEMA01 PeopleSoft Message Agent

DIRXML_SCHEMA01.IST verifies that all of the fields on the DIRXML_SCHEMA01 business process definition are being passed to the Message Agent.

  1. Double-click the message test program.

  2. Click File > Open.

  3. Click the DIRXML_SCHEMA01.IST file > Open.

  4. Verify that the appropriate connect string, operator ID, and password are listed.

  5. Modify the INSTANCEID, INSTSTATUS, ACTIVITY NAME, and EVENTNAME fields.

    You can find this information by searching for the person and viewing the DIRXML_SCHEMA01 panel on the eDirectory Work List Maintenance Search panel.

    Figure 16
    eDirectory Work List Maintenance Search Panel

    These fields must correspond to the event that you are trying to receive the output data for. Copy and paste appropriate values from the output from the previous test. This output was generated from testing DIRXML_WL_SRCH.IST.

  6. Click Save.

  7. Click Execute!

    If the Message Agent is working properly, all the fields that are populated in PeopleSoft will be populated in the output.

    The following is a sample script:

    Connect 137.65.147.182:7000,PS,PS;
    StartMessage DIRXML_SCHEMA01,DIRXML_SCHEMA01;
    Setfield BUSPROCNAME=DIRXML_INTEGRATION;
    Setfield ACTIVITYNAME=DIRXML_EVENT1;
    Setfield EVENTNAME=ADD;
    Setfield WORKLISTNAME=DIRXML_ADD;
    Setfield INSTANCEID=5;
    Setfield INSTSTATUS=0;
    Setfield COMMENTSHORT=Selected;
    ProcessMessage;
    GetOutPutall;
    Disconnect;

  8. Close the log files.


Testing the DIRXML_SCHEMA01_UPDATE PeopleSoft Message Agent

DIRXML_SCHEMA01_UPDATE.IST tests updates to the PeopleSoft record DIRXML_SCHEMA01_UPDATE. This process tests events that come from eDirectory rather than events that are sent from PeopleSoft.

  1. Double-click the message test program.

  2. Click File > Open.

  3. Click the DIRXML_SCHEMA01_UPDATE.IST file > Open.

  4. Verify that the appropriate connect string, operator ID, and password are listed.

  5. Modify the ASSOC ID, NDS ID, NDS CONTEXT, and Description fields.

    These fields must correspond to the employee that you are trying to update.

  6. Click Save.

  7. Click Execute!.

    If the Message Agent is working properly, the eDirectory Subscriber page (the NDS Data Update panel for PeopleSoft 7.5) will be populated with the appropriate eDirectory ID, Distinguished Name, e-mail, and Description fields for the selected employee.

    The following is a sample script:

    Connect 137.65.139.178:7000,PS,PS;
    StartMessage DIRXML_SCHEMA01_UPDATE,DIRXML_SCHEMA01_UPDATE;
    SetField Assoc ID=8964;
    SetField NDS ID=GHORNBE;
    SetField NDS CONTEXT=NCS.PRV.NOVELL;
    SetField Description=Updated;
    SetField email=unknown;
    ProcessMessage;
    GetOutPutall;
    Disconnect;

  8. Close the log file.


Testing the DIRXML_SCHEMA01_QUERY PeopleSoft Message Agent

DIRXML_SCHEMA01_QUERY.IST tests the query function for the driver from PeopleSoft. This process tests the ability to retrieve data from PeopleSoft based on ASSOC ID.

The Output fields defined on the Query object need to be equivalent to those that are defined on the DIRXML_SCHEMA01 object. The primary difference between these two objects is the key input fields. This object only has the object ID as the key field (for example, ASSOC ID).

  1. Double-click the message test program.

  2. Click File > Open.

  3. Click the DIRXML_SCHEMA01_QUERY.IST file > Open.

  4. Verify that the appropriate connect string, operator ID, and password are listed.

  5. Modify the ASSOC ID.

    This field must correspond to the employee that you are trying to access.

  6. Click Execute!.

    If the Message Agent is working properly, all the fields that are populated in PeopleSoft will be populated in the output.

    The following is a sample script:

    Connect 137.65.139.178:7000,PS,PS;
    StartMessage DIRXML_SCHEMA01_QUERY,DIRXML_SCHEMA01_QUERY;
    SetField Assoc ID=8964;
    ProcessMessage;
    GetOutPutall;
    Disconnect

  7. Close the log file.


Installing the Event Server


Manually Installing and Configuring the Event Server

Typically, the Event Server is installed when you run the installation program. If either of the following has occurred, manually install or configure the desktop shortcut for the Event Server:


Installing the Event Server

The following steps assume that eDirectory has been installed on drive C: of the server in the \NOVELL\RemoteLoader\ directory.

  1. Copy NPS75EVENTSERVER.EXE to the C:\NOVELL\NDS directory.

  2. Create a shortcut for the Event Server application on the desktop.

    IMPORTANT:  If you are running multiple PeopleSoft drivers, create one shortcut for each Event Server.

  3. Edit the command line in the Target field. Right-click the shortcut > click Properties > Shortcut.

    The following graphic illustrates this field:

    Figure 17
    The Target Field for Desktop Shortcuts

    Enter parameters for the shortcut. In the following example, {PS_Home} is the root of the PeopleSoft directory structure.

    C:\Novell\NDS\NPS75EventServer.exe -c -s:16386 -p:{PS_Home}\bin\client\winx86

    The -c parameter configures the Event Server so that it runs as a console application. When you use this parameter, configure the DOS window properties with the following:

    The Event Server communicates with the driver using a Windows sockets interface or listening port. The PeopleSoft 7.5 Event Server uses socket number 16386. If this number conflicts with sockets already being used in your organization, use a different port set. This number is the Event Server Port number you will need when configuring the driver.

    Because each Event Server requires four consecutive sockets or ports, socket numbers for multiple Event Servers must be at least four digits apart.

    The Event Server must establish communications with the PeopleSoft Message Agent. It does this by connecting to the PeopleSoft Message Agent DLL files.

    These DLL files are typically located in the {PS_HOME}\BIN\CLIENT\WINX86 directory.

    For the NPS75EventServer shortcut, an example path to the PeopleSoft Message DLLs is -p:d:\psoft\hr757\bin\client\winX86. In this example, {PS_HOME} is equal to d:\psoft\hr757.

  4. Enter the following in the Start In field:

    c:\Novell\NDS

    This is the directory where eDirectory is installed. The following figure illustrates this field:

    Figure 18
    The Start In Field

  5. Select Apply > Click OK.

  6. Open the application via the shortcut.

You can customize the scroll bar and color changes by right-clicking the window's menu and customizing its properties.


Stopping the Event Server

You might need to stop the Event Server to refresh PeopleSoft connectivity, recycle the server, or debug. When you stop the Event Server, the Event Server sends a stop command to the driver shim. This command shuts down the driver shim before the Event Server exits.

To stop the Event Server from a console window:

  1. Select the Event Server window.

  2. Enter Q.

IMPORTANT:  You can stop the Event Server by clicking the Exit icon in the window. However, click this icon only if the driver shim is not running. Before clicking the icon, shut down the driver shim. Do this from the DirXML Driver Set Properties menu.


Installing the Event Server as a Service

You can install the Event Server as an NT or Windows 2000 service. Normally, the Event Server is installed during the driver installation.

Two additional shortcuts are placed on the desktop during the installation process. These shortcuts enable you to create or remove the Event Server as a service.

To install the Event Server as a service:

  1. Ensure that the Event Server program is available.

  2. At the command prompt, go to the directory where the executable file is stored, then enter the following:

    NPS75EventServer.exe -i -s:16386 -p:{PS_HOME}\bin\client\winx86

    The socket number and the path to the PeopleSoft PSMSG.DLL might be different, based on your environment and driver configuration.

  3. From the Start menu, click Settings > Control Panel > Services > DirXML Event Server for PS 7.5 (or the appropriate release).

  4. Click Startup > select the Automatic radio button to automatically start up the Event Server at login > click Start.

To stop the service:

  1. From the Start menu, click Settings > Control Panel > Services.

  2. Select the service, then click Stop.


Manually Uninstalling the Event Server as a Service

You can uninstall or remove the Event Server as a service. Follow the same steps as for installing the Event Server. However, in Step 2 substitute the -u parameter for the -i parameter.

For example, enter NPS75EventServer.exe -u -s:16386 -p:{PS_HOME}\bin\client\winx86

NOTE:  When the Event Server runs as a service, there is no console window. All debug information will only be available in the DSTRACE log.


Configuring the Remote Loader for the Driver

If you are running another DirXML Remote Loader service on this computer, such as the Remote Loader for the Exchange driver, stop that service before starting this procedure. Restart the service after completing this Remote Loader installation.

  1. Run the DirXML Remote Loader Configuration Wizard on your desktop.

  2. At the Welcome page, click Next.

  3. Keep the default Command Port number, then click Next.

  4. Keep the default Configuration File Name, then click Next.

  5. In the DirXML Driver dialog box, mark Native, browse to the PeopleSoft 3.6 driver, c:\Novell\Remoteloader\NPSshim.dll, then click Next.

  6. In the Connection to DirXML dialog box, leave the default Port settings, unmark SSL.

  7. Record the port number in the table under Collecting Configuration Information . Then click Next. This information will be required later during driver parameter configuration.

  8. Set the Trace Level to 3, so that you'll get minimal tracking data for troubleshooting, specify a filename and location for trace file, then click Next.

    NOTE:  If you are running multiple Remote Loader sessions on a single computer, you should create separate trace files.

  9. Mark Install the Remote Loader Instance as a Service and click Next.

  10. Set remote and driver passwords.

    We recommend keeping remote passwords and driver passwords the same across systems and changing them later when you go to production. Record the passwords in the table under Collecting Configuration Information . This information will be required later during driver parameter configuration.

  11. Click Next, review the summary, then click Finish.

  12. Start the service when prompted.

    The PeopleSoft system is prepared to provision resources to employees. Complete preparation of other participating systems and then proceed to Configuring DirXML Drivers .