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 (role-based access control) or WSRBAC (Workspaces role-based access control).

If using Environment Roles (not using WSRBAC):

• Creator roles can view all data in this tool.

If using WSRBAC:

• Creators can view data related to modules and workflows inside Workspaces where they have access.

• If a Creator cannot access specific data, they likely do not have access to the Workspace 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.

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 path* 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:

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:

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:

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 GET Module submission format: {your-environment}.unqork.io/fbu/uapi/modules/{moduleId}/submissions.

Use this URL in a Plug-In component's Source Data URL field to populate a dashboard, drop-down, or any other component that uses schema data.

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:

To format the JSON neatly in your browser, you can install a JSON Formatter Chrome extension.