Entities open by default in read-only mode. To open an Entity for editing, press the Alt key while double-clicking the Entity or click Edit in the top ribbon of the Entity window.
The Home tab and main view of an Entity contains the following things:
- Top ribbon here the user can find the different editing options and buttons available, such as save, disable/enable, add entry or variable, etc.
- Entries editor here the entries of the Entity is written in a table-like view.
- Used by panel gives information about where the Entity is used in the solution.
- Examples gives the option to add examples of what the Entity covers.
Zooming in on the top ribbon, the user is presented with the following options:
- Entity area:
- Edit area:
- Entries area:
- Add Entry
- Delete (entry)
- Variables area:
- Add Variable
- Delete (variable)
- Stable Version:
- Set (current version to stable)
- Unset (stable version)
- Branching area:
- Include (in solutions of Localization setups)
Clicking the Entity tab in the top-left corner of an Entity takes the user to the backstage, where the following options are available:
- Save option to save the current, modified version of the Entity
- Properties this tab allows to edit the name or description of the Entity, and it is possible to find the document number of the object
- History this tab contains the history and former versions of the Entity
- Close this option closes the Entity.
The Properties of an Entity contains the Name and Description of the Entity.
The Name is used when the Entity is being referenced to from a condition either in another Entity, a language object or an Intent Trigger. When referencing an Entity the name should be preceded by the
The Description field can be used to add a descriptive text about the coverage of the Entity. This is especially useful when multiple users work in the same solution to ensure that all users understand the coverage of the object.
The Document Number is the unique document number of the Entity. All Flows, Language Objects and Entities in a solution have their unique document number which identifies that particular object.