Schema

Learn about Schemas, which are referenced when importing WSDL and describe the messages used by the services.

View the Schema Summary screen by going to Configure > Registry and then clicking on the Schemas tab.

Registry TOC

Table of Contents

  1. About Schemas
  2. View Schema
  3. View Service References for Schema
  4. Perform Schema Search
  5. Add Schema
  6. Schema Identifiers
  7. Schema Categories

About Schemas

Each web service includes a set of schemas that describe the structure of information (service model, constraints, commonalities, and so forth). The purpose of a schema is to allow machine validation of document structure.

When importing WSDL, all referenced schemas that describe the messages used by the services are extracted, indexed and stored in the Metadata Repository.

  • This allows the Workbench to reuse schema between services, allowing users to see how many service references a particular schema has and therefore determine the impact of any change to a particular schema.
  • To preserve the integrity of the metadata repository, each schema should have a unique and sensible namespace to allow for their successful correlation and discovery.

back to top

View Schema

The Schemas Summary screen includes a list of schemas that are currently utilized in service definitions and are stored in the Policy Manager data repository.

Notes:

  • Schema metadata is copied to the Policy Manager Registry when the service is registered using the Create Physical Service Wizard.
  • Each schema can be viewed in a browser window by selecting the View Schema action via the Actions drop-down list box.

To view a schema
  1. Go to Configure > Registry.
  2. Click on the Schema tab.

    The Schemas Summary screen displays.

  3. For the Schema you would like to review, select View Schema from the Actions drop-down list box.

    A browser window loads and displays the content of the selected schema.

back to top

View Service References for Schema

The Schema Summary screen displays a Number of References column that indicates the number of services that are currently utilizing a specific schema.

You can view the specific service references using the View Service References action.

Note: The number of references column shows both references from bindings and services.

  1. Go to Configure > Registry.
  2. Click on the Schema tab.

    The Schemas Summary screen displays.

  3. For the Schema you would like to review, select View Service References from the Actions drop-down list box.

    The Workbench > Search screen displays, showing the references associated with the selected schema.

back to top

Query Policy Manager and target schemas for the purposes of viewing schema details, references, and performing impact analysis.

Notes:

  • Valid search criteria can be any part of the Schema Namespace.
  • When you perform a search, a list of results display that match your defined search criteria.
  1. Go to Configure > Registry.
  2. Click on the Schema tab.

    The Schemas Summary screen displays.

  3. Define your Search Criteria.

    You can enter any portion of a Schema Namespace.

  4. Click Search.

    A list of schemas that match your defined search criteria is displayed.

  5. (Optional) Apply Schema Actions to each search result via the Actions drop-down list box.

back to top

Add Schema

Import schemas from .xsd files into the Policy Manager data repository. These schemas can then be reused to model web services.

  1. Go to Configure > Registry.
  2. Click on the Schema tab.

    The Schemas Summary screen displays.

  3. Click Add Schema to launch the Add Schema Wizard.

    The Select Schema Import Option screen displays.

  4. Use the radio buttons to select one of the following:
    • Schema Path—To specify a schema path, click Browse to navigate to the directory location of the Schema file, and select the Schema file. The field display populates with the selected path.
    • Schema URL—To specify the Schema using a Uniform Resource Locator (URL), click the Schema URL radio button and enter the address into the field display. The name format must conform to a supported Uniform Resource Identifier (URI) scheme.
    • Zip Archive Path—To specify a path to the Zip Archive Path, click Browse to navigate to the directory location of the Zip Archive File, and select the file. The field display populates with the selected path.
  5. Click Finish.

    The Completion Summary screen displays.

  6. Review the summary information, and then click Close to exit.

back to top

Schema Identifiers

To see a listing of Schema Identifiers that are defined for the current Schema definition:

  1. Go to Configure > Registry.
  2. Click on the Schema tab.

    The Schemas Summary screen displays.

  3. For the Schema you would like to review, select View Schema Details from the Actions drop-down list box.

    The Schema Details screen displays.

Assign Schema Identifiers

Assign an Identifier Scheme, Key Name, and Key Value that represent lookup elements that will be invoked during a search.

  1. Go to Configure > Registry.
  2. Click on the Schema tab.

    The Schemas Summary screen displays.

  3. Target a schema that you would like to assign an identifier to.
  4. Select View Schema Details from the Actions drop-down list box.

    The Schema Details screen displays.

  5. Click the Identifiers tab.

    The Schema Identifiers Summary screen displays.

  6. Click Assign Identifier.

    The Assign Identifier screen displays.

  7. Select a desired Identifier Scheme from the drop-down list box.
  8. Enter the Key Name [physical name] to associate with the selected Identifier Scheme.
  9. Enter the internal Key Value being referenced in the selected Identifier Scheme.
  10. Click Apply.

    The system saves the definition and you are returned to the Schema Identifier Summary screen.

Unassign Schema Identifiers

Remove the identifier association from the current Schema definition.

Removing an identifier could become necessary if, among other reasons, the established association with the selected identifier scheme is no longer valid or the Schema definition changed requiring a new identifier association.

  1. Go to Configure > Registry.
  2. Click on the Schema tab.

    The Schemas Summary screen displays.

  3. Target a schema that you would like to assign an identifier to.
  4. Select View Schema Details from the Actions drop-down list box.

    The Schema Details screen displays.

  5. Click the Identifiers tab.

    The Schema Identifiers Summary screen displays.

  6. Click Unassign Identifier.
  7. At the confirmation message, click OK to unassign the identifier.

back to top

Schema Categories

To view the Schema Categories Summary:

  1. Go to Configure > Registry.
  2. Click on the Schema tab.

    The Schemas Summary screen displays.

  3. Target a schema that you would like to assign an identifier to.
  4. Select View Schema Details from the Actions drop-down list box.

    The Schema Details screen displays.

  5. Click the Categories tab.

    The Schema Categories Summary screen displays, presenting all the categories that are defined for the current schema.

Assign Schema Category

To assign a Schema Category, you will:

  • Navigate the Category Hierarchy to select a Category Scheme
  • Navigate the tiers of the Category Scheme to select the Category Values
  • Apply the selected values to the current Schema definition

After applying the selected category values, a category definition is created and the record is displayed on the Schema Category Summary screen.

  1. Follow steps #1 through #5 as outlined at the beginning of this section (Schema Categories).
  2. Click Assign Category.

    The Select Categories screen displays, presenting the Category Hierarchy.

  3. Select a Category Scheme.
  4. Navigate the tiers of the Category Scheme and select a Category Value to apply to the current schema definition.
  5. Click Finish

    The system assigns the selected category value to the current organization definition and you are returned to the Add Categories Summary screen.

  6. Click Close.

    You are returned to the Categories Summary screen where any new category assignments are displayed.

Unassign Schema Category

Remove the category association from the current Schema definition.

Removing a category could become necessary, among other reasons, if the established association with a selected category scheme is no longer valid or a Schema definition changed requiring a new category association.

  1. Follow steps #1 through #5 as outlined in Schema Categories above.
  2. Click Unassign Category.
  3. At the confirmation message, click OK to unassign the category.

Assign Schema Group

Category Groups allow you to categorize service relationships with a higher level of granularity, and contain a list of business categories that describe specific business aspects of the Organizations, Services, tModels, Schemas, Interfaces, or Bindings.

Examples of categories are:

  • Industry
  • Product category
  • Geographic region.

One or more Category Groups can be assigned to each:

  • Organization
  • Service
  • tModel
  • Schema
  • Interface
  • Binding
To assign a schema group
  1. Follow steps #1 through #5 as outlined in Schema Categories above.
  2. Click Assign Category Group.

    The Assign Category Group Wizard is launched, displaying the Select Category Group screen, where a list of Category Groups that exist for the current schema is presented.

  3. Select the radio button next to the Category Group that you would like to assign new categories to.
  4. Click Next. The Select Categories screen displays.
  5. Navigate the tiers of the Category Scheme and select a Category Value to apply to the current schema definition.
  6. Click Finish.

    The system assigns the selected category value to the current Category Group assigned to the schema, and you are returned to the Add Category Group Summary screen.

  7. Review the summary information.
  8. Click Close to exit the Add Category Group Wizard.

Unassign Schema Group

Remove the category group association from the current Schema Instance.

Removing a category group could become necessary if, among other reasons, the established association with a selected category group is no longer valid or a Schema definition changed requiring a new category association.

  1. Follow steps #1 through #5 as outlined in Schema Categories above.
  2. Click Unassign Category Group.
  3. At the confirmation message, click OK to unassign the category.

back to top