When updating the index, the indexing applications need to make sure that only one document per entity is indexed. This is important as it would not be very useful to have multiple search result for the same case.
The <identification/> node describes how to uniquely identify a Dovetail CRM entity in the index. During indexing three identifying index document fields are created: domain, id, and uri fields. Adding these standard identifying fields to each index document allow a single search index to contain many different types of entities while still be able to uniquely identify them in search results and during indexing.
Clarify Table Example
<identification displayName="solution" table="probdesc" idColumnName="id_number"/>
In this situation, the indexing applications know to create solution documents in the index that are identified by the id_number column on the probdesc table.
Search results matching solution documents will have the following identification fields:
Field |
Value |
Description |
scheme |
dovetail |
Documents created for Dovetail CRM entities always have a scheme of dovetail. |
domain |
solution |
The displayName of the specification. |
id |
<'id_number' column value> |
Contains the value from the probdesc table's id_number column for the solution. The contents of this field come from the database column name specified in the idColumnName attribute. Note: The document specification must be configured so that documents generated are unique. You should make sure you specify an idColumnName for the object being indexed that is unique. |
uri |
dovetail://solution/<id_number> |
To uniquely identify each document, the three identifying fields above are formatted into this single field. |
Clarify View Example
<identification displayName="site" table="site_view" idColumnName="site_id"/>
In this situation, the indexing applications know to create site documents in the index that are identified by the site_id column on the site_view view.
Search results matching site documents will have the following identification fields:
Field |
Value |
Description |
domain |
site |
The display name of the specification. |
id |
<'site_id' column value> |
Contains the value from the site_view view's site_id column for the solution. The contents of this field come from the database column name specified in the idColumnName attribute. Note: The document specification must be configured so that documents generated are unique. You should make sure you specify an idColumnName for the object being indexed that is unique. |
uri |
dovetail://site/<site_id> |
To uniquely identify each document, the three identifying fields above are formatted into this single field. |
Note: when using a Clarify view as the base "table" of a document specification document required and custom field paths cannot traverse relations.
See Also |
Next |