Siebel Application Integration for Oracle Fusion Middleware Guide > Working with XSDs Using SAI for Oracle Fusion Middleware > Process of Designing and Deploying XSDs Using SAI for Oracle Fusion Middleware >

Designing XSDs Using SAI for Oracle Fusion Middleware

This topic describes how to design XML Schema Definitions (XSDs) using SAI for Oracle Fusion Middleware. For general information about working with XSDs, see About Working with XSDs Using SAI for Oracle Fusion Middleware.

This task is a step in Process of Designing and Deploying XSDs Using SAI for Oracle Fusion Middleware.

To design an XSD using SAI for Oracle Fusion Middleware

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.

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 XSD Design for the artifact type, and then click Next.
7. Select the base integration object you want to use to design the XSD 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 Account integration objects become available for selection.

   2. From the Base Integration Object drop-down list, select the integration object you want to use, and then click 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.

8. 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 9.

9. (Optional) If you need to create new or update user properties or create new integration component keys or integration component key fields, then perform one or more of the following, otherwise skip to Step 10.

• New User Property. Right-click the integration component or integration component field for which you want to create new user properties, enter the details, and then click OK to return to the Design XSD wizard page.
• 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.

10. Click Save XSD Design.

    If the XSD file already exists, then the Specify XSD Name dialog box appears asking if you want to overwrite it. Do one of the following:

    • If you choose Yes, then the current XSD definition will be overwritten with the same file name.
    • If you choose No, then another dialog box appears, which enables you to specify a new XSD file name. Click OK to continue.

      The naming convention for saved XSD files is baseioname_X_Y_seq.xsd, where:

    • baseioname is the base integration object name
    • X is the base integration object major number
    • Y is base integration object minor number
    • seq is the next sequence available when there is an existing file
11. (Optional) Click Show XSDs to view a list of the XSD files you have just saved, and then click OK to return the Design XSD wizard page.
12. Click Next to continue.
13. 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.

      The XSD files are saved in memory until you click Finish. The XSD file will be generated in the XSD file path you defined in the General tab in the Siebel Application Integration for Oracle Fusion Middleware Preferences.

      NOTE:  If the deployment fails, then check the SiebelToolkitExtension.log file for details and troubleshooting information. Also make sure that at least one user key is defined for the integration components you are using.

Related Topics

About Working with XSDs Using SAI for Oracle Fusion Middleware

Process of Designing and Deploying XSDs Using SAI for Oracle Fusion Middleware

Deploying XSDs Using SAI for Oracle Fusion Middleware

About Using XSDs with Siebel RESTful Services

Undeploying XSDs That Were Created Using SAI for Oracle Fusion Middleware