Overview

A design in Alloy is a set of attributes that describe an item. Alloy allows you to customise a standard and user design. You can configure each design with its own unique set of attributes.

You can add or edit attributes of any standard or user design to represent an item’s characteristics. An item is an object such as a street light or an inspection. See Items.

Attributes can represent an item’s custom data fields, as well as links to other designs (e.g. the Team member design is a linked attribute of the Team design).

Note

Standard designs contain preset attributes that you cannot edit or delete, however, you can use the Stencil editor to hide attributes that are not necessarily used. You can add custom attributes to standard designs.

Adding custom design attributes

  1. Select a design to view its details.
  2. In the Item details panel, select the Attributes tab.
  3. Select the more actions button from the action bar.

  4. Select Add attribute, the Available types page is displayed on the left, which allows you to choose the type of attribute you need.

  5. When you select an attribute type the attribute details are displayed in the fields in the left panel.

  6. The following fields are common to all types of attributes:

    • Required - this allows you to make the attribute mandatory or optional.
    • Read-only - this allows you to make the attribute content read-only once an item is created using the design.
    • Unique - this allows you ensure the content of the attribute is unique when items are created using the design.
    • Name - This allows you to define the attribute name that appears within the design.
Note

If you add or change custom attribute settings within an existing design, then the changes are not applied to any existing items based on that design.

  1. When you have completed the attribute settings select Create to add the attribute to the design.

List of Attribute types

The following table provides a list of attribute types:

Attribute type Description
Yes/No Data field with options Yes or No
Text This provides an input field accepting text up to the specified number of characters
Date This displays a date field that opens a calendar date picker
Time This displays a time field that opens a time picker
Date and Time This displays a date and time field that opens date and time picker
Seasonal This displays a day and month field that opens a calendar date picker
Number This displays a numeric input field that allows you to enter whole numbers.
JSON This provides access to a JSON editor to store JSON data within items.
Geometry Make geometry required or optional (specify in design properties).
Link This allows you to include another design or interface as an attribute. When a linked design includes the active design as an attribute, the linked design appears in the Parents tab within the Item details panel. For example, a Job design may include a range of assets such as Street Lights or Carriageways as parents, meaning you can create a job against those asset types. Similarly, when viewing a Street Light asset, you can view jobs assigned against the asset.
AQS This allows you to access to the AQS builder to store queries within items.