Documentation Index

Fetch the complete documentation index at: https://docs.unqork.io/llms.txt

Use this file to discover all available pages before exploring further.

Smart Component Settings

Prev Next

The Smart Component Settings dialog is where Creators configure a component's name and description. For Query Smart Components, it also includes execution settings and role-based access controls.

Settings can be opened from the following locations:

  • In the Smart Components Hub, hover over a component in the Explorer panel and click the EllipsisVertical (ellipsis) that displays, then select Settings.
  • In the Smart Component Editor, click the EllipsisVertical (ellipsis) in the editor toolbar and select Settings.

Component Details

The Component Details section is available for all Smart Component types.

Field Description
Type The component type: UI, Logic, or Query. Read-only. The type is fixed at creation and cannot be changed.
Component Name The display name for this component. Editable. The internal component ID is fixed at creation and is not affected by renaming.
Description A brief description of what the component does. Optional.
Category The component tray section this component is grouped under in the Module Builder. Select from the fixed set of available categories. Clearing the field places the component under Uncategorized.

Execution Settings

The Execution Settings section is available for Query Smart Components only. It controls how and by whom the query can be executed at runtime.

Backend Execution Only

Setting Description
Backend Execution Only When set to ON, this setting restricts the query to server-side execution only. Front-end modules that attempt to call the query will receive a 403 Forbidden response. Use this setting when the query accesses sensitive data that must not be exposed to the client.

Role Permissions

The Role Permissions section controls which Express roles can execute this query at runtime. Roles not listed in the permissions section default to no access.

To add a role, select it from the Select a role to add drop-down. Only roles that exist in the current environment are available. Each added role can be set to Read access or removed from the list entirely.

Note: If no Express roles are configured in the environment, the drop-down does not display.


Saving

Click Save Changes to apply any updates. The dialog displays a confirmation message when settings are saved successfully.


Changelog

Date Change
2026-08-13 Added Category field to Component Details (EN-8006, PR #8367).
2026-08-11 Initial publication (EN-7975). Documents Component Details and Execution Settings (backendExecutionOnly, role permissions) for Query Smart Components (UQE-16405).