Unqork documentation is available in two workspaces: UnqorkAI for the latest AI-first platform, and legacy Unqork for previous versions. Use the drop-down near the logo to switch.

Module Settings

Prev Next

The MCP server is a Beta feature for environments with UnqorkAI. Test each published tool and verify its results before relying on it.

Module Settings is where Creators configure module-level properties, execution behavior, workflow triggers, and access control. For API modules, it also publishes a tool that external AI agents can call.

To open Module Settings, select the EllipsisVertical ellipsis next to a module in the Explorer panel and select Settings from the drop-down.

The settings dialog has the following pages, listed in the left rail: Module Details, Advanced Settings, Workflow Settings, User Permissions, and MCP Settings. MCP Settings displays only for API modules in environments with UnqorkAI.

LayoutList Module Details

Module Details collects the module's identity and metadata. Required fields are noted below.

Setting Description
Module Name The display name of the module in the UnqorkAI platform and the File Explorer tab. Required.
Module Path The URL-safe identifier used in API calls and routing. Click the copy button to copy it to the clipboard. Required.
Module ID Read-only. A system-assigned unique identifier for the module. Click the copy button to copy it to the clipboard.
Module Description A description of the module's purpose. Accepts up to 500 characters.
Runtime The execution runtime for the module. Options: or Vega (2.0). Centauri is the standard runtime. Select Vega for modules that use Vega-only components like iFrame, Image, Menu, Search Select, Simple Select, Vega Table, or Vega Chart.
Module Type Sets the module's execution model. Options include: API, Front-End, or Other (data storage, rerouting, and so on). Selecting API automatically enables Server-side Execution Only on the Advanced Settings page. Selecting Front-End automatically disables it. Required.
Tags Categorization labels for organizing and searching modules. Enter a name to create a new tag, or select an existing one.
Data Models Links the module to data model schemas for component bindings. Models already referenced by a component in this module cannot be removed.
Module Size Read-only. Displays the current size of the module in KB or MB, in both the UnqorkAI platform and Express.

Settings Advanced Settings

Advanced Settings controls execution behavior and Express display options for the module.

General Settings

Setting Description
Load Submissions With Initial Module Version When set to ON, this setting loads submissions using the module version that was active when the submission was first created, instead of the current version.
Enable Stagger Load When set to ON, this setting loads module components incrementally instead of all at once, improving perceived performance for large modules.
Container Components' Propagate "Disabled" to Logic Components When set to ON, this setting prevents logic components inside a disabled container from executing. Applies to Panel, Field Group, and Columns components.
Disable Default Main and Form Regions When set to ON, this setting removes the default main and form HTML regions, letting you define custom container elements with custom role wrappers.

Server-side Execution

Field

Description

Server-side Execution Only

When set to ON, this setting restricts the module to server-side execution only. Creators with Designer permissions can still preview the module in Express. This setting is automatically enabled when Module Type is API and automatically disabled when Module Type is Front-End.

Act as Super-User when server-side executing

When set to ON, this setting executes all server-side calls for this module with super-user privileges, regardless of the role of the caller. Use only when integration tasks require administrative access.

Capture Only Certain Fields in SSE Logs

When set to ON, this setting restricts SSE logs to capture only the request and response body properties specified in the allow-lists below. When set to OFF, the full request and response body is logged. Visible when SSE logging is enabled for the environment.

↳

Allowed Request Body Properties

The request body property paths to include in SSE logs. Enter each path in (for example, data.user.name). If no keys are added, the entire request body is logged. Use the Add Allowed Request Body Property button to add entries. Visible when Capture Only Certain Fields in SSE Logs is ON.

Allowed Response Body Properties

The response body property paths to include in SSE logs. Enter each path in dot notation (for example, result.id). If no keys are added, the entire response body is logged. Use the Add Allowed Response Body Property button to add entries. Visible when Capture Only Certain Fields in SSE Logs is ON.

Express Settings

<DocsHierarchyTable fieldLabel="Setting" rows={[ { field: "Enable Tracker", description: <>When set to ON, this setting activates session tracking for the module and reveals the Track User and Track Value sub-settings.</>, children: [ { field: "Track User", description: <>When set to ON, this setting records the identity of the Creator or end-user interacting with the module. Visible when Enable Tracker is ON.</> }, { field: "Track Value", description: <>When set to ON, this setting records field values during the session. Sensitive data is not obfuscated unless the component's RBAC is set to Obfuscate. Use the Protected Field component for fields that store sensitive information. Visible when Enable Tracker is ON.</> } ] }, { field: "Show Page Title", description: <>When set to ON, this setting displays the Page Title value in the browser tab, appending the workspace site name for context. Required for ADA compliance.</>, children: [ { field: "Page Title", description: <>The text that displays in the browser tab when this module is open in Express. Visible when Show Page Title is ON.</> } ] } ]} />

GitBranch Workflow Settings

Workflow Settings configures validation behavior and navigation triggers for modules used inside a Workflow application.

Validation

Setting Description
Validate On Opening Submission When set to ON, this setting runs field validation when a submission is opened, not only when navigating forward.

Workflow Navigation Triggers

Workflow Navigation Triggers apply only to default Workflow navigation and do not apply to Button components placed in the module. Post Trigger and Post Validate Trigger execute only when navigating forward.

Setting Description
Post Trigger Selects the component to trigger after a Workflow navigation step completes. Options include all components in the current module.
Post Validate Trigger Selects the component to trigger after validation passes when navigating forward in a Workflow. Options include all components in the current module.
Post Save Trigger Selects the component to trigger after the submission is saved during Workflow navigation. Options include all components in the current module.

User Permissions

User Permissions controls who can access this module in Express, using role-based access control (RBAC).

Role-Based Access Control

<DocsHierarchyTable fieldLabel="Setting" rows={[ { field: "Customize RBAC for This Module", description: <>When set to ON, this setting activates module-level RBAC and reveals the Allow Access to Anonymous Users setting and the permissions table below. When set to OFF, only roles with no-access environment permissions are restricted; all other roles have write access by default.</>, children: [ { field: "Allow Access to Anonymous Users", description: <>When set to ON, this setting lets unauthenticated end-users view this module. Customize RBAC for This Module must be ON for this setting to take effect. Visible when Customize RBAC for This Module is ON.</> } ] } ]} />

Module Role-Based Access Control

When Customize RBAC for This Module is ON and roles exist in the workspace, a permissions table displays below the toggles. Each row represents an Express role. Use the Permission drop-down in each row to set the module-level access for that role.

Column Description
Role (Express) The name of the Express role as configured in the workspace.
Permission The permission applied at the module level. Options include: Inherit (uses the role's default permission), No Access, Read-Only, or Write.
Effective Permission The resolved permission for the role, taking module-level and role-default values into account.
Inherited From Indicates whether the effective permission comes from a module-level override (Module) or the role's default settings (Role Defaults).

Bot MCP Settings

MCP Settings publishes an API module as a tool that external AI agents call through the environment's Model Context Protocol (MCP) endpoint. The page displays only for API modules in environments with UnqorkAI. The module must be in Editing mode to change the settings.

Setting Description
How to set up an agent A guide that lists the steps from creating an agent's role to connecting it, with the environment's MCP endpoint and a copyable token request. The guide is open until a role can call the tool.
Agents can call this module as a tool (MCP) When set to ON, this setting publishes the module as a tool. The switch is unavailable until the Build Agent completes the first setup with Set up with Build Agent.
Who can call it Lists the Express roles that can call the tool, and alerts for roles that cannot. The list reads the module's User Permissions page.
Tool The tool's Tool name, Description, Inputs, Outputs, Calls per minute, per agent, and Calls at once, per agent.

For every setting on the page, see MCP Settings. For the steps to set up a tool, including roles, credentials, and tokens, see the Publish API Modules as MCP Tools. For how the MCP server works and its limits, see MCP Server for API Modules.


Changelog

Date Change
2026-11-09 Corrected the Module Name location to the File Explorer tab.
2026-11-05 Linked the MCP Settings reference article from the MCP Settings section.
2026-11-05 Added the MCP Settings page and the Beta callout; renamed the Module Settings section to Advanced Settings to match the dialog.
2026-07-07 Updated access — Module Settings is now opened via the Explorer ellipsis menu.
2026-06-16 Updated H1 to Module Settings; added Vega Table and Vega Chart to Runtime field; language sweep.
2026-06-09 Updated Runtime field to document both Centauri (1.0) and Vega (2.0) options.
2026-06-02 Removed Type column from all tables; integrated Read-only notes into descriptions; Front-End capitalization fix; "etc." → "and so on".
2026-05-28 Added Capture Only Certain Fields in SSE Logs and its sub-settings.
2026-05-27 Initial publication.