Bookshelf Home | Contents | Index | PDF     

Siebel Web UI Dynamic Developer Kit Guide > Web UI DDK Overview >

About the Web UI DDK Wizard

The Web UI DDK Wizard enables the Siebel developer to generate a development kit with sample JavaServer pages and other J2EE artifacts that can be passed on to the Java developer and deployed in a custom-built Web application. The sample JavaServer pages are based on a Siebel view and provide Java developers with working examples of how to use Web services to expose Siebel functionality in a custom-built Web application.

The Web UI DDK Wizard guides the Siebel developer through the process of associating Web services with views, MVGs, and picklists. It provides a link to the Data Access Service Wizard, which enables the Siebel developer to configure Web services, including creating integration objects and business services. The end result is a development kit that includes everything that the Java developer needs to run the sample JavaServer pages in a custom-built application.

Siebel developers select a given Siebel View in Siebel Tools, and then run the Web UI DDK Wizard. The wizard walks the developer through the process of mapping data from the View to an integration objects and creating integration objects and UI Data Sync business services. The Wizard automatically publishes business services as Web services and generates the sample JavaServer pages and J2EE artifacts that represent the selected view and can be deployed in a Web application. Figure 2 summarizes the process of using the Web UI DDK Wizard.

Figure 2. Web UI DDK Wizard
Click for full size image

For information about running the Web UI DDK Wizard, see Running the Web UI DDK Wizard.

The remaining sections in this topic cover details about each screen in the Web UI DDK Wizard.

The Web UI Dynamic Developer Kit Wizard Screen

Use this screen to select the applets to display on the sample JavaServer pages. The Web UI DDK supports list and form applets only.

  • Parent applets are applets whose business component is the same as the primary business component associated with the view's business object.
  • Child applets are applets whose business component has a parent-child relationship with the primary business component associated with the view's business object.

The Web Service Data Source Screen

Use this screen to associate a view and any MVG fields or dynamic picklist fields with Web services. You must associate each MVG and picklist field you want to edit with a Web service. After you click Next, the wizard validates the integration object associated with the Web service and synchronizes it with the selected component.

NOTE:  The synchronization process makes changes to repository objects that require you to recompile the SRF.

If no Web service is available, you can click Create Web Service to open the Data Access Service Wizard and create a new Web service. If you click Create Web Service, the The Integration Object Page appears.

Web services are available to associate to views, MVGs, and picklists as described in Table 2.

Table 2. Summary of Web Service Reuse
Object Type
Web Services Are Available for a given View, MVG, or Picklist When...

View
  • The Web service port refers to a business service (UI Data Sync Service).
  • The business service (UI Data Sync Service) refers to an integration object with an External Name Property that matches the name of the view's business object. The integration object is referenced in the Integration Object property of the Business Service Method Arguments.
  • The integration object has a root integration component with an External Name that matches the Primary Business Component of the view's business object.
  • The integration object has a Base Object Type property set to Siebel Business Object.

MVG or Picklist
  • The Web service refers to a business service (UI Data Sync Service).
  • The business service (UI Data Sync Service) refers to an integration object that has a root integration component with an External Name property that matches the primary business component of the dynamic picklist or MVG applet.
  • The Base Object Type property of the integration object is set to Siebel Business Object.

The Integration Object Page

Use this page to indicate whether you want base your Web service on an existing integration object or create a new one. Typically, you need an integration object for each business object you want to expose.

You must select a project to associate with the integration object. Only locked projects appear in Project drop-down list.

The Integration Object Builder Page

Use this page to enter the source object for a new integration object.

  • If you are creating a Web service for a view, the source object is the name of the business object associated with the view.
  • If you are creating a Web service for an MVG or a picklist, the available values in the source object drop-down list are business objects containing a primary business component that can represent the data for the picklist or the MVG.
  • If you open the Data Access Wizard from the Web UI DDK Wizard, the root component is automatically populated. If you open the Data Access Wizard as a stand-alone wizard, you must select the root component.

CAUTION:  Do not include spaces in the integration object name. During deployment, spaces in the names of integration objects cause spaces to appear in the package names generated by Axis. The Java compiler does not accept spaces in package names.

The Integration Object Builder-Choose Integration Components Page

Use this page to select the integration components to be activated.

NOTE:  You can deselect the entire tree of integration components by clicking the check mark from the top-level object. This removes the check mark from the top-level object and from all child components in the tree.

The Web UI DDK Wizard validates and synchronizes the integration object. The synchronization process automatically selects any integration components or integration component fields that are needed to render the view, even those you have not selected in this page of the Data Access Service Wizard.

The UDS Methods Page

Use this page to see the methods included in the UI Data Sync business service. All available methods are selected by default.

CAUTION:  all methods must be selected, otherwise the Web UI DDK files will not compile.

The Web Service Page

Use this page to define a URL for the Web service. This information is stored in the Address field of the Web Service Port in the Administration Web Service.

The Repository and Administrative Data Changes Screen

This screen displays the following information for you to review:

  • Errors that prevent the Web UI DDK Wizard from proceeding. If errors occur, Next is disabled and you must go back to previous screens to correct the problems.
  • Repository changes to be made. After reviewing the changes, click Next to commit the changes to the database.
  • A list of dynamic picklists or MVGs fields that have not been associated with a Web service.

The Web UI DDK Options Screen

Use this screen to specify the location where the sample JSP pages and other Java artifacts generated by the wizard will be stored.

    
Siebel Web UI Dynamic Developer Kit Guide