Getters

Getters are read-only properties built into every module's submission data object. They expose platform-level information: environment details, user session data, URL parameters, and validation state. No component write or storage is required.

You can reference getters anywhere a Property ID is accepted: component inputs and outputs, Data Workflow nodes, Calculator formulas, and Plug-In component mappings. Use to access a nested property (getEnv.CUSTOMER, currentUser.email).

Available Getters

Getter	Description
`currentUser`	Profile of the end-user currently viewing the module. See currentUser Properties below.
`getBrowser`	Browser connectivity status. Returns `{: true }` or `{: false }`. Used with Offline Mode to make connectivity-based decisions.
`getEnv`	Environment configuration for the current application. See getEnv Properties below.
`getMetadata`	Module metadata. Stores key/value pairs that are not part of the submission data object and are not persisted to the database.
`getModuleFields`	Component definitions for the current module. Returns the same data as the module JSON definition. Legacy alias; equivalent to `@getModuleInSlot('main')` in the current platform.
`getSubmissionFields`	Submission-level identifiers. See getSubmissionFields Properties below.
`integratorErrors`	Integration error details returned from API calls. Specific to Plug-In components and API-connected workflows.
`validationErrors`	Validation error details for all components that failed validation. Not API-specific.
`vars`	Global variables defined in Administration > Global Variables.
`_getData`	All current submission data. Accessing individual component values with `_getData.key` is deprecated; reference the Property ID directly instead.
`_query`	URL query parameters passed to the module. Standard Property ID references cannot read URL parameters; `_query` can.

Referencing getModuleFields without a specific property causes significant performance slowdown that worsens as the module grows. When the reference is unqualified, the watcher fires on every module change: component visibility changes, value updates, and all other runtime events. Always reference the specific property needed: use getModuleFields._id instead of getModuleFields alone.

currentUser Properties

The currentUser getter contains the profile of the end-user viewing the module. Reference individual properties with dot notation: currentUser.email.

Property	Type	Description
`userId`	String	The end-user's unique ID in the platform.
`email`	String	The end-user's email address.
`name`	String	The end-user's display name.
`role`	String	The end-user's primary role (`Administrator` or `Anonymous`).
`expressRoles`	Array	All Express Roles assigned to the end-user.
`groups`	Array	Groups the end-user belongs to.
`applicationRoles`	Object	Application-specific roles, keyed by application ID.
`isAdmin`	Boolean	Whether the end-user has Administrator access.
`isServiceUser`	Boolean	Whether the account is a service account rather than a human end-user.
`isUserLocked`	Boolean	Whether the account is currently locked.
`locale`	String	The end-user's locale setting (for example, `en-US`).
`created`	String	ISO 8601 timestamp of when the account was created.
`modified`	String	ISO 8601 timestamp of when the account was last modified.
`lastLogin`	String	ISO 8601 timestamp of the end-user's most recent login.
`ip`	String	IP address of the end-user's current session.

getEnv Properties

The getEnv getter contains environment configuration set at the platform level. Reference individual properties with dot notation: getEnv.CUSTOMER.

Property	Description
`CUSTOMER`	The customer name for this environment (for example, `acme`).
`ENVIRONMENT_GROUP`	The environment tier: `development`, `staging`, or `production`.
`NODE_ENV`	The Node.js runtime environment. Typically `production` for all hosted environments.
`REMOTE_ROOT`	The base URL of the environment (for example, `https://app.acme.unqork.io`).

The environment may include additional properties beyond those listed here depending on platform configuration. The four properties above are consistently available across all environments.

Example: To conditionally show a component in production, set a Decision component's condition to getEnv.ENVIRONMENT_GROUP === "production".

getSubmissionFields Properties

The getSubmissionFields getter contains identifiers written by the platform when a submission is created or saved.

Property	Description
`id`	Unique identifier for this submission record.
`moduleId`	The ID of the module this submission belongs to.
`userId`	The ID of the end-user who created or last modified the submission.
`created`	ISO 8601 timestamp of when the submission was first created.
`modified`	ISO 8601 timestamp of when the submission was last saved.

How to Reference a Getter

Reference any getter directly by its name as a Property ID, or use dot notation to access a nested property:

Reference	Returns
`getEnv`	The full `getEnv` object
`getEnv.CUSTOMER`	The customer name string
`currentUser.email`	The current end-user's email address
`currentUser.expressRoles`	Array of roles assigned to the end-user
`getSubmissionFields.userId`	The current end-user's ID
`_query.redirectUrl`	The `redirectUrl` URL parameter

To inspect all getter values in a running module, open the submission in Express View. Right-click the page, select Inspect, and open the DevTools Console. The submission data object lists every getter and its current value.

Changelog

Date	Change
2026-10-05	Initial publication — full getter reference sourced from platform runtime code, including currentUser property table. Added getModuleFields performance warning (EN-8187).