Adding Categories for an Asset

This feature allows you to further filter (narrow down) the results of a particular search, by selecting a specific value or a set of values for a given attribute in WSO2 G-Reg Store. You can provide the filtering criteria for multiple attributes.

You can configure this in the RXT of the asset type. For an example, you can enable categorization by adding new fields to a new Categorization table of SOAP Services as explained below. 

1.   Log in to the WSO2 G-Reg Management Console using the following URL and admin/admin credentials: https://<G-REG_HOST>:<G-REG_PORT>/carbon/
2. Click Extensions, and then click Artifact Types in the Configure menu.
3. Click the corresponding  View/Edit  link of the artifact type, in which you want to enable categorization a shown below.
   
   

4. Add the following configuration to add option fields to a new Categorization table of the SOAP service RXT using the provided Editor as shown below.  

   <table name="Categorization">
   <field type="options" categorization="true">
   <name label="Business">Business</name>
   <values>
   <value>Customer Care</value>
   <value>Corporate</value>
   <value>Gas Technology</value>
   <value>Energy Supply</value>
   <value>Information Technology</value>
   </values>
   </field>
   <field type="options" categorization="true">
   <name label="Availability">Availability</name>
   <values>
   <value>Tier 1</value>
   <value>Tier 2</value>
   <value>Tier 3</value>
   <value>Tier 4</value>
   </values>
   </field>
   <field type="options" categorization="true">
   <name label="Environment">Environment</name>
   <values>
   <value>Dev</value>
   <value>Test</value>
   <value>QA</value>
   <value>Disaster Recovery</value>
   <value>Production</value>
   </values>
   </field>
   <field type="options" categorization="true">
   <name label="Platform">Platform</name>
   <values>
   <value>J­EE</value>
   <value>ETL</value>
   <value>File Transfer</value>
   <value>EDI</value>
   <value>ESB</value>
   </values>
   </field>
   <field type="options" categorization="true">
   <name label="Service Type">Service Type</name>
   <values>
   <value>HTTP­SOAP</value>
   <value>HTTP­REST</value>
   <value>JMS­XML</value>
   <value>JMS­JSON</value>
   <value>JMS­BINARY</value>
   </values>
   </field>
   </table>

   You can enable categorization by adding  an option field to any of the existing tables in the RXT of a particular type (e.g. Overview).

5. Click  Save, and then click Ok in the message which pops-up as shown below.

   
   

6. Add a new categoryField within the categories element under the asset.configure function for each field, in the < G-REG_HOME>/repository/deployment/server/jaggeryapps/store/extensions/assets/default/ asset.js file as follows.

   Add the value of the  categoryField  property in the following format:  <TABLE_NAME>_<FIELD-NAME> . You can pick the  <TABLE_NAME> from the RXT of the particular asset type, and the <FIELD-NAME> from the configuration you added to the RXT.

   categories: {
   categoryField: 'Categorization_Business',
   categoryField: 'Categorization_Availability',
   categoryField: 'Categorization_Environment',
   categoryField: 'Categorization_Platform',
   categoryField: 'Categorization_Service Type',
   },

7. Restart the WSO2 G-Reg server.

Once you configure the RXT to enable categorization, you can select the categorization values for a particular asset in the WSO2 G-Reg Publisher when creating a SOAP Service using the G-Reg Publisher or updating a SOAP Service as shown below.

You can use categorization to search for a SOAP Service in the G-Reg Store by its category as shown below.

Other configuration options

You can use the following configuration options, when creating categories for asset types in WSO2 G-Reg.

To get the values to display under each categorization option from Apache Solr 

Change the value of the solarFacetsEnabled element under the asset.configure function to true, in the < G-REG_HOME>/repository/deployment/server/jaggeryapps/store/extensions/assets/default/ asset.js file as follows, to retrieve the values from Solr facets.

categorization: {
solarFacetsEnabled: true,
}

To configure the number of categorization fields, to be expanded by default in the Store.

Change the value of the collapseInMenuCount element under the asset.configure function to true, in the <G-REG_HOME>/repository/deployment/server/jaggeryapps/store/extensions/assets/default/ asset.js file as follows, to configure the number of categorization fields, to be expanded by default in the Store.

categorization: {
collapseInMenuCount: 3
}