Skip to main content

Designs and Interfaces

Define a set of attributes for each type of thing​

The data structure of your company project is determined by its designs and interfaces, known collectively as DoDIs.

Use designs to define the data attributes you want to record and store for each type of thing. Use interfaces to group related designs and extend them with shared data attributes.

If you're new to CausewayOne Asset Management, see the Designs and Interfaces concept docs for a simple overview of their key features.

info

If you're unable to view or manage designs/interfaces, your user account may lack the required permissions.

Designs​

A design is a set of attributes that describe a type of thing, which can be physical (e.g. assets, components) or abstract (e.g. defects, tasks). Many system designs are included and you can create your own.

Different attribute types store different types of data, e.g. numbers, dates, text, geometry. You can add custom attributes to any design, including the system ones.

All designs have these system attributes:

  • Title - the primary text label. It often includes a unique attribute to identify each item, e.g. a serial number, asset tag.

  • Subtitle - the secondary text label. By default, it displays the item's design, but can also include attributes, e.g. installed date, task status.

  • Geometry - coordinates representing the item's location and shape. Optional by default but can be required. Different geometry types store different types of coordinates, e.g. point, line, polygon.

To store data in CausewayOne Asset Management, you create items of your designs. When creating or editing an item, you populate its attributes with values to represent a specific instance of that design. Items can subsequently be queried to fetch their attribute data, which can be filtered and sorted as needed.

A comparison of the Litter Bin design and a Litter Bin item

Interfaces​

While interfaces are similar to designs, items cannot be created directly from them.

Instead, an interface defines a set of generic attributes that can be shared among related designs (and other interfaces). If a design/interface implements an interface, it inherits that interface's attributes alongside its own. This saves you from redefining the same attribute in multiple places.

For example, the Defects interface has generic attributes for recording any defect, e.g. Status, Reported Date. If you create a design to represent a defect type, it automatically implements the Defects interface and inherits those generic attributes. Want to add a new Hazard Score attribute to all your defects? Just add it to the Defects interface.

An interface also provides a reference point for multiple designs. When performing a query, you can target an interface to query all the designs that implement it (directly and indirectly).

For example, inspection and job designs implement their respective interfaces, which both implement the Tasks interface. Therefore, you can target Inspections to query all inspection items, Jobs to query all job items, or Tasks to query both.

To learn more, see Implementing interfaces.

Diagram of an example defect design
Diagram depicting the structure of a defect design

System DoDIs​

Various system designs and interfaces are included. They provide core functionality, along with modular functionality related to specific service areas or integrations. While they can't be fundamentally changed or deleted, you can customise their appearance (e.g. colour, icon, title, subtitle) and extend them with custom attributes as needed.

You can also create any number of custom designs and custom interfaces to represent your organisation's assets, operations and business processes.

Comparison​

DesignsInterfaces
Specific attributes for one type of thingGeneric attributes shared among multiple types of things
Designs can implement interfaces to inherit their attributesInterfaces can implement other interfaces to inherit their attributes
Items can be created from designsItems cannot be created from interfaces