Skip to main content

Number attribute

Store an integer or decimal number​

A Number attribute can store a single number to any amount of decimal places.

Configuration​

When adding or editing a Number 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 - the attribute won't accept a value smaller than this number.

  • Max - the attribute won't accept a value larger than this number.

  • Decimal places * - enter the desired amount.

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

    Available system tags

    Treat the attribute as:

    • Currency - an amount of local currency, determined by your company project.

    • Percentage - a decimal between 0 and 1.

    • Bytes - a size in bytes.

    • AutoIncrement - a number that increments automatically per item. See below for details.

    • 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 or 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 a number that meets the configured restrictions.

A Number attribute field

Auto increment​

A design may benefit from having an incrementing Number attribute, which is set automatically for each item. This can be added as a variable in the design's title/subtitle for easy identification.

For example, all jobs have an automatic Job Number attribute inherited from the standard Jobs interface, which is displayed in each job item's title.

An example job item showing its Job Number attribute in the title

To enable this behaviour when adding or editing a Number attribute on a design/interface:

  1. Select its Tags property and assign the AutoIncrement tag.

  2. Enable Required and Unique to ensure no items can receive the same number.

  3. Set Decimal places and Min to 0. Leave Default value and Max blank.

  4. Select Save to finish.

From now on, the attribute will be set automatically, so it won't be shown when creating or editing items.

Existing items will receive the attribute when they're next edited (consider using a bulk action to Touch them). If an item already has the attribute with a positive number stored (e.g. from a data import), that value will remain untouched. Template items never receive a number.

How it works

When AutoIncrement is assigned to an attribute, an item of the Counters design is created, with its Number attribute set to 1. If that attribute is on an interface, every design that implements the interface shares the same counter.

When an item is created, its AutoIncrement attribute is populated with the counter's number. The counter then always increments, even if item creation fails (e.g. due to lack of permission). This can result in numbers being skipped.