Module Settings

 

Overview

In a Module Settings modal A modal is a window that appears on top of the content you are currently viewing., you can view or edit module details, settings, configure workflow triggers, and assign user permissions. Adjusting your module's settings lets you make decisions about performance, event tracking, server-side execution, and 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.

Below are the different tabs available in the Module Settings modal:

Tab Description

Module Details

This tab contains the basic module information where you can configure the Module Name, Path, Description, and Type. You can also use this tab to assign tags and a Data Model to the module.

Module Settings

This tab lets you determine 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. calls and shape how each module behaves.

Some settings are unavailable depending on the module type you create.

Workflow Settings

This tab includes module-specific settings that let you control how navigation impacts modules in your workflow. Use this feature to trigger logic components, like Initializer and Decisions components, when:

User Permissions

This tab lets you tab determine what users can access or modify the module.

Accessing Module Settings

To access Module Builder Settings:

1. Open your module in the Module Builder.
2. Click the ··· (ellipsis) button.
3. Select Module Settings.

A static image displaying how to access the Module Settings from the Module Builder ellipsis.

Module Settings

Click the tabs below to explore the various Module Settings.

Module Details

This section explores the Module Details tab 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 & Close.

A static image displaying the Module Info section of the Module Settings.

Attribute Description

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

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

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

 

Resources