About this feature
This guide describes how to set up an automatic export of your Lexeri termbase to Congree. Once set up, Lexeri regularly exports your termbase as a TBX file to the hot folder of your Congree tenant and automatically starts the import there. This way, Congree always checks your texts against the current terminology from Lexeri.
Note: The plug-in is currently available as a beta version. Some features may still change, and errors may occur. We welcome your feedback at service@lexeri.com.
In this article
- Prerequisites
- Step 1: Request credentials from Congree
- Step 2: Open the "Schedule automatic export" wizard
- Step 3: Configure the Congree integration
- Step 4: Set the export schedule
- Step 5: Select languages and filters
- How an export works
- What data is exported
- Troubleshooting
Prerequisites
- In Congree: A Congree tenant with access to the Congree interface for terminology import (TermImportSolution API).
- A hot folder for file exchange.
- The credentials for this interface: server URL, tenant ID, username, and password.
- In Lexeri: the termbase administrator role or, if you use custom roles, the permissions required to set up integrations for the termbase in question.
- In Lexeri: the automatic exports extension.
Step 1: Request credentials from Congree
Unlike with other target systems, you don't create the credentials for the Congree import yourself. Congree sets up the hot folder and the import for your tenant.
- Contact your Congree representative and let them know that you want to import terminology from Lexeri automatically.
- Ask them for the server URL, the tenant ID, and the username and password for the import interface.
- Find out which file name your tenant's import reads files under. Lexeri uses
lexeri-export.tbxunless you specify otherwise.
Note: Congree imports only the file with the name set up for your tenant. If the name in Lexeri differs, the export is uploaded but not imported.
Step 2: Open the "Schedule automatic export" wizard
- In Lexeri, open the termbase you want to export.
- Go to the termbase settings and open the Exports tab.
- Click Schedule automatic export.
- Select Congree as the target system and click Next.
Step 3: Configure the Congree integration
- Enter the credentials from Step 1:
-
Server URL: the address of your Congree server, such as
https://partner.getcongree.com. You can also enter the URL exactly as Congree gave it to you, including the path/CongreeTermImportSolutionAPI. - Tenant ID
- Username
- Password
-
Server URL: the address of your Congree server, such as
- Leave the File name (optional) field empty if your tenant's import reads the file
lexeri-export.tbx. Enter a name here only if Congree has set up a different one for you. If the extension is missing, Lexeri adds.tbx. - Click Next.
Lexeri verifies the credentials directly with Congree before you continue. If the connection fails, the message "The connection to Congree failed" appears. In that case, check the server URL, tenant ID, username, and password.
Note: Unlike with Crowdin or Smartling, you don't select a glossary or termbase in the target system: A Congree tenant has exactly one hot folder, and Lexeri exports to it.
Step 4: Set the export schedule
- Select the interval at which the terminology is to be exported to Congree: daily, weekly, or monthly.
Step 5: Select languages and filters
- Select the source language and the languages to export.
- If needed, set filters for the export.
The terminology is now exported to Congree according to your settings.
How an export works
- For each scheduled export, Lexeri creates a TBX file in the Congree TBX format, uploads it as a ZIP archive to your tenant's hot folder, and unpacks it there under the file name you set.
- The import in Congree then starts. Lexeri waits for the result of the import. You don't need to trigger anything manually in Congree.
- The ZIP archive makes it possible to transfer even large termbases. Congree limits uncompressed uploads to about 10 MB.
- You can see the newly created export plan in Lexeri in the list of automatic exports. There, you can pause the automatic exports or delete the plan.
What data is exported
Lexeri exports in Congree's TBX dialect. The exported data includes:
- Terms with usage status (such as preferred, admitted, prohibited), part of speech, gender, number, and term type
- Definitions and their sources
- Usage examples and source references for terms
- Subject areas
- Custom fields of term entries and terms
Good to know:
- Congree has no language-independent terms. For this reason, Lexeri copies terms in "Do not translate" into every exported language. To make this work, also select "Do not translate" in Step 5.
- Values such as usage status or part of speech are mapped in Congree through your tenant's import configuration. Custom usage statuses from Lexeri arrive in Congree with their identifier and can be mapped there as well.
- Images, notes, tags, and relations are currently not exported.
Troubleshooting
- The export plan shows "Failed": Lexeri couldn't transfer the file, or Congree reported an error during the import. A common cause is changed credentials. Because the credentials of an existing plan can't be edited, delete the plan and create it again with the current credentials.
- The export plan is active, but no changes arrive in Congree: Check with your Congree representative whether your tenant's import is set to the same file name as the export in Lexeri. Congree accepts a file with a different name but doesn't import it, and it shows no error message.