3
Supported PeopleSoft Interfaces

This chapter provides information specific to PeopleSoft. The following topics are discussed:

• Working with Oracle and PeopleSoft

• Importing the OracleAS InterConnect Project into PeopleSoft

• Creating a New Operator Class and Assigning Permission

• Exception Fields

• Message Agent

• Open Query

• Creating an Implemented Procedure

• Creating a Subscribed Event

• Creating a Published Event

Working with Oracle and PeopleSoft

OracleAS InterConnect provides a complete framework for e-Business application integration across Application to Application, Active Server Pages (Microsoft), and Business to Business domains. PeopleSoft users often configure PeopleSoft to employ OracleAS InterConnect connectivity. For this reason, a PeopleSoft 7.5x adapter can be installed with your PeopleSoft component.

Importing the OracleAS InterConnect Project into PeopleSoft

To use PeopleSoft, you must import the OracleAS InterConnect PeopleSoft message definition project. You can import the message definition project into your PeopleSoft environment.

To automatically import the project, you must have an existing Source Database and a Target Database. The Source Database is the *.dat file supplied with OracleAS InterConnect, containing the current objects that you want to copy to another database. The Target Database is the database where you want to copy your objects.

See Also: Chapter 3, "Supported PeopleSoft Interfaces" "Exception Fields" "Creating a New Operator Class and Assigning Permission"

Regardless of how you create the project, you must create a class of operators and assign permissions.

To import the OracleAS InterConnect project you will need:

• Application Update Database.

• Peoplesoft's Data Mover--Databases inside PeopleSoft are separate entities. The Data Mover transfers data from one database to another inside PeopleSoft.

• The following Connection types:
  • Source and Target Databases require a two- or three-tier connection type.

  • Data Mover requires a two-tier connection type.

Automatically Import the OracleAS InterConnect Project

The goal of this section is to place the objects from a source database into a project. This involves the following:

• Importing the psosa.DAT file from the install_directory\OAI\9.0.4\PeopleSoft directory into the Application Update Database using Data Mover.

  Note: Application Update Database is for the Message Agent only.

• Copying items from the Application Update Database to the production database.

• Verifying that the new imported items exist.

The Project Name specified is used throughout the moving process.

Step 1 Import *.DAT to the Application Update Database using the Data Mover

1. Copy the install_directory\OAI\9.0.4\PeopleSoft\psosa.DAT file to the c:\Temp directory or to the directory defined by the TEMP Environment Variable setting.

2. Select Start > Programs > Peoplesoft > Data Mover.

   The PeopleSoft Signon dialog displays.

   Figure 3-1 PeopleSoft Signon

   

   Text description of the illustration pssamplelogin.gif

3. Enter information in the following fields:
   • Connection Type--A two-tier Connection Type. For example, select Microsoft SQL server from the dropdown select list.

   • Database Name--The name of the Application Update Database. The Application Update Database is a temporary holding area, comprising a development table with empty cells.

     See Also: The PeopleSoft Installation and Administration Guide if you do not have an Application Update Database

   • Operator ID--The database operator ID.

   • Password--The database password.

4. Click OK.

5. Select File > Open and access the Aurefrsh.dms located in the /Scripts directory to refresh the Application Update Database.

6. Select File > Run Script to execute the refresh.

7. Select File > Open and access the Auimport.dms located in the /Scripts directory to import your project into the Application Update Database.

8. Select Edit > Replace.

   The Replace dialog displays.

   Figure 3-2 Replace Dialog

   

   Text description of the illustration pssamplereplacetext.gif

9. Enter information in the following fields:
   • Find What--Enter AU999999.

   • Replace With--Enter your project name, for example YourProjectName.

10. Click Replace All.

11. Select File > Run Script to execute the import.

12. Close the Data Mover.

Step 2 Copy Project to the Target Database

The following steps copy the business process definition and the activity definition from the Application Update Database to the target database.

1. Log on to the PeopleSoft Application Designer.

2. Select File > Open.

3. Enter your project name, YourProjectName, in the Selection Criteria Name field.

4. Click Select.

5. Select Tools > Upgrade > Copy.

6. Enter the Database Name, Operator ID, and Password for the target database.

7. Click OK.

   Verify that the Source database, Target database, and Object Types are correct.

   Figure 3-3 Copy Dialog

   

   Text description of the illustration pssamplecopyscreen.gif

8. Check the Export Project box to copy the project to the database.

9. Click Copy to complete the copy process.

10. Exit the PeopleSoft application.

Step 3 Verify the Objects Exist

To verify the object exists, you must first log on to PeopleSoft.

1. Select Start > Programs > Peoplesoft > Application Designer.

2. Select a three-tier connection type from the dropdown menu. For example, select Application Server.

   Figure 3-4 PeopleSoft Signon

   

   Text description of the illustration pssignon.gif

3. Select File > Open.

4. Select the Project Object Type.

5. Enter the object name, YourProjectName, and click Select.

You have successfully imported the objects into your target database. The Business Process Object and its related object, Activity, are now in the target database.

Manually Create the OracleAS InterConnect Project for 7.5.6

The following steps guide you through manually creating the OracleAS InterConnect project for 7.5.6.

Step 1 Create a Project

1. Select File > New > Project to create a project on the PeopleSoft Application Designer.

2. Select File > New > Panel to create a panel.

3. Select Insert > Grid to add a grid to the panel.

   Select the grid by clicking on it and placing it on the panel. Click and hold the mouse. Drag the mouse to increase the size the grid then release the mouse after finishing your resize of the grid.

4. Press Ctrl+F or right-click Panel Field Properties to open the grid properties dialog.

5. Select the General tab.

6. Enter PSMSGAGTDEFN in the Main Record input field.

7. Select the Columns tab and click Add.

8. Select Edit Box as the column type and click OK.

9. Enter ACTIVITYNAME in the Field Name input field.

10. Select the Label tab.

11. Enter Activity in the Text input field and click OK.

12. Click Add.

13. Select Edit Box as the column type and click OK.

14. Enter INPUTNAME in the Field Name input field.

15. Select the Label tab.

16. Enter Message and click OK.

17. Click Add.

18. Select Long Edit Box as the column type and click OK.

19. Enter DESCRLONG in the Field Name input field.

20. Select the Label tab.

21. Enter Description in the Text input field.

22. Click OK twice.

23. Resize the grid and grid columns.

24. Select File > Save to save the panel.

25. Specify a panel name, for example, PSOSA_MESSAGENAMES, and click OK.

Step 2 Insert the Current Object into a Project

1. Close the panel dialog.

2. Select File > New > Panel Group to create a Panel Group.

3. Select Insert > Panel into the new group.

4. Enter the name of the panel just saved, for example, PSOSA_MESSAGENAMES in the Name input field and click Insert.

5. Close the dialog box.

6. Press Alt+Enter while the panel group's dialog is active.

7. Select the Use panel.

8. Specify PSMSGAGTDEFN as the search record.

9. Check only Update/Display.

10. Click OK.

11. Select File > Save to save the Panel Group.

12. Specify a panel group name, for example, PSOSA_MESSAGENAMES and click OK.

13. Select Insert > Current Object into Project.

14. Close the Panel Group dialog.

Step 3 Create a Menu

1. Select File > New > Menu.

2. Click OK - Standard Menu.

3. Double-click the rectangle between Favorites and Language.

4. Enter values into the Name and Label text areas for the Bar Item, for example, USE and Use, and click OK.

5. Double-click the rectangle below the new menu item Use.

6. Enter values into the Name and Label text areas for the Bar Item, for example, GETMESSAGENAMES and Get Message Names and click Select.

7. Enter the name of the Panel Group, for example, PSOSA_MESSAGENAMES, in the input field labeled Name and click Select.

8. Click OK.

9. Press Alt+Enter.

10. Select the Use tab.

11. Specify a menu label, for example, the PeopleSoft 7.5x adapter.

12. Check Menu Installed.

13. Click OK.

Step 4 Save the Menu

1. Select File > Save.

2. Specify a menu name, for example, PSOSA_MNU and click OK.

3. Select Insert > Current Object into Project.

4. Close the Menu dialog.

Step 5 Create a Business Process

1. Select File > New > Business Process.

2. Click Activity on the palette (the icon with foot prints) and clicking on the Business Process dialog to add an activity.

3. Click OK in the Activity Choices dialog.

4. Right-click Activity and enter ObjectAdapter as the activity name.

5. Click OK.

6. Double click Activity.

7. Click Other app (the icon with a opened door) and on the Business Process dialog to add a message.

Step 6 Create the Message Definition

1. Right-click the Message icon.

2. Enter GetMessageNames as the name of the message.

3. Enter a short description to display in the browser.

4. Click Attributes.

5. Select the new menu (PSOSA_MNU), the bar name (USE), the item name (GETMESSAGSNAMES), the action name, (&Update/Display), and the search record name (PSMSGAGTDEFN).

6. Click OK.

7. Click Level Mapping... .

8. Check the Output all occurrences.

9. Click OK.

10. Click Field Mapping... .

11. Click Add.

12. Specify ACTIVITYNAME (case sensitive) as the field name.

13. Select PSMSGAGTDEFN value in the Record list.

14. Select the ACTIVITYNAME value in the Field list.

15. Select Output in the Map When combo box and click OK.

16. Click Add.

17. Specify INPUTNAME (case sensitive) as the field name.

18. Select PSMSGAGTDEFN value in the Record list.

19. Select the INPUTNAME value in the Field list.

20. Select Output in the Map When combo box and click OK.

21. Click Add.

22. Specify DESCRIPTION (case sensitive) as the field name.

23. Select PSMSGAGTDEFN value in the Record list.

24. Select the DESCRLONG in the Field list.

25. Select Output in the Map When combo box.

26. Click OK three times to return to the main menu.

27. Select File > Save to save the Business Process.

28. Specify a business process name, for example, PSOSA_BP.

29. Click OK.

30. Select Insert > Current Object into Project.

31. Close the Business Process dialog.

32. Select File > Save Project to save the project.

33. Specify a project name, for example, PSOSA_PRJ.

    See Also: "Creating a New Operator Class and Assigning Permission" for instructions on creating a class of operators and assigning permissions

Creating a New Operator Class and Assigning Permission

Regardless of how you import the OracleAS InterConnect Message Agent Project, either automatically or manually, you must give access to the new menu and panel by creating a class of operators and assigning permission. You then assign the new class with the permissions to the PeopleSoft 7.5x adapter operator. The following steps describe this process.

Step 1 Create a Class of Operators

1. Select Go > PeopleTools > Security Administrator.

   A new PeopleSoft dialog displays.

2. Select File > New to create a new class of operator.

3. Select Class Of Operators as the value of the Security Definition Type combo.

4. Select Insert > Menu Name.

5. Select the new menu, NewMenuName, and click OK.

   The Select Menu Items dialog displays.

6. Click Select All, then click OK.

7. Select File > Save and specify a name, for example, PSOSA_OP.

   This saves the class of operators under the name of PSOSA_OP.

8. Click OK and close the dialog.

Step 2 Assign the Permissions of the Class to the New Operator

1. Select File > Open.

2. Select an operator.

3. Click the Classes icon.

4. Select Insert > Class.

5. Select the new class of operators, for example, PSOSA_OP.

6. Click OK.

7. Close the dialog and select Yes when prompted to save your changes.

Step 3 Test the New Setup

1. Run the Application designer and sign on as the operator with permission to access the panel.

2. Select Go.

   A new dialog displays.

3. Select Use > Get Message Names.

   The new panel displays the list of messages defined in your Peoplesoft database.

Additional Information

The following is additional information for the PeopleSoft 7.5x adapter pre-installation tasks.

• Building or Altering Tables and Administering Menu Security--If you copied tables to your target database, then you will need to either Build or Alter the tables depending on which tables were copied.

  See Also: PeopleBooks: Development Tools/Application Designer/Building SQL Objects

• Building or Altering Tables and Administering Menu Security--You may need to administer security to objects that were copied to your target database, such as menu items.

  See Also: PeopleBooks: Administration Tools/Security/Security Administrator

Exception Fields

If an error happens during a call, the exception field generally contains a detailed description of the error that occurred. You can then propagate this error string to the calling application.

For example, setup PeopleSoft on one side, an OracleAS InterConnect hub in the middle, and a Web front end on the other side. If the Web front end tries to add a record to the PeopleSoft side and a record with the same primary key already exists in PeopleSoft, a non-retryable error occurs. The exception field contains the exception data can then be propagated back to the Web front end.

Example 3-1 Exception Message:

exception: E-OAI0003: Exception occurred during call to 
AddWidget@PeopleSoft://Messages/WidgetStore
User defined exception
Exception occurred:

Source: WidgetStore::AddWidget

    Cause: PeopleSoft://Messages/exception=MsgAgentException (Unique ID <none>)

Exception occurred:
Source: WidgetStore::AddWidget
Cause: PeopleSoft://Messages/exception=MsgAgentException (Unique ID <none>)

Exception data:

struct MsgAgentExceptionData = 
String Source = "PSMsgProcessMessage(WidgetStore::AddWidget)"
String ErrorText = "Row exists in ADD or DATAENTRY mode (81,10)"
String Explanation = "The specified search keys resulted in an existing


level 0 row found when in ADD or DATAENTRY mode."

Message Agent

Using the PeopleSoft Message Agent, PeopleSoft panel groups can be accessed outside the PeopleSoft environment. Each panel in a PeopleSoft panel group is used to enter and retrieve data. Access to PeopleSoft panels is gained through a set of Application Programming Interfaces (APIs) together with a message definition. A message definition creates the mapping between fields in the message definition and fields on a PeopleSoft panel. This is the way PeopleSoft programs are exposed. The PeopleSoft 7.5x adapter acts as the client message agent program, which allows you to access and call all message agent definitions within a PeopleSoft application server. The PeopleSoft 7.5x adapter communicates with the Message Agent Server when a client sends an inbound call via the adapter.

Open Query

Open Query allows you to call queries that exist on the PeopleSoft application server through the standard ODBC interface. The iStudio browser allows you to graphically explore all Open Query definitions on an application server with the Component Selector. This simplifies the process of invoking the queries by exposing them as objects with a single execute method.

Creating an Implemented Procedure

1. Start iStudio.

2. Right-click Implemented Procedures and select New under the Applications folder.

   Figure 3-5 Creating an Implemented Procedure

   

   Text description of the illustration psoai0001.gif

The Implement Wizard--Select a Procedure dialog displays.

Figure 3-6 Implement Wizard - Select a Procedure

Text description of the illustration selectaprocedure.gif

3. Select a procedure and click Next.

   The Define Application View dialog displays. Use this dialog to import attributes from PeopleSoft. To import attributes, you must log in to PeopleSoft.

   See Also: "Importing Attributes"

   After logging in to PeopleSoft and importing attributes, the Define Application View dialog is populated with the selected components.

   Figure 3-7 Implement Wizard - Define Application View

   

   Text description of the illustration queagent2.gif

4. Click Next.

   The Define Mapping Arguments dialog displays.

   Figure 3-8 Implement Wizard - Define Mapping:IN Arguments

   

   Text description of the illustration queagent3.gif

5. Click New.

6. Define the mappings and click Finish.

Importing Attributes

To import attributes from PeopleSoft:

1. Click Import and select PeopleSoft on the Define Application View dialog.

   The PeopleSoft Login dialog displays.

   Figure 3-9 PeopleSoft Login

   

   Text description of the illustration psoai0005.gif

2. Enter information in the following fields:
   • Data Source Dialog--Automatically populated by the PeopleSoft 7.5x adapter when accessed through the iStudio wizards.

   • Application Server Name--A valid application server name.

   • Operator ID--A valid operator ID.

   • Password--A valid password.

     Note: If you do not have a valid operator ID or password, contact your PeopleSoft administrator.

3. Click OK.

   The Component Selector dialog displays.

   Figure 3-10 Component Selector

   

   Text description of the illustration mesagent1.gif

4. Expand the Message Agent adapter folder.

5. Double-click a message to expand the tree.

6. Select a component and click OK.

   The selected component and its attributes display on the Define Application View dialog.

   Note: When publishing an event, the Component Selector displays the Events folder. Select an Event to import and click OK.

Creating a Subscribed Event

To create a subscribed event in iStudio:

1. Start iStudio.

2. Right-click Subscribed Event and select New under the Applications folder.

   Figure 3-11 Creating a Subscribed Event

   

   Text description of the illustration subevent1.gif

   The Subscribe Wizard--Select an Event dialog displays.

   Figure 3-12 Subscribe Wizard - Select an Event

   

   Text description of the illustration subevent2.gif

3. Select the Application and Message Type from the dropdown menus.

4. Select an Event and click Next.

   The Define Application View dialog displays.

   Figure 3-13 Subscribe Wizard - Define Application View

   

   Text description of the illustration subevent3.gif

5. Click Import and select PeopleSoft.

   The Define Application View dialog displays. Use this dialog to import attributes from PeopleSoft. To import attributes, you must log in to PeopleSoft.

   See Also: "Importing Attributes"

   After logging in to PeopleSoft and importing attributes, the Define Application View dialog is populated with the selected components.

   Figure 3-14 Subscribe Wizard - Define Application View

   

   Text description of the illustration mesagent2.gif

6. Click Next.

   The Define Mapping dialog displays.

7. Click New to define mappings and click Finish.

Creating a Published Event

To publish an event from PeopleSoft, there is a configuration step that must be completed. You need to define a published event in the publishing database for the PeopleSoft 7.5x adapter. These definitions can be created using the pubmgr tool.

See Also: Oracle Application Server InterConnect Adapter Publishing Engine

To publish an event using iStudio:

1. Right-click Published Events under the PeopleSoft folder and click New.

   Figure 3-15 Creating a Published Event

   

   Text description of the illustration pubeng1.gif

   The Publish Wizard--Select an Event dialog displays.

   Figure 3-16 Publish Wizard - Select an Event

   

   Text description of the illustration pubeng2.gif

2. Select an event and click Next.

   The Define Application View dialog displays. Use this dialog to import attributes from PeopleSoft. To import attributes, you must log in to PeopleSoft.

   See Also: "Importing Attributes"

   After logging in to PeopleSoft and importing attributes, the Define Application View dialog is populated with the selected components.

   Figure 3-17 Publish Wizard - Define Application View

   

   Text description of the illustration pubeng5.gif

3. Click Next.

   The Define Mappings dialog displays.

4. Click New to define mappings and click Finish.