Paths

Paths are used within document fields to populate the search index with data about the Dovetail CRM entity being indexed. Paths start from a base table and walk across entity relations until they end up at a database column name.

Note: when using a Clarify view as the base table of a document specification field paths can only be field names present on the base view.

All required and custom fields should contain one or more paths.

Path Examples

Below is an example of a path for a solution document specification.

<path>probdesc2workaround:description</path>

Notice that the path starts by traversing to a related workaround and resolving to the description field on the workaround table.

The following are legal paths that start from probdesc as the base table:

Paths that expand to have more than one value (one to many relationships) will have all related values put into the field.

Paths Can Be Mixed With Text

It is perfectly fine to mix paths with text. Here is an example of the required field summary for a case document specification:

<summary xml:space="preserve">Case title: <path>title</path>

Owner: <path>case_owner2user:login_name</path>

</summary>

Notice the use of xml:space to preserve white space within the summary field. Without the xml:space attribute it is possible that any whitespace present could be ignored.

Multiple Paths

It is allowed and common to have many paths per specification. Below is an example search contents specification for a case:

<contents>

 <path>id_number</path>

 <path>title</path>

 <path>case_history</path>

</contents>

Notice how the content specification has multiple path elements each mapping to a field on the case table.

Note: If you are familiar with creating properties for rules in Dovetail RuleManager, you are likely familiar with paths. Dovetail Admin includes a utility for creating paths.

Did this topic help you? Email us your feedback.
Last updated: 8/10/2010 1:09:03 PM
© by Dovetail Software, Inc.