--- title: "Schema Docs Dashboard Tool" slug: "schema-docs-dashboard-tool" description: "Explore the Schema Docs Dashboard tool to manage schema modules, filter components, and analyze submission data for efficient database management." updated: 2026-04-27T17:24:20Z published: 2026-04-27T17:24:20Z canonical: "docs.unqork.io/schema-docs-dashboard-tool" --- > ## Documentation Index > Fetch the complete documentation index at: https://docs.unqork.io/llms.txt > Use this file to discover all available pages before exploring further. # Schema Docs Dashboard Tool The **Schema Docs Dashboard tool** displays all schema modules in your environment. Schema modules serve as blueprints for the database that stores submission data. The dashboard provides filters to help you find a specific module. After locating a module, view its component information and Submission Data in your browser. This lets you analyze submissions and generate a URL to retrieve data into your Application. The Schema Docs Dashboard provides filters to find schema modules in your environment. Available filters include: - ID - Title After you locate a schema module, view its details. The dashboard displays the module's title and its components with the following information: - Label - Property Name - Type - Required - Comments If your schema module has many components, filter by any of the above options. ### Schema Docs Dashboard Tool Access This tool requires Creators to have specific role access in [Environment Role RBAC](/v1/docs/creator-role-administration) (role-based access control) or [WSRBAC](/v1/docs/workspaces-role-based-access-control-wsrbac) (Workspaces role-based access control). If using [Environment Roles](/v1/docs/creator-role-administration?Highlight=environment%20role) (not using WSRBAC): - Creator roles can view all data in this tool. If using [WSRBAC](/v1/docs/workspaces-role-based-access-control-wsrbac): - Creators can view data related to [modules](/v1/docs/introduction-to-the-module-builder) and [workflows](/v1/docs/introduction-to-workflow) inside Workspaces where they have access. - If a Creator cannot access specific data, they likely do not have access to the [Workspace](/v1/docs/introduction-to-workspaces) containing the module. ## Schema Module Specifications Configure schema modules using Schema Module Specifications. The only extra step is to add a `schema` tag. Then configure all components following Unqork best practices. Schema modules store your data, so include only fields. Do not include Decisions, Calculators, Initializers, or any other Data & Event Processing components. Use the following steps to set up your schema modules. > [!NOTE] > These instructions assume you have a workspace open, saved, and with a title. To create a module in your application: 1. From your Application page, click **+ Create New**. 2. Select **Module**. 3. In the **Module** **Name** field, enter a unique name. The **Module** ***** field populates with a URL-friendly version of the name you enter. 4. From the **Module** **Type*** drop-down, select **Other (data storage, rerouting, etc.)**. 5. In the **Tags** field, enter `schema` and press **Enter** **(Return)** on your keyboard. 6. Click **Create**. 7. **Save** your module. After this setup, configure the rest of your schema module. ## Navigating the Schema Docs Dashboard To view schema module details, use the Schema Docs Dashboard table. By default, the table displays 10 entries. Click the pagination buttons below the table to display more entries. Click the **View** button on the right side of each table entry to see a list of all the components in your module. Below is an example of how the dashboard looks: [![A image showing Schema Docs Dashboard tool screen.](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/Schema_Docs_Tool_SH_thumb_0_0(1).png?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A45Z&se=2026-11-07T18%3A57%3A45Z&sr=c&sp=r&sig=kOjymUBOFAt%2FujjbrqDV28Pm6f3feJOVmWIsT7Q7R10%3D)](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/Schema%20Docs%20Tool%20SH(1).png?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A45Z&se=2026-11-07T18%3A57%3A45Z&sr=c&sp=r&sig=kOjymUBOFAt%2FujjbrqDV28Pm6f3feJOVmWIsT7Q7R10%3D) ## Filtering the Schema Docs Dashboard The dashboard has two filters to help you locate a schema module in your environment. Use any or all filters, depending on how narrow you want the results. As you enter text into the fields, the results display automatically. To clear all fields, click the funnel icon on the far right. The available filters are: | Filter | Description | | --- | --- | | ID | This is your module's module ID. | | Title | This is your module's title. | ## Viewing Your Schema Module After you locate your schema module, click the **View** button on the far right. A new page opens with a list of all the components inside the module. The page also displays the following information related to those components: - The component's Label or Label Text. - The component's Property Name or Property ID. - The component type. - If the component is required. - Any comments added to the component. The following example shows the module's component view: [![A image showing the Schema module components.](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/Schema_Docs_02_thumb_0_0.jpg?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A45Z&se=2026-11-07T18%3A57%3A45Z&sr=c&sp=r&sig=kOjymUBOFAt%2FujjbrqDV28Pm6f3feJOVmWIsT7Q7R10%3D)](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/Schema%20Docs%2002.jpg?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A45Z&se=2026-11-07T18%3A57%3A45Z&sr=c&sp=r&sig=kOjymUBOFAt%2FujjbrqDV28Pm6f3feJOVmWIsT7Q7R10%3D) ### Viewing the Module's Submissions Below your schema module's title, click the **View Submissions** button. The page displays all schema module submissions as unformatted JSON. The URL on this page is an API call following the **Module** **submission** format: `{your-environment}.unqork.io/fbu/uapi/modules/{moduleId}/submissions.` Use this URL in a [Plug-In](/v1/docs/plug-in-component) component's **Source Data URL** field to populate a dashboard, drop-down, or any other component that uses schema data. > [!WARNING] > No matter how many submissions exist in your schema module, only 50 submissions display. You can only call these 50 submissions into your application. The following extract is an example of what you might see after clicking **View Submissions**: [![A image showing extract on clicking View Submissions.](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/Schema_Docs_03_thumb_0_0.jpg?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A45Z&se=2026-11-07T18%3A57%3A45Z&sr=c&sp=r&sig=kOjymUBOFAt%2FujjbrqDV28Pm6f3feJOVmWIsT7Q7R10%3D)](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/Schema%20Docs%2003.jpg?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A45Z&se=2026-11-07T18%3A57%3A45Z&sr=c&sp=r&sig=kOjymUBOFAt%2FujjbrqDV28Pm6f3feJOVmWIsT7Q7R10%3D) > To format the JSON neatly in your browser, you can install a JSON Formatter Chrome extension. Also known as Record Data. Submission data consists of information saved by Unqork components. View submission data by using the angular command, or in Record Collections. Also known as Record Data. Submission data consists of information saved by Unqork components. View submission data by using the angular command, or in Record Collections. Also known as Record Data. Submission data consists of information saved by Unqork components. View submission data by using the angular command, or in Record Collections. A URL (uniform resource locator) is a unique identifier used to locate a resource on the internet. Also known as a web address. In Unqork an application is a program used to perform specific tasks. An application can be one of two types: workflow or module. Label Text conveys what the input component is and what information it displays. Enter the purpose of the corresponding component or field. A Property ID is the unique field ID used by Unqork to track and link components in your module. Also known as Unqork Users, or Designer Users; is anyone who is inside the Unqork platform. RBAC (Role-Based Access Control) is a method to control system access for authorized users. The role in RBAC refers to the levels of access employees have to a network. RBAC (Role-Based Access Control) is a method to control system access for authorized users. The role in RBAC refers to the levels of access employees have to a network. WSRBAC (Workspaces Role-Based Access Control) is a method to control user access to a workspace. Users must be assigned to a workspace using WSRBAC before they can view or edit applications and modules inside the space. Also known as Unqork Users, or Designer Users; is anyone who is inside the Unqork platform. Pagination is the process of separating content into individual pages. Label Text conveys what the input component is and what information it displays. Enter the purpose of the corresponding component or field. A Property ID is the unique field ID used by Unqork to track and link components in your module. JSON (JavaScript Object Notation) is an open standard file and data interchange format. Unqork uses JSON for submission (record) data. APIs (application programming interfaces) are a set of protocols and definitions developers use to build and integrate application software. APIs act as the connective tissue between products and services. Also known as Record Data. Submission data consists of information saved by Unqork components. View submission data by using the angular command, or in Record Collections. ## Related - [Introduction to the Unqork Development Life Cycle Toolkit](/introduction-to-the-unqork-development-life-cycle-toolkit.md)