Skip to main content
 

How can we help?

Search

Import Terms with the Term Transfer Tool

  • Updated

You can import terms by running the Term Transfer Tool from the command line with the appropriate parameters.

To import terms, run the Term Transfer Tool with the following command:

$ bash ./transfer.sh --import [--usage|--deploy|--legacy] --server <serverAddress> --user <userName> --password <password> --config <importConfig> --filename <filename> [--charset <charset>]

Example

transfer.bat --import --legacy --server acrolinx.demo-inc.com --user admin --password qe8TedAC --config DemoTermsImport --filename c:\files\import\demoterms.csv --charset UTF-8

You can use the following options and arguments to import terms with the Term Transfer Tool script. For each argument, you can use either the abbreviated ("-d") or the full name ("-deploy"):

Option

Description

-? (--usage or --help)

(Optional) Display help for the arguments.

--import

Select import mode.

-d (--deploy)

(Optional) Deploy the imported terms for checking after the import is complete. After the import, the Term Transfer Tool automatically reloads the language configuration on all language servers.

You can only use this option when connecting to Acrolinx versions 2.4 or later. You also need the privilege "Reload language server configuration."

-l (--legacy)

(For legacy Acrolinx versions only) Connect to Acrolinx version 2.3 or earlier.

-s (--server) <serverAddress>

Set your Acrolinx URL.

Example

https://acrolinx.demo-inc.com

-u (--user) <userName>

Set the username that you use to sign in to Acrolinx.

-p (--password) <password>

Set the password that you use to sign in to Acrolinx.

-k <API token>

(Optional) Send an API token to the server for authentication and authorization purposes. You can't use this along with the -p option, which specifies a password.

Note

Note that the user who owns the API token needs to have the "Access API-based terminology applications" privilege.

-c (--config) <importConfig>

Set the name of the saved import configuration that contains the import settings for your import file.

-i (--filename) <filePath>

The path to the import file.

-t (--charset) <charset>

(For legacy Acrolinx versions only) Set the encoding of your import file when connecting to Acrolinx versions 2.3 or earlier.

You can use one of the following supported character sets:

  • US-ASCII

  • ISO-8859-1

  • UTF-8

  • UTF16BE

  • UTF-16LE

  • UTF16

You can also enter the name of any character set listed on the Internet Assigned Numbers Authority (IANA) website.

On Acrolinx versions 2.4 or later, the encoding is defined in the saved import configuration for CSV files or in the encoding attribute in XML files.

-n (--noCheckCertificate)

(Optional) Set the importer to not check the server certificate when using HTTPS.

-v

(Optional) Prints the version information to the command line.

Note

If this option is present, the tool will ignore all other options and only print version information.

Configure All Existing Terms to Be Deleted on Import

To make sure your Acrolinx terminology database always reflects the current state of your source terminology database, you can configure your Terminology Manager to delete all existing terms before each new import. Do this by editing the saved import configuration that you use for your import tasks.

To configure all existing terms to be deleted on import, follow these steps:

  1. Navigate to Terminology > Import & Export > Saved Configurations and download the relevant saved import configuration.

  2. Open the downloaded file in a text editor of your choice and look for the property importMode.

  3. Change the value of importMode as follows:

    • importMode=REPLACE - to remove the old terms and insert the new terms in one transaction.

      Notice

      Always select this import mode unless you have issues during term transfer.

    • importMode=REPLACE2 - to remove the old terms and insert the new terms in two separate transactions. This import mode can solve issues that might occur when transferring terms in very large databases. The disadvantage of this import mode is that it isn’t possible to roll back to the previous database state if an error occurs during the insertion phase. Use this import mode only if you have issues during term transfer.

  4. Save and upload the file to the Saved Configurations page.

    When you upload the file, select the configuration type Import.

    The next time you select the edited import configuration for an import task, Acrolinx deletes all existing terms before the new terms are imported.