Skip to main content

Text attribute

Store a string of text​

A Text attribute can store a single text string containing any number of characters.

Configuration​

When adding or editing a Text 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.

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

  • Min length - the attribute won't accept text with fewer characters than this. If left blank, this is effectively 0.

  • Max length - the attribute won't accept text with more characters than this. If left blank, text is only constrained by database limitations (roughly 16 million characters).

  • Regular expression - the attribute will only accept text that matches the supplied regular expression, e.g. to block special characters, enter ^[A-Za-z0-9\., ]+$

  • Searchable - if disabled, the attribute will be excluded from all searches and AQS queries. Useful for storing sensitive data!

    Important

    This can only be disabled when adding the attribute. It can't be edited afterwards.

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

    Available system tags

    Treat the attribute as:

    • Barcode - each value is rendered as a scannable barcode in Alloy Mobile.

    • Colour - a hexadecimal colour code, e.g. #df412c . Users can choose a value with the colour picker.

    • Email - an email address.

    • FeatureCode - an Asset Management feature code, e.g. designs_bollards. Users can choose a value with a picker, which lets them browse available feature objects by category.

    • Icon - an icon library code, e.g. icon-element-fire . Users can choose a value with the icon picker.

    • Image - a URL to an image. If valid, the image is displayed.

    • Phone - a phone number.

    • Svg - a URL to an SVG. If valid, the SVG image is displayed.

    • Url - a URL to a website. Users can select Open to view the website in a new browser tab.

    • Username - an Asset Management username.

    • 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 start typing in it. Enter or paste in text that meets the configured restrictions.

A Text attribute field