---
schema_version: "1"
id: e9a1c4d0a2cbb929c29692a44fb9ee5c0036e2ee7952176149c0be0c356fc20d
title: ui.json Attributes
collection: developer
version: current
locale: en-us
portal_url: https://docs.salesforce.com/developer/current/en-us/analytics/bi_dev_guide_wave_templates/guides/reference/bi-templatesdev-ui-json-attributes.md
canonical_url: https://developer.salesforce.com/docs/analytics/bi-dev-guide-wave-templates/guide/bi-templatesdev-ui-json-attributes.html
source_site: developer.salesforce.com
content_type: documentation
content_hash: 44985a61ded72ef1090657a92fc65793a00da114f76787d54d7ff660e6198889
products:
  - Analytics Templates Developer Guide
  - analytics
---

# ui.json Attributes

The `ui.json` file attributes are:

| Attribute                            | Required                    | Description                                                                                                 |
| ------------------------------------ | --------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `pages`                              | No                          | Container attribute only - array of UI pages to be displayed.                                               |
| `pages` → `title`                    | Yes                         | String title to be displayed at the top of the page.                                                        |
| `pages` → `variables`                | Yes                         | Array of variables to display on a page, 1 variable is necessary.                                           |
| `pages` → `variables` → `name`       | Yes                         | Variable name, must match name of variable defined in variables.json.                                       |
| `pages` → `variables` → `visibility` | No                          | Variable visibility (visible, disabled, hidden) defined by conditional.                                     |
| `pages` → `condition`                | No                          | If condition is met, then the page will display; if the condition is not met, the page will not display.    |
| `pages` → `helpUrl`                  | No                          | URL provided by template dev to additional content to help user with creating app.                          |
| `pages` → `vfPage`                   | No                          | Container attribute only: defines the VisualForce Page to customize this page.                              |
| `pages` → `vfPage` → `name`          | Yes                         | The name of VisualForce class to use.                                                                       |
| `pages` → `vfPage` → `namespace`     | Yes, if org uses namespace. | The namespace for the org.                                                                                  |
| `displayMessages`                    | No                          | Container attribute only - array of custom display message, currently only 1 `displayMessage` is supported. |
| `displayMessages` → `text`           | Yes                         | Text to display on the app creation progress landing page (running Astro page).                             |
| `displayMessages` → `location`       | Yes                         | `“AppLandingPage”` is only supported location.                                                              |

**See Also**

- [Edit ui.json](https://developer.salesforce.com/docs/analytics/bi-dev-guide-wave-templates/concept/bi-templatesdev-edit-ui-json.md)