Page tree
Skip to end of metadata
Go to start of metadata


Integrate NEC-TM as LanguageResource.

Bootstrap Class

TypeCore plug-in (delivered with translate5 core)

Please note

To use the NEC-TM translate5 plug-in you have to install NEC-TM itself as shown here. The NEC-TM translate5 plug-in only provides the connector between translate5 and NEC-TM, not NEC-TM itself.


  • For each translate5 instance only one set of NEC TM credentials is configured.
    1. username
    2. password
    3. a range of one or more top-level tags (these tags can only be set in the configuration on instance level of translate5)
  • All this data is passed on authentication of this translate5 instance with NEC TM and thus only TM data below the top-level tags can be accessed (plus all public data). To ensure this is in the responsibility of NEC TM.
  • On login and when the user enters the LanguageResources, translate5 queries NEC TM for all tags that can be accessed with the system credentials in NEC TM. The existing tags are saved in the translate5 DB. Tags that already exist in translate5 DB but do not exist any more in NEC TM are removed from the DB and from all language resource associations (current implementation: without any notification to the user or admin).
  • When a new NEC language resources is added in translate5, all tags are offered to choose from that translate5 in step 3 above has gotten from NEC TM.

For using LanguageResources in translate5, see Basic usage - LanguageResources.

Configuration of the translate5 NEC-TM- Plug-In for usage with your NEC-TM server

Config nameValuesDefaultDescription



NEC-TM Api Server; format: ["SCHEME://HOST:PORT"]

By default the port to be used is 27979

runtimeOptions.plugins.NecTm.credentialslist[]Credentials (licenses) to the NEC-TM API; format: ["username:password"]
runtimeOptions.plugins.NecTm.topLevelCategoriesIdslist[]These top-level categories (NEC-TM calls them tags) are always send to NEC-TM in addition to the categories defined with your current NEC-TM language resource. So if you set a category here, for all NEC-TM language resources that you create in your translate5 instance only segments will be send for your queries, that contain the categories, that are set here. This definition can stay empty.
Enter the NEC-TM's tag-ids here, not their tag-names! Example: ["tag391","tag840"].
runtimeOptions.worker.editor_Plugins_NecTm_Worker.maxParallelWorkersinteger3Max parallel running workers of the NEC-TM-categories-synchronization worker

Configuration of your NEC-TM server for translate5

You can reach NEC-TM after installation at http://yourdomain:27979/admin with username admin and pw admin (please change this!)


You have to create only one user in NEC-TM per translate5 instancse. Do only use alpha-numeric characters from ASCII for user names - NEC-TM may not be able to handle others (for "-" it is not). Put these user credentials in your translate5 configuration.

Tags (Categories in translate5's language)

All tags / categories, that you want to use in translate5 to sub-select data from your NEC-TM for certain language resources have to be created in NEC-TM.

If you want to use more than 1 translate5 instance with the same NEC-TM, but make the TMs of both instances completely separate, you have to create an translate5 instance specific tag and assign this tag to the runtimeOptions.plugins.NecTm.topLevelCategoriesIds of your translate5.

User scopes

For each tag / category, that you want to make use of in translate5, you have to create an own, separate user scope at your translate5 user in NEC-Tm and assign this tag (and only this) to this scope. If you use an translate5 instance specific tag (see above) you have to add this instance specific tag to each scope as well.

In translate5 you still will be able to define language resources to which you assign more than one category / tag. If you do so you will get only matches for segments, that have all categories / tags of your language resources.

Attention regarding user scopes: For every tag combination you want to use for language resources in translaste5, you have to create a separate user scope. For example if you have the categories / tags tag1, tag2 and tag3, that you want flexibly combine in translate5 for language resource usage, you need 7 scopes:

  • Scope 1: tag1
  • Scope 2: tag2
  • Scope 3: tag3
  • Scope 4: tag1, tag2
  • Scope 5: tag1, tag3
  • Scope 6: tag2, tag3
  • Scope 7: tag1, tag2, tag3
  • No labels