---
title: "Add document record fields - Microsoft Word"
slug: "add-document-record-fields-microsoft-word"
description: "Learn how to add record fields to Microsoft Word documents, ensuring proper setup for external files and key field management."
tags: ["Task topic"]
status: "update"
updated: 2026-10-05T12:01:28Z
published: 2026-10-05T12:01:28Z
canonical: "docs.staedean.com/add-document-record-fields-microsoft-word"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.staedean.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Add document record fields - Microsoft Word

To each document record, add the data fields whose values must be exchanged. For external file-based documents, set up the fields in line with naming in the file. For **Microsoft Word** documents, fields are always of type string, to enable type conversions. This topic explains how to add record fields to a **Microsoft Word** document.

If fields are already selected for or copied to the record, you can review and complete the setup for these fields. To do so, skip step 6.

### Steps

1. Click **Connectivity studio - Integration Design**.
2. Click the **Documents** tab.
3. In the list, find and select the desired **Microsoft Word** document.
4. Click **Edit**.
5. In the **Records** section, in the **Record** list, find and select the desired record.
6. Click **New**.
7. As a field name, enter a free-definable name. Usually, this is the name used in the external file. In the **Field name** field, type a value.

> [!NOTE]
> Note
> 
> The value of this field cannot have spaces.
8. As a record table, enter a free-definable name. Usually, this is the name used in the external file. The value, as entered in the **Field name** field, is the default value. You can change this value. In the **Record table field** field, type a value.

> [!NOTE]
> **Note**
> 
> The value of this field cannot have spaces.
9. Indicate if the field is a key field for the record. Select the **Key field** check box.
10. Indicate if the field is mandatory to be filled. If on processing the document, the field has no value and **Mandatory** is set to:

  - **Yes**, an error is given, and the document is not processed.
  - **Warning**, a warning message is given, but the document is processed.
  - **No**, the document is processed.

In the **Mandatory** field, select an option.
11. Set the field length carefully. Make sure the number of characters is sufficient to contain the value. If you set the length too short, the value is truncated. In the **Length** field, enter a number.
12. Define the style to be applied to the field value. Select a style as defined in the template.

In the **Style** field, enter or select a value.
13. Define the type of marker that is used to indicate the position where the field value must be added to the document.

In the **Marker type** field, select an option.
14. Define the marker that is used to indicate the position where the field value must be added to the document. When writing data to the document, the marker is replaced by the field value.

If the marker type is:

In the **Marker** field, type a value.
  - **Text**, enter the text marker that is used in the template. You are advised to use a name between brackets, for example, [RecordName]. Use the full marker, including the brackets, both in the template and here.
  - **Bookmark**, enter the bookmark name as defined in the template. In the template, the bookmark name is preceded by a hashtag (#). In this field, only enter the marker name, without the hashtag.
15. You can add a label above or before the field value. The label to be added is searched for in this sequence: 1. Label ID, 2. Label, 3. Field name.

In the **Word label** field, select an option.
16. If the **Word label** field is set to **Above** or **Before**, define the style to be applied to the label. Select a style as defined in the template.

In the **Label style** field, enter or select a value.
17. If the **Word label** field is set to **Above** or **Before**, you can define the text to be used as the label.

> [!NOTE]
> **Note**
> 
> If a **Label ID** is defined, this label is not used.

In the **Labels** field, type a value.
18. If the **Word label** field is set to **Above** or **Before**, you can define the label to be used. Enter the label code: @[labelID].

In the **Label ID** field, type a value.
19. If the record type is **Paragraph**, define the layout of the data in the paragraph with these fields in the field settings:

Define how the field value must be separated from the previous value.

In the **Break before** field, select an option.
  - **Break before**
  - **Custom separator before**
  - **Break after**
  - **Custom separator after**
20. If the break before is '**Custom**', define a separator to separate the field value from the previous value.

In the **Custom separator before** field, type a value.
21. Define how the field value must be separated from the next value.

In the **Break after** field, select an option.
22. If the break after is '**Custom**', define a separator to separate the field value from the next value.

In the **Custom separator after** field, type a value.
23. Sub-task: Set external references for record.

  1. In the **Line details** section, set the external references for the record.

You can indicate which of the records fields contains the unique ID of the record in the external database. In this way, you link the external ID to the record ID.

In the **External reference** field, enter or select a value.

> [!NOTE]
> **Note**
> 
> Usually, you only use this for an **ODBC** connection with CRM or if you use web services.
  2. You can indicate which of the records fields contains the revision of the record in the external database. In this way, you find and link the latest revision to the record ID.

In the **Revision field** field, enter or select a value.

> [!NOTE]
> **Note**
> 
> You can only use this field in combination with the **External reference** field.
24. Close the page.