Module Settings

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.

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.

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

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

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

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).

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

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.

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.

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 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).

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.

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).

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).

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.