Creating a schema specification

What you should be able to do

Introduction

Now that the service version plan has been approved, as described in the tutorial Providing scoping and planning information for the service, the development process can begin. The first stage of this development process is bring under governance control the interfaces, schemas and business objects that are used when interacting with this new service.

As part of the process of developing a new version of the business service, a common understanding and representation of the account creation service structures are required.

Part 1: Creating a schema specification

Having already developed and loaded the schemas via the loading of the SCA module, Development create a new schema specification to bring them under governance control.

1. If you have security enabled, and have assigned separate user IDs to each of the governance enablement profile roles, as described in Governing an SCA service: the provider story, log in to the web user interface with the user ID that is assigned to the Development role. Otherwise, go to the next step.
2. Create a new schema specification.
   1. In the web user interface, switch to the Development perspective, if necessary, by selecting Development from the Perspective list.
   2. Click Actions > Create > Schema Specification.
   3. Enter the following property values:
      • Name: Unformatted Address.
      • Description: The schema definition for an unformatted address.
      • Namespace: http://www.jkhle.com/AddressFormatter.
      • Version: 1.0.0.
      • Requirements Link: http://requirements.jkhle.com/requirements.jsp&id=2382. This is a link, fictitious in this case, to the relevant item in JKHL Enterprises' requirements tracking tool.
3. Assign an owning organization to the schema specification.
   1. Click Add Organization alongside the Owning Organization relationship.
   2. Enter C in the Name field, select Common services from the auto suggest list, and click Add. The Common services organization is added as a target of the Owning organization relationship.
   3. Click Finish to save the schema specification. The details page for the schema specification is displayed. Note that the Specified Schemas relationship has been filled in for you, with http://www.jkhle.com/AddressFormatter (1.0.0).
4. View the governance state of the new schema specification.
   1. Note that the new governance state is Asset Identified. This is the initial state in the Asset lifecycle; a new schema specification is entered into the Asset lifecycle automatically. In the Asset Identified state, the scope and requirements for representing the schema are agreed.

Part 2: Proposing the schema specification scope

The schema specification is now ready for review by the SOA governance team. To indicate its readiness for review, and to make it available to the reviewers, the scheme specification scope must be proposed.

1. Propose the schema specification.
   1. Click the Propose button. Note that the new governance state is Asset Scope Review.

Part 3: Approving the schema specification scope

The SOA Governance team confirm that the requirements provided are realistic and do not duplicate existing WSRR content, and therefore approve the scope of the schema specification.

1. If you have security enabled, and have assigned separate user IDs to each of the governance enablement profile roles, as described in Governing an SCA service: the provider story, log in to the Business Space user interface with the user ID that is assigned to the SOAGovernance role. Otherwise, go to the next step.
2. Approve the schema specification.
   1. In the Business Space user interface, switch to the SOA Governance space if necessary, by clicking Go to Spaces > SOAG, and ensure that the Overview page is selected.
   2. In the Watch List (SOA Governance) widget, click Unformatted Address (1.0.0) to display the schema specification details.
   3. In the Service Registry Detail widget, click Action > Approve Scope, and note that the new governance state is Asset Scoped.

Part 4: Referencing an XSD document

Now that the schema specification has been approved, a member of the Development team references the XSD document that describes the schema that was loaded as part of the SCA module, and associates it with the schema specification.

1. If you have security enabled, and have assigned separate user IDs to each of the governance enablement profile roles, as described in Governing an SCA service: the provider story, log in to the web user interface with the user ID that is assigned to the Development role. Otherwise, go to the next step.
2. Load the XSD document that describes the schema.
   1. In the web user interface, switch to the Development perspective, if necessary, by selecting Development from the Perspective list.
   2. Click Tasks > Schema Specification Tasks > Schema Specification.
   3. Click Unformatted Address to display the schema specification details.
   4. Click Edit Relationships.
   5. Click Add Document alongside the Artifacts relationship.
   6. Enter * in the Name field, and click Search.
   7. Select the check box alongside AddressFormatter_Unformatted.xsd, and click Apply Selected Targets.
   8. Click Finish to save your changes.

Part 5: Submitting the specification of the schema specification for approval

Having provided the technical details of the schema definition, the development team can now propose the specification for review.

1. Transition the schema specification to the Asset Specification Review state.
   1. Click Propose Asset Specification, and note that the new governance state is Asset Specification Review.

Part 6: Approving the specification of the schema specification

A development review is now held, to verify that the specification artifacts can be realized and fully meet the requirements, and to confirm that the service schema definition is agreed and will not change.

1. Transition the schema specification to the Asset Specified state.
   1. Click Tasks > Schema Specification Tasks > Schema Specifications for Specification Review.
   2. Click Unformatted Address to display the schema specification details.
   3. Click Approve Asset Specification, and note that the new governance state is Asset Specified.

Part 7: Submitting the schema specification for approval

At this point in its lifecycle, the schema is specified and is available for review by the other stakeholders, such as the organizations that will consume the service. They review the specification to ensure that it meets their requirements, and that the business objects it utilizes have been specified in a manner that promotes their future reuse. After it has been agreed that all aspects of the design meet their requirements, the schema is submitted for final review by the SOA governance team.

1. Transition the schema specification to the Asset Review state.
   1. Click Tasks > Schema Specification Tasks > Schema Specification Realization.
   2. Click Unformatted Address to display the schema specification details.
   3. Click Submit Asset for Approval, and note that the new governance state is Asset Review.

Part 8: Approving the schema specification

The SOA governance team carry out the final review, and approve the schema specification.

1. If you have security enabled, and have assigned separate user IDs to each of the governance enablement profile roles, as described in Governing an SCA service: the provider story, log in to the Business Space user interface with the user ID that is assigned to the SOAGovernance role. Otherwise, go to the next step.
2. Transition the schema specification to the Asset Approved state.
   1. In the Business Space user interface, switch to the SOA Governance space if necessary, by clicking Go to Spaces > SOAG, and ensure that the Overview page is selected.
   2. In the Watch List (SOA Governance) widget, click Unformatted Address (1.0.0) to display the schema specification details.
   3. In the Service Registry Detail widget, click Action > Approve Asset, and note that the new governance state is Asset Approved.

Part 9: Create and govern the schema specification for the Formatted Address schema

There is a second schema associated with the SCA module; this schema describes the response from the service.

You must repeat Parts 1 to 8 for this schema; follow exactly the same steps again, but with a schema specification name of Formatted Address.

What you did in this tutorial