About the Index Configuration File

Collaboration and Approvals installs with the index configuration file, also called config.xml file. The indexing process reads this file stored in your database, which contains all the configuration options for 3DSpace Index.

The config.xml file contains many business object types and fields (parametric, relationship, and program fields), which allows you to configure all Business Process Services and applications.

This page presents the following topics:

This page discusses:

Structure
Index File Names
Enable Slashes for Facet Category Names
Wildcard Searches
Recent Content
Focus on Type Indexing
Override Hard-Coded Fields

Structure

The diagram below shows the tag structure:

Index File Names

By default, 3DSpace Index does not index the names of files attached to a business object automatically. If you want to be able to search on file names, add the following to the config.xml file:

<FIELD name="FILENAME" select="format.file.name" type="STRING"/>

Enable Slashes for Facet Category Names

You may want to use slashes / when creating facet categories to classify business objects, for example, B/R for Body Red.

Supporting slashes for category names fixes issues in the display of 6WTags and make your data easy to understand.

Before this function, the 3DSpace Index either escaped the slash and replaced it with _47_, or sometimes used it as a hierarchical separator.

For example, the rendering of the B/R Red category for the 6WTags ds6w:libraries could be:

- ds6w:libraries
  o B
    R Red

Or:

- ds6w:libraries
  B_47_R Red

With this function, you get a consistent rendering:

- ds6w:libraries
  o B/R Red

This function changes the behavior of all fields generating a facet in the index, that is, fields of type:

STRING,PARAMETRIC or STRING,CLASSIFICATION
TAXONOMY
ds6w: Tags

Note: This function does not deduce facet hierarchies. If you want to create a hierarchy, register data in the database using the _BELCHAR_ separator.

Important: As this function changes the index structure:

To update existing data:
1. In the CloudView Administration Console, go to Index > Consolidation.
2. Run Force aggregation.
To index new data, run a partial indexing on all vaults:
```
start searchindex mode PARTIAL;
```
For more information, see Partial Indexing Process.

Wildcard Searches

Wildcard search is enabled for Title and Name fields only.

For example, if you search for base, search results like database and basedir display only if base appears in the Title or in the Name field.

Recent Content

This feature returns results from specific vaults if you specify vault names for the <RECENTCONTENT includedvaults="" /> property in the config.xml.

For example, if you specify the property to:

<RECENTCONTENT includedvaults="eService Production,SIXW,TestVault1"/>

Recent Content returns results from the eService Production, SIXW, and TestVault1 vaults only. It excludes all other vaults defined on the MCS automatically.

If <RECENTCONTENT includedvaults="" /> is not defined in the config.xml, Recent Content returns results from the eService Production, SIXW, and vplm vaults only.

Focus on Type Indexing

A subtype can define by itself whether it must be indexed, independently of the parent type's indexing.

Important: The excludetypes attribute on the BOTYPE parameter is deprecated.

Use the active attribute instead. It allows a type to define by itself whether it must be indexed (rather than being declared by its parent type). This approach provides more granularity to index type inclusion and exclusion, and makes it easier to customize applications. See Config.xml Parameters.

To index the type, define active="true", which is the default. To exclude the type from indexing, define active="false" as in the following:

Note: The active attribute affects the current type only. If the current type has active="true", and its parent type and a child type both have active="false", the current type is indexed, while the parent and child types are not. Indexing of a type is independent of both its parent and child type indexing.

You could also define FIELDS for such types so that subtypes could inherit these fields (if the subtypes use inheritfields="true").

Inheritance and Indexing

For the BOTYPE parameter, the optional inheritfields attribute allows a subtype (declared as BOTYPE in the config.xml file) to inherit indexed fields (BOTYPEFIELDS) from its closest parent type included in the indexing.

If the parent type defines active="false", the child type still inherits the fields declared in the includes attribute of the parent type. In other words, if the config.xml file includes the parent type, its fields are available for its child types to inherit, regardless of the parent value for the active attribute.

Replacing Attributes

The new active attribute and the old excludetypes attribute for the BOTYPE parameter are redundant and can lead to conflicting settings with:

A parent defining excludetypes=child,
While its child defines active=true.

If you customized your config.xml to use excludetypes=child:

Remove this attribute from all parent types.
Add <BOTYPE name="child" active="false".../> for any type you want to exclude from indexing.

Override Hard-Coded Fields

You may need to override hard-coded fields that are not available in config.xml.

To override fields, define a new set of:

BOTYPEFIELDS (with name bo_defaultbasics).
RELATIONSHIPTYPEFIELDS (with name rel_defaultbasics).

Warning: Do not override the following hard-coded fields as they are required for internal use: MAJORID, TYPE, BOVAULT, and RELVAULT.

Hard-Coded Fields for the `BOTYPEFIELDS` Section

<BOTYPEFIELDS name="bo.defaultbasics">
<TAXONOMY name="TYPES" select="program[emxTypeLineage -method getLineage '${TYPE}']"/>
<TAXONOMY name="INTERFACES" select="execute[emxInterfaceLineage -method getLineage interface]" hidden="true"/>
<TAGTAXONOMY name="TAGS" select="execute[emxTagLineage -method getLineage physicalid proxy[SIXW|RDFUri].exists]" hidden="true"/>
<TAXONOMY name="bo.RDFClasses" select="execute[emxTagLineage -method getPredicateForTypeWithHierarchy classtype 'type']" sixw="ds6w:class"/>
<FIELD name="bo.RDFClassExt" select="execute[emxTagLineage -method getPredicateForType classinterface 'interface']" type="STRING" sixw="ds6w:kind"/>
<FIELD name="bo.RDFClass" select="execute[emxTagLineage -method getPredicateForType classtype 'type']" type="STRING"/>
<FIELD name="bo.dataSource" select="evaluate['Collaborative Spaces__BELCHAR__'+project]" type="STRING,PARAMETRIC"/>
<FIELD name="TYPE" chooserJPO="emxAEFFullSearch:getTypeChooserValues" chooserURL="${COMMON_DIR}/emxTypeChooser.jsp" select="type" type="STRING,PARAMETRIC" sixw="ds6w:type"/>
<FIELD name="LABEL" select="evaluate[if (attribute[Title] != '') then (attribute[Title]) else if (attribute[PLMEntity.V_Name] != '') then (attribute[PLMEntity.V_Name]) else (name)]" type="STRING" fastsort="true" ramBased="true" sixw="ds6w:label"/>
<FIELD name="IDENTIFIER" select="name" type="STRING" sixw="ds6w:identifier"/>
<FIELD name="DESCRIPTION" select="evaluate[if (attribute[PLMEntity.V_description] != '') then (attribute[PLMEntity.V_description]) else (description)]" type="STRING" sixw="ds6w:description"/>
<FIELD name="INTERFACE" select="interface" type="STRING,PARAMETRIC"/>
<FIELD name="ORIGINATED" select="originated" type="DATETIME" fastsort="true" ramBased="true" />
<FIELD name="MODIFIED" select="modified" type="DATETIME" fastsort="true" ramBased="true" />
<FIELD name="ORIGINATED_PARAM" select="originated" type="DATE,PARAMETRIC" fastsort="true" ramBased="true" sixw="ds6w:created"/>
<FIELD name="MODIFIED_PARAM" select="modified" type="DATE,PARAMETRIC" fastsort="true" ramBased="true" sixw="ds6w:modified"/>
<FIELD name="RESERVEDBY" select="reservedby" format="user" type="STRING,PARAMETRIC" sixw="ds6w:reservedBy"/>
<FIELD name="RESERVED" select="reserved" type="BOOLEAN,PARAMETRIC" sixw="ds6w:reserved"/>
<FIELD name="OWNER" select="owner" format="user" type="STRING" hidden="true"/>
<FIELD name="OWNER_FULLNAME" select="program[emxPerson -method getMemberFullName ${OBJECTID} 'owner']" type="STRING,PARAMETRIC" fastsort="true" ramBased="true" sixw="ds6w:responsible"/>
<FIELD name="ORGANIZATION" select="organization" type="STRING,PARAMETRIC" sixw="ds6w:organizationResponsible"/>
<FIELD name="PROJECT" select="project" type="STRING,PARAMETRIC" sixw="ds6w:project"/>
<FIELD name="POLICY" select="policy" type="STRING,PARAMETRIC" sixw="ds6w:policy"/>
<FIELD name="REVISION" select="revision" type="STRING" sixw="ds6wg:revision"/>
<FIELD name="MAJORREVISION" select="majorrevision" type="STRING" sixw="ds6wg:majorrevision"/>
<FIELD name="MINORREVISION" select="minorrevision" type="STRING" sixw="ds6wg:minorrevision"/>
<FIELD name="CURRENT" chooserJPO="emxAEFFullSearch:getStateChooserValues" select="current" type="STRING,PARAMETRIC" sixw="ds6w:status"/>
<FIELD name="BOVAULT" select="vault" type="STRING" hidden="true"/>
<FIELD name="PHYSICALID" select="physicalid" type="IDENTIFIER" />
<FIELD name="MAJORID" key="bo" select="majorid" type="VALUE" retrievable="true" searchable="true" ramBased="true" multiValued="false" useSimpleProperty="true"/>
</BOTYPEFIELDS>

To override FIELD, TAXONOMY and TAGTAXONOMY described in the section above, add the following to config.xml:

<BOTYPEFIELDS name="bo_defaultbasics">
<FIELD name="OWNER_FULLNAME" select="program[emxPerson -method getMemberFullName ${OBJECTID} 'owner']" type="STRING " ramBased="true" sixw="ds6w:responsible" " override=”true”/>
</BOTYPEFIELDS>

Hard-Coded Fields for the `RELATIONSHIPTYPEFIELDS` Section

<RELATIONSHIPTYPEFIELDS name="ro.defaultbasics">
<TAXONOMY name="RELTYPES" select="program[emxRelationshipLineage -method getLineage '${TYPE}']"/>
<FIELD name="TYPE" chooserJPO="emxAEFFullSearch:getTypeChooserValues" chooserURL="${COMMON_DIR}/emxTypeChooser.jsp" select="type" type="STRING,PARAMETRIC" sixw="ds6w:businessType"/>
<FIELD name="ID" select="id" type="IDENTIFIER" hidden="true"/>
<FIELD name="FROMID" select="from.id" type="IDENTIFIER" />
<FIELD name="TOID" select="to.id" type="IDENTIFIER" />
<FIELD name="RELVAULT" select="vault" type="STRING" hidden="true"/>
<FIELD name="PHYSICALID" select="physicalid" type="IDENTIFIER" />
<FIELD name="MAJORID" key="ro" select="majorid" type="VALUE" retrievable="true" searchable="true" ramBased="true" multiValued="false" useSimpleProperty="true"/>
</RELATIONSHIPTYPEFIELDS>

To override the fields described in the section above, add the following to config.xml:

<RELATIONSHIPTYPEFIELDS name="rel_defaultbasics">
<FIELD name="MAJORID" key="ro" select="majorid" type="VALUE" retrievable="true" searchable="true" ramBased="false" multiValued="false" useSimpleProperty="true" override=”true”/>
</RELATIONSHIPTYPEFIELDS>

Override a Field and Have the Field Index Nothing

If you want to override a field and have the field index nothing, use the CONST: keyword as shown below:

<BOTYPEFIELDS name="bo_defaultbasics">
<FIELD name="LASTMODIFIEDBY" select="CONST:" type="STRING,PARAMETRIC" sixw="ds6w:lastModifiedBy" retrievable="true" override="true" />
</BOTYPEFIELDS>

The crawler does not index anything for this field.