Teneo Developers

Format Entities

Entity file specifications

Before creating the file to import Entities, please make sure to read thegeneral specifications first.

Each Entity, to import through Bulk import, needs to have a name and an entry. The following is an example of an Entity in its simplest format in the Bulk import file.

#entity,AIRPORTS #entry,Arlanda

Tags and fields

The file for performing a Bulk Import of Entities can contain the tags and fields as visualized in the below table.

TagField 1Field 2Field 3Field 4
#entity<name><description><positive examples><negative examples>
#string_variable<string variable name>
#script_variable<script variable name>
#entry<entry value><value of string variable><value of script variable>
#folder<folder name>

Mandatory fields with mandatory values

These fieldsmust exist in the file and they must contain values.

  • #entity Mandatory tag, indicates the beginning of a new Entity
  • <name> Mandatory field, contains the name of the Entity
    • Must be written in capital letters
    • Must be unique (both within the file and within the solution it is imported to)
  • #entry Mandatory tag, indicates the beginning of a new entry
    • It is possible to add as many #entry tags in the file as needed per Entity
  • <entry value> Mandatory field, contains an entry of the Entity

Optional fields with optional values and fixed placement

These fields are optional and so are their values.

  • description Mandatory field, optional value
  • <positive examples> Mandatory field, optional value
    • Positive examples of an Entity
    • Separate examples with / (slash)
  • negative examples Mandatory field, optional value
    • Negative examples of an Entity
    • Separate examples with / (slash)

Optional tags with mandatory values

  • #string_variable <string variable name> Optional tag, when added the variable name is mandatory, indicates a new string variable
  • Several #string_variable and <string variable name> tags/names can be added to the file
    • One tag per line; Note that the <value of string variable> is added to the line of the #entry tag (see below)
  • #script_variable <script variable name> Optional tag, when added the variable name is mandatory, indicates a new script variable
    • Several #script_variable and <script variable name> tags/names can be added to the file
    • One tag per line; Note that the <value of script variable is added to the line of the #entry tag (see below)

Optional fields with optional values

  • <value of string variable> Optional field, contains the value of the string value of an entry
    • Added in the same line as the #entry tag it belongs to
    • String values do not need to be quoted in the file, quotes are automatically added in Teneo Studio upon Bulk Import
  • <value of script variable>Optional field, contains the value of the script value of an entry
    • Added in the same line as the #entry tag it belongs to

Optional tag with optional value

  • #folder <folder name> Optional tag, optional value
    • Folder tag and relative folder are mandatory if importing to solution root
    • The folder name is relative to the selected folder in Teneo Studio upon Bulk Import
    • To specify a subfolder, each folder should be separated with / (slash)