14 XML Documents

This chapter describes how to create, locate, edit, and delete XML Document resources using the Oracle Service Bus Administration Console.

Use XML Document resources to store XML files for use in proxy or business service configurations. For example, create XML Document resources for TopLink or EclipseLink mapping files needed in JCA proxy or business services that communicate with JCA-compliant systems.

For more information on JCA services, see Chapter 13, "JCA Bindings."

This chapter contains the following sections:

14.1 Locating XML Documents

The Summary of XML Documents page lists the XML Documents that you have added to the Oracle Service Bus domain.

  1. Do either of the following:

    • Select Project Explorer to display the Projects View page or the Project/Folder View page. Then navigate through projects and folders to find the XML Document.

    • Select Resource Browser > XML Documents. The Summary of XML Documents page displays the information shown in Table 14-1. For a more detailed description of the properties, see Section 14.3, "Editing XML Documents."

  2. To locate a specific XML Document:

    • To restrict the number of items in the list, you can filter by name and path before you click Search.

      Path is the project name and the name of the folder(s) in which the resource resides.

    • Click View All to remove the search filters and display all XML Documents.

Table 14-1 XML Documents Details

Property Description

XML Document

The unique name assigned to the XML Document. The name is a link to the View the XML Document page. See Section 14.3, "Editing XML Documents."

Path

The path is the project name and the name of the folder in which the XML Document resides. It is a link to the project or folder that contains this resource. See Section 4.1.1, "Qualifying Resource Names Using Projects and Folders."

Options

Click the Delete icon to delete a specific XML Documents. See Section 14.4, "Deleting XML Documents."


14.2 Adding XML Documents

The easiest way to create XML Documents in Oracle Service Bus is by bulk importing them. For example, if you bulk import JCA resources you have created (.jca file, associated WSDL, and TopLink or EclipseLink mapping file), Oracle Service Bus automatically generates XML Document resources out of mapping files and maintains the dependencies among resource files.

For more information on importing, see Section 4.15, "Loading Resources from a Zip File.", Section 4.17, "Loading Resources from a URL." and Section 29.1, "Importing Resources."

If you do not bulk import, you can manually create XML Documents, described in the following steps:

  1. If you have not already done so, click Create to create a new session, or click Edit to enter an existing session. See Section 3.1, "Using the Change Center."

  2. Select Project Explorer, then select a project or folder in which to add the XML Document. The Project/Folder View page is displayed.

  3. From the Create Resource field, select XML Document to display the Create a New XML Document page.

  4. In the XML File field, click Browse and select the XML file you want to use.

    The Resource Name field is automatically populated with the file name (minus the file extension).

    Instead of selecting a file, you can copy and past the contents of an XML file in the XML File field text area.

  5. In the Resource Name field, enter or change the name of the XML document. XML Document names must be unique.

    Follow the Section 2.3, "Resource Naming Restrictions" for naming guidance.

  6. In the Resource Description field, enter a description for the XML Document.

  7. Click Save. The new XML Document is saved in the current session.

  8. To end the session and deploy the configuration to the runtime, click Activate under Change Center.

14.3 Editing XML Documents

Use the Edit an XML Document page to view and change details of a JCA Binding.

  1. If you have not already done so, click Create to create a new session or click Edit to enter an existing session. See Section 3.1, "Using the Change Center."

  2. Locate the XML Document, as described in Section 14.1, "Locating XML Documents."

  3. Click the XML Document name. The View the XML Document page displays the information shown in Table 14-2.

    Table 14-2 XML Document Details

    Property Description

    Last Modified By

    The user who created this XML Document or imported it into the configuration.

    Last Modified On

    The date and time that the user created this XML Document or imported it into the configuration. Click the date and time link to view the change history of this resource. See Section 4.23, "View Change History Page."

    References

    The number of objects that this XML Document references. If such references exist, click the numeric link to view a list of the objects. See Section 4.22, "Viewing References to Resources."

    Referenced by

    The number of objects that reference this XML Document. If such references exist, click the numeric link to view a list of the objects. For example, if the XML file is a TopLink file referenced by a JCA Binding, the JCA Binding is listed as a reference when you click the link. See Section 4.22, "Viewing References to Resources."

    Description

    A description of this XML Document, if one exists.


    The a read-only view of the XML Document is displayed by default.

  4. To edit the XML Document, click Edit. See Section 14.2, "Adding XML Documents" for field descriptions.

  5. Make the appropriate edits and click Save to commit the updates in the current session.

  6. To end the session and deploy the configuration to the runtime, click Activate under Change Center.

14.4 Deleting XML Documents

If any resources such as JCA Bindings reference the XML Document you want to delete, remove those references before deleting the XML Document.

  1. If you have not already done so, click Create to create a new session or click Edit to enter an existing session. See Section 3.1, "Using the Change Center."

  2. Select Resource Browser > XML Documents.

  3. Click the Delete icon in the Options field of the XML Document you want to delete. The XML Document is deleted in the current session. A Deletion Warning icon is displayed when other resources reference this resource. You can delete the resource with a warning confirmation. This might result in conflicts due to unresolved references to the deleted resource.

  4. To end the session and deploy the configuration to the runtime, click Activate in the Change Center.