Bookshelf Home | Contents | Index | PDF     

Siebel Application Integration for Oracle Fusion Middleware Guide > Working with Web Services Using SAI for Oracle Fusion Middleware > Process of Deploying Inbound Web Services Using SAI for Oracle Fusion Middleware >

Creating Inbound Web Services Based on Siebel Workflow Processes

This topic describes how to create inbound Web services based on a Siebel workflow process. For more information about working with Web services using SAI for Oracle Fusion Middleware, see About Working with Web Services Using SAI for Oracle Fusion Middleware.

This task is a step in Process of Deploying Inbound Web Services Using SAI for Oracle Fusion Middleware.

To create an inbound Web service based on a Siebel workflow process

  1. Start Oracle JDeveloper.
  2. Make sure you have specified the database parameters specific to your environment in the General tab in the SAI for Oracle Fusion Middleware Preferences.

    For information about specifying database parameters, see Setting Preferences for SAI for Oracle Fusion Middleware.

    NOTE:  By setting preferences, you have access to Siebel workflow processes when using the Design Wizard.

  3. From the application-level menu, select File, and then click the New menu item.
  4. In the New Gallery dialog box, perform the following:
    1. In the Business Tier category, select Siebel Application Integration for Oracle Fusion Middleware.
    2. Select the Design item, and then click OK.
  5. At the Welcome to the Design Wizard screen, click Next.
  6. Select Siebel Workflow Process for the artifact type, and then click Next.

    A list of available Siebel workflow processes, with a status of complete and that are active, appears.

  7. Specify the binding option and the settings that control the structure of the SOAP message that is transmitted to and from the Siebel Web service, and then click Next.
    1. Select either SOAP 1.1 or 1.2 binding.
    2. Select the SOAP message format:
      • Document/Literal. If you choose this option, then the following annotation is added to your Web service:

    @SOAPBinding(style=SOAPBinding.Style.DOCUMENT, use=SOAPBinding.Use.LITERAL, parameterStyle=SOAPBinding.ParameterStyle.WRAPPED)

    • RPC/Literal. If you choose this option, then the following annotation is added to your Web service:

    @SOAPBinding(style=SOAPBinding.Style.RPC, use=SOAPBinding.Use.LITERAL, parameterStyle=SOAPBinding.ParameterStyle.WRAPPED)

    For more information about SOAP message formats using SAI for Oracle Fusion Middleware, see About Binding Options and Settings for Controlling the Structure of SOAP Messages.

  8. Select the Siebel workflow process you want to use, and then click Next.

    TIP:   Alternatively, you can query for a specific workflow process by typing in the name of the workflow process, and then clicking Query. You can use wildcards to find the workflow process that you want using standard Siebel CRM wildcards, for example, %Account%.

    The details for the workflow process and its associated workflow process properties appear.

  9. Review the Siebel workflow process properties, and then click Next to continue.
  10. Select how this Web service will use XSDs, and then click Next.
    • Create New XSD. Select this option to create a new XSD file by selecting a base integration object.

      NOTE:  To create new XSDs, you must choose a workflow process that has at least one argument with the data type of Integration Object defined.

    • Use Existing XSD. Select this option to choose an existing XSD file for code generation.
    • Do Not Use XSD. Select this option to use Siebel integration object definitions configured in the Siebel Repository to generate code.

      NOTE:  You can use the same integration object at runtime for the inbound Web service execution.

      The resultant dialog box depends on the XSD type you choose.

  11. Do one of the following for code generation:
    • If you are creating a new XSD, then proceed to Step 12.
    • If you are using an existing XSD, then proceed to Step 13.
    • If you are not using an XSD, then proceed to Step 14.
  12. If you are creating a new XSD to support Web service deployments, then select a base integration object to design an XSD using the integration object by doing the following:
    1. Click Query Integration Objects, and in the Enter Query dialog box, query for potential integration objects (using the percent sign (%) wildcard), and then click OK.

      TIP:   Alternatively, you can select an integration object from the prepopulated Base Integration Object drop-down list without performing a query.

      The Base Integration Object field populates with all the integration objects for that query. For example, if you enter %Account% for your query, then all the integration objects that have Account as part of their name become available for selection.

    2. (Optional) If applicable, then select a different method name and method argument, otherwise accept the defaults.
    3. From the Base Integration Object drop-down list, select the integration object you want to use, and then Load.

      The load operation queries the integration object selected and populates the Available XSD tree with the integration object and its user properties as well as the integration component, its fields, user properties, and user keys that are configured for that integration object. However, only those integration components indicated as Active in Siebel Tools appears.

      NOTE:  Loading the integration object definition might take some time.

    4. Use the arrows to move the integration object and its user properties and the integration component fields, user properties, and user keys that are configured for that integration object from the Available XSD tree to the Selected XSD tree.

      CAUTION:  A requirement of XSD generation is that at least one user key is defined for an integration component. If this requirement is not met, then an error occurs when you generate the XSDs. To define user keys in the Selected XSD tree, see Step e.

    5. (Optional) If you need to create new or update user properties or create new integration component keys or integration component key fields, then do the following:
      • Update User Property. Right click the integration component user property you want to update, replace the user property value, and then click OK to return to the Design XSD wizard page.
      • New Integration Component Key. Right-click the integration components or integration component fields for which you want to create new integration component keys, enter the details, and then click OK to return to the Design XSD wizard page.
      • New Integration Component Key Field. Right click the integration component key for which you want a new integration component key field, select the integration component key field you want to use from the autopopulated list, and then click OK to return to the Design XSD wizard page.

        The integration component user key is updated with the new field. If the field already exists in the user key, then no changes occur.
    6. If there are multiple methods with arguments of type Integration Object, then the Use same XSD for all the methods option is enabled. You can choose to use this option or not.

      NOTE:  If you do not keep the Use same XSD for all methods option enabled, then you must repeat Step c through Step e for all the methods listed in the Method Name drop-down list.

    7. Click Next to continue.

      A message appears upon successful completion stating that the XSD file was successfully generated. The file is saved in the XSD file path that you defined in the General tab in the SAI for Oracle Fusion Middleware Preferences.

      NOTE:  If an error occurs generating the XSD file, then check the SiebelToolkitExtension.log file for errors and troubleshooting information.

    8. Click OK exit the message and continue on to the next wizard page.
    9. Review the XSD files (and the path) for which code will be generated, and then click Next.
    10. Proceed to Step 14 to review the code generation summary.
  13. If you are using an existing XSD for code generation, then do the following, otherwise skip this step:
    1. Browse to choose an XSD file, then click Open to return to the Choose an Existing XSD wizard page.
    2. If there are multiple methods with arguments of type Integration Object, then the Use same XSD for all the methods option is enabled. Select this option if you want to use the first XSD built for all methods. Do not select this option if you want to provide different XSDs for each method.

      NOTE:  If you do not choose the Use the same XSD for all methods option, then you must repeat Step c through Step e in Step 12 for all the methods listed in the Method Name drop-down list.

    3. Click Next to continue.
  14. Review the code generation summary, and then click Finish to start generation.

    If there is an existing archive folder structure, then a warning appears asking if you want to overwrite it. One of the following happens:

      • If you click Yes, then the folder structure is overwritten.
      • If you click No, then a dialog box appears in which you can save the new folder structure in a directory of your choice. By default, the path is set to the XSD file path you defined in the General tab in the SAI for Oracle Fusion Middleware Preferences.
    
Siebel Application Integration for Oracle Fusion Middleware Guide Copyright © 2013, Oracle and/or its affiliates. All rights reserved. Legal Notices.