Using PeopleSoftODA in business object designer

This section describes how to use PeopleSoftODA in Business Object Designer to generate business object definitions. For information on launching Business Object Designer, see the Business Object Development Guide.

After you launch an ODA, you must launch Business Object Designer to configure and run it. There are six steps in Business Object Designer to generate business object definitions using an ODA. Business Object Designer provides a wizard that guides you through each of these steps.

After starting the ODA, do the following to start the wizard:

  1. Open Business Object Designer.
  2. From the File menu, select the New Using ODA... submenu.

    Business Object Designer displays the first window in the wizard, named Select Agent. Figure 11 illustrates this window.

To select, configure, and run the ODA, follow these steps:

  1. Select the ODA
  2. "Configure initialization properties"
  3. "Expand nodes and select component interfaces and collections"
  4. "Confirm selection of objects"
  5. "Generate the definition" and, optionally, "Provide additional information"
  6. "Save the definition"

Select the ODA

Figure 11 illustrates the first dialog box in Business Object Designer's six-step wizard. From this window, select the ODA to run.

Figure 11. Selecting the ODA

To select the ODA:

  1. Click the Find Agents button to display all registered or currently running ODAs in the Located agents field.
    Note:
    If Business Object Designer does not locate your desired ODA, check the setup of the ODA.
  2. Select the desired ODA from the displayed list.

    Business Object Designer displays your selection in the Agent's name field.

Configure initialization properties

The first time Business Object Designer communicates with PeopleSoftODA, it prompts you to enter a set of initialization properties as shown in Figure 12. You can save these properties in a named profile so that you do not need to re-enter them each time you use PeopleSoftODA. For information on specifying an ODA profile, see the Business Object Development Guide.

Figure 12. Configuring agent initialization properties

Configure the PeopleSoftODA properties described in Table 12.

Table 12. PeopleSoftODA properties

Row number Property name Property type Description
1 UserName String Name of the user with authorization to connect to the PeopleSoft application using the Application Server
2 Password String Password of the user with authorization to connect to the PeopleSoft application
3 AppServerMachineName String Name or IP address of the machine on which the PeopleSoft Server is running
4 PortNumber String The Jolt port used to connect to the Application Server. The default value is 9000. Note: This port is different from the Tuxedo port.
5 DefaultBOPrefix String Text that is prepended to the name of the business object to make it unique. The prefix cannot begin with an underscore (_). You can change this value later, if required, when Business Object Designer prompts you for business object properties. For more information, see "Provide additional information".
6 TraceFileName String File into which PeopleSoftODA writes trace information. If the file does not exist, PeopleSoftODA creates it in the \ODA\PeopleSoft directory. If the file already exists, PeopleSoftODA appends to it. PeopleSoftODA names the file according to the naming convention. For example, if the agent is named PeopleSoftODA, it generates a trace file named PeopleSoftODAtrace.txt. Use this property to specify a different name for this file.
7 TraceLevel Integer Level of tracing enabled for PeopleSoftODA. For more information, see "Working with error and trace message files".
8 MessageFile String Name of the error and message file. PeopleSoftODA displays the filename according to the naming convention. For example, if the agent is named PeopleSoftODA, the value of the message file property displays as PeopleSoftODAAgent.txt.Important: The error and message file must be located in the \ODA\messages directory. Use this property to verify or specify an existing file.
Important:
Correct the name of the message file if the default value displayed in Business Object Designer represents a non-existent file. If the name is not correct when you move forward from this dialog box, Business Object Designer displays an error message in the window from which the ODA was launched. This message does not popup in Business Object Designer. Failing to specify a valid message file causes the ODA to run without messages.

Expand nodes and select component interfaces and collections

Business Object Designer uses the properties configured in the previous step to create a connect string that connects the tool to the specified PeopleSoft application. After connecting, Business Object Designer displays a tree whose nodes represent all the Component Interfaces defined in the PeopleSoft application.

Click on a node to display the next-level Collection of the Component Interface. You can expand the Component Interfaces to display the entire hierarchical representation. For each Collection, PeopleSoftODA creates a child business object definition.

Figure 13 illustrates this dialog box with some Component Interfaces expanded.

Figure 13. Tree of component interfaces with expanded nodes

Select all required Component Interfaces, along with all necessary Collections, and click Next.

Confirm selection of objects

After you identify all the Component Interfaces and Collections to be associated with the generated business object definitions, Business Object Designer displays the dialog box with only the selected objects. Figure 14 illustrates this dialog box.

Figure 14. Confirming selection of objects

This window provides the following options:

Generate the definition

After you confirm the Component Interfaces and Collections, the next dialog box informs you that Business Object Designer is generating the definitions. If a large number of Component Interfaces has been selected, this generation step can take time.

Figure 15 illustrates this dialog box.

Figure 15. Generating the definition

Provide additional information

If the PeopleSoftODA needs additional information, Business Object Designer displays the BO Properties window, which prompts you for the information. Figure 16 illustrates this dialog box.

Figure 16. Providing additional Information

In the BO Properties window, enter or change the following information:

Save the definition

After you provide all required information in the BO Properties dialog box and click OK, Business Object Designer displays the final dialog box in the wizard. In this dialog box, you can save the definition to the server (if ICS is the integration broker) or to a file (for any integration broker), or you can open the definition for editing in Business Object Designer. For more information, and to make further modifications, see the Business Object Development Guide.

Figure 17 illustrates this dialog box.

Figure 17. Saving the business object definition


Copyright IBM Corp. 1997, 2003