Configuration

Introduction

This document describes the content of the AgileXPLORER configuration file, config.xml.

The config.xml is a file, in XML format, which defines parameters that control some of the user facing aspects of AgileXPLORER:

  • Categorization of Attributes/Fields
  • Search Properties
  • Data Sources
  • Field Action Links
  • Key Attributes
  • Search Modes
  • Common and Class Specific Catalog Filters
  • Catalog Structure
  • Results Views

For each of the sections above there is a set of tags that can be updated by the admin. These tags will be detailed in this document.

When data is extracted from Agile PLM a config.xml file is created in the AgileXPLORER-<version>/etl folder. When the application is restarted that file is copied to AgileXPLORER-<version>/data/config and read by the application.

If you would like to make changes update the etl/config.xml before an application restart.

Attribute Categories

This section, starting with <AttributeCategories> allows you to group attributes/fields into named categories.

Parameter Name

Description

Default/Sample Value

id

Category identifier referenced in other sections of the xml

agile common

expand

If set to true the node for this category is automatically expanded in the Filter parameters panel after a catalog search.

true

label

This is the name of the category presented to the user in the Attribute Selection forms and Filter parameters panel with Catalog search

Parameters

showInFacets

If true these set of attributes will be displayed in the Filter parameters panel after a Catalog search.

true

Search Properties

This section, starting with <Properties> defines some conditions used during search.

Property Name

Description

Default Value

results.allow.leadingwildcard

If set to true allows a user to specify a * at the start of a search string.

true

searching.key

???

cpn

Data Sources

This section, starting with <DataSources > defines some parameters for the Agile data source.

Parameter Name

Description

Default Value

id

Identifier for the source.

agile

name

Descriptive name for the source.

Agile Instance

partUrl

URL used to view the part details in Agile PLM.

http://<host:port>/Agile/object/${type}/${cpn}"

Field Action Links

This section, starting with <ColumnActions> allows you to tie an action link to a results field value. The action may be the opening of a different results view or an URL to launch a webpage to an internal program.

Parameter Name

Description

Default/Sample Value

id

Identifier for the action. This would be reference in the definition of the field in a results view.

open-cpn-details

label

Descriptive name for action.

Open Part Details

column

Index field name to which the action will be tied.

cpn

Url

Action to be executed.

![CDATA[javascript:jsOpenCpnDetailsWithQuery('(cpn:"${cpn}")');]]

Key Attributes

This section, starting with <KeyAttributes> defines key attributes that are used by the User Interface.

Property Name

Description

Default Value

PartNumberAttribute

Index field that represents the Part Number

cpn

ManufacturerPartNumberAttribute

Index field that represents the Manufacturer/Vendor Part Number

mpn

ManufacturerNameAttribute

Index field that represents the Manufacturer/Vendor Name

mfg

Search Modes

This section, starting with <QueryTemplates> defines key attributes that are used by the User Interface.

Parameter

Description

Default/Sample Value

QueryTemplate id

Identifier for the mode

cpn

name

Description name that will appears in the Search Mode dropdown list within the UI

Part Number

template

Query executed when this Search Mode is active. ${term} represents the search string entered by the user.

cpn:${term}

 TargetView id

Results view that will display these results. The base AgileXPLORER product has one view.

parts.active

mode

GroupBy id activated in the Results view with this search.

cpn

Catalog Results Filters – Common

This section, starting with <DefaultColumns> defines a common set of filter attributes that can be displayed in the Filter parameters panel after a Catalog search. These are generally attributes not specific to one Agile PLM subclass and commonly include Title Block and Page Two attributes.

Parameter

Description

Default/Sample Value

groupBy

This should not be changed.

cpn

field

Index field name

lifecycle_phase

label

Description name displayed in results views and attribute selection forms.

Lifecycle Phase

visible

If set to true a column for this field will be displayed in the results view.

true

catid

Attribute categories for this field. Attribute categories are display in the Catalog Filters panel, the Properties views, and the Attribute Selection forms.

agile common

size

Column width for this field in the results table views

100

filterable

If set to true a filterable list of field values is displayed in the column header for this field in the Results table view

false

Catalog Results Filters – Node Specific

This section, starting with <ColumnGroups> defines a set of filter attributes for a specific Agile PLM Part Type/Subclass. These attributes would be displayed in the Filter parameters panel after a Catalog search.

Parameter

Description

Default/Sample Value

name

Name for the set of attribute. Normally equivalent to the Agile subclass name.

capacitor

field

Index field name

tolerance

label

Description name displayed in results views and attribute selection forms.

Tolerance

visible

If set to true a column for this field will be displayed in the results view.

true

catid

Attribute categories for this field. Attribute categories are display in the Catalog Filters panel, the Properties views, and the Attribute Selection forms.

parameter

size

Column width for this field in the results table views

100

filterable

If set to true a filterable list of field values is displayed in the column header for this field in the Results table view

false

Catalog Structure

This section, starting with <Catalogs> defines the structure of the Catalog tree. Each node of the tree is specified in this section. The Catalog Structure can describe any level of hierarchy. An always starts with he grouping of "Catalogs". The catalogs section may have any number of "Catalog" definitions. A Catalog can either be a node Or may contain a  list of children Catalogs by specifying a sub Catalogs section.

<Catalogs> 

    <Catalog name="Level 0">

    <Catalogs>

         <Catalog name="Level 1 ">

                <Catalogs>

                      <Catalog name = "Level 2".......

Parameter

Description

Default/Sample Value

name

Name of the tree node as it will appear in the Catalog tree.

Capacitor

ColumnGroups

One of more comma separated catalog filter names. Default references the common attributes defined in the <DefaultColumns> section. In this example, capacitor, references the ‘name’ parameter in the <ColumnGroups> section.

default,capacitor

Criteria

This is the search string executed when the node is activated. Any Lucene search string is valid here. By default these search for all parts in the specified Agile class.

class_code:"Capacitor"

The Following is an example of the fully populated Catalogs definition: 

<Catalogs>
<Catalog name="Diode">
<ColumnGroups>default,diode</ColumnGroups>
<Criteria>class_code:"Diode"</Criteria>
</Catalog>
            <Catalog name="01 - FB Assembly">
<ColumnGroups>default,01_-_fb_assembly</ColumnGroups>
<Criteria>class_code:"01 - FB Assembly"</Criteria>
</Catalog>
            <Catalog name="02 - FB Motherboard">
<ColumnGroups>default,02_-_fb_motherboard</ColumnGroups>
<Criteria>class_code:"02 - FB Motherboard"</Criteria>
</Catalog>
</Catalogs> 

Results Views

This section, starting with <ActivePartsView> defines the columns in the Results table after a Catalog or Keyword search the Results view has a set of columns with field values. This view also allows the user to reset the focus of the view by use of the GroupBy feature. The grouping is defined in this section.

Parameter

Description

Default/Sample Value

id

Results view that will displays the table. This should not be changed.

parts.active

label

Descriptive name for the Active view

Default

GroupByField id

Identifier for the grouping.

cpn

GroupByField label

Descriptive name for the grouping displayed in the Group By dropdown list.

CPN

GroupByField enable-subpanels

If set to true one or more sub panels will be available within the Group By view

true

GroupByField default-subgroup

Subgroup id that will be the default sub panel for this Group By

aml

GroupByField grouping-fields

Comma separated list of field names that uniquely define the row in the table.

cpn

GroupByField sorting

Comma separated list of field names used to sort the table rows

cpn

GroupColumns

Section header for the list of columns in the main panel for the Group By

 

SubGroupColumns

Section header for the list of columns in the sub main panels for the Group By

 

SubGroupColumns grouping

Comma separated list of field names that uniquely define the row in the sub grouping.

mpn

SubGroupColumns id

Identifier for the sub grouping

aml

Column field

Index field name

cpn

Column label

Description name displayed in results views and attribute selection forms.

CPN

Column visible

If set to true a column for this field will be displayed in the results view.

true

Column catid

Attribute categories for this field. Attribute categories are display in the Catalog Filters panel, the Properties views, and the Attribute Selection forms.

agile common

Column size

Column width for this field in the results table views

100

Column filterable

If set to true a filterable list of field values is displayed in the column header for this field in the Results table view

false

Column ActionLink id

Optionally an identifier for the action to be executed when clicking this field. This reference a definition in <ColumnActions> section

open-cpn-details

Have more questions? Submit a request

0 Comments

Article is closed for comments.
Powered by Zendesk