The following sections explain how to search an locate an asset in WSO2 G-Reg Store.
Navigating to G-Reg Store
You can navigate to the G-Reg Store Web user interface to discover and use various asset types as described below.
URL format | http://<G-REG_HOST>:<G-REG_HTTP_PORT>/store https://<G-REG_HOST>:<G-REG_HTTPS_PORT>/store |
---|
Description | By default, <G-REG_HOST> is localhost. However, if you are using a public IP, specify the respective IP address or domain. By default, <G-REG_HTTPS_PORT> is set to 9443, and <G-REG_HTTP_PORT> is set to 9763. However, if the you apply a port offset incremented by n, you need to increment the default port value by n. |
---|
Example | http://localhost:9763/store https://localhost:9443/store |
---|
You view the home page for anonymous users as shown below.
Registering with G-Reg Store
The system administrator will be able to log in using admin
as the username and password. However, other users will have to first register with G-Reg Store before being able to log in. Follow the instructions below to register with G-Reg Store.
Navigate to the G-Reg Store. For instructions, see Navigating to G-Reg Store.
- Click the following Register button in the upper right corner of the screen.
You view the following screen.
- Enter a preferred username and password.
- Enter the password again for Confirm Password.
- Enter the email address.
- Enter the first and last names.
- Click REGISTER.
- Click the Sign in link in the following screen which you view once the new user is successfully created.
- Sign in using the credentials of the user you created. For instructions, see steps 3-4 in Logging into G-Reg Store.
Logging in to G-Reg Store
Follow the instructions below to log in to WSO2 G-Reg Store.
Navigate to the G-Reg Store. For instructions, see Navigating to G-Reg Store.
- Click the following Sign in button in the upper right corner of the screen.
Enter your username and password in the next screen as shown below.
- Click SIGN IN. The home page will appear as shown below.
Logging out of G-Reg Store
Follow the instructions below to log out of WSO2 G-Reg Store.
- Navigate to the menu with your username. For example, if your username is admin, click on admin.
- Click Sign out.
Searching for an asset
Once you access the G-Reg Store, you can search for assets using the provided search field as shown below.
Using keywords to search
WSO2 G-Reg Store supports the following advanced search operators, for you to use as keywords or symbols, to find what you are looking for quickly and accurately in the search operation. You can view a summary of these by clicking the info icon next to the search filed as shown below.
Operator | Description | Example |
---|
name:
| Specifies the asset name. You view assets that contain the word you enter in its name, which you define when creating the asset. | |
mediaType:
| Specifies the asset type (mime type). The search keywords for o ut of the box media types are: wsdl, wadl, policy, xsd, restservice, soap-service, etc. You view assets which contain the word you enter in its media type (e.g. application/wsdl+xml , application/vnd.wso2-soap-service+xml ). For information on finding the media-type or artifact-type of an asset, see Governance Artifacts Configuration Model Elements. | -
mediaType: wsdl -
mediaType: soap-service
|
version:
| Specify the asset version. You view assets of which the version equals to what you enter. To search by this, you need to create of the selected asset. For information on creating new versions of an asset, see Adding a New Version of an Asset. | version: 1.0.0 |
tags:
| Specifies tags attached to the asset. You view assets which are tagged with the word you enter. To search by this, you need to create tags for the selected asset. For information on creating tags for an asset, see Viewing, Adding and Deleting Tags in Publisher. | -
tags: mac -
tags: new-Engineering
|
content:
| Searches for assets with content as preferred. You view assets which contain the word you enter in its content. Other than that, you can search sentences by passing the value within quotes. | |
lcName:
| Specifies the asset's lifecycle name. You view assets of which the lifecycle name equals to what you enter. For information on the life cycle of an asset, see Managing Life Cycles of Assets. |
lcName:
ServiceLifeCycle |
lcState:
| Specifies the asset's lifecycle state. You view assets of which the lifecycle state equals to what you enter. For information on the life cycle of an asset, see Managing Life Cycles of Assets . | lcState: Development |
associationType:
| Searches for assets which are associated with the given type. To search by this, you need to create associations for the selected asset. For information on creating associations for an asset, see Adding Associations for an Asset. | -
associationType: depends -
associationType: security
|
author:
| Specifies the author of the asset. You view assets which are created or deployed by the given author. | author: admin |
updater:
| Specifies the last updater of the asset. You view assets which are last updated by the given author. | updater: admin |
category:
| Searches for assets that belong to the given category. To search by this, you need to create categories for the selected asset. For information on creating categories for an asset, see Adding Categories for an Asset. | category: Engineeringcategory: Marketing
|
<RXT_TABLE_NAME>_<RXT_FIELD_NAME> :<RXT_FIELD_VALUE> | Searches for assets by the given RXT field value. You view assets which have the value as specified of the given RXT field name. For information on table and field names of a Configurable Governance Artifact (RXT) file, see Governance Artifacts Configuration Model Elements. | |
[space] - in between the search operators | Searches assets by two or more fields. You view assets which match all the given search operators. | name: echo version: 1.0.0
|
Tracking search history
WSO2 G-Reg is capable of tracking the search history in the G-Reg Store search functionality. When you search for assets in the G-Reg Store, those search queries will be automatically stored against your user role. Hence, you will not loose search history results even when the session is destroyed. Also, WSO2 G-Reg maintains search history per asset type. E.g. search history in REST Services and search history in SOAP Services will be different.
When you start typing a search query in the provided search field, you view a list with matching search history queries as shown in the example below.
This allows you to reuse the same query without completing typing it as shown below.
Search history tracking configurations
Follow the steps below to configure the search history tracking feature by changing the properties defined in the /_system/config/store/configs/
store.json
file in the Registry.
- Log in to the G-Reg Management Console using the following URL and admin/admin credentials: https://<G-REG_HOST>:<G-REG_PORT>/carbon
- Click Main, and then click Browse in the Resources menu as shown below.
- Select and click the
/_system/config/store/configs/
store.json
file as shown below.
- Click Edit as text in the Content menu as shown below.
You can enable/disable the search history tracking by changing the value of the searchHistory:enabled
property as shown below.
Restart the WSO2 G-Reg server by pressing Ctrl+C in the server startup logs after doing the above configurations.
For an example, you can search for version 1.0.0 of the BuyMoreBillCalculateRESTAPI asset (i.e. deployed when you execute the Quick Start Guide sample), by typing the following text in the provided search field as shown below:
name:BuyMoreBillCalculateRESTAPI version:1.0.0
You view the version 1.0.0 of the BuyMoreBillCalculateRESTAPI asset as shown below.