> For the complete documentation index, see [llms.txt](https://docs.biscit.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.biscit.com/ekr-user-guide/configuration/administration/format-masks.md).

# Format Masks

Format masks define the structure of your Proposal and Agreement numbers.

The Format Masks configuration screen allows users to set the automatic naming and numbering convention for EKR proposals and agreements. This ensures consistency across all Proposals and Agreements, making then easy to identify and quote.

{% hint style="info" %}
This screenshot displays the Format Masks configuration screen with the Proposal tab active
{% endhint %}

<figure><img src="https://3143154457-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFuMjREj8WHcxhf8dRWZN%2Fuploads%2F03WSFSCbhOKDw0dkkXms%2Fimage.png?alt=media&amp;token=f86f2281-7dd6-464e-a836-bd91193934c0" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
This screenshot displays the Format Masks configuration screen with the Agreement tab active
{% endhint %}

<figure><img src="https://3143154457-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFuMjREj8WHcxhf8dRWZN%2Fuploads%2Fn0Yp7x4ROgzS5E4BbvtW%2Fimage.png?alt=media&amp;token=e166b6c8-a6b5-4576-8a30-fee0b28650ea" alt=""><figcaption></figcaption></figure>

### Interface Components

#### 1. Record Type Selection

Tabs at the top of the screen allow you to switch between different record types:

* **PROPOSAL:** Configures the ID format for sales proposals.
* **AGREEMENT**: Configures the ID format for agreements.

#### 2. Preview Panel

Located at the top of the configuration area, this panel provides real-time feedback on your changes:

* Current Proposal/Agreement: Displays the ID of the most recently generated proposal.
* New Proposal/Agreement: Shows a preview of what the *next* proposal ID will look like based on the current settings in the "Selected Options" list.

#### 3. Configuration Columns

* Available Options (Left): A list of data elements that can be added to the mask.
* Selected Options (Right): The active elements currently constructing the ID. The order of these blocks (top to bottom) corresponds to the structure of the ID string (left to right).

### How to Configure the Mask

To build a Format Mask, organize the Selected Options stack. You can customize specific parameters within each block.

#### Management Controls

* Reorder: Use the Green Arrows (↑ ↓) to change the position of an element within the ID string.
* Remove: Click the Red X to remove an element from the mask.

#### Field Definitions

| **Element Type**      | **Field**              | **Description**                                                                                                      |
| --------------------- | ---------------------- | -------------------------------------------------------------------------------------------------------------------- |
| Text                  | Text                   | Defines a static prefix or suffix. In the example shown, "P" is used to denote "Proposal."                           |
| Date (Day/Month/Year) | Delimiter Before/After | Allows you to insert separators (such as hyphens `-` or slashes `/`) immediately before or after the date component. |
| Number                | Next Number            | The starting number for the next record generated.                                                                   |
|                       | Leading Zeros          | Determines the padding of the number (e.g., setting this to '2' ensures numbers display as '01', '02', etc.).        |
|                       | Increment By           | Determines the step count for each new record (usually set to 1).                                                    |
|                       | Delimiter Before/After | Inserts a separator between the sequence number and the previous element.                                            |

To configure **Format Masks**, refer to our **How to Configure Format Masks** guide.

{% content-ref url="/pages/yXab5kOiEibJmFG4N3Tx" %}
[How to Configure Format Masks](https://docs.biscit.com/ekr-user-guide/how-to/how-to-configure-format-masks.md)
{% endcontent-ref %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.biscit.com/ekr-user-guide/configuration/administration/format-masks.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
