Unify Logo Footer.svg
Platform Tools
Logo
Create your first Object

Create your first Object

Logo

6 mins READ

Create your first object

Create an object

Let's create an object from scratch.

  1. Click on New Object to start creating an object. The New Object Details page opens, with Details, Storage, Organization, and Object features sections.

    create-new-object.png
    create-new-object.png

  2. In Details, enter a Singular name and a Plural name, and optionally describe the object in About this object. The Unique ID is filled in from the singular name. You can edit it (up to 32 characters), but you can't change it once the object is created. In Storage, choose where records live under Store data in: JSON Store, Blob Store, Key Value Store, Event Store, Vector Store, or Analytics Store. Each of these is explained in a later section. The storage type can't be changed once the object has data. You can also set an optional Retention period; leave it empty to keep records forever. Under Organization, add Tags if you like, and under Object features turn on any toggles you need, such as audit trail, activity tracking, or reporting. You can change these later from the Settings tab.

  3. Click on Create object, and you'll be taken to the landing page of your object, where you can design the schema of your object and enable additional configurations in settings.

Setting up your Schema

  • You can add fields to your object's schema in bulk by pasting a sample JSON. Additionally, you can modify your schema by adding fields one by one.

  • Once you click on Add Fields, a menu offers Enter manually and Use Code Snippet. Choose Enter manually to open the Add New Field panel, or Use Code Snippet to add fields from code. In the Add New Field panel, you set the following parameters:

Parameter

Description

Key

The unique identifier for the field within the object.

Display Label

A human-readable name for the field.

Field Type

Specifies the data type of the field, which can be number, string, etc.

Help Text

A brief explanation for users about the field's expected input.

Default Value

The value is automatically assigned to this field when creating a new record if no other value is provided.

Nest Under

Allows for hierarchical data structuring by making this field a sub-field.

Is Optional

When checked, it indicates that the field is not required and can be left empty.

Primary Key

When checked, this field is designated as the unique identifier for each record in the object.

Unique Key

Ensures uniqueness of values across records. Available on JSON Store objects only.

  • You can also use advanced settings to customise field behaviour, enhance security, and control data visibility and accessibility. The following are the available parameters:

ParameterDescription
Enable HashingWhen checked, this option securely hashes and stores the data.
Secure FieldThis option allows data to be stored in an encrypted format.
Display NameIt allows the field's content to be visible when viewing associated data across the system.
Enable Search FunctionalityThis option permits searching in this field.
Enable SortingAllows sorting of records based on this field.
Enable FilteringThis option allows the filtering of records using this field.
Control VisibilityThis toggle switch activates a set of customisable conditions to control the visibility of this field.
  • Once you have added all the required fields, click save. The schema can be modified later.

Import Records

  • You can easily bulk-add records to your object by importing a file, to save time and effort.

  • From Add Record, choose Upload file and upload a CSV, Excel (XLS/XLSX), or JSON file. On the Map Fields step, review the automatic matches and map the remaining columns. Every required field must be mapped. Use Preview Data to verify the first rows, then confirm the import. The import runs in the background and records are added in batches.

  • If some rows fail, the import continues and finishes as completed with errors. Open Import details to see Imported, Skipped, and Total rows in file, review each failed row and its reason, and download the error report.

  • For more on imports, see Importing and bulk actions on records.

Export Records

  • You can easily export records in various file formats using the export feature to extract data from your object.

  • Click on Export from the object landing page, and a dropdown will appear where you can select your preferred export format from CSV, XLSX, or XLS.

  • You can choose to export either all records or filtered records based on your current view or search criteria.

  • The export will be processed in the background for large datasets, and you'll receive a notification when your file is ready to download.

Types of Data Stores

Choose a storage type based on your needs. The available options are JSON Store, Blob Store, Key Value Store, Event Store, Vector Store, and Analytics Store.

  • JSON Store: Used to store data in JSON format. Typically implemented using DocumentDB or MongoDB, depending on the cloud provider. This is the most common way of storing data in objects.

  • Blob Store: Primarily used for large unstructured data like files or images. Implemented using services like S3 in AWS or equivalent services in other cloud providers (like Google Cloud Storage in GCP or Azure Blob Storage).

  • Key Value Store: Used to store simple key-value pair data. Typically implemented using Redis, offering fast access and caching capabilities.

  • Event Store: Stores time-series data or event logs. Implemented using Apache Kafka, enabling real-time event streaming and processing.

  • Vector Store: Used for storing and querying vector embeddings, often used in machine learning applications. Typically implemented using OpenSearch, enabling efficient similarity searches.

  • Analytics Store: Used for time-series and aggregated metrics for dashboards.

Types of Fields

Field TypeDescriptionExample use cases
StringUsed for storing text-based dataNames, descriptions, addresses
NumberUsed for storing floating number dataPrices, measurements and percentages
IntegerUsed for storing non-decimal numbersAge, count and quantity
Auto NumberAutomatically generated sequential numbersTicket IDs and reference numbers
BooleanUsed for storing true/false valuesis_active, is_completed and has_subscription
DateUsed for storing dates as epochsBirth date and expiry date
Date TimeUsed for storing date and time combined, stored as epochsModified time and event timings
Single Select DropdownUsed for selecting a single option from either a static or lookup listStatus, category and priority
Multi Select DropdownUsed for selecting multiple options from either a static or lookup listTags, categories and preferences
ObjectUsed for complex data structures comprising multiple fields nested inside themEmployee details and other nested structures
ArrayUsed for storing a list of values of the same typePhone numbers and email addresses
FileUsed for storing file attachmentsDocuments, images and attachments

Lookups

Lookups allow you to reference data from other objects in your current object, creating relationships between different data sets. Here's how to set up and use lookups:

  • When creating a Single Select or Multi Select Dropdown field, you can choose 'Lookup' as the source of options instead of a static list.

  • Select the target object from which you want to look up data. The field used to join the two objects must be a primary key in your lookup object.

  • In your lookup object, set the field you want to act as a display name by ticking the display name checkbox in the edit field modal.

  • Now, you can access data from your secondary object, thus enabling you to create cleaner and non-repetitive objects.

Using your object

  • In your application builder, set up a data source which fetches records from your object using Storage by UnifyApps.