Module Settings

Module Name*                                                                            

The name of your module. You can use this field to rename your module after you've created it.

A Module Name is required to save changes.

Module Path*                                                                            

The path of your module. You can use this field to edit your module path after you've created it. Click Copy to copy your module path.

A Module Path is required to save changes.

Module ID

The unique identifier of your module. Click Copy to copy your module ID.

You cannot change the module ID once the module has been created.

Module Description                                                                            

Add a module description in this field to make it easier to onboard team members or hand off projects.

Module Type*                                                                            

The type of function this module is designed for. Module types include:

• API: An API-type module includes preconfigured components that meet Unqork API specifications for server-side/remote execution. An API tag is also added by default to ensure the module displays in the API Docs Dashboard tool. When creating an API-type module, the Server-Side Execution setting is set to (ON) by default, and disabled. Disabling this setting promotes security best practices.

• Front-End: A Front-End-type module is an  element built for user interfaces. When creating a Front-End module, the Server-Side Execution setting is set to (OFF) by default, and disabled. Disabling this setting ensures this module type is always accessible in Express View.

• Other: An Other-type module is for module elements that aren’t considered Front-End or API modules. This module type includes modules used for storing data, rerouting data, and so on. When creating an Other-type module, the Server-Side Execution setting is set to (OFF) by default. With Other-type modules, you can choose to set the Server-Side Execution setting to (ON).

Tags                                                                            

Create or select tags for your module. Tags are optional but can help you locate specific modules in your environment.

Data Models                                                                            

Add or remove Data Models from your module. Only Data Models in your current workspace are accessible. A Data Model cannot be removed from a module if there are components bound to fields in it.

Module Size                                                                            

The size of the module configuration in the Unqork database. This field does not include the size of any Automatically Referenced Imported Modules, as they are imported on load.

Modules greater than 8 MB in size cause performance issues with the Real-Time Configuration Analysis tool.

When the Enable Translations setting toggle is set to (ON), the module size is also dependent on the size of your translations information.

Module Size in Express                                                                            

The size of the module that loads in Express View. This field includes all Automatically Referenced Imported Modules.

When the Enable Translations setting toggle is set to (ON), the module size is also dependent on the size of your translations information.

Load Submissions With Initial Module Version                                                                            

Set the Load Submissions With Initial Module Version toggle to (ON) to allow older submissions that track data to load in your dashboard in Express View. Enable this setting if you want to continue displaying submission data that you no longer track. For example, let's say you have a module that collects data from the end-user that displays in a dashboard. The data consists of Name, Age, and Occupation. Later, you decide to stop tracking the age of your end-user but still want to display previously collected age data.

By default, the Load Submissions With Initial Module Version toggle is set to (OFF).

Enable Stagger Load                                                                            

Enable this setting to prevent hidden components from being loaded into the module until displayed.  Doing so improves loading performance for larger modules containing many components that are hidden on load.

When set to (ON), components remain hidden and do not trigger until displayed. These components include those with Hide Field set to (ON) or when a logic component controls another component with a hidden Output Type.

By default, the Enable Stagger Load setting is set to (OFF).

Container Components' Propagate "Disabled" to Logic Components                                                                            

Enabling this setting controls whether the Disable Execution setting for logic components inside container components is set or ignored when the container component is disabled. For example, let's say you have a logic component inside a Panel component. If the Container Components' Propagate "Disabled" to Logic Components setting is set to (ON) , and the Panel component is disabled, that logic component doesn't execute.

By default, the Container Components' Propagate "Disabled" to Logic Components toggle is set to (OFF).

Container components consist of Columns, Panel, and Field Group components.

Disable default main and form regions                                                                            

For accessibility purposes, defining regions on a page is crucial, especially for users of screen readers. It helps them understand the page structure, identify where they are on the page, and avoid repetitive content where possible. The <main> region represents the primary content, so screen readers navigate to it and avoid re-reading headers and navigation.

Unqork automatically wraps every application module with <main> and <form> tags to support semantic structure. But, sometimes a module acts as a navigation menu or a footer, or it might contain multiple regions. Disabling the default <main> and <form> tags lets you define page regions to control the layout for screen readers. This provides more flexibility while supporting accessibility best practices.

By default, this setting is set to (OFF).

Server-side Execution Only                                                                            

Set the Server-Side Execution Only toggle to (ON) to remote execute this module on the Unqork server. Creators often use SSE, or remote executes to increase security. When enabled, you cannot view this module in Express View. Instead, use the Server Side Execution Testing tool to test and view your remote execute.

By default, the Server-side Execution Only toggle is set to (OFF).

The API service and the module using the service must have the same execution method. To learn more, view our Services Administration article.

The Server Side Execution Only toggle enables HTTP status code outputs in API modules. To learn more about HTTP Output, view our HTTP Status Codes article.

Act as Super-User When Server-Side Executing                                                                            

Set the Act as Super-User When Server-Side Executing toggle to (ON) to allow Super-User permissions to server-side executions. Super-User permissions override all other permissions.

Use this option carefully as it gives non-administrative users higher privileges to perform functions in the module.

Enable Tracker                                                                            

Set the Enable Tracker toggle to (ON) if you want to track where end-users click and how much time they spend on each component. You can also track values and changes to a component's values.

You can set up a Business Intelligence (BI) Connector to access this data for analytics purposes. As an Administrator, you can also access the tracked information using the tracker endpoint: https://{NAME_OF_ENVIRONMENT}.unqork.io/fbu/uapi/tracker/submission/{SUBMISSION_ID}.

To learn more about setting up a BI Connector in Unqork, see our Accessing Your Data Using MongoDB Connector for Business Intelligence (BI) article.

By default, the Enable Tracker toggle is set to (OFF).

Track User                                                                                

After enabling the Enable Tracker toggle, set the Track User toggle to (ON) to track where end-users click and how much time they spend on each component.

By default, the Track User toggle is set to (OFF).

Track Value                                                                                

After enabling the Enable Tracker toggle, set the Track Value toggle to (ON) to track values and changes to a component's values.

By default, the Track Value toggle is set to (OFF).

Track Value only applies to components that have the Store Data in Database toggle set to (ON).

Show Page Title                                                                            

Set the Show Page Title toggle to (ON) to open the Page Title field so you can enter the text that displays in the current page's browser tab. Doing so provides context for the end-user and is required to meet ADA compliance.

By default, the Show Page Title toggle is set to (OFF).

Validate on Opening Submission                                                                        

When set to (ON), validation errors display when an end-user arrives at the module. Before entering any information, red text displays next to the required fields to notify the end-user that they must complete these fields before proceeding. When set to (OFF), your module validates data when end-users click the workflow's Next button. If required information is missing, end-users are prompted to complete the fields before proceeding.

By default, the Validate on Opening Submission toggle is set to (OFF).

Post Trigger                                                                        

Select a logic component to trigger after the end-user clicks the workflow's Next button.

Post Validate Trigger                                                                        

Select a logic component to trigger when module fields are valid.

Post Save Trigger                                                                        

Select a logic component to trigger when module fields are valid, and the end-user clicks the workflow's Save and Exit button.

Role (Express)                                                                        

The Express role.

Permission                                                                        

The permission for the corresponding Express role. Permissions include:

• Inherit: Inherit means that the role's access in this module is the same as at the environmental level.

• No Access: Your end-user has no access to your application.

• Read-Only: Your end-user can view but cannot write or engage with your application.

• Write: Your end-user has full access to write and engage with your application.

Effective Permission                                                                        

Confirmation of the selected permission from the Permission drop-down.

Inherited From                                                                        

If the permission is Inherit, this column displays where the permission was inherited from.

Cache this Module to Allow for Offline Access                                                                        

When the Cache this Module to Allow for Offline Access toggle is (ON), the module caches for offline use. Before going offline, be sure to open your application in Express View. using Express View must navigate to the associated URL for their module to cache. Once you enable offline access and open the module in your browser, you can begin using your application offline.

By default, this setting is set to (OFF).

When you enable offline access, the following settings disable:

• Load Submissions with Initial Module Version

• Server Side Execution Only

• Act as Super-user when Server Side Executing

• Enable Tracker