WSO2 Task Server - Distribution

##### WSO2 Task Server

- Release Notes
- Home

##### Documentation

- Installation
- User Guide

##### Getting Help

- Mailing Lists
- Library

##### Project Information

- Issue Tracking
- License
- Checkout the Source

# Registry Resources

The WSO2 Registry is a repository that stores resources in a structured way. Here are some of the features provided by the registry interface.

- Provides the facility to organize resources into collections. (Similar to how you organize files in directories.)
- Keeps multiple versions of resources
- Manages social aspects such as rating,tagging and commenting resources
- AtomPub interfaces to publish, view and manage resources from remote or non-Java clients

The key components of Registry resource view would be as follows.

- Registry User Interface

- Registry User Interface Views
- Components of Registry User Interface

- Add Resources
- Add Collections
- Symbolic Links and Remote Links
- Media Types
- Optional Portlets

## Registry User Interface

In the navigator, under Registry, click Resources. The Registry resource browser provides two resource interfaces to the user, one is the Tree view and the other is the Detail view .

## Registry User Interface Views

### Tree view

The Tree view provides an hierarchical view of the organization of resources in the registry, which allows the users to easily locate a resource.

Figure 1 : Registry Resource Browser - Tree view

### Detail view

The Detail view provides an informative view of a selected resource in the registry. Any resource in the registry can either be a collection or resource. The Detail view of a collection and a resource would be different from information and functionalities provided.

Figure 2 : Registry Resource Browser - Detail view

## Components of Registry User Interface

The Detail view is the Registry User Interface for a resource. Following are the key components of Registry User Interface

- Breadcrumb:- Shows the current directory hierarchy
- Meta Data Panel:- Shows meta data for the resource/collection

- View Version
- Details of version

- Properties Panel:- Shows properties for the resource/collection
- Content Panel:- Shows the contents of the resource/collection

### 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 3: The Breadcrumb

### Meta Data Panel

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

- Created Time and Author
- Last Updated Time and Author
- Media Type which will get assigned while the resource get updated, but can be edited as user prefers.
- URL for the permanent link
- Versions of the resource
- Description about the resource/collection.

Figure 4 : The meta data panel

### View Version

Allows to view versions of a resource/collection. The importance of maintaining versions is to trace the changes made to a resources and restore a resource back to that version if necessary.

- Version - Shows the number of a resource/collection version.
- Last Modified Date - Shows the last date of updating.
- Last Modified By - Shows the author of alterations.
- Actions
- Details - Allows to get to the "Browse" page of a particular resource/collection version.
- Restore - Allows to restore a resource/collection version.

Figure 5 : View version

### Details of version

When user clicks the Detail link from the View version of a resource the page get redirected to the Details page of that version which illustrates the versioned components of a selected version of a resource. This would give a Browse view of the versioned resource.

Figure 6 : Details view

### Properties Panel

This panel displays the properties of the currently selected resource or collection. New properties can be added, while existing properties can be edited or deleted.

Figure 7 : The properties 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.

- Name - Click to access the content of this entry
- Created Date
- Author
- Ratings
- The link to the Atom feed

Figure 8 : View of Directory Entries

If the currently selected entity is a resource, the Content panel provides a user interface through which you can display, edit upload, and download the content.

Figure 9 : View of the Content

## Add Resources

When adding a resource users can select an upload method.An external entity can be uploaded by selecting upload content from file or import content from URL. By selecting the Create Text content a text resource can be created with defining the content as well. When the resource is being uploaded the name field will get populated by the resource name. The media type would also get added if the resource contains an identifiable media type or else the user has to manually enter.

Figure 10 : Add Resource

## Add Collections

Add collection is used to add a new collection. User can give a prefered name and a media type for the new collection.

Figure 11 : Add Collection

## Symbolic Links and Remote Links

Symbolic links and Remote links can be created in a similar way to adding a normal resource. Add resource drop down list contains options to add symbolic and remote links.

Figure 12 : Add Symbolic Link

When adding a symbolic link, you have to provide a name for the link and the path of an existing resource or collection which is being linked. It creates a link to the particular resource. The created symbolic link is shown by an icon with an arrow in the entries panel.

Figure 13 : Symbolic Link

Adding a Remote link is much similar to adding a symbolic link. You can mount a collection in a remotely deployed registry instance to your registry instance by adding a remote link. You can provide a name for the remote link in the name field, and choose the instance to which you are going to mount (Please refer the registry user guide to see how to configure the remote instances in registry.xml). You can give the path of the remote collection which you need to mount for the path field, or else the root collection will be mounted.

Figure 14 : Add Remote Link

After mounting the remote collection you can access and work on that collection from your local instance.

## 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. For collections the first method does not apply, and the only available mechanism is to configure the media types via the server administration console.

Initially the system will contain the media types defined in the mime.types file will be available for resources and a set of default media types will be available for collections.

Managing media types for resources can be done via the server administration console, by editing the properties of the /_system/config/repository/components/org.wso2.carbon.governance/media-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.

Figure 15 : Editing Media Types

## Optional Portlets

- Tag Search
- Dependencies
- Associations
- Life Cycles
- Adding Subscriptions
- Comments,Ratings and Tags

### Tag Search

The Search portlet allows the user to search resources by tags assigned to it.

Figure 16: Search

### Dependencies

The Dependencies portlet allows the user to add any resource as a dependency to the selected resource. A dependency is also an association with the type depends. All the added dependencies will be shown on a table in the same portlet.

Figure 17: Add Dependencies

### Associations

The Associations portlet allows the user to assign any resource as an association to the selected resource. The users are able to specify the type of the association and all the added association will be shown on a table in the same portlet.

Figure 18: Add Associations

### Life Cycles

The Life Cycle portlet allows the user to associate a life cycle aspect to a selected resource. The user will be prompted with all the available life cycles in a drop down list. When a life cycle is assigned, in the portlet it will display the life cycle name,the current state and the check list items of the current state if any.

Figure 19: Add Life Cycles

### Adding Subscriptions

The Subscriptions portlet allows you to add subscriptions to resources and collections. Clicking Add Subscription brings up a form which allows users to create new subscriptions. If you already have any subscriptions, they will be listed in a table displayed within this portlet.

Figure 20: Add Subscriptions to a Resource

### Hierarchical Subscriptions

For Collections there is an additional facility of creating Hierarchical Subscriptions if needed. By default when a user adds a subscription to a Collection it will only get added to that collection. Similarly the user can add a subscription to that collection and its immediate child resources by selecting the option Collection and Children only or to that collection and all of its child resources by selecting the option Collection,Children and Grand Children.

Figure 21: Add Subscriptions to a Collection

Once a subscription has been added, you are also allowed to delete subscriptions (or unsubscribe), by clicking on the relevant Delete link.

Figure 22: Manage Notifications

Adding a subscription involves selecting the event type and the notification method. The event types supported by default are as follows:

- Check LC Item - Represents an event that fires when a item is checked in a lifecycle check-list.
- Uncheck LC Item - Represents an event that fires when a item is unchecked in a lifecycle check-list.
- Create Child - Represents an event of creating a resource (or collection) within an existing collection.
- Delete Child - Represents an event of deleting a resource (or collection) within an existing collection.
- Delete - Represents an event of deleting a resource (or collection).
- Create LC - Represents an event of creating a lifecycle.
- Delete LC - Represents an event of deleting a lifecycle.
- Change LC State - Represents an event of changing a lifecycle state.
- Update - Represents an event of updating a resource or collection.

Please note that some of these events may not be available for certain types resources and collections. We support a variety of notification methods as well.

- E-mail - Any valid e-mail address.
- HTML/Plain-Text - An endpoint accepting HTML or text content.
- SOAP - An endpoint accepting notifications as a SOAP message.
- User Profile - A valid user's profile. Notifications will be sent to the e-mail address specified on the user's default profile.
- Group Profile - A valid role. Notifications will be sent to all the users in the specified role.
- Management Console - A valid role. Notifications will be sent to work-list for role.
- JMX - Notifications will be sent via JMX.

Based on the notification method you select, you may be required to provide additional information, such as the e-mail address to use of the name of the user of whom the profile will be used. Having done this step, you will have to click on the Subscribe button to add a subscription (see Figure above).

### Comments,Ratings and Tags

Comments,Ratings and Tags portlets allows the user to add comments, give ratings and add search tags for resources respectively.

Figure 23: Add Comments

Figure 24: Add Ratings

Figure 25: Add Tags