Encompass Catalog Specific Views

Configuring Catalog Specific Views

The following describes utilizing a feature of Encompass that controls how data is displayed by catalog. This feature allows a unique results view be configured for Each Catalog Node. This  capability is important especially for technical categories where the types of critical parameters varies between different types of items. For Example, A Capacitor Catalog might want to show - Capacitance, Voltage, and Package Type, Where a Resistor Catalog might need to show Resistance, Tolerance,  and Wattage. Additionally many parts are characterized by a small number of key properties, the order by which results should be sorted can be configured to be a multi-tier sort based on the key properties. For example Resistors might be sorted by “Resistance” then by “Wattage” then by “ Tolerance”. This will help place the most appropriate items towards the top of the results list for the user.

To utilize the capability, the Config.XML must be edited to utilize the new “TargetView” Tag.

The TargetView defines which GroupBy configuration will be used when a user selects the Catalog. 

Therefore, for the example above, the catalogs for resistor and capacitor may specify a TargetView of “resistor” or “capacitor” respectively. Next the GroupBy  sections  <Column> sections should be defined to show only the parameters relevant to each GroupBy. Lastly, the GroupBy sections Sorting should be configured based on the priority of the key properties.

It is also recommended to take advantage of the Attribute Categories. This allows for logical groups of attributes in the facet panel (the panel on the left hand side of the application). Attribute categories allow each attribute to reside in its own collapsible tree. For example place cost, and risk into the "supply-chain" category, while placing resistance and voltage into the the Technical category. This allows the user to only expand the types of attributes they need to work with. This involves updating the <Column> sections with the "catid" field, and providing the configuration of each category group in the <AttributeCatagories> section.

Configuring a TargetView

The TargetView tag is defined in the <Catalog> Sections for the each Catalog that requires a specific view configured. 



<Catalog name="11:Capacitors">



    <TargetView id="parts.active" mode="capacitor" />



Set id = “active.parts” to specify a view on “ACTIVE” Results Tab.

Set mode = “{TARGET_VIEW_ID}” where the TARGET_VIEW_ID is the ID of a corresponding GroupBy View.

Configuring the GroupByField for TargetView

This section defines what field the view will be grouped by, in the following example, the results will be grouped by CPN.  Additionally the line defines the TargetView ID. this is the ID value which was associated in the TargetView  stanza earlier. Its important these ID’s be globally unique in the file.

 <GroupByField id="capacitor" label="Capacitors" grouping-fields="cpn" sorting="cap_type,capacitance" enable-subpanels="false">

Configure the GroupByField section for the proper Display Columns.

When a user selects a catalog that has a TargetView defined, it will cause Encompass to use the GroupBy with the matching id field.  Then display  various parametric for each row in the results view.  To configure the display columns specify the index Field into the “field”  tag, and the human readable label  into the “label” tag.


      <Column catorder="95" field="test_thumbnail" label="Image" size="55" visible="true" thumbnail="true" />

      <Column catorder="96" field="bom_parent" label="" size="24" visible="true" filterable="true" />

      <Column catorder="97" field="bom_child" label="" size="24" visible="true" filterable="true" />

Configuring default Sort Order for the catalog

To define the sort order, define the “sorting” tag. The sorting tag, is a comma separated list of index field names in sort order.

<GroupByField id="capacitor" label="Capacitors" grouping-fields="cpn" sorting="cap_type,capacitance" enable-subpanels="false">

These edits should be made for all catalogs & GroupBy’s where unique attribute views are desired. Once complete, install the new config.xml and restart encompass for the changes to take effect.

Configuring Attribute Categories

As there can be many attributes for a given result set, each attribute can be placed into a category. This has the effect of producing collapsible category trees in the left hand facet panel.  Each Attribute gets assigned an ID. This ID is later referenced in a  section to define each group or bucket  of attributes.

Update Column definitions

The following edits must be made for each attribute that is to be assigned an attribute category. 

“id” :  this value is used to assign an attribute to a category in the <Column>  statements via the “catid” tag. This corresponds to its definition in the <AttributeCatagory> section later.

"catorder": is a simple numeric value. Any value can be used, however when the attributes are placed in the GUI they will be sorted ascending in the view according to this value.

It is permissible to have multiple <Column lines for one index attribute.

<Column field="referencecost" label="ReferenceCost" visible="true" catorder="90" catid="cost" size="100"/>

Attribute Category Definition

       For each attribute category assigned in the Column definition, its details must be defined in the <AttributeCatagories> section later in the config.xml .

-          “label” :   this value is the Category name that shows up in the Facets and the column selector forms

-          “showInFacets” :  if set to true this category node (and its related attributes) will show up in the Facets view with a catalog search.

-          “expand” :  if set to true this category node in the Facets view is automatically expanded (this works in conjunction with the previous tag)

-          “showInSearchResults” : if set to true a column is added to the results view for each of the category attributes that has a value in the result set.

-          “uncategorized” : this is the default category for fields that do not have a catid specified



  <AttributeCategories uncategorized="System Admin Use Only">

                <AttributeCategory id="technical" label="Technical" showInFacets="true" expand="false" showInSearchResults="false" />

                <AttributeCategory id="cost" label="Cost" expand="false" showInFacets="true" showInSearchResults="false" />

                <AttributeCategory id="availability" label="Availability" expand="false" showInFacets="true" showInSearchResults="false" />

                <AttributeCategory id="System Admin Use Only" label="System Admin Use Only" expand="false" showInFacets="true" showInSearchResults="false" />





Have more questions? Submit a request


Article is closed for comments.
Powered by Zendesk