# Doc: https://www.hipaatizer.com/docs/form-builder/variables

> LLM view for https://www.hipaatizer.com/docs/form-builder/variables

This file contains all documentation content in a single document following the llmstxt.org standard.

## Variables

## Using Variables in HIPAAtizer

HIPAAtizer supports the use of **variables** to dynamically insert values into various parts of your form ecosystem, including:

- Web forms
- Printable forms
- Success pages
- Notification emails
- Webhooks
- Secure messages
- External integrations

---

## Form Variables

When you add a component to a form, its **Unique Name** automatically becomes a form variable. These variables represent the values entered by the user during form submission.

:::info Example
A component with the Unique Name `firstName` can be used as a variable:
`${firstName}` → renders the value the user entered in that field.
:::

:::tip Using Variables in Paragraphs
You can use **form variables** inside [**Paragraphs**](https://www.hipaatizer.com/docs/form-builder/variables/components/paragraph-text) or [**Checkboxes**](https://www.hipaatizer.com/docs/form-builder/variables/components/checkbox) to dynamically display information on the form.

For example, including `${date-today}` in a paragraph will render the **current date** during preview and when the form is filled out.

You can insert any available variable, including:
- **System variables** like `${date-today}`
- **Component variables** based on **Unique Names**, such as `${firstName}` or `${appointmentDate}`
:::

### Extended Variables

Some components expose additional sub-fields through **extended variables**. For example:

**Address Component Variables**
- `${address}` - full address string
- `${address.street}`
- `${address.streetNumber}`
- `${address.streetName}`
- `${address.street2}`
- `${address.city}`
- `${address.state}`
- `${address.zipcode}`
- `${address.country}`

:::tip
Use clear and unique component names to avoid confusion when referencing variables.
:::

---

### Built-in Form Variables

These variables are either always available or conditionally available based on form configuration or submission status.

:::danger Important
Some variables (like `${submissionId}`) are only available after the form is partially or fully submitted.
:::

| **Variable Name**         | **Syntax**                 | **Description**                                  |
|--------------------------|----------------------------|--------------------------------------------------|
| **Form Name**             | `${form-name}`             | The name of the current form.                    |
| **Increment**             | `${increment}`             | A unique auto-incremented ID for the submission. [¹](#note-1) |
| **Location Title**        | `${locationTitle}`         | The title of the selected form location.         [²](#note-2) |
| **Location Address**      | `${locationAddress}`       | The full address of the selected location.       [²](#note-2) |
| **Location Email**        | `${locationEmail}`         | Email address associated with the location.      [²](#note-2) |
| **Location Phone**        | `${locationPhone}`         | Phone number associated with the location.       [²](#note-2) |
| **Submission ID**         | `${submissionId}`          | Unique ID for the current submission.            [¹](#note-1) |
| **Form Submission Limit** | `${form-submission-limit}` | The maximum number of allowed submissions.       [³](#note-3) |

---

***Annotations***

- [¹] Available only after the submission is partially or fully completed.
- [²] Available if the form or submission is associated with a location.
- [³] Available only if a submission limit is enabled for the form.

---

## System Variables

HIPAAtizer also provides predefined **system variables**, grouped by context. These are automatically populated and do not require user input.

---

### 📂 Profile Variables

| **Variable Name**              | **Syntax**                        | **Description**                             |
|-------------------------------|-----------------------------------|---------------------------------------------|
| Profile Business Name         | `${profile-business-name}`        | The organization or business name.          |
| Profile Business Address      | `${profile-business-address}`     | Primary address line 1.                     |
| Profile Business Address 2    | `${profile-business-address2}`    | Secondary address line 2.                   |
| Profile Business City         | `${profile-business-city}`        | Business city.                              |
| Profile Business State        | `${profile-business-state}`       | Business state or province.                 |
| Profile Business Zip          | `${profile-business-zip}`         | Postal/ZIP code.                            |
| Profile Business Phone        | `${profile-business-phone}`       | Business phone number.                      |
| Profile Business Fax          | `${profile-business-fax}`         | Business fax number.                        |
| Profile Business Email        | `${profile-business-email}`       | Contact email for the business.             |

---

### 📅 Date Variables

| **Variable Name**           | **Syntax**                    | **Description**                                 |
|----------------------------|-------------------------------|-------------------------------------------------|
| Date Today                 | `${date-today}`               | Renders the current date.                       |
| YYMMDDHHMMSS               | `${YYMMDDHHMMSS}`             | Compact date-time stamp (e.g., `240528153022`). |
| MMDDYYHHMMSS               | `${MMDDYYHHMMSS}`             | Alternative compact date-time format.           |
| DDMMYYHHMMSS               | `${DDMMYYHHMMSS}`             | Alternative compact date-time format.           |
| MM-DD-YYYY                 | `${MM-DD-YYYY}`               | Date in dash-separated format.                  |
| MM.dd.yyyy HH.mm           | `${MM_DD_YYYY_HH_mm}`         | Date-time in dot-separated format.              |
| Previous Year              | `${previousYear}`             | Last calendar year (e.g., `2024`).              |
| Time Now                   | `${time-now}`                 | Current time only (e.g., `03:30 PM`).           |
| Submission Created Date    | `${submission-created-date}`  | Date the submission was initially started.      |

---

### 🔗 Link Variables

| **Variable Name**                   | **Syntax**                                 | **Description**                                        |
|------------------------------------|--------------------------------------------|--------------------------------------------------------|
| View Submission Link               | `${viewSubmissionLink}`                    | Opens the submitted form in view mode. [⁴](#note-4)    |
| Edit Submission Link               | `${editSubmissionLink}`                    | Link to edit the current submission. [⁴](#note-4)      |
| Download PDF Link                  | `${downloadPdfLink}`                       | Direct download link to the submission PDF. [⁴](#note-4) |
| Download Access Log Link           | `${downloadAccessLogLink}`                 | PDF link to access history (who opened the form). [⁴](#note-4) |
| Download Merged PDF Link           | `${downloadMergedPdfLink}`                 | PDF with merged forms in packets (if applicable). [⁴](#note-4) |
| Download CSV Link                  | `${downloadCsvLink}`                       | Submission data as CSV. [⁴](#note-4)                   |
| Download Merged CSV Link           | `${downloadMergedCsvLink}`                 | Packet data exported as a single CSV. [⁴](#note-4)     |
| Download Attachments Link          | `${downloadAttachmentsLink}`               | ZIP of all uploaded files from the submission. [⁴](#note-4) |
| Next Step Link                     | `${nextStepLink}`                          | URL to the next workflow step. [⁵](#note-5)            |
| Notification Template Settings Link| `${formSettingsNotificationTemplateLink}`  | Link to notification template settings in the form builder. [⁴](#note-4) |
| Submissions Filtered Table Link    | `${submissionsFilteredTableLink}`          | Pre-filtered link to view submissions in the dashboard. [⁴](#note-4) |
| Current Workflow URL               | `${currentWorkflowLink}`                   | URL of the current workflow step. [⁵](#note-5)         |

---

***Annotations***

- [⁴] These links are only accessible to **logged-in users** with permission to view the form or submission.
- [⁵] These variables are only available when the form is part of a **form packet** within a multi-step workflow.