Skip to main content

Create an Object

Objects store your business data.

Objects store your business data. Before adding attributes, you must first create the object specification - its name, settings, and behaviour.


Before You Start

Plan the object's unique key before you begin. It cannot be changed after the object is created. For guidance on unique key design, see Understanding the Data Model.


Step 1 - Open the Objects Screen

  1. Open the Configuration application.

  2. Navigate to Objects \> Objects.

  3. Click Detail to display the full set of object settings.

  4. Click Edit.


Step 2 - Add a New Object

  1. Enter the number of objects you want to create next to Add.

  2. Click Add. A new row is created for each object.


Step 3 - Complete the Object Settings


System Name

The internal database name. Rules:

  • Maximum 24 characters

  • No spaces

  • Letters (A-Z), numbers (0-9), and underscores only

  • Must start with a letter

  • Cannot end with _V

  • Should follow your agreed naming conventions

This name is used in configuration, processes, and the OData API. It cannot be changed once saved.


Business Name

The name shown to end users. No length restriction. Should be clear, meaningful, and singular - for example, "Contract" not "Contracts".


Description

Explains what the object stores and how it is intended to be used. This helps future configurators understand its purpose and must not simply repeat the Business Name.


Audited

Controls whether users can view the revision history of records in this object.

  • True - revision history is visible to users

  • False - revision history is not visible

Note: users must always enter an Audit Comment when saving records, regardless of this setting.


Apply Data Security

Determines whether record-level data security rules restrict which records users can see.

  • True - data security rules are applied

  • False - access is controlled by user roles and screen visibility only

Most implementations rely primarily on user roles rather than data security.


Pre-Save Process

Optionally trigger a process before records are saved. Used for validation, additional logic, or automatic updates.


Post-Save Process

Optionally trigger a process after records are saved. Used for derived calculations, workflow triggers, or notifications.


Lock Date

Applies date-based data locking. If set, records dated before the lock date cannot be modified/updated.


Virtual

Leave blank or set to False for standard objects. Set to True only when creating a virtual object through this screen directly - in most cases virtual objects are created via Objects \> Virtual Objects.


Filter on Modification Dates

Controls whether the object supports filtering by record creation date and last modification date. If enabled, these fields are available to processes and the OData API but do not appear on the standard object screen.


Step 4 - Save the Object

  1. Enter an Audit Comment explaining why the object is being created.

  2. Click Save and Refresh.

The object specification is now created. Related configuration sections become visible beneath the record.


Next Step

After creating the object, define its attributes. See Create Object Attributes.

Did this answer your question?