Entity Overview

   MaestroPreviously known as Transact Maestro.  |    Form Builder Platform Developer |  17.10 This feature was introduced in 17.10.

Maestro uses entities to group components in a way you need to implement your business requirements. Entities are connected to properties of components and other entities and they define a domain model of a form. The entities of the domain model are stored in the form manifest as a JSON object containing a set of name and value pairs, each representing a real-world concept, such as a street name. The name in each pair identifies an entity while the value is either empty (default) or another object which has its own name and value pairs for child entities. The example of an entity is shown below:


{
	applicant:
		homeAddress:
		deliveryAddress:
	asset: {}
}

You can create and manage entities in the Maestro editor using the Model pane or a component's ID field in the Properties pane.

The Maestro editor knows that a component is an entity by checking for an underscore in a component ID field. If you add a prefix ending with an underscore to the component ID, Maestro adds the entity and the data item (property) to the domain model. For example, the prefix applicant1_ applied to the firstName component results in the component ID applicant1_firstName, which identifies that the firstName component belongs to the applicant1 entity.

Any existing component IDs, including those with an underscore, will not cause entities to be created. An entity is only created using the Model pane or when a user modifies a component ID.

Next, learn how to create an entity.