Calculated field templates

You use a calculated field template when you add a calculated field to a record type. The following templates are available:

Search for	Example	Results
A single word	`cat`	Topics that contain the word "cat". You will also find its grammatical variations, such as "cats".
A phrase. You can specify that the search results contain a specific phrase.	`"cat food"` (quotation marks)	Topics that contain the literal phrase "cat food" and all its grammatical variations. Without the quotation marks, the query is equivalent to specifying an OR operator, which finds topics with one of the individual words instead of the phrase.

Search for	Operator	Example
Two or more words in the same topic	`AND` `and` `+` (plus symbol) `&` (ampersand)	`cat AND dog` `"cat food"+milk` `"cat food"&"dog food"`
Either word in a topic	`OR` `or` `\|` (pipe)	`cat OR dog` `cat \| dog`
Topics that do not contain a specific word or phrase	`NOT` `not` `!` (exclamation point)	`NOT cat` `! dog`
Topics that contain one string and do not contain another	`^` (caret)	`cat ^ mouse`
A combination of search types	`( )` parentheses	`cat + (dog \| mouse)` `cat \| dog + (! mouse)`

Template	Parameters	Description
Field value changes count	field	Integer. Number of times the value of the selected field changed. Note If you use this template for a calculated field, when a new record is created: If the relevant field is then populated, that is counted as a change. If the relevant field is not populated, it is not counted as a change until the field is later populated.
Was record in phase	phase	Boolean. Whether the record was ever in the selected phase.
Was field assigned with value	field value	Boolean. Whether the selected field was ever populated with the specified value.
Phase duration	phase	Total time the record was in a selected phase. Note If the record is in the selected phase more than once, the phase duration is the total accumulated time spent in the phase.
Duration between phases	entered/exited phase	Total time between the following: The record entering (or exiting) the first specified phase, and The record entering (or exiting) the second specified phase. Note Where the record enters (or exits) the second specified phase more than once, the time is measured to the last entry or exit,
Duration between events	field to/from value	Total time between the following: First selected field changing to (or from) a value, and Another selected field changing to (or from) a value. Note Where the second field changes to (or from) a value more than once, the time is measured to the first change to (or from) a value, as appropriate.

Template

Parameters

Description

Field value changes count

field

Integer. Number of times the value of the selected field changed.

Note If you use this template for a calculated field, when a new record is created:

If the relevant field is then populated, that is counted as a change.
If the relevant field is not populated, it is not counted as a change until the field is later populated.

Was record in phase

phase

Boolean. Whether the record was ever in the selected phase.

Was field assigned with value

field

value

Boolean. Whether the selected field was ever populated with the specified value.

Phase duration

phase

Total time the record was in a selected phase.

Note If the record is in the selected phase more than once, the phase duration is the total accumulated time spent in the phase.

Duration between phases

entered/exited

phase

Total time between the following:

The record entering (or exiting) the first specified phase, and
The record entering (or exiting) the second specified phase.

Note Where the record enters (or exits) the second specified phase more than once, the time is measured to the last entry or exit,

Duration between events

field

to/from

value

Total time between the following:

First selected field changing to (or from) a value, and
Another selected field changing to (or from) a value.

Note Where the second field changes to (or from) a value more than once, the time is measured to the first change to (or from) a value, as appropriate.

Calculated field example

The following example shows how to use the Duration between events template to create a calculated field that measures the time it takes to assign a change record. This is done by tracking a change to the Owner of the change record.

From the main menu, select Administration > Configuration > Studio> Fields.

Select Change in the drop-down list at the top of the page.

Click New calculated-field.

Select Duration between events from the list of templates that is displayed.

In the template:

Click the first field.
Select Owner from the drop-down list, and click OK.
Click the first changed to/from.
Select Changed to from the drop-down list, and click OK.
Click field.
Select Owner from the drop-down list, and click OK.
Click changed to/from.
Select Changed from from the drop-down list, and click OK.
Click OK.
Edit the Name and Multilingual label for the field as required.

Note Both the value parameters remain empty.

Click Create.