Skip to main content




Service Studio version:


  • Edit
    Collaborate with us
    Edit this page on GitHub
  • An Entity represents a table in a database.

    Exposed Entity

    An exposed entity can have its records protected from modifications by setting the entity's Expose Read Only property to Yes. However, note that it's still possible to change records using SQL even when enabling this property.


    Name Description Mandatory Default value Observations
    Name Identifies the entity in the module. Yes
    Description Text that documents the element. Useful for documentation purpose.
    The maximum size of this property is 2000 characters.
    Label Label used to describe the entity in the user interface of the application.
    Label (plural) Label used to describe the plural of the entity in the user interface of the application.
    Public Set to Yes to allow the element to be added as dependency by other modules. Yes No
    Expose Read Only Set to Yes to expose the entity while protecting its data records from being written in a consumer module. Yes No Note: Consumer modules can update data records using SQL even when this property is set to Yes.
    Identifier Attribute Attribute that uniquely identifies the entity.
    Label Attribute Attribute displayed to the users when creating combo boxes. This Attribute also becomes the source of data for the table row based on the Entity, when scaffolding a screen.
    Order By Attribute Attribute used for the default ordering of the records of the entity. (None)
    Is Active Attribute Specifies a Boolean attribute of the entity which defines if the record is to be fetched in a query. (None)
    Original Name Name of the element as defined in the module which implements it (producer module). This property is read-only. Yes This property is only visible for referenced elements.
    Update Behavior Set which is the way the update of entity records is performed:
    - All Attributes: all the attributes are always updated in the database.
    - Changed Attributes: only the attributes that were changed are updated in the database thus, improving efficiency.
    Yes Changed Attributes The Change Attribute only works with an entity variable type that's populated by an Aggregate or SQL node. That data is flagged as "original" and changes to that data by an Assign node sets this flag to "changed." That's how the platform knows how to build a more efficient query when invoking the entity's CreateOrUpdate or Update action.
    Expose Process Events If set to True, creating or updating entity records issues events to processes. Yes No
    Is Multi-tenant Set to Yes to isolate data per tenant or No to share data among tenants. If not set, it inherits the module setting. Yes
    Show Tenant Identifier Set to Yes to show the TenantId entity attribute and disable automatic data isolation for this entity. Yes No
    Original Show Tenant Identifier Indicates the TenantId property value originally set in the referenced module. Yes No
    Logical Database The Platform's logical name for the external database where the entity is stored.
    Supports Nulls If set to Yes, mandatory attributes that are set with the default value are converted to/from null when storing/retrieving data from the external database. Otherwise no conversion is done. Yes No This property is only visible for reference entities from extension modules.
    The value conversion only applies to mandatory attributes.
    • Was this article helpful?