Termweb

Setup and Configuration Guide for the Lilt-Termweb Connector

This guide will help you set up and configure the connector between Lilt and Termweb to seamlessly sync your terminology between the two platforms.

Prerequisites

Before starting, ensure the following prerequisites are met:

• A dictionary must exist in TermWeb:

  • It should contain one or more concepts with target language translations.

  • At least one target term must have a blank or Published "Term Process Status."

  • Note: Terms with the Deprecated status will not be transferred to Lilt.

• A Memory must be mapped in the connector. Terms will sync or update in this specified Memory.

• All terms synced via this connector will use the default term status (Draft, Unreviewed, or Reviewed) based on the Memory settings. To change this default status:

  1. Open the Settings panel of the Memory.

  2. Set the Default TB Entry Status.

Steps in TermWeb

1. Create a Lilt Account: Ensure you have an account with Lilt. It is recommended that the password expiration is set to 'indefinitely' for continuous connectivity.

2. Set Up Permissions: Determine how content is shared or assigned to Lilt. Termweb has user-based permissions for various Dictionaries and potentially API usage permissions. (Refer to TermWeb documentation for API usage permissions.)

3. Lilt User Settings: The user in Lilt must have an Administrator Role.

Running the Connector Job

To transfer terms (as a .tbx file) from Termweb to Lilt, ensure the following:

1. Connector Configuration: All fields listed above in the "Configuration" section must be filled out.

2. Dictionary in Termweb:

   • Must contain at least one term (concept) with:

     • A target language entry.

     • A "Term Process Status" that is not Deprecated (should be blank or Published).

3. Trigger the Import:

   • Set up the Schedule and Next Schedule fields, or

   • Click the Submit Import Job button to start the process manually.

FAQs and Technical Details

1. What term metadata is available through the Termweb API?

   • Review Termweb API documentation to understand the available metadata and how it integrates with Lilt.

2. Handling Multiple Translations:

   • If a term has multiple translations in a single language (e.g., French), only the first translation will be imported. Consider use cases where this might need to change.

3. API Calls for Language Codes:

   • Use the /dictionaries endpoint in Termweb to retrieve language codes required for configuration.

4. Handling Term Updates:

   • If a term is updated in Termweb, the new version will be included in the subsequent file added to the associated Lilt Memory.

Workflow Summary

1. Log in to Termweb.

2. Select the Dictionary with the terms to import.

3. Open the Connector Configuration in Lilt and complete the setup as described.

4. Submit the Terms through the connector.

5. Open the Target Memory in Lilt to confirm the imported terms.

6. Manage Resources: Verify the file upload and term import status.