Using SiebelODA in Business Object Designer

This section describes how to use Business Object Designer to generate business object definitions using SiebelODA. For information on launching Business Object Designer, see the Business Object Development Guide. Business Object Designer provides a wizard, called Business Object Wizard, that guides you through each of these steps. After you launch an ODA, you must launch Business Object Designer to obtain access to Business Object Wizard (which configures and runs the ODA). There are six steps in Business Object Wizard to generate business object definitions using an ODA.

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 Wizard displays the first window in the wizard, named Select Agent. Figure 2 illustrates this window.

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

  1. Select the ODA
  2. Specify configuration properties
  3. Selecting the source
  4. Confirm selection of objects
  5. Generate the business object definition and, optionally, Provide additional information
  6. Save the business object definition

Select the ODA

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

Figure 2. Business Object Wizard, Select ODA screen


To select the ODA:

  1. Click the Find Agents button to display all registered or currently running ODAs in the Located agents field. Alternatively, you can find the ODA using its host name and port number.
    Note:
    If Business Object Wizard does not locate your desired ODA, check the setup of the ODA.
  2. Select the desired ODA from the displayed list.

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

  3. Click Next.

Specify configuration properties

The first time Business Object Wizard communicates with SiebelODA, it prompts you to enter a set of ODA configuration properties as shown in Figure 4.

Figure 3. Business Object Wizard, Configure Agent screen


Configure the SiebelODA properties described in Table 9.

Table 9. SiebelODA configuration properties

Row number Property name Property type Description
1 UserName String Siebel application login name
2 Password String Siebel application password
3 SiebelConnectionString String Connect string to log into the Siebel application.

Examples:

For Siebel 7.x: //machinename/enterprisename/objectmanager/servername

For Siebel 7.5: //machinename/enterprisename/objectmanager_ languageCode/servername

4 Language version String Language version. For example, use ENU for English.
5 DefaultBOPrefix String Prefix that the ODA applies to the name of each business object definition for the Siebel document. If you do not specify a business-object prefix, the ODA does not prepend any string to the name of the business object definition.
6 FileLocation String The absolute path containing the files with previous versions of business object definitions. For example, in UNIX, the path is /home/SiebelBos, and in Windows, the path is C:\SiebelBos.
7 RepositoryName String The name of the Siebel repository in the Siebel application.
8 SiebelVersion String Identifies the Siebel Application version. For Siebel version 6.x, this property must be set to 6.x. For Siebel version 7.x, do not set.
9 TraceFileName String

Full pathname of the file into which SiebelODA writes trace information. If the file does not exist, SiebelODA creates it in the specified directory. If the file already exists, SiebelODA appends to it.

By default, SiebelODA creates a trace file named SiebelODAtrace.txt in the ODA\Siebel subdirectory of the product directory.

Use this property to specify a different name for the trace file.

10 TraceLevel Integer Level of tracing enabled for SiebelODA. Valid values are zero through five (0-5). Property defaults to a value of 5 (full tracing enabled). For more information, see Working with error and trace message files.
11 MessageFile String

Full pathname of the error and message file. By default, SiebelODA creates a message and error file named SiebelODAAgent.txt.

Important: The error and message file must be located in the ODA\messages subdirectory of the product 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 pop up in Business Object Designer. Failing to specify a valid message file causes the ODA to run without messages.

You can save these properties in a named profile so that you do not need to re-enter them each time you use SiebelODA. For information on specifying an ODA profile, see the Business Object Development Guide.

Selecting the source

After you configure all initialization properties for SiebelODA, the Select Source screen appears (see Figure 4).

Figure 4. Business Object Wizard, Select Source screen


This screen has two expandable options, Convert and Generate. If you need to convert old business objects into new ones, expand Convert. This displays the repository files that need to be converted (see Figure 5 ).

Figure 5. Business Object Wizard, screen displaying business objects to be converted


If you need to generate new business objects, expand Generate. From there, you have three expandable options: Business objects, Integration objects, and Application services. For examples of these options expanded, see Figure 6, Figure 7, and Figure 8. When you expand a business object, you can select a business component for that object. Similarly, when you expand an integration object, you can select an integration component for that object. When you expand an application service, however, a corresponding integration object is already selected.

Note:
If an integration component is listed in both the Application Services and Integraion Object options, that integraion object can be generated only by using Application Services.
Note:
When you generate an integration objects, all of the components listed for that object are generated.

Figure 6. Business Object Wizard, displaying Business Objects expanded


Figure 7. Business Object Wizard, displaying Integration Objects expanded


Figure 8. Business Object Wizard, displaying Application Services expanded


Figure 9. Business Object Wizard, displaying Business Services


Confirm selection of objects

After you identify all the Siebel elements to be associated with the generated business object definitions, Business Object Designer displays the dialog box with only the selected objects and components. Figure 10 illustrates this dialog box.

Figure 10. Business Object Wizard, confirming selecting of objects and components


This window provides the following options:

Generate the business object definition

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

Figure 11 illustrates this dialog box.

Figure 11. Generating the business object definitions


Provide additional information

Because SiebelODA needs additional information about the verbs, Business Object Designer displays the BO Properties window for each of the generation types you chose (business objects, integration objects, and application services), which prompts you for the information. Figure 12 illustrates these screens.

Figure 12. Providing additional information for business object


Figure 13. Providing additional information for integration object


Figure 14. Providing additional information for application service


Figure 15. Providing additional information for a custom-written business service


In the BO Properties window, enter or change the verb information. Click in the Value field and select one or more verbs from the pop-up menu. These are the verbs supported by the business object.

Note:
If a field in the BO Properties dialog box has multiple values, the field appears to be empty when the dialog box first displays. Click in the field to display a drop-down list of its values.

Save the business object 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 take any of the following actions:

For more information, and to make further modifications, see the Business Object Development Guide.

Figure 16 illustrates this dialog box.

Figure 16. Saving the business object definition


Copyright IBM Corp. 1997, 2004