Extensibility

Storing metadata about objects within the Lockstep Platform

The Lockstep Platform provides mechanism for storing extensible metadata about objects. This metadata allows you to tag records in the Lockstep Platform with extra fields, comments, and attachments. Read on for how to use these extensibility features.

Types of Extensibility

Lockstep provides three key types of extensible data objects: Attachments, Custom Fields, and Notes.

Metadata TypeData TypeExample Data
AttachmentModelFile storageA PDF of an invoice
CustomFieldValueModelTyped metadata storage: strings, numeric, dates, or JSON objectsA "Credit Score" field for a customer
NoteModelFreeform human-readable text intended for user reviewA comment: "Alice called this customer and verified their address on June 3rd."

Linking metadata to an object

To attach metadata to an object, Lockstep uses TableKey and ObjectKey. The TableKey value identifies the kind of data that is being extended, and the ObjectKey value identifies which data object is being extended. For example, when we link a note to a company, we set the TableKey to 'Company' and the ObjectKey to the CompanyId value of the company.

This table explains how to extend common data models:

Attachments

Attachments represent files linked to an object. An example would be a PDF file for an invoice, or a reseller certificate for a company.

Custom Fields

To store custom metadata on an object, you create a CustomField. Once the Definition exists, you can then create Custom Field Values and attach them to objects. For example, if your app tracks an object and needs to know the last time the object was checked, you can create a Custom Field Definition called "LastTrackingStatus". You can then create a Custom Field Value attached to the object you have tracked.

Notes

Your software can add Notes to each object. These notes can be viewed by users on Lockstep Inbox. A note is a comment that can include markdown.


Did this page help you?