||
Skip to end of metadata
Go to start of metadata

Follow the instructions below to search for an asset in the Store.  

  1. Sign into the Store.

    If required you can carry out an anonymous search, by not signing into the Store, via the top-assets page, which is the page that appears when accessing the Store URL (http://<HTTP_HOSTNAME>:<HTTP_PORT>/store). However, WSO2 ES will not track your search history when searching for assets anonymously.

  2. Click on the asset type for which you need to carry out the search. 
    • If you need to search against one asset type (e.g., searching only for gadgets), click on the menu that corresponds to that specific asset type (e.g., Gadget) in the left menu navigator.
    • If you need your search to be based on all the asset types, click ALL in the left menu navigator.
  3. Enter the search criteria. You can use one of the following approaches to enter the search criteria.

    • If required the administrator can restrict assets to a certain user role, which is done at the asset level. If users who are assigned to a restricted asset role signs into the Store, the Store search function does not list the restricted assets.
    • If required the administrator can allow or deny access to anonymous user groups for specific assets. If anonymous user groups are denied access to certain assets, the Store search function does not list the restricted assets when a user has not signed into the Store.
  •  Use search history.

    WSO2 ES is capable of tracking the user search history in the Store search functionality. When assets are searched for in the Store, those search queries are automatically stored in the /_system/config/users/searchhistory/ registry path in a separate file for each user. Therefore, users do not lose their search history results even when the session is destroyed. Furthermore, WSO2 ES maintains the search history based on the asset type (e.g., the search history for gadgets and the search history for sites are different). Therefore, separate search histories for each asset type are available in WSO2 ES.

    When you start typing a search query in the provided search text box, a list of matching search history queries are displayed. Thereby, this allows you to reuse the same search query without completely retyping it.

    To learn how to enable and disable the search history and also to change the maximum number of entries that is shown in the search history results, see Working with Search History Configurations.

  • Carry out a full search.
    Enter an actual word, which corresponds to an attribute in an asset, to carry out a full search.
  • Carry out a partial search.
    Enter part of a word or combine the search criteria with a wild character such as an asterisk (*) or a question mark (?) to carry out a partial search.
    The asterisk (*) denotes any and the question mark (?) denotes one character in the search query.
  • Search by asset category.
    Select the asset category from the All Categories drop-down box. This lists all the assets that belong to the selected category.
  •  Use keywords in a search query.

    The following sections describe the various types of keywords that are used to search for assets in the Store.

    General keywords

    The following table describes the general keywords that are used to search for assets.

    KeywordsDescriptionExample
    name:

    Use this keyword to search for assets based on the asset name itself.

    • name:uber
    • name:"Ordering Service.wadl"

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

    • Buymore

      If you type text without a keyword in the search field, by default the search query uses the name keyword to search for the corresponding assets.  

      For example, by simply entering BuyMore the search query interprets the entry as follows: name:BuyMore

    mediaType:

    Use this keyword to search for assets based on its asset type (MIME type). The search keywords for out of the box media types are as follows: gadgets, sites. See RXT Configuration Definitions to get more information on identifying the media type of an asset. 

    • mediaType:gadgets
    • mediaType:sites
    version:

    Use this keyword to search for assets that correspond to the version that you entered in the search query.

    version:1.0.0

    tags:

    Use this keyword to search for assets based on the tags that are assigned to the assets.

    • tags:wso2
    • tags:new-Engineering 

    The search query for tags do 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 in the search query.

    content:

    Use this keyword to search for assets based on any text value that is included in the asset attributes. For example, if there is an asset named foo and there is another asset that includes the term "foo" in its description when you carry out a content search using foo ( content:foo ), both the latter mentioned assets appear as each asset has attributes that include the search criterion. If you are passing multiple words that are separated by spaces, enclose the sentence within double quotation marks.

     

    • content:foo

    • content:"Chart is used"  

    lcName:

    Use this keyword to search for assets that include the lifecycle, which you entered in the search query.

    lcName:ServiceLifeCycle
    lcState:

    Use this keyword to search for assets that are in a particular lifecycle state.

    lcState:Development
    author: Use this keyword to search for assets that are created by the author, which is specified in the search query.author:admin
    updater:

    Use this keyword to search for assets that were last updated by the author that is specified in the search query.

    updater:admin
    category:

    Use this keyword to search for assets that belong to the specified category.

    • category:Engineering
    • category:Marketing

     

    Advanced keywords
    KeywordsDescriptionExample
    mediaType:

    Use this keyword to search for assets based on the ShortName of the artifact type. The search keywords for out of the box media types are as follows: gadgets, sites. For example, if the RXT has the following code snippet, the mediaType search query should appear as follows: mediaType:events

    <artifactType hasNamespace="false" iconset="9" pluralLabel="Events" shortName="events"
    singularLabel="Event" type="application/vnd.wso2-events+xml">
        </artifactType>

    For more information, RXT Configuration Definitions

    • mediaType:gadgets
    • mediaType:sites
    <RXT_TABLE_NAME>_<RXT_FIELD_NAME>:<RXT_FIELD_VALUE>

    Use asset attributes when you dynamic keywords to search for assets by asset attributes that are given in the RXT field value. For information on the table and field names of a configurable RXT file, see RXT Configuration Definitions.

     

    • overview_category:Engineering

      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) as it gets automatically appended to the search query. Therefore, you can type the above search query as follows: category:Engineering

     

    Combining keywords

    You can use a space in between the keywords in the search query when you need to use a combination of keywords to search for an asset.

    For example, you can search for version 1.0.0 of the Pinterest asset, by typing the following text in the provided search text-box.
    name:Pinterest version:1.0.0 

     

  • No labels