If the directory/file paths specified in this guide do not exist in your WSO2 product, see Directory Structure of WSO2 Products to locate the paths applicable to your product.
Skip to end of metadata
Go to start of metadata

A collection includes a set of a child collections and resources. If you select a collection in the registry, the Entries panel opens with details of the child collections and resources of the collection. For example,

The Info and Actions links in the Entries panel provide the following information:

Links in the Entries panelDescription
Add CollectionSee  Adding child collections.
Add ResourceSee Adding and Editing resources.
Create LinkSee Entries and Content#Adding links.
  • Feed - Generate a RSS feed for the resource
  • Rating - Ratings of the resource
  • Media type - Each collection or resource created and stored on the repository has an associated media type. If you leave the media type unspecified, it takes the default value. There are two main ways to configure media types for resources.
    1. Use a one-time configuration, by modifying the mime.types file found in the server configuration directory. Done just once before the initial start-up of the server. This method does not apply to collections. The only way to configure media types for a collection is using the second method.
    2. Use the management console as described when adding a collection and a resource.

    Initially, the system contains media types defined in mime.types file. They are available for resources and a set of default media types is available for collections.

    Human-readable media types have shorter names in place of MIME names (for example, WSDL is used instead of application/wsdl+xml). This is achieved by introducing a new file as <PRODUCT_HOME>/repository/conf/mime.mappings . For more information, see Configuring Registry Files section in WSO2 Governance Registry documentation.

    You can manage media types for resources by editing the properties of /system/mime.types/index collection. This collection contains two resources: collection and custom.ui. To manage media types of collections and custom user interfaces, edit the properties of these two resources.


Allows you to rename, move, copy or delete a resource/child collection.

You cannot move/copy resources and collections across registry mounts if they have dependencies or associations. You can only move/copy within a mount. For more information on mounts, read WSO2 Governance Registry documentation: Remote Instance and Mount Configuration Details.

These options are not available for all resources/collections.

Adding child collections

You can create a child collection to existing collections in a registry as shown below:

  1. Select a collection. You can see the Entries panel with details of child collections and resources it has.
  2. Click Add Collection.
  3. Specify the following options:
    • A unique name for the collection and a description
    • Select a media type from the drop-down menu
  4. Click Add.  

Adding resources to a collection

You can add a resource to a collection for more convenient usage of resources as follows:

  1. Select a collection. In its detailed view, you can see the  Entries panel with details of child collections and resources it has.
  2. In the Entries panel, click Add Resource.
  3. In the Add Resource page that opens, select one of the following methods:

    Uploading content from file

    Allows you to create a resource by fetching its content from a specified file (e.g., XML, WSDL, JAR). For example,

    Importing content from URL

    Allows you to fetch a resource from a specified URL path. For example,

    Creating text content

    Allows you to write the content in the UI itself, using either the Rich Text Editor or Plain Text Editor. For example,

    You can add external links (hyperlinks) as resources in the registry. To add such a link, create a text resource with the media type application/vnd.wso2-hyperlink and specify the URL as the resource's content.

    Creating custom content

    Allows you to create your own type of content with a specified media type. For example, to add a user profile to the registry, create custom content with the media type application/vnd.wso2-profiles+xml and provide the user name. For example,

Editing resources

If you select a resource, in its detailed view, you can see the  Content panel , which provides a UI to edit, upload, and download the content as follows:

  • Display as text : Allows only to view the configuration of a resource. For example,

  • Edit as text : Allows to edit a resource either in plain text editor or rich text editor.

  • Upload : Allows to upload a file to the resource. The existing content of the resource will be replaced by the you upload.

    NOTE: Be sure to upload a file of the same type as the existing resource, in order to avoid corrupting the resource. For resources such as WSDLs or Schemas, do not upload modifications that include changes to namespaces and imports.
  • Download : Allows to download a resource from its host to a file in a specified location.

    If a Security Warning appears when you try to download a resource, click Save to start downloading.

Symbolic links are much like hyperlinks to existing resources or collections in the local registry instance. When you access a symbolic link, the actual resource metadata, community features, associations and the content can be viewed from that location. If you make a change to the Symlink resource, the actual resource will get affected. These Symlink resources are soft links so that the actual resource does not keep a count for links from which it is referenced by. Instead the link shows a resource with a description saying that it could not make link to the original resource. Symbolic and remote links does not support versioning at the moment.

Remote links are created to mount a collection of a remotely deployed registry instance to the local instance. Any path/collection of the remote instance can be mounted at any point in the local instance. After mounting, the rest is very similar to symbolic links. You can work on the remote resource from the local instance.

Follow the instructions below to create a link on a resource/collection in the collection.

  1. Symbolic links and Remote links can be created in a similar way to adding a normal resource. To add a link, click "Create Link" in the "Entries" panel.
  2. From the drop-down menu, select a symbolic or a remote link to add:

    When adding a Symbolic link, enter a name for the link and the path of the existing resource or collection 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.

    You can mount a collection in a remotely deployed registry instance to your registry instance by adding a remote link. Provide a name, the instance to which you are going to mount and also the path of the remote collection. If no path is given, the root collection will be mounted.

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

  • No labels