Generating business object definitions

This section describes how to use the JD Edwards OneWorld ODA in Business Object Designer to generate business object definitions. For information on launching and using Business Object Designer, see IBM WebSphere Business Integration Adapters Business Object Development Guide.

Starting the ODA

The ODA can be run from any machine that can mount the file system on which the metadata repository (that is, the IDL files) resides, using the start_OneWorldODA.bat (NT/Windows 2000) or start_OneWorldODA.sh (Unix) start file. This file contains start parameters, including the paths to certain required OneWorld and connector .jar files.

The ODA for OneWorld has a default name of OneWorldODA. The name can be changed by changing the value of the AGENTNAME variable in the start script (start_OneWorldODA.bat).

To start the ODA, run this command:

start_OneWorldODA

Running Business Object Designer

Business Object Designer provides a wizard that guides you through the steps to generate a business object definition using the ODA. The steps are as follows:

Select the agent

  1. Start Business Object Designer.
  2. Click File > New Using ODA. The Business Object Wizard - Step 1 of 6 - Select Agent screen appears.
  3. Select the ODA/AGENTNAME (from the start_OneWorldODA script) in the Located agents list and click Next. (You may have to click Find Agents if the desired agent is not listed.)

    Figure 2. Select Agent screen

Configure the agent

After you click Next, the Business Object Wizard - Step 2 of 6 - Configure Agent screen appears. Figure 3 illustrates this screen with sample values.


Figure 3. Configure Agent screen

The properties you set on this screen are described in Table 4. You can save all the values you enter on this screen to a profile. Instead of retyping the property data next time you run the ODA, you simply select a profile from the drop-down menu and re-use the saved values. You can save multiple profiles, each with a different set of specified values.

Table 4. Configure Agent properties

Property name Default value Type Description
BOPrefix None String The prefix that the ODA prepends to the names of the business objects it generates.
JarFileDirectory None String (Required) The directory where the .jar files are located. All the .jar files having business functions that must be invoked using the adapter must be placed in this directory.
TraceFileName None String The name of the trace message file; for example, OneWorldODAtrace.txt.
TraceLevel 5 Integer (Required) The tracing level (from 0 to 5) for the Agent. For details about tracing levels, see Tracing.
MessageFile None String (required) The name of the message file that contains all the messages displayed by the ODA. For OneWorld, the name of this file is BIA_OneWorldODAAgent.txt. If you do not correctly specify the name of the message file, the ODA will generate an error.
  1. Use the New and Save buttons in the Profiles group box any time you want the ODA to create a new profile. When you use the ODA again, you can select an existing profile.
  2. Type the value of each property, as defined in Table 4.
    Note:
    If you use a profile, the property values are filled in for you, though you can modify the values as needed. You can also save new values.

Select a business object

The Business Object Wizard - Step 3 of 6 - Select Source screen appears, as illustrated in Figure 4.

The following lists the rules associated with selecting objects for generation:

To determine which OneWorld objects listed on this screen are child objects of a high-level object, refer to the original GenJava file. You can also simply select all the OneWorld objects listed on this screen and generate their corresponding business objects. The resulting business objects will reflect the parent-child relationships.

Figure 4. Select Source screen

  1. If necessary, expand a OneWorld module to see a list of sub-objects.
  2. Select the OneWorld object(s) you want to use.
  3. Click Next.

Confirm the object selection

The Business Object Wizard - Step 4 of 6 - Confirm source nodes for business object definitions screen appears. It shows the object(s) you selected.

For the business objects you generate using the ODA, you must manually mark any key fields in Business Object Designer before saving the business objects. The ODA does not mark any attributes as key fields.


Figure 5. Confirm source node screen

Click Back to make changes or Next to confirm that the list is correct.

The Business Object Wizard - Step 5 of 6 - Generating business objects... screen appears with a message stating that the wizard is generating the business objects.

Check the option to open the selected business object(s) in a separate window.

Specifying business object information

After you create a business object, you can specify the verbs that are valid for the object, the method sequence of a given verb on the object, the business object-level ASI, and the attribute-level ASI. This section describes how to specify this information, using the ODA with Business Object Designer. For a detailed description of these categories of information and what they mean for business object structure in the JD Edwards OneWorld connector, see Understanding business objects.

Selecting verbs

In Business Object Designer, the first screen that appears when you finish creating a business object and then open it in a separate window is the BO Properties - Select Verbs for component screen. Figure 6 illustrates this screen for the AddressBook business object.

Figure 6. Select verb for component screen

On this screen you specify the verbs that the business objects supports. You can specify the verbs that you need for a specific business object by typing the verb names and delimiting them with a ;. The verb names must follow the naming convention as specified in the Business Object Development Guide.

The standard verbs used in WebSphere Business Integration are Create, Retrieve, Delete, and Update. For details about business object verb ASI for the OneWorld connector, see Verb ASI

Specifying the verb ASI

For each verb selected, a separate window appears where you specify the business function sequence that must be executed for the verb.

Figure 7 illustrates this screen for the Retrieve verb of the AddressBook business object created in Figure 4 and Figure 5.


Figure 7. Setting the verb method sequence

  1. In the Value list for the MethodSequence property, click the method that you want the business object to execute first for the verb. In Figure 7, the method sequence is as follows:

    By specifying a business function sequence for the verb, you are creating the verb ASI that is associated with that verb. If necessary, this verb ASI can be modified later.

  2. Click OK.
Open the business object in a separate window

The Business Object Wizard - Step 6 of 6 - Save business objects screen appears with options to save a copy of the business objects to another file, to open the new business objects in another window, and to shut down the OneWorld ODA. If you choose to open the new business objects in another window, the Business Object Designer displays a window where you can modify the attributes for those business objects.


Figure 8. Save business objects screen

You must open the business object in a separate window within Business Object Designer. After specifying a key for the top-level business object, save the generated business object definitions to a file.

To open the business objects in separate windows:

  1. Select Open the new BOs in separate windows. A dialog box appears.
  2. Click Finish. Each business object appears in a separate window where you can view and set the ASI information for the business objects and business object verbs you just created. For details, see Specifying business object information.

To save the business objects to a file (only after you a have specified a key for the parent-level business object):

  1. Select Save a copy of the business objects to a separate file. A dialog box appears.
  2. Type the location in which you want the copy of the new business object definitions to be saved.

Business Object Designer saves the files to the specified location.

If you have finished working with the ODA, you can shut it down by checking "Shutdown ODA JD Edwards OneWorld ODA" before clicking Finish.

Copyright IBM Corp. 1997, 2003