Creating a schema specification

What you should be able to do

Roles participating in this task

	The user in the Development role creates the schema specification, loads the XSD document, and approves the specification for the schema specification.
	The user in the SOA Governance role proposes and approves the schema specification scope, and finally approves the schema specification.

Introduction

Now that the service version plan has been approved, as described in the lesson Planning a service version, the development process can begin. The first stage of this development process is to design the interfaces, schemas and business objects that will be 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.

Use the WSRR dashboard to follow the steps in this lesson.

Part 1: Creating a schema specification

Finding no relevant schemas in the registry, Development create a new schema specification item.

1. If necessary, log in to the dashboard as the development user. Switch to the Development view.
2. On the Overview page, select Create a Schema Specification in the Actions widget and specify the following details:
   1. In the Name field, enter Account creation schema.
   2. In the Description field, enter The schema definition for the Account creation service interface.
   3. In the Namespace field, enter http://www.jkhle.com/Account.
   4. In the Version field, enter 1.0.0.
   Click Finish to save your changes.
3. Note that the governance state of the new schema specification is Asset Identified. This is the initial state in the Asset lifecycle. 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 schema specification scope must be proposed. If you had any documentation that described the schema and its implementation, you could attach them to the schema specification as artifacts during this part of the lesson.

1. If necessary, log in as the development user. Switch to the Development view.
2. View the schema specification details in the Detail widget.
3. Propose the schema specification. Select Action > Propose Scope. Note that the new governance state is Asset Scope Review.

Part 3: Approving the schema specification scope

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

1. If necessary, log in as the SOA Governance user. Switch to the SOA Governance view.
2. View the schema specification details in the Detail widget.
3. Approve the schema specification. Select Action > Approve Scope, and note that the new governance state is Asset Scoped.

Part 4: Loading an XSD document

Now that the scope of the schema specification has been approved, a member of the Development team creates and loads the XSD document that describes the schema, and associates it with the schema specification item created in part 1 of this lesson.

1. If necessary, log in as the development user. Switch to the Development view.
2. View the schema specification in the Detail widget, and Edit icon ().
3. In the Edit window, load the XSD document that describes the schema as an artifact of the schema:
   1. Under the Artifacts heading, click Add Document.
   2. Select the XSD Document option from the Type list, and select Load.
   3. Select Load from file system.
   4. Click Browse next to the Specify document field.
   5. Navigate to the directory to which you extracted the tutorial sample files, and select AccountCreationSchema.xsd. Click Open.
   6. Specify a document version of 1.0.0.
   7. Click Next.
   8. Review the details in the Documents to be Loaded page, and click Finish.
4. Associate the schema specification item with its schema.
   1. In the Edit window, click Add Schema under the Specified Schemas heading.
   2. Enter h and select http://www.jkhle.com/Account from the auto-suggest list.
   3. Click Finish to save your changes.

Part 5: Submitting the implementation 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. This part, and the next two parts of the lesson, involve various members of the development team, and reflect the internal processes of the team in implementing the required service and associated items.

1. If necessary, log in as the development user. Switch to the Development view.
2. Select the Account creation schema specification to view its details in the Detail widget.
3. Transition the schema specification to the Asset Specification Review state. Select Action > Propose Asset Specification and note that the new governance state is Asset Specification Review.

Part 6: Approving the implementation 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. If necessary, log in as the development user. Switch to the Development view.
2. Select the Account creation schema specification to view its details in the Detail widget.
3. Transition the schema specification to the Asset Specified state. Select Action > 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 has been 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. If necessary, log in as the development user. Switch to the Development view.
2. View the schema specification details in the Detail widget.
3. Transition the schema specification to the Asset Review state. Select Action > 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 necessary, log in as the SOA Governance user. Switch to the SOA Governance view.
2. View the schema specification details in the Detail widget.
3. Transition the schema specification to the Asset Approved state. Select Action > Approve Asset, and note that the new governance state is Asset Approved.

What you did in this lesson