Module Settings

Estimated Reading Time: 2 minutes

Overview

In a module's Settingsmodal A modal is a window that appears on top of the content you are currently viewing., you can view or edit module details, settings, and User Permissions. The Module details page includes the name, path, description and module type. The User Permissions page displays who can access or modify the module. Finally, the Settings page you choose how your module interacts with API 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. (application programming interfaces) calls and shape how each module behaves. Adjusting your module's settings lets you make decisions about:

Performance
Server-side Execution
Event tracking
Browser tab display

Once you create your module, you can enable or disable any of its settings anytime. It's important to note that these settings are module-specific. If you have a workflow that uses three modules, you must match the settings for all three modules.

Accessing Module Settings

To access Module Builder Settings:

Open your module in the Module Builder.

Click the ··· (ellipsis) button.

Select .

Module Settings

The Module Settings modal contains Module Details, Module Settings, and User Permissions.

Module Details

This section explores the Module Details of the Module Settings modal A modal is a window that appears on top of the content you are currently viewing.. After making adjustments to the modal, click Save.

Attribute	Description
Module Name*	The name of your module. You can use this field to rename your module after you've created it. NOTE 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. NOTE A Module Path is required to save changes.
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 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. FE 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. O 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 locate specific modules in your environment.
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. NOTE Modules greater than 8 MB in size cause performance issues with the Real-Time Configuration Analysis tool. NOTE 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 Express View is how your end-user views you application. Express View also lets you preview your applications to test your configuration and view the styling. This is also the view your end-users will see when interacting with your application. After configuring a module, click Preview in the Module Builder to interact with the module in Express View.. This field includes all Automatically Referenced Imported Modules. NOTE When the Enable Translations setting toggle is set to (ON), the module size is also dependent on the size of your translations information.

Setting	Description
Load Submissions With Initial Module Version	Set the Load Submissions With Initial Module Version toggle to (ON) to allow older submissions that track age 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 End-users, also known as Express Users, are the individuals accessing an application through Express View. In most cases, end-users are the customers using the product. 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. NOTE 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). TIP Container components consist of Columns, Panel, and Field Group components.

Setting	Description
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). NOTE The API service and the module using the service must have the same execution method. To learn more, see our Services Administration article. TIP The Server Side Execution Only toggle enables HTTP status code outputs in API modules. To learn more about HTTP Output, visit 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. WARNING Use this option carefully, as it gives non-administrative users higher privileges to perform functions in the module.

Setting	Description
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}. TIP 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). NOTE Track Value only applies to components that have the Store Data in Database toggle set to (ON). To learn more about this setting, search for your component on our Documentation Hub.
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).

User Permissions

This section explores the User Permissions section of the Module Settings modal. After making adjustments to the modal, click Save.

TIP To learn more about Module User Permissions, view our Module Permissions article.

Setting	Description
Customize RBAC for This Module	When set to (ON), you can customize module and component access for each of your roles. By default, the Customize RBAC for This Module toggle is set to (ON).
Allow Access to Anonymous Users	When set to (ON), unauthenticated end-users can access this module without logging in. Unauthenticated or anonymous means the end-user doesn't have to be registered in Unqork. When an anonymous end-user navigates to your module, they receive a temporary token. Using this token, anonymous end-users can view the module in Express View. By default, the Allow Access to Anonymous Users toggle is set to (OFF).

Setting

Description

Customize RBAC for This Module

When set to (ON), you can customize module and component access for each of your roles.

By default, the Customize RBAC for This Module toggle is set to (ON).

Allow Access to Anonymous Users

When set to (ON), unauthenticated end-users can access this module without logging in. Unauthenticated or anonymous means the end-user doesn't have to be registered in Unqork. When an anonymous end-user navigates to your module, they receive a temporary token. Using this token, anonymous end-users can view the module in Express View.

By default, the Allow Access to Anonymous Users toggle is set to (OFF).

Module Role-Based Access Control

When the Customize RBAC for This Module toggle is set to (ON), you can adjust permissions for specific roles in your module. The modal displays roles and permissions in the following grid:

Attribute	Description
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.