Custom entity folder structure

Custom entities are stored alongside your project files at the following path.

\Custom\SalienceData\<language>\salience\entities\<EntityTypeName>\

To ensure that you can easily find it, the project path is displayed as a clickable link when you select the Project item Project Tree - Project icon from the Project Tree.

You need to create this directory structure if it does not already exist.

There are two variables in this path that must be supplied by you. First, there is the <language> folder. This is the two-character code of the language that you are using. For example, the following are the languages that are supported by the Natural language processing engine along with the two-character codes that you must use to name the folder.

  • German - de

  • English - en

  • Spanish - es

  • French - fr

  • Italian - it

  • Japanese - ja

  • Korean - ko

  • Dutch - nl

  • Portuguese - pt

  • Romanian - ro

  • Chinese - zh

The second variable is the name of the folder under the entities folder. The name of this folder is what determines the Entity Type that is returned by the NLP engine. The entity type is visible when using a table field and the Named Entity Locator, or when viewing a test document in the XDoc Browser.

For example, if you have a custom entity in a folder called Cars, the NLP engine is able to recognize that this is a noun and that it is in plural format. Because of this, the returned Entity Type in this example is actually Car. If the folder name is already singular, or it is not recognized as plural, the folder name is returned instead, as long as the entity .cdl file is in the correct format.