View Article

Entity Configuration Controls

By Xelence Documentation posted 01-23-2024 14:42

  

Details Section:

File Name

  • What it does: Identifies the entity's programmatic ID.
  • How to use it: Read-only.



Description

  • What it does: Text description of the entity. 
  • How to use it: Enter text.



Parent Entity

  • What it does: Entity from which the entity inherits information.
  • How to use it: Enter the entity's ID.



Schema Name

  • What it does: Identifies a collection of database objects such as tables, functions, etc.
  • How to use it: Enter text.



Database Name

  • What it does: Identifies the external database the entity is linked to, if any.
  • How to use it: Enter the name of the database.



Allow From Platform Api

  • What it does: Determines whether the entity can be exposed on Platform API.
  • How to use it: Check to expose the entity. Otherwise, leave it unchecked.



Table Name

  • What it does: Identifies the database table mapped to the entity.
  • How to use it: Read-only.



Other Details Section:

ReadOnly Rule

  • What it does: Rule that determines whether records that use this entity are editable when the user opens them in update mode.
  • How to use it: Enter the rule.



Checklist ID

  • What it does: PickList that identifies the code group to use as the entity's checklist.
  • How to use it: Select the PickList. 



Checklist Table

  • What it does: Table that stores the checklist IDs when the checklist is evaluated.
  • How to use it: Enter the table name.



SoftError Details Section: 

Error Table

  • What it does: Table that stores the soft error instances.
  • How to use it: Click the Add Error Table icon to create the table. Click the Delete Error Table icon to remove the table. Otherwise, this field is read-only.



Status Column

  • What it does: Column that stores the status of any records that use this entity.
  • How to use it: Click the Add PickList Column icon to create a new column or enter the PickList to use as the status values.



History Table Details Section: 

History Table

  • What it does: Indicates whether this entity's table is included in the app's history table. If included, any updates to records that use this entity are inserted into the history table.
  • How to use it: Check or uncheck the checkbox.


This post is part of the Entity topic. Click here to open the Entity Overview.


#Entity

0 comments
58 views