Schema

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

To view the Schema Summary page, go to Configure > Registry and then click 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: for example, service model, constraints, and commonalities. 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 successful correlation and discovery of multiple schemas.

back to top

View Schema

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

Notes:

  • When the service is registered using the Create Physical Service Wizard, schema metadata is copied to the Policy Manager Registry.
  • You can view each schema in a browser window: from the Actions drop-down list box, choose View Schema.
To view a schema
  1. Go to Configure > Registry.
  2. Click the Schema tab. The Schemas Summary page is displayed.
  3. Find the schema you want to review, and then, from the from the Actions drop-down list box, select View Schema. A browser window opens, with the content of the selected schema.

back to top

View Service References for Schema

The Schema Summary page includes a Number of References column that indicates how many services are currently using a specific schema.

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

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

  1. Go to Configure > Registry.
  2. Click the Schema tab. The Schemas Summary page is displayed.
  3. From the Actions drop-down list box, select View Service References for the schema you want to review.

    The Workbench > Search page is displayed, showing the references associated with the selected schema.

back to top

You can query Policy Manager to find schemas. For example, you might need to search for specific schemas to view schema details, view references, or perform impact analysis. You can search by any part of the Schema Namespace.

  1. Go to Configure > Registry.
  2. Click the Schema tab. The Schemas Summary page is displayed.
  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 the Schema tab. The Schemas Summary page is displayed.
  3. Click Add Schema to launch the Add Schema Wizard. The Select Schema Import Option page is displayed.
  4. Use the 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 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 a ZIP file, click Browse, navigate to the directory location, and select the file.
  5. Click Finish. The Completion Summary page is displayed.
  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. Click the Schema tab.

    The Schemas Summary page is displayed.

  2. For the schema you want to review, select View Schema Details from the Actions drop-down list box. The Schema Details page is displayed.

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 the Schema tab. The Schemas Summary page is displayed.
  3. Find the schema that you want to assign an identifier to.
  4. From the Actions drop-down list box, select View Schema Details. The Schema Details page is displayed.
  5. Click the Identifiers tab. The Schema Identifiers Summary page is displayed.
  6. Click Assign Identifier. The Assign Identifier page is displayed.
  7. From the drop-down list box, select a desired Identifier Scheme.
  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.

Unassign Schema Identifiers

Remove the identifier association from the current Schema definition.

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

To unassign schema identifiers
  1. Go to Configure > Registry.
  2. Click the Schema tab. The Schemas Summary page is displayed.
  3. Find the schema that you want to assign an identifier to.
  4. From the Actions drop-down list box, select View Schema Details. The Schema Details page is displayed.
  5. Click the Identifiers tab. The Schema Identifiers Summary page is displayed.
  6. Click Unassign Identifier.
  7. At the confirmation message, click OK.

back to top

Schema Categories

To view the Schema Categories Summary:

  1. Go to Configure > Registry.
  2. Click the Schema tab. The Schemas Summary page is displayed.
  3. Find the schema that you want to assign an identifier to.
  4. From the Actions drop-down list box, select View Schema Details. The Schema Details page is displayed.
  5. Click the Categories tab. The Schema Categories Summary page is displayed, showing 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.

To assign a schema category
  1. Follow steps #1 through #5 as outlined in Schema Categories.
  2. Click Assign Category. The Select Categories page is displayed, 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.
  6. Click Close. You are returned to the Categories Summary page where any new category assignments are displayed.

Unassign Schema Category

You can remove the category association from the current Schema definition.

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

to unassign a schema category
  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 Category 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.

Examples of categories are:

  • Industry
  • Product category
  • Geographic region

You can assign one or more Category Groups to each of the following:

  • 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 page, with a list of Category Groups for the current schema.

  3. Click the button next to the Category Group that you want to assign new categories to.
  4. Click Next. The Select Categories page is displayed.
  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.
  7. Review the summary information, then click Close to exit.

Unassign Schema Group

Remove the category group association from the current Schema Instance.

Unassigning a category group association could become necessary if, for example, the established association with a selected category group is no longer valid, or if a Schema definition changes, requiring a new category association.

To unassign a schema category group
  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