The WSO2 Governance Registry (G-Reg) is an SOA-integrated registry-repository for storing and managing data or metadata related to services and other artifacts. It consists of two Web-based interfaces: the G-Reg Publisher and G-Reg Store. The Publisher is used to create and manage assets, while the Store is used to search for and subscribe to assets.
...
Introducing the sample
BuyMore is a fictitious supermarket chain with more than 200 retail branches. Given below is a snapshot of the existing services of BuyMore with their lifecycle states:
...
Tip | ||||||
---|---|---|---|---|---|---|
Before you begin:
|
Deploying the sample to create assets
...
- Log in to the G-Reg Store (https://localhost:9443/store/) as Smith. Smith's credentials are smith/smith@bm.
- Click Rest Services in the left menu.
Search for the asset by typing "name:BuyMoreBillCalculateRESTAPI" in the search field and clicking the search icon.
Notice that many services are shown in the search results. Smith Smith knows that the service he wants (i.e.,BuyMoreBillCalculateRESTAPI version 1.0.0
) is is owned by the Think Tank team in Boston and is hosted by the Vancouver data center, so he filters the search by those criteria to make sure he finds the right one. - Expand the Teams filter in the Filter by menu, expand the Boston menu, and click the icon with the plus sign next to Think Tank to select it.
- Expand the DataCenters filter in the Filter by menu, and click the icon with the plus sign next to Vancouver to select it.
- Search for the asset by typing "name:BuyMoreBillCalculateRESTAPI" in the search field and clicking the search icon.
- The service
BuyMoreBillCalculateRESTAPI
version 1.0.0
appears in the search results. Click it to open it.
The asset opens. Scroll down to see the following links:
- Visualize: Opens a Swagger console where you can invoke the REST asset.
- Show Dependencies: Opens a diagram displaying all the dependencies this asset has with other assets.
- Copy URL: Gives you the option to copy the URL of the Swagger definition.
- Download: Downloads the Swagger definition of the REST asset to a given location on your machine.
Smith has now discovered the REST asset that can be called from other applications to calculate bill values. Next, Smith subscribes to receive notifications for this asset. A notification is an alert that you get via email and/or the G-Reg Store regarding an asset's lifecycle and/or information change.
Click the ->OPTIONS button in the top right-hand corner of the screen to expand the notification settings.
You can subscribe to receive notifications through emails or through the G-Reg Store. You can also opt to receive notifications when an asset is changed and/or when it goes through a lifecycle state change.Enable the option to receive notifications related to lifecycle state changes via the G-Reg Store.
...
- Log in to the G-Reg Publisher ( https://localhost:9443/publisher/ ) as Mark. Mark's credentials are mark/ mark@bm.
Use the following text to search for the service to be promoted to production, and then click the asset to open it.
name:BuyMoreBillCalculateRESTAPI version:2.0.0
Once the asset opens in the Publisher, go to its LIFECYCLE tab, add a comment to explain why you are changing its lifecycle state, and then click Promote .
Note that the lifecycle state of the service is changed from
TESTING
toPRODUCTION
, and the comment you added appears under history. Any user who goes to the LIFECYCLE tab of this service can see the comments history.
Now that a new version of the asset is in production, Mark deprecates the older version (i.e., version 1). This triggers an alert to Smith, who is subscribed to it to receive notifications.i.e., version 1). This triggers an alert to Smith, who is subscribed to it to receive notifications.- Click the GOVERNANCE CENTER - PUBLISHER label at the top of the console to go to the publisher's Homepage, search for the term "BuyMoreBillCalculateRESTAPI", and click version 1.0.0 of the asset to open it.
Once the asset is opened, go to its LIFECYCLE tab and click Deprecate.
Note that the lifecycle state of the asset is updated successfully.
...
Reviewing the new version of the asset
In the previous step, Smith opened BuyMoreBillCalculateRESTAPI Version 2.0.0
in the G-Reg Store.
- Go to the User Reviews tab of the asset and add a rating (let's say 5). Also add a review comment (such as "This version of the asset is recommended as it implements the company's new loyalty scheme"), and then click Post Review.
- Note that the review that Smith just added appears on the console, under the NEWEST category. You can filter reviews according to popularity and the date added.
...
Log in to the G-Reg Publisher (https://localhost:9443/publisher/) as Mark (credentials: mark/mark@bm).
Search for the term "BuyMoreBillCalculateRESTAPI" and click version 1.0.0 of the asset to open it.
- C lick Show Dependencies to view the asset's dependency graph and the policies.
The dependency graph opens. Note that you can click the icons to view more information about them.
Tip For more information on viewing dependencies of an asset, go to Dependency Visualization with WSO2 Governance Registry.
As this asset has no dependencies with other assets, Mark continues to make it obsolete.
- Go to the asset's LIFECYCLE tab and click Obsolete.
- Note that the lifecycle state of version 1.0.0 is now
OBSOLETE
.
...