Merge field examples
| The content of this website is last updated to F2 version 13. cBrain are working hard on supplying you with the newest documentation of F2. In the meantime you can read about the latest features and changes in our release notes. |
On this page, you can find examples of merge fields for records, cases, and participants. You can also read about list merge fields.
Merge fields on records
The table below shows examples of commonly used merge fields on a record. The prefix dossier must be added to the field names in the “Metadata field” column to indicate that the fields refer to data from a record. The “Merge field” column shows the field name prefixed with the record type. The “Merge code” column shows how the field is referred to when using merge codes.
| Metadata field | Merge field | Merge code |
|---|---|---|
Access |
dossier_accesstype |
$dossier_accesstype$ |
Bcc |
dossier_bccreceivernames |
$dossier_bccreceivernames$ |
Case help |
dossier_casehelp |
$dossier_casehelp$ |
Cc |
dossier_ccreceivernames |
$dossier_ccreceivernames$ |
Created by |
dossier_createdbyusername |
$dossier_createdbyusername$ |
Creation date |
dossier_createddate |
$dossier_createddate$ |
Deadline |
dossier_deadline |
$dossier_deadline$ |
Flag |
dossier_myflag |
$dossier_myflag$ |
Keywords |
dossier_keywords |
$dossier_keywords$ |
Letter date |
dossier_letterdate |
$dossier_letterdate$ |
Locked |
dossier_locked |
$dossier_locked$ |
Personal deadline |
dossier_mydeadline |
$dossier_mydeadline$ |
Previous case no. |
dossier_previouscasenumber |
$dossier_previouscasenumber$ |
Received date |
dossier_mailreceiveddate |
$dossier_mailreceiveddate$ |
Recipient |
dossier_receivernames |
$dossier_receivernames$ |
Record no. |
dossier_documentnumber |
$dossier_documentnumber$ |
Record type |
dossier_documenttype |
$dossier_documenttype$ |
Registered |
dossier_archived |
$dossier_archived$ |
Reminder date |
dossier_reminddate |
$dossier_reminddate$ |
Responsible user |
dossier_responsiblename |
$dossier_responsiblename$ |
Sender |
dossier_sendername |
$dossier_sendername$ |
SSN/Company no. |
dossier_cprnumber |
$dossier_cprnumber$ |
Status |
dossier_status |
$dossier_status$ |
Title |
dossier_title |
$dossier_title$ |
Merge fields on cases
The table below shows examples of commonly used merge fields on a case. The prefix case must be added to the field names in the “Metadata field” column to indicate that the fields refer to data from a case. The “Merge field” column shows the field name prefixed with the case type. The “Merge code” column shows how the field is referred to when using merge codes.
| Metadata field | Merge field | Merge code |
|---|---|---|
Case no. |
case_f2casenumber |
$case_f2casenumber$ |
Case title |
case_title |
$case_title$ |
Deadline |
case_deadline |
$case_deadline$ |
Keywords |
case_keywords |
$case_keywords$ |
Previous case no. |
case_previouscasenumber |
$case_previouscasenumber$ |
Progress code |
case_progresscode |
$case_progresscode$ |
Responsible user |
case_responsiblename |
$case_responsiblename$ |
SSN/Company no. |
case_cprcvrnumber |
$case_cprcvrnumber$ |
Status |
case_status |
$case_status$ |
Suppl. case manager |
case_supplcaseworkers_0_name |
$case_supplcaseworkers_0_name$ |
Suppl. case manager |
case_supplcaseworkers_1_name |
$case_supplcaseworkers_1_name$ |
Merge fields on participants
The table below shows examples of commonly used participant merge fields on records and cases. The prefix dossier or case must be added to the field names in the "Metadata field" column to indicate that the fields refer to data from a record or a case. The "Merge field" column shows the field name prefixed with the record or case type. The "Merge code" column shows how the field is referred to using merge codes.
Merge fields for participants can retrieve information from two different sources:
-
The participant register, where participants are maintained.
-
The record or case, where additional metadata can be added to the participant, such as a participant type (documentation available in Danish).
The suffixes org and notype are used to indicate where the information has been retrieved from.
The suffix org indicates that the merge field retrieves participant information as it appears on the record or case. If the suffix is not included, the merge field retrieves the information as it appears in the participant register.
The suffix notype indicates that the merge field retrieves participant information without a participant type being set. If a participant type is set on a participant, another selectable merge field is added.
When there are multiple participants on a record or a case, the merge fields are numbered 1, 2, 3, etc.
| Metadata field | Merge field | Merge code | Description |
|---|---|---|---|
Name of first record participant |
dossier_party_1_name |
$dossier_party_1_name$ |
Retrieves information from the participant register. |
Email of second record participant |
dossier_party_2_email_org |
$dossier_party_2_email_org$ |
Retrieves information from the record. |
Address of first case participant |
case_party_1_address1_org |
$case_party_1_address1_org$ |
Retrieves information from the case. |
City of second case participant |
case_party_Chairman2_city |
$case_party_Chairman2_city$ |
Participant type is defined. Retrieves information from the participant register. |
Name of third case participant |
case_party_notype3_name_org |
$case_party_notype3_name_org$ |
Participant type is undefined. Retrieves information from the case. |
List merge fields
It is possible to merge lists from F2 into a Word or Excel template. This functionality is often relevant in connection with case guides.
For Word templates, data containing a list can be merged as, for example, a table or a bulleted list. In the merged document, a table row, bullet point, or paragraph is repeated for each item in the list.
For Excel templates, an Excel row is repeated for each row in the list.
There are several types of list merge fields, including documents attached to a record as well as lists and embedded search templates in case guides.
| Search templates and other external data sources can only be used as list merge fields if they have been configured for this purpose in F2. Contact cBrain for more information. |
Syntax for list merge fields
Use the following syntax to add a list to an Excel or Word template:
$[case_fielddata_LISTNAME].FIELDNAME$
| Variables from a case guide can also be used in Excel and Word templates. These must be prefixed with "case_vardata_". |
List merge fields must start and end with the "$" sign as with regular merge fields. For list merge fields, the name of the merge field must be in square brackets. After the merge field’s name, you must specify which field from the list to include in the template.
| It is helpful to show paragraph marks in Word when setting up a template with list merge codes to ensure that the merged document has the intended layout. |