DataProperty

MPO Version: 1.3.0

The definition of a data property within a data object. A data property is not just a storage field—it encapsulates the logic, behavior, and metadata associated with a specific piece of data. Through its settings, a data property can define relationships, context-aware values, session-based defaults, computed formulas, access filters, enums, and more. It serves as a powerful unit of business logic tightly integrated with the data model.

interface DataProperty = {
  basicSettings : PropertyBasicSettings;
  indexSettings : PropertyIndexSettings;
  relationSettings : PropertyRelation;
  sessionSettings : PropertySessionSettings;
  staticJoin : PropertyStaticJoin;
}

PropertyBasicSettings

MPO Version: 1.3.0

Defines the core structure and behavior of a data property. Beyond basic typing, this section governs how the property participates in data integrity, mutability, API exposure, and logic-driven behaviors such as hashing or auto-increment. Use this section to establish the foundational logic and identity of the property within your data object.

interface PropertyBasicSettings = {
  name : String;
  type : DataTypes;
  isArray : Boolean;
  description : Text;
  isRequired : Boolean;
  allowUpdate : Boolean;
  autoIncrement : Boolean;
  hashed : Boolean;
  isSecret : Boolean;
  defaultName : Boolean;
  isFilterParameter : Boolean;
  enumOptions : String[];
  defaultValue : AnyComplex;
}

DataTypes

These are the standardized data types used in microservice data models and BFF data views in Mindbricks.

const DataTypes = {
  ID: "ID",
  String: "String",
  Text: "Text",
  Integer: "Integer",
  Boolean: "Boolean",
  Double: "Double",
  Float: "Float",
  Short: "Short",
  Object: "Object",
  Date: "Date",
  Enum: "Enum",
  GeoPoint: "GeoPoint",
  GeoRoute: "GeoRoute",
  GeoArea: "GeoArea",
  Blob: "Blob",
};

PropertyIndexSettings

MPO Version: 1.3.0

Index configuration for the data property across supported storage and caching layers. This includes Elasticsearch indexing for query performance, relational database indexing for faster selection, and Redis-based optimizations for efficient cache invalidation and retrieval. Use these settings to control how the property contributes to performance, queryability, and caching logic.

interface PropertyIndexSettings = {
  indexedInElastic : Boolean;
  fulltextSearch : Boolean;
  indexedInDb : Boolean;
  unique : Boolean;
  clusterInRedis : Boolean;
  cacheSelect : Boolean;
  isSecondaryKey : Boolean;
}

PropertyRelation

MPO Version: 1.3.0

Defines the foreign-key relationship for this property to another data object. Populate this block when basicSettings.hasRelation === true. Leave null/absent otherwise. The activation flag lives on basicSettings (next to source) so a single property-level write declares both the source and the relation.

interface PropertyRelation = {
  relationName : String;
  relationTargetObject : DataObjectName;
  relationTargetKey : PropRefer;
  onDeleteAction : RelationOnDeleteAction;
  relationIsRequired : Boolean;
}

RelationOnDeleteAction

Defines the available strategies for handling related records when a referenced (parent) object is deleted.

const RelationOnDeleteAction = {
  doDelete: "doDelete",
  setNull: "setNull",
};

PropRefer

MPO Version: 1.3.0

Represents a reference to a property of a data object, optionally renaming it in the current context. It is a string data, however can store string pairs joined with ':'.The first part is the name ofthe property and the second part after ':' mark is how it will be renamed in the context. If no second partis provided, the property is named in the context with its original name. Renaming is useful for mapping remote object properties to local aliases or transforming naming for aggregation.

interface PropRefer = {
}

PropertySessionSettings

MPO Version: 1.3.0

Defines how this property is populated from the session context when basicSettings.source === 'session'. Session-driven properties are commonly used to associate records with the current user or tenant automatically during create/update operations. Leave the wrapping object null when the property's source is not session.

interface PropertySessionSettings = {
  sessionParam : String;
  isOwnerField : Boolean;
}

PropertyStaticJoin

MPO Version: 1.3.0

Static join settings define how this property's value is derived from another data object at the time of creation or update when basicSettings.source === 'joined'. This approach is useful when a field in the current object depends on a static value from a related object, and that value is not expected to change frequently. Unlike dynamic joins, static joins store the fetched value directly to allow for faster queries and avoid repeated lookups. A common use case is transferring tenant or client identifiers from a parent object into a child record. For example, when creating an email job for a specific user, the system can use the userId to join the User object, fetch its clientId, and statically assign it to the EmailJob object. This makes it easy to query email jobs by clientId without needing to join back to the User table at runtime. Note that, all static joins are executed before any per-API customData entries, so customData expressions can read the joined value via this.<property>. Leave the wrapping object null when the property's source is not joined.

interface PropertyStaticJoin = {
  jointSource : DataObjectName;
  jointRead : PropRefer;
  jointSourceKey : PropRefer;
  jointForeignKey : PropRefer;
  defaultValue : MScript;
}