MultiTerm Developers Forum - Recent Threads

RE: How to verify if database import or export by API has been successful

Nils Jörn — Mon, 13 Oct 2025 08:45:14 GMT

thank you very much for confirming that it seems to be a bug. I've reported the issue with CS0028010.

Best regards
Nils

How to verify if database import or export by API has been successful

Nils Jörn — Tue, 02 Sep 2025 08:33:16 GMT

Dear all,

according to the documentation here (developers.rws.com/.../Sdl.MultiTerm.TMO.Interop.ImportDefinition.ProcessImport.html, there's no return value from the ProcessImport method.
Unfortunately, it's not clear to me, how to verify, if an import or export has been successful by using the API.
How is it designed by RWS to be able to verify, if an import or an export has been successful?

We're using MultiTerm 2024 SR1 - 18.1.2.3594 and GroupShare-/MultiTerm-Server "GS: 15.2.0.1904 - GS 2020 SR2"

If you have any further questions, please don't hesitate to let me know.
Thank you very much in advance for your support.

Best regards and have a nice day.
Nils

RE: How to verify if database import or export by API has been successful

Daniel Brockmann — Mon, 13 Oct 2025 08:12:14 GMT

Thanks Nils Jörn ! Well this explains it then. I would also consider it a bug. I guess you can still try and get the information from the log file but more implicitly, for instance by looking for "Added" or "Merged" keywords, or perhaps better "entry number". If you could report the bug to our support team, they should be able to add it to our ticketing system and we can then hopefully address it down the line. Thanks, Daniel

RE: How to verify if database import or export by API has been successful

Nils Jörn — Mon, 13 Oct 2025 06:52:32 GMT

Good morning Daniel Brockmann ,

sure, you can ask. I've run the import via the user interface. And, yes, the log file now includes the lines, missing in the log file if running the import via the API. Is that works as designed?! 🤔 In my opinion, it seems to be a bug.

Thank you very much in advance for investigating this on your end.

Best regards and have a good start into the new week.
Nils

RE: How to verify if database import or export by API has been successful

Daniel Brockmann — Fri, 10 Oct 2025 07:40:50 GMT

Thanks Nils - can I ask you to run the import via the user interface and see if you get a different log file with these additional lines? I seem to always get these lines when doing the import via the UI, I am wondering if this might be different to calling it via the API.
Thanks, Daniel

RE: How to verify if database import or export by API has been successful

Nils Jörn — Fri, 10 Oct 2025 05:20:56 GMT

Good morning Daniel Brockmann ,

thank you very much for your reply and your explanations.

Yes, we already have a support and maintenance agreement with you, but according to support this is not something that they handle in support unfortunately.

The log file, which is created during the import looks like:

"General information:
Import definition name:
Import definition name: DBName
Import file: c:\tmp\DBName.xml
Import log file: c:\tmp\DBName.log
Exclusion file: c:\tmp\ausschluss.xcl
Exclusion file: true
Exclusion file: true
Exclusion file: false
Exclusion file: true

Filter settings:
Import all entries: Synchronize entries on entry number

Synchronize entries on entry number:
Entry number exists in the target termbase:
Import all entries: Overwrite existing entry with import entry
Entry number does not exist in the target termbase:
Import all entries: Add import entry as new

...

Entry number XYZ (XYZ) replaced existing entry.

[start date] [start time]
[end date] [end time]"

I've copied all the lines, from "Entry number XYZ" to the end of the file, completely. There isn't any further information between the "Entry number" line and the two last lines which contains date and time. Unfortunately, the information like "Total entries processed", etc. is missing. 🤔

Please be so kind to have a look at this and let me know, how to get these information included in the log file.
Thank you very much in advance

Best regards and have a nice day.
Nils

RE: How to verify if database import or export by API has been successful

Daniel Brockmann — Thu, 09 Oct 2025 08:11:40 GMT

Hi Nils,

You may need to get this information implicitly from the log file. It has this section at the end:

Total entries processed: 0
Total entries added: 0
Total entries merged: 0
Total entries omitted: 0
Total entries written to the output file: 0

Depending on the options you choose for the import, you will get the info from all of these lines. For instance, if you decide to write non-imported entries to the output file, then the final line will have information on that. Of course the "Total entries added" line will the the most important one. If it says 0, you can be sure the import was not successful.

For these more advanced product questions, it can be beneficial to contact our support team, which is a good option in case your organization has a support and maintenance agreement with us. This will ensure faster replies, and the team also typically works with us on any questions they cannot answer.

Thanks, Daniel

RE: Is MultiTerm API thread safe?

Nils Jörn — Thu, 02 Oct 2025 12:05:40 GMT

Hello Patrick Andrew Hartnett ,
hello Daniel Brockmann ,

thank you very much for your new detailed reply. What a pity, the MultiTerm API isn't thread save. 😞
I'm going to have a look if I could run the import in a separate helper process.

By the way: Unfortunately, until now, I didn't got any reply on my second post How to verify if database import or export by API has been successful . Can you answer that question, too?

Best regards and have a nice day.
Nils

Is MultiTerm API thread safe?

Nils Jörn — Fri, 12 Sep 2025 06:17:46 GMT

Dear all,

currently, I'm developing a commandline application for importing data into a MultiTerm server database.
Unfortunately, I'm facing issues (System.ArgumentException) in that application. I'm trying to run the ".ProcessImport(MultiTermIX.MtTaskType.mtScript)" in a new thread to be able to stop the import process, if it takes much longer than normal.
The application is developed in Visual Basic.
My question therefore is, if the API from MultiTerm is thread safe and if it is possible to outsource the import process to a new, independent process/thread.

If you have any further questions or any hints, please don't hesitate to let me know.

Thank you very much in advance for your soon reply.
Best regards and have an easy day
Nils

RE: Is MultiTerm API thread safe?

Daniel Brockmann — Wed, 24 Sep 2025 07:27:58 GMT

Thank you Patrick Andrew Hartnett - confirmed. Thanks, Daniel

RE: Is MultiTerm API thread safe?

Patrick Andrew Hartnett — Tue, 23 Sep 2025 15:13:12 GMT

[quote userid="179217" url="~/developers-more/trados-portfolio/multiterm-developers/f/multiterm-developers-forum/58989/is-multiterm-api-thread-safe/187328"]Then, my original question is still relevant. I'd love to get an answer if the MultiTerm API is thread save and if it's possible to run the .ProcessImport method in a new thread.[/quote]

Hi Nils Jörn , I suspect that the short answer is no.

Simply because I know that Multiterm is a COM automation API, which use STA (sinle theaded aparment), e.g. not guarenteed thread safe. From experience, calling COM from MTA or attemptting to marshel it accross threads more often leads to unpredictable behaviour. I'm old enough to simply not do it anymore, I like sleeping and not working/debugging all night :-)

I would recommend:

Use it from a single STA thread only. Do not create objects on one thread and call them from another like you're attempting here.
ProcessImport is a synchronous, blocking COM call. I suspect that there is no supported way to cancel it mid-call or safely abort the thread.
If you need a hard timeout/cancellation, run the import in a separate helper process and kill that process on timeout.

Daniel Brockmann can also confirm this with the multiterm team directly? although, I'd doubt the answer is different to what I'm writing here.

RE: Is MultiTerm API thread safe?

Community Jira — Tue, 23 Sep 2025 13:03:00 GMT

Thank you for bringing this to our attention. Our development team will review it in the context of our ongoing projects and priorities. Your understanding and patience as we assess this matter is appreciated. We have recorded the issue in our tracking system under the reference number CRQ-43524

RE: Is MultiTerm API thread safe?

Patrick Andrew Hartnett — Mon, 15 Sep 2025 10:51:06 GMT

Hi Nils Jörn , thank you for raising this. We'll need to review the documentation and remove that statement here, where is suggests "Only empty termbases support importing content". Importing terms to an existing termbase with terms is supported, as you suspected.

It's possible that an early release of the Public API had this limitation, and this statement got overlooked.

I have alerted the team of this and they will update the documentation with next public release.

Internal ref: CRQ-43524

RE: Is MultiTerm API thread safe?

Nils Jörn — Mon, 15 Sep 2025 08:55:05 GMT

Good morning Paul Filkin ,

thank you very much for your detailed answer. 👍

Then, my original question is still relevant. I'd love to get an answer if the MultiTerm API is thread save and if it's possible to run the .ProcessImport method in a new thread.
And even, how to verify if the import has been successful, according to my other question here: community.rws.com/.../how-to-verify-if-database-import-or-export-by-api-has-been-successful

Best regards and have a great start into the new week.
Nils

RE: Is MultiTerm API thread safe?

Daniel Brockmann — Fri, 12 Sep 2025 11:34:20 GMT

Yes, my bad - I was under the impression we can do bulk imports in the MultiTerm Server/GroupShare API but we don't, apologies Nils. Thanks, Daniel

RE: Is MultiTerm API thread safe?

Paul Filkin — Fri, 12 Sep 2025 10:23:15 GMT

Nils Jörn

Just want to make sure you don't confuse the Trados Cloud API with the GroupShare REST API. These are completely different products.

As far as I am aware the GroupShare REST API is designed more for individual term management and search operations rather than bulk data import scenarios. For true bulk imports, the traditional MultiTerm Desktop approach remains the most practical and efficient method. So your original question may still be relevant,

The GroupShare REST APIs only make this available:

Individual concept management: POST /multiterm/api/1.0/termbases/{termbaseId}/concepts - Add single concepts
Concept updates: PUT /multiterm/api/1.0/termbases/{termbaseId}/concepts - Update individual concepts
Concept deletion: DELETE /multiterm/api/1.0/termbases/{termbaseId}/concepts/{conceptId}
Search and retrieval: Various endpoints for finding and retrieving terminology
Multimedia support: POST /multiterm/api/1.0/termbases/{termbaseId}/multimedia - Add images/media

What's Missing:

No bulk import endpoints for file-based imports (XML, TBX, CSV, Excel)
No batch concept creation endpoints
No import definition management via REST API

I'd love to be corrected, but I'm pretty sure this is accurate based on the documentation we provide.

[quote userid="179217" url="~/developers-more/trados-portfolio/trados-studio-developers/f/sdk_qa/58989/is-multiterm-api-thread-safe/187290"]one additional question regarding the documentation. In the documentation of the Trados Cloud Platform API (https://eu.cloud.trados.com/lc/api-docs/termbase-import-export) it is mentioned, that "Only empty termbases support importing content.".
But, a few lines later at the "duplicateEntriesStrategy" parameter : "override The content of the current entry with the same identifier will be replaced by the imported entry."
If the termbase must be empty to be able to support importing content, which content could be overwritten?[/quote]

A good question... the documentation does contain conflicting statements:

"Only empty termbases support importing content" - This suggests imports are restricted to empty termbases
Duplicate entry strategies (ignore, merge, override) - These options only make sense if the termbase already contains entries

Perhaps Patrick Andrew Hartnett can confirm whether this is a documentation error or duplicate strategies that might be describing intended functionality that isn't fully implemented yet?

RE: Is MultiTerm API thread safe?

Nils Jörn — Fri, 12 Sep 2025 09:50:34 GMT

Hi Daniel Brockmann ,

one additional question regarding the documentation. In the documentation of the Trados Cloud Platform API (https://eu.cloud.trados.com/lc/api-docs/termbase-import-export) it is mentioned, that "Only empty termbases support importing content.".
But, a few lines later at the "duplicateEntriesStrategy" parameter : "override The content of the current entry with the same identifier will be replaced by the imported entry."
If the termbase must be empty to be able to support importing content, which content could be overwritten?
Do I misunderstand the documentation or is that a failure in the documentation?
Thanks in advance for your clarification.

Best regards
Nils

RE: Is MultiTerm API thread safe?

Nils Jörn — Fri, 12 Sep 2025 09:29:18 GMT

Hi Daniel Brockmann ,

thanks for your update. Do I understand you correctly that we could also import the terminology data into our MultiTerm server database using the GroupShare REST API? Then that would probably be a really good alternative to a command line tool.

Best regards
Nils

RE: Is MultiTerm API thread safe?

Daniel Brockmann — Fri, 12 Sep 2025 09:15:48 GMT

Hi Nils - because you mentioned thread safety - I guess desktop APIs cannot be as robust as server- or cloud based REST APIs with scalability and robustness built in by design. We have products for all ways of working - local, server/on-premise, cloud - and I was just pointing out that in your particular case, the GroupShare REST API (with terminology-specific REST calls) or cloud based terminology might be a potential future path. For the Passolo context, the GroupShare REST API might be worth a look as you have it already anyway. Thanks, Daniel

RE: Is MultiTerm API thread safe?

Nils Jörn — Fri, 12 Sep 2025 09:05:48 GMT

Good morning Daniel Brockmann ,

thank you very much for your soon reply.

Why are you wondering if the cloud-based terminology might be a better choice for this use case? Why could Trados Terminology be a better choice for us? And would it be a replacement for our MultiTerm/GroupShare server?
Unfortunately, I'm not that familar with all the different RWS tools (MultiTerm, Trados Terminology, LanguageWeaver, ...).

We're using MultiTerm in addition to Passolo for translating our applications and get a tbx export from another terminology database which isn't compatible with Passolo. Therefore, we're currently using MultiTerm.

Thank you very much in advance for your further informations.

Best regards
Nils

RE: Is MultiTerm API thread safe?

Daniel Brockmann — Fri, 12 Sep 2025 07:52:07 GMT

Hi Nils - I am wondering if our cloud-based terminology (called Trados Terminology) might be a better choice now for this kind of use case. Its API is described here: Trados Cloud Platform API Documentation. Another alternative could be to use the REST-based API for server-based termbases - I think you can access its documentation on our public GroupShare server at https://groupsharedev.sdlproducts.com/documentation/api/index#/. Thanks, Daniel

RE: How to verify if database import or export by API has been successful

Nils Jörn — Mon, 08 Sep 2025 07:49:11 GMT

Dear all,

as there is a log file, written by the import process, I like to know, what strings are possible at the end, mentioning, if the import has been successful or not.

Currently, it seems to me that in case of a successful import at the end of the log file, there are only two lines after the last "Entry number x (x) replaced existing entry." mentioning the start and endtime of the process. Unfortunately, there seem to be no information, if the import has been successful or not.

Please be so kind to let me know, how to receive the information from the log file, if the import has been successful. Which entry is written in case of a successful and which in case of an unsuccessful import?

Thank you very much in advance.

Best regards
Nils

RE: Custom Plugin Development for MultiTerm

Patrick Andrew Hartnett — Tue, 03 Jun 2025 07:09:14 GMT

Hi Helena Grulichova , MultiTerm does not provide an official/plugins SDK comparable to Trados Studio’s plugin architecture.There's no supported way to develop in-process or in-app add-ins that extend the MultiTerm Desktop UI to add custom actions triggered by user interaction (e.g. add/edit entries ...)

The COM and .net API's enable you to develop an external service or app that interacts with MultiTerm termbases via the available API.

Referece: developers.rws.com/.../connect.html

Custom Plugin Development for MultiTerm

Helena Grulichova — Thu, 17 Apr 2025 06:46:40 GMT

Hello,

Is it possible to develop a custom plugin for MultiTerm that integrates with it in a similar way to how plugins work in Trados Studio? So far, I’ve only come across standalone applications. We would like to add a custom action triggered when users add or edit entries in MultiTerm.

Thank you,
Helena

Customizing Termbase Search

Helena Grulichova — Wed, 09 Apr 2025 13:01:32 GMT

Hello,

We are using code like the following to search a termbase:

Termbase oTb = oTbs["Termbase name"];
TermbaseSearch search = oTb.Search;
search.Direction = Sdl.MultiTerm.TMO.Interop.MtSearchDirection.mtSearchDown;
search.MaximumHits = 10;
search.FuzzySearch = true;
search.SearchExpression = "search term";
search.SourceIndex = "English";
HitTerms oHits = search.Execute();

Is it possible to customize the search further? Specifically, we would like to lemmatize the terms in the termbase before performing the search.

We are using Trados Studio 2024.

Thank you,
Helena