WSO2 Governance Registry - User Guide [ Documentation Index ]

WSO2 Governance Registry - User Guide

Resources User Interface

In the navigator, under Registry, click Resources.

Figure 1 : Registry User Interface

Components of Registry User Interface

Resource Breadcrumb

Use the breadcrumb to navigate backward in the current branch of the directory path, by clicking on a directory name in the breadcrumb. Note that you can access the root of the directory path by clicking the Home icon in the breadcrumb. Figure 2: The Breadcrumb

Meta Data Panel

The meta data panel displays the following properties of the resource or the collection Figure 3 : The meta data panel

Content Panel

If the currently selected entity is a collection, the Content Panel shows the child entries under that collection. It provides details of each entry. An entry can be either another collection or a resource. Figure 4 : View of Directory Entries

Adding a new Resource

Adding a resource could be done for a collection of resources or for an individual resource. To add a collection or directory, click on the "Add resource"/"Add collection" link provided and a page will be presented to fill in the required information. Optionally, a description can be included for the resource in question. Note : Adding and and deleting resources within the registry are considered version operations. Therefore, provision is made to rollback or restore a resource to any previous version. Refer Versions for additional information on this topic.

Deleting a Resource

To delete a resource , click on the cylindric icon provided. However, upon doing so a resource will not be removed from the database but instead marked as deleted. This provides the opportunity to restore a previously deleted resource. If the currently selected entity is a resource, the Content panel provides a user interface through which you can display, edit and download the content. Figure 5 : View of the Content

Permissions

Using the following screen, WSO2 Governance Registry permissions can be assigned to different roles and individual users. The top half of the permission's screen is used to define user roles and the bottom half for defining role permissions.

Figure 6 : Permissions

To assign permissions to users or roles follow the steps given below:

  1. select user/role from User/Role drop down
  2. choose an action from the 'Action' drop down menu
  3. select permission type. users are able to choose 'Allow' or 'Deny' by selecting appropriate option button.
  4. Click 'Add Permission' to apply selection
Existing permissions can be changed by selecting and clearing the check boxes for required permissions and clicking the "Apply All Permissions" button. Note: 'User permissions' have higher priority over 'role permissions'. 'Deny' permissions have higher priority over 'allow' priorities. Essentially, this means that permissions assigned to users overrides permissions assigned for a role and that a deny permission always overrides an 'allow' permission assigned to a user. The right side of the resources page houses 3 additional blocks, namely: Tags, Comments and Versions.

Tags

Provides space to enter tags for a given resource. These tags can be used when searching for a resource as key words for search criteria.

Users can enter as many tags as they like provided individual tags are separated by commas and a given tag is not used by the same author to identify the same resource repeatedly.

Figure 7 : Tags

Search

Users can perform a "tag" search using the search block. To perform an advanced search, in the navigator, under Registry, click Search.

Figure 8 : Search

Ratings

Users can either rate or view ratings made by others using the ratings block.

Figure 9 : Ratings

Comments

Users can either comment or refer comments made by others using the comments block.

To add a new comment:

1. select the "Add Comment" located on the comments block

2. enter comment in the text box provided

3. click the 'Add' button to continue.

Figure 10 : Comments

Dependencies and Associations

Resources or collections stored in the Registry can be associated according to the user's requirements. These can either be dependencies or named custom associations.

Media Types

Each collection or resource that you create and store on the repository has an associated media type. However, you also have the option to leave this unspecified enforcing the default media type. There are two main ways in which you can configure media types for resources.

The first method is by means of a one-time configuration which can be done by modifying the mime.types file found in the server configuration directory. This can be done just once before the initial start-up of the server. The second method is to configure the media types via the server administration console.

Managing media types for resources can be done via the server administration console, by editing the properties of the /system/mime.types/index collection. This collection contains two resources, collection and custom.ui. To manage media types of collections and custom user interfaces, you need to edit the properties of these two resources.

Creating a Governance WSDL Archive

WSO2 Governance Registry only allows you to upload one resource at a time. However, a WSDL file can have several imported resources (Schemas and WSDLs) that are required to be uploaded all at once. To address this, you now can create a zipped-archive of the WSDL file you want to upload including the imported Schemas and WSDLs placed in a proper directory structure. As an example, let's upload the WSDL file found at http://131.107.72.15/SoapWsdl_BaseDataTypes_XmlFormatter_Service_Indigo/BaseDataTypesDocLitB.svc?wsdl

Step 1: Save the WSDL to your local file system (by the name BaseDataTypesDocLitB.svc.wsdl) to a folder named, myWSDL.

Step 2: You need to open the WSDL file and identify the directory structure of the imports. The WSDL file we use has absolute Schema locations. Therefore, we first of all need to make them relative.

Step 3: We will replace the Schema locations to reflect a relative directory structure. Replace http://131.107.72.15/SoapWsdl_BaseDataTypes_XmlFormatter_Service_Indigo/BaseDataTypesDocLitB.svc?xsd=xsd1 with schemas/xsd1.xsd. Similarly replace the other two locations as, schemas/xsd0.xsd and schemas/xsd2.xsd.

Step 4: Create a folder named schemas inside the folder myWSDL. Now, save the three Schemas, within the schemas folder. Save http://131.107.72.15/SoapWsdl_BaseDataTypes_XmlFormatter_Service_Indigo/BaseDataTypesDocLitB.svc?xsd=xsd0 as xsd0.xsd, http://131.107.72.15/SoapWsdl_BaseDataTypes_XmlFormatter_Service_Indigo/BaseDataTypesDocLitB.svc?xsd=xsd1 as xsd1.xsd, and http://131.107.72.15/SoapWsdl_BaseDataTypes_XmlFormatter_Service_Indigo/BaseDataTypesDocLitB.svc?xsd=xsd2 as xsd2.xsd.

Step 5: You then need to open each Schema file and fix the locations of the imported Schemas. The Schema files we have uses absolute Schema locations, and we need to make them relative as well.

Step 6: Open xsd1.xsd, and replace http://131.107.72.15/SoapWsdl_BaseDataTypes_XmlFormatter_Service_Indigo/BaseDataTypesDocLitB.svc?xsd=xsd0 with xsd0.xsd, and http://131.107.72.15/SoapWsdl_BaseDataTypes_XmlFormatter_Service_Indigo/BaseDataTypesDocLitB.svc?xsd=xsd2 with xsd2.xsd. Then, open xsd2.xsd and do the same changes.

Step 7: Save and close the WSDL and Schema files, if you haven't done so. Then, create a zip archive of the folder myWSDL. Lets say you named it myZIP.zip. Now change the extension of this file from .zip to .gwa. Your file should now have the name, myZIP.gwa.

Step 8: Upload the myZIP.gwa to the registry, through the 'Browse' sub menu under the 'Resources' menu. Now, you should see your WSDL listed under the 'WSDLs' section under the 'List' sub-menu of the 'Metadata' menu.