Functions (by category)

General Data Functions

 

Function Short Description
Exists Returns true if a given data item exists.
Field Returns a given field within any given record (see also the GetField function below).
FieldText Returns the value of a given field (see also the GetFieldText function below).
FileRoot Returns a reference to the file root if there is one.
GetContextItem Allows a reference to a data item in a particular context (such as the current witness, in a witness sentence template). Normally a contextual data reference would be used in such cases, but if that is not possible, this function may be used instead.
GetDataWarning Gives a warning of any known possible problem with a given data item. Can be used with any data item, but in fact currently only warns of possible problems with dates.
GetField Returns a given field within any given record. Is similar to the Field function above, but slower to execute and more flexible.
GetFieldText Returns the value of a given field. Is similar to the FieldText function above, but slower to execute and more flexible.
GetLinkedItem If passed a data item that stores a link to another record, this function will return the record that it links to.
GetParentItem Returns the immediate 'parent' data item of a given data item.
GetRecord Returns the record that a given field belongs to.
Individual See Type-Specifier functions.
IsEmpty Returns TRUE if a data item doesn't exist or has no value
IsSameItem Returns true if two references to a data item are references to the same data item.
IsSet Returns TRUE if a data item exists and has a value
Item See Type-Specifier functions.
ItemIf Takes a boolean expression (True or False) and 2 data items. If the boolean expression evaluates as True, the first data item is returned; otherwise the second data item is returned.
LinksFrom Returns the number of links from 1 record to another.
LinksTo Returns the number of links to a given record. Used in the query Links to Media Objects.
Name Returns the name of a given record.
Record Allows you to specify a given record by record type, and record id.
RecordId Returns the record id of a given record.
RecordName Returns the name of a given record.
RecordType Returns the record type of a given record, as a single character string.