Skip to main content

AQS attribute

Store an AQS query​

An AQS attribute can store a single AQS query in JSON format.

Configuration​

When adding or editing an AQS attribute on a design/interface, you can configure the following properties. These determine how the attribute will behave when users populate its value on corresponding items.

  • Code (read-only) - the attribute's Global Unique Code (Guc) identifier.
  • Name * - enter a distinct name that clearly identifies the attribute.
  • Description - describe what the attribute represents and how it's intended to be used. This helps users and AI agents to understand its purpose.

  • Required - if enabled, the attribute must be populated before an item can be saved. It can't be left blank!

  • Read-only - if enabled, the attribute can only be populated when creating items. It can't be edited afterwards!

  • Unique - if enabled, the attribute only accepts values that aren't already stored in other items of the design/interface.

  • Allowed query types - the attribute will only accept AQS queries that use one of the selected root nodes.

  • Design or interface - the attribute will only accept AQS queries that target the chosen design/interface.

  • Attributes - use the Pathfinder to select one or more attributes from the chosen design/interface. The attribute will only accept AQS queries that include these selected attributes.

  • Default value - the attribute is automatically populated with this value. It can usually be changed before saving, unless the attribute is also Read-only or excluded from an item form.

  • Tags - use the Tag Manager to assign custom tags or a relevant system tag.

    Available system tags

    • RequiredOnTaskStatus[Completed/Cancelled] - only relevant if the design/interface implements the Tasks interface. The attribute becomes required when a task's status changes to Completed/Cancelled.

    • ActionParameter[Dynamic] - for internal use only. Marks the attribute as a configurable parameter on a workflow action.

  • AQS agent enabled - if disabled, the attribute is excluded from AI agent queries.

Populate the attribute on items​

When creating or editing an item, select the attribute to open the AQS Builder. Build your query visually, load a saved query or enter AQS code.

An AQS attribute field
Building a query with the AQS Builder