Versions Compared

Old Version 5

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user Former user

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The following sections explain how to search an locate an asset in WSO2 G-Reg Store.

Table of Contents
maxLevel3

...

You can navigate to the G-Reg Store Web user interface to discover and use various asset types as described below.

Info

For information on accessing the G-Reg Store using a remote instance, see Enabling Remote Access for Governance Center.

URL formathttp://<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.

Examplehttp://localhost:9763/store
https://localhost:9443/store

You view the home page for anonymous users as shown below.

anonymous users' home pageImage Removed

...

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.

  1. Navigate to the G-Reg Store. For instructions, see Navigating to G-Reg Store.

  2. Click the following Register button in the upper right corner of the screen.
    Register buttonImage Removed
    You view the following screen. 
    create a new accountImage Removed
  3. Enter a preferred username and password.
  4. Enter the password again for Confirm Password.
  5. Enter the email address.
  6. Enter the first and last names.
  7. Click REGISTER.
  8. Click the Sign in link in the following screen which you view once the new user is successfully created.
    sign -in linkImage Removed
  9. Sign in using the credentials of the user you created. For instructions, see steps 3-4 in  Logging into G-Reg Store.

...

Follow the instructions below to log in to WSO2 G-Reg Store.

  1. Navigate to the G-Reg Store. For instructions, see Navigating to G-Reg Store.

  2. Click the following Sign in button in the upper right corner of the screen.
    Sign in buttonImage Removed

  3. Enter your username and password in the next screen as shown below.

    Tip

    If you do not have credentials to log in yet or if you did not register, you may temporarily use the default admin/admin credentials.

    sign in screenImage Removed

  4. Click SIGN IN. The home page will appear as shown below.
    home page of a created userImage Removed
Expand
titleLogging out of G-Reg Store

Follow the instructions below to log out of WSO2 G-Reg Store.

  1. Navigate to the menu with your username. For example, if your username is admin, click on admin.
    sign out buttonImage Removed
  2. 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.

Note
  • If you need to search against all assets, do the search in the Governance Store Home page or in the top-assets page, which you view when you click ALL in the left menu of the G-Reg Store Home page.
  • If you need to search against one asset type (e.g. search only in SOAP services), do the search in the page that lists all assets of that asset type, which you view when you click the button of that asset type (e.g. SOAP Service) in the left menu of the Governance Store Home page.
  • There can be assets, which are restricted for a certain user role, which is done at artifact level. If you are logged in to the store as one of the users with a role restricted for a certain artifact, you will not view that particular artifact in the Store search. 
  • In asset level, you can allow/deny access to the anonymous user group. If you search for an artifact with denied access to an anonymous user while you are logged out from the G-Reg Store, you will not view those restricted artifacts in the Store search function.
  • You can use the the wildcard (*) search, and the character ? to represent one character in the search queries.

search with advanced search operatorsImage Removed

...

titleUsing 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.

 store search keywordsImage Removed

...

name:"Ordering Service.wadl"

Info

Use double quotes within the search query, if you are specifying the name of an asset, which includes spaces in between its words.

...

Buymore

Info

If you type text without a keyword in the search field, the search query interprets it as you want to retrieve an asset that contains the word you enter in its name. For an example, typing "BuyMore" is similar to the following search query: name:BuyMore.

...

  • mediaType:wsdl
  • mediaType:soap-service

...

version:1.0.0

...

  • tags:mac
  • tags:new-Engineering 
Note

The search query for tags does not allow you to use spaces in between its words. Therefore, to search using a tag that includes spaces (e.g. "new Engineering"), use the dash sign in the search query.

...

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.

content:uber

Info

For assets with metadata-type RXTs, which you create (e.g. SOAP and REST Services etc.), use words found in any field name or value in the RXT file of the asset as search parameters in the search query. For information on the field names and values, see any section in the Viewing Information of an Asset .

...

content:"Adding the WSDL file"
 

Info

For assets with content-type RXTs (e.g. WSDLs, WADLs, Swaggers etc.), use words found in the source file of the asset as search parameters in the search query. For information on the source file, see the Content section in Viewing Information of an Asset.

...

  • associationType:depends
  • associationType:security

...

 

...

  • category: Engineering
  • category:Marketing

...

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.

 

...

  • overview_category:Engineering

    Info

    You do not need to specify the <RXT_TABLE_NAME> (i.e. overview_) when searching for values in fields of the overview table (e.g. category), since it gets automatically appended in the search query. Hence, you can type the above search query as category:Engineering.

  • interface_transports:https
  • security_authenticationType:none

...

name: echo version: 1.0.0

Expand
titleTracking 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. 

Image Removed

This allows you to reuse the same query without completing typing it as shown below.

Image Removed

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.

  1. Log in to the G-Reg Management Console using the following URL and admin/admin credentials: https://<G-REG_HOST>:<G-REG_PORT>/carbon
  2. Click Main, and then click Browse in the Resources menu as shown below.
    Image Removed
  3. Select and click the /_system/config/store/configs/store.json file as shown below.
    Image Removed
  4. Click Edit as text in the Content menu as shown below.
    Image Removed

  5. You can enable/disable the search history tracking by changing the value of the searchHistory:enabled property as shown below.

    Info

    Also, you can configure the maximum number of search history entries saved in the system by changing the searchHistory:maxCount property as shown below. By default, this is set to 05 per asset type.

    Image Removed

  6. Restart the WSO2 G-Reg server by pressing Ctrl+C in the server startup logs after doing the above configurations.

Expand
titleSearching for an asset using taxonomy

Once you create an asset by assigning terms to it, it will be available in the WSO2 G-Reg Store. You can navigate through the top drop-down hierarchy, to select the asset as shown below.

G-Reg Store taxonomyImage Removed

For example, once  you select Line Of Business 3 and Department15 as shown below, it lists down all the assets that belong to Line Of Business 3/Department15.

Image Removed

Expand
titleSearching for an asset using categories

Once you add categories to an asset, you can use categorization to search for a SOAP Service in the G-Reg Store by its category as shown below.

search filters in StoreImage Removed

view search filtersImage Removed

...

example searchImage Removed

You view the version 1.0.0 of the BuyMoreBillCalculateRESTAPI asset as shown below.
search resultsImage Removed

...

The following sections explain how to search an locate an asset in WSO2 G-Reg Store.

Table of Contents
maxLevel3

Anchor
Navigating to G-Reg Store
Navigating to 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.

Info

For information on accessing the G-Reg Store using a remote instance, see Enabling Remote Access for Governance Center.

URL formathttp://<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.

Examplehttp://localhost:9763/store
https://localhost:9443/store

You view the home page for anonymous users as shown below.

anonymous users' home pageImage Added

Anchor
Registering with G-Reg Store
Registering with G-Reg Store
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.

  1. Navigate to the G-Reg Store. For instructions, see Navigating to G-Reg Store.

  2. Click the following Register button in the upper right corner of the screen.
    Register buttonImage Added
    You view the following screen. 
    create a new accountImage Added
  3. Enter a preferred username and password.
  4. Enter the password again for Confirm Password.
  5. Enter the email address.
  6. Enter the first and last names.
  7. Click REGISTER.
  8. Click the Sign in link in the following screen which you view once the new user is successfully created.
    sign -in linkImage Added
  9. Sign in using the credentials of the user you created. For instructions, see steps 3-4 in  Logging into G-Reg Store.

Anchor
Logging into G-Reg Publisher
Logging into G-Reg Publisher
Logging in to G-Reg Store

Follow the instructions below to log in to WSO2 G-Reg Store.

  1. Navigate to the G-Reg Store. For instructions, see Navigating to G-Reg Store.

  2. Click the following Sign in button in the upper right corner of the screen.
    Sign in buttonImage Added

  3. Enter your username and password in the next screen as shown below.

    Tip

    If you do not have credentials to log in yet or if you did not register, you may temporarily use the default admin/admin credentials.

    sign in screenImage Added

  4. Click SIGN IN. The home page will appear as shown below.
    home page of a created userImage Added
Expand
titleLogging out of G-Reg Store

Follow the instructions below to log out of WSO2 G-Reg Store.

  1. Navigate to the menu with your username. For example, if your username is admin, click on admin.
    sign out buttonImage Added
  2. 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.

Note
  • If you need to search against all assets, do the search in the Governance Store Home page or in the top-assets page, which you view when you click ALL in the left menu of the G-Reg Store Home page.
  • If you need to search against one asset type (e.g. search only in SOAP services), do the search in the page that lists all assets of that asset type, which you view when you click the button of that asset type (e.g. SOAP Service) in the left menu of the Governance Store Home page.
  • There can be assets, which are restricted for a certain user role, which is done at artifact level. If you are logged in to the store as one of the users with a role restricted for a certain artifact, you will not view that particular artifact in the Store search. 
  • In asset level, you can allow/deny access to the anonymous user group. If you search for an artifact with denied access to an anonymous user while you are logged out from the G-Reg Store, you will not view those restricted artifacts in the Store search function.
  • You can use the the wildcard (*) search, and the character ? to represent one character in the search queries.

search with advanced search operatorsImage Added

Expand
titleUsing 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.

 store search keywordsImage Added

OperatorDescriptionExample
name: Specifies the asset name. You view assets that contain the word you enter in its name, which you define when creating the asset.
  • name:uber

  • name:"Ordering Service.wadl"

    Info

    Use double quotes within the search query, if you are specifying the name of an asset, which includes spaces in between its words.


  • Buymore

    Info

    If you type text without a keyword in the search field, the search query interprets it as you want to retrieve an asset that contains the word you enter in its name. For an example, typing "BuyMore" is similar to the following search query: name:BuyMore.

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 
Note

The search query for tags does not allow you to use spaces in between its words. Therefore, to search using a tag that includes spaces (e.g. "new Engineering"), use the dash sign in the search query.


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.


  • content:uber

    Info

    For assets with metadata-type RXTs, which you create (e.g. SOAP and REST Services etc.), use words found in any field name or value in the RXT file of the asset as search parameters in the search query. For information on the field names and values, see any section in the Viewing Information of an Asset .


  • content:"Adding the WSDL file"
     

    Info

    For assets with content-type RXTs (e.g. WSDLs, WADLs, Swaggers etc.), use words found in the source file of the asset as search parameters in the search query. For information on the source file, see the Content section in Viewing Information of an Asset.

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: Engineering
  • category: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.

 


  • overview_category:Engineering

    Info

    You do not need to specify the <RXT_TABLE_NAME> (i.e. overview_) when searching for values in fields of the overview table (e.g. category), since it gets automatically appended in the search query. Hence, you can type the above search query as category:Engineering.

  • interface_transports:https
  • security_authenticationType:none

[space] - in between the search operators

 


Searches assets by two or more fields. You view assets that match all the given search operators.

Info

This denotes the AND operation performed on the search operators.


name:cxf version:2.0.0

 

Info

You can also perform the AND operation on multiple values of the same operator as follows: name:(cxf AND BuyMore)

Then, you need to have the AND operator in between the two values.

OR - in between the search operatorsSearches assets by two or more fields. You view assets that match both the given search operators.

name:cxf OR version:2.0.0

Info

You can also perform the OR operation on multiple values of the same operator as follows: name:(cxf OR BuyMore)


complex search queriesSearches assets based on the fields and values given in the complex search query.name:(cxf AND BuyMore) lcState:(Development OR Testing)
Expand
titleTracking 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. 

Image Added

This allows you to reuse the same query without completing typing it as shown below.

Image Added

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.

  1. Log in to the G-Reg Management Console using the following URL and admin/admin credentials: https://<G-REG_HOST>:<G-REG_PORT>/carbon
  2. Click Main, and then click Browse in the Resources menu as shown below.
    Image Added
  3. Select and click the /_system/config/store/configs/store.json file as shown below.
    Image Added
  4. Click Edit as text in the Content menu as shown below.
    Image Added

  5. You can enable/disable the search history tracking by changing the value of the searchHistory:enabled property as shown below.

    Info

    Also, you can configure the maximum number of search history entries saved in the system by changing the searchHistory:maxCount property as shown below. By default, this is set to 05 per asset type.

    Image Added

  6. Restart the WSO2 G-Reg server by pressing Ctrl+C in the server startup logs after doing the above configurations.

Expand
titleSearching for an asset using filters

Once you add filters to an asset, you can use those filters to search for an asset in the G-Reg Store as shown below.

filters in StoreImage Added

Navigate through the Taxonomy hierarchy nodes and click Add Filter to create the filter at a preferred level. 

In the following example, Teams -> New Jersey -> The Rock Stars has been selected.

Tip

You can drill down the navigation by clicking on the respective taxonomy nodes and add parent nodes and/or leaf nodes to filter the assets.

add one child nodeImage Added

 You can add more filters from the same taxonomy by clicking on the Add Filter button as shown below.

Tip

In the following example, Teams -> New Jersey -> The Rock Stars and Teams -> Boston -> Concept Crew have been selected. When you add more filtering terms inside the same taxonomy, it performs an OR search query. Furthermore, search queries only contain Taxonomy IDs. For example the two filters above translate to the following search query:
(*Teams/New Jersey/The Rock Stars/* OR *Teams/Boston/Concept Crew/*)

 

adding another nodeImage Addedadd second nodeImage AddedImage Added

Also, you can add multiple filters from different taxonomies as shown below.

Info

When you add multiple taxonomies it performs an AND search between those taxonomies. In the following example, Teams -> New Jersey -> The Rock Stars and Data Centers -> Austin have been selected.

 Image Added

Info

Click the respective Remove option to remove any of the Taxonomy based filters as shown below.

removing a nodeImage Added

Click Edit respective to the filter, select another Taxonomy node, and click Update filter to update any of the Taxonomy based filters as shown below.

edit filterImage Addedupdate filterImage Added


Expand
titleRefining the search results

Once you add categories as search refinements to an asset, you can use them to search for a SOAP Service in the G-Reg Store by its category as shown below.

search by refinementsImage Added

Anchor
example
example

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 

example searchImage Added

You view the version 1.0.0 of the BuyMoreBillCalculateRESTAPI asset as shown below.
search resultsImage Added
Click on the retrieved asset and perform the available Store operations on it. For more information, see Performing Store Operations on an Asset.

Changing the default search

In G-Reg versions 5.1.0 and 5.2.0, the default search returned results only related to the name field of the RXT. However, in G-Reg 5.3.0, you can change this default search behavior in WSO2 Governance Registry Store to give any query pattern for the default search as required. Follow the steps below to configure the default search.

Note

This default search query will be given more priority than the taxonomy and categorization search.

  1. Navigate to the <G-REG_HOME>/repository/deployment/server/jaggeryapps/publisher/config/store.json file.

  2. Change the value of the following defaultSearch template to the query you need to execute as the default search.

     

    Code Block
    languagejs
    "search": {
    	"defaultSearchTemplate":"name=*$input* OR *$input*"
	}

     

    For example, if you need the default search query to return results, which are related to the name field or lcName field of the RXT, you can change the value as follows:

    Code Block
    languagejs
    "search": {
    	"defaultSearchTemplate":"name=*$input* OR lcName=*$input*"
	}