Teneo Developers

Working with Entities

Create a new Entity

Entity button in Top ribbon

To create a new Entity, simply follow the below steps:

  • Go to the Solution Explorer in the main Teneo Studio window
  • Select the folder, or alternatively create a new folder, where the Entity should be added
  • In the top ribbon, click on the Entity button in the New area
  • The Entity window opens on the Properties tab, add the Name of the Entity. Note that the .ENTITY suffix is automatically added to the Name field
  • Optionally, add a Description
  • Click the green Play icon, or the back arrow in the top left corner
  • Enter the Entries and optionally NLU Variables and Values, optionally, add Examples in the right-hand side panel
  • Remember to Save to preserve all the modifications.

For information on how to work with the entries of an Entity, please see the Entries and NLU variables section.

Bulk import of Entities

To facilitate the creation of many Entities (or Language Objects), the Bulk Import functionality can be used to create the wanted objects externally in a csv file. For more details please see Bulk Import.

Bulk data creation

Data can be added to an Entity in bulk by dragging/dropping or copying/pasting content from external files. The data can be single piece of text (no TABs and a maximum of one trailing carriage-return) which when pasting will enter the text in all the selected cells, or an array of data with 1-n rows and 1-n columns. Pasting or drag-dropping will create new entries.

Please note:

  • Rows are carriage-return separated
  • Columns are TAB separated
  • Variable columns are only created if they are needed when using drag/drop or copy/paste
  • When creating new variable columns, the user can decide if first row in the pasted data should be header, i.e. variable names or just data
  • If the Entity already has enough variables defined, then no variable columns are created
  • Variable columns created when using drag/drop or copy/paste defaults to the type string
  • If one or more of the variables to be pasted should be of the type scripts, to avoid them becoming string types when pasted (and thus resulting in quoted scripts if the type is changed), rather:
    • Copy and paste the header, i.e. the variable names only, this will just create the variable columns
      • Remember to include an empty entry column in the one-row of data to copy
      • Change the type of the variables that are to be script types
      • Now, copy and paste the entries data.
  • When using Ctrl+C on more than one row, the Ctrl+V shortcut will paste into the first column as entries
  • When using Ctrl+C on one field and marking several rows, doing Ctrl+V will paste to several rows the same content.

Open an Entity

Open in read-only mode

An Entity can be opened by browsing to the folder where the Entity is stored and double-clicking on it to open in read-only mode. To activate edit mode, simply click Edit in the top ribbon of the Entity.

By selecting one or more Entities in the Solution Explorer these can also be opened from the right-click mouse menu or by clicking the Open button in the top ribbon of Teneo Studio.

Open in edit-mode

To open an Entity directly in edit mode, select the Entity and click the Edit button in the top ribbon or press Alt while double-clicking the object(s).

Open an Entity from the condition editor

In the condition editor, to open an Entity used in the condition, either double-click on the name of the Entity to open in read-only mode or press Alt while clicking with the mouse to open in edit mode.

Entities being referenced from a lexical resource will always open in read-only mode.

Save an Entity

Saving can be done by simply clicking Save in the top ribbon on the Home tab of the Entity. A dialogue box prompts the user to add a comment, next click OK.

To save direct and bypass the comment option, press Alt on the keyboard while clicking Save.

Teneo Studio, furthermore, provides keyboard shortcuts Ctrl+S to save with comment and Ctrl+Alt+S to save without comment.

Close an Entity

To close an Entity, simply click the X in the top, right corner of the Entity window. If there are unsaved changes, Teneo Studio will prompt the user to save or close without saving the changes performed by the user.

Alternatively, click the Entity tab in the top left corner to go to the backstage of the Entity and choose Close in the options to the left.

Disable or Enable an Entity

In the top ribbon of an Entity it is possible to Disable or Enable the object. By default new Entities are enabled.

In the Solution Explorer view, it is possible to multi-select Entities to disable or enable several objects at the same time. Use the Disable/Enable buttons in the top ribbon of Teneo Studio and select Yes in the dialogue box.

When clicking Disable/Enable while having a folder selected, a dialogue will be displayed for the user to confirm the action of all the selected objects in the selected folder and subfolders.

When disabling/enabling multiple objects at a time, clicking Run in background in the dialogue box permits the user to keep working while the actual disabling/enabling is carried out.

A dialogue box will be displayed when the disabling or enabling has finished successfully.

Version Flag

The Stable Version area in the top ribbon of an Entity allows to set the current version of the Entity as stable by clicking Set; and to unset a stable version by clicking Unset.

In the backstage of the Entity (Entity tab > History) it is possible to set a previous version of the Entity as the stable version, to do so simply select the wanted version and click the Set Stable button which appears in the top of the list when selecting an item.

Note that it is not possible to set a new Entity to stable until a first version of the object has been saved.

Read more about Versi

Include or Exclude from Branching

The Branching area in the top ribbon contains two buttons: Include and Exclude . These buttons refers to if the object should be included or excluded from a Local solution when working in a Localization setup.

Navigate panels and tabs

Used by panel

In the main window of an Entity, it is possible to see where that particular Entity is used within the solution. To see this information, open the **Used by **panel by clicking with the mouse.

By hovering over objects in this panel, tooltips providing more information are displayed. Clicking on an object will open the location of the usage in read-only mode. Use Alt + click to open in edit mode.

Used by Tooltip

Errors panel

The Errors panel is visible, next to the Used by panel, when one or more errors are detected in the Entity. The following errors will automatically display an information message:

  • Empty variable column
  • Empty entries

Furthermore, the following errors will be displayed on a save-action in case one or more of them are present in the Entity:

ErrorMessage type
An entity has no nameError
An entity doesn't contain at least one entry with a valueError
An entity contains some empty entriesInformation – only rows containing data are saved
An entry value contains a reference to itselfError
An entity has no nameError
A variable has no nameError
A variable is called lob or contains _USED_WORDSError
Two or more variables have the same nameError
An entry value is empty, but the entry contains variable valuesError

To remove any of the error messages, simply resolve the issue the error refers to.

History tab

The History tab in the backstage of an Entity contains the History of each time the Entity has been saved. If users have added comments when saving, these will be displayed here.

In the history list it is possible to click the version number to see a previous version of the Entity. If needed, a previous version available in the history can be restored by opening the object and clicking the Restore button available in the top ribbon. A new version of the Entity will be created, containing the data of the selected version.

When restoring an object, it is recommended to check that referenced objects are still available in the solution for correction functionality.

Properties tab

The Properties tab contain the following information related to the Entity:

  • Name
  • Description
  • Document Number
  • Entity Location

Move and copy Entities

Teneo Studio allows to copy and move around objects within a solution and from another solution to the currently open one. For more details, please see Moving and copying objects.

Delete an Entity

It is possible to delete one or more Entities from a solution, to learn how please check out the Delete objects section.

Language Objects
Localization setup
Entities as Match Requirements
More on NLU Variables in the Knowledge Base
Entities in Teneo Language Resources