ConfigurationLast updated: 7 October 2024

Default settings are ones that primarily control how the add-on interacts with ExpressionEngine and its wider server environment.

Each of the System Defaults options are described below:

Settings

Enable JCOGS Auto-Translate

Controls whether the add-on is in operation or not.  When this is set to off JCOGS Auto-Translate tags within your templates will be disabled - i.e. the tags will be read and removed from your templates, but produce no output.

Choose default translation service

You can control which translation service is used at the tag level, but if this is not specified the service chosen from this drop-down is used. The default choice is DeepL.

Caching and System Options

Auto-Translate Caching Report

Provides a concise report on the size of the translation cache. The cache stores “text fragments” which broadly correspond to sentences of text within your template output.

Clear the Translation Cache

Click on this button to empty the translation cache.

Caching: Default time period (in seconds) to keep a cached copy of translations

Fragments are kept in the cache for the time specified here. The default period is 10 years and 1 day.

Enable Debugging Messages in Template Log

When enabled, causes helpful messages to be placed in the EE Template debug log recording what is happening as JCOGS Auto-Translate operates.

Auto-Translate provides a mechanism for accessing the DeepL Machine Translation Service. For this mechanism to work you will need to set up one or more account(s) with DeepL and provide the add-on with some information about such account(s). This panel captures some information about this/these accounts and also lets you set some default values for commonly used tag parameters.

DeepL Settings

DeepL API Key

This area gives a summary of current usage of the DeepL API key(s) specified in this table.

Enter your DeepL API keys into the table. You can add/remove/reorder your DeepL API key(s).

Each key you add will be validated with DeepL, and if valid a summary of the available translation capacity will be given.

If you enter more than one key JCOGS Auto-Translate will automatically rotate through the keys provided when generating translations: as one key is used up it will move on to using the next key in the table that has available translation capacity; it will progress through the keys in the order that they are placed in the table. To change the order simply drag / drop the rows to give the order that you prefer. 

To remove a key simply click on the trash icon on the RHS of the table.

Enable DeepL Translation

This slider controls whether a the DeepL machine translation service is to be used. If it is disabled in this settings panel, any EE Auto-Translate tags that are configured to use the service will have no function regardless of any parameters they may contain. Upon processing the EE Auto-Translate tags will simply return the specified text unchanged to the template.

Choose default source language for this translation service

If you choose a default source language, this will be sent to the translation service along with the text to be translated. Specifying the default source language may improve the quality of translation provided. If this value is not provided, and not provided via the from= parameter in the tag, the translation service will attempt to determine the source language automatically.

Auto-Translate provides a mechanism for accessing the MS Azure AI Translator service. For this mechanism to work you will need to set up one or more account(s) with Microsoft and provide the add-on with some information about such account(s). This panel captures some information about this/these accounts and also lets you set some default values for commonly used tag parameters.

Microsoft Settings

Microsoft API Key

This area contains a table into which you can add/remove/reorder your Microsoft API key(s).

Microsoft requires that you add the Microsoft Key Region for each API key you enter. Without this Key Region information, the key will fail validation with Microsoft and be marked Not valid.

Each key you add will be validated with Microsoft, and the status returned will be shown in the “status” column of the table.

If you enter more than one key JCOGS Auto-Translate will automatically rotate through the keys provided when generating translations: as one key is used up it will move on to using the next key in the table that has available translation capacity; it will progress through the keys in the order that they are placed in the table. To change the order simply drag / drop the rows to give the order that you prefer. 

To remove a key simply click on the trash icon on the RHS of the table.

Enable MS Azure AI Translation Service?

This slider controls whether a the  MS Azure AI Translator machine translation service is to be used. If it is disabled in this settings panel, any EE Auto-Translate tags that are configured to use the service will have no function regardless of any parameters they may contain. Upon processing the EE Auto-Translate tags will simply return the specified text unchanged to the template.

Choose default source language for this translation service

If you choose a default source language, this will be sent to the translation service along with the text to be translated. Specifying the default source language may improve the quality of translation provided. If this value is not provided, and not provided via the from= parameter in the tag, the translation service will attempt to determine the source language automatically.

Auto-Translate provides a mechanism for accessing the MS Azure AI Translator service. For this mechanism to work you will need to set up one or more account(s) with Microsoft and provide the add-on with some information about such account(s). This panel captures some information about this/these accounts and also lets you set some default values for commonly used tag parameters.

Settings

Microsoft API Key

This area contains a table into which you can add/remove/reorder your Microsoft API key(s).

Microsoft requires that you add the Microsoft Key Region for each API key you enter. Without this Key Region information, the key will fail validation with Microsoft and be marked Not valid.

Each key you add will be validated with Microsoft, and the status returned will be shown in the “status” column of the table.

If you enter more than one key JCOGS Auto-Translate will automatically rotate through the keys provided when generating translations: as one key is used up it will move on to using the next key in the table that has available translation capacity; it will progress through the keys in the order that they are placed in the table. To change the order simply drag / drop the rows to give the order that you prefer. 

To remove a key simply click on the trash icon on the RHS of the table.

Enable MS Azure AI Translation Service?

This slider controls whether a the  MS Azure AI Translator machine translation service is to be used. If it is disabled in this settings panel, any EE Auto-Translate tags that are configured to use the service will have no function regardless of any parameters they may contain. Upon processing the EE Auto-Translate tags will simply return the specified text unchanged to the template.

Choose default source language for this translation service

If you choose a default source language, this will be sent to the translation service along with the text to be translated. Specifying the default source language may improve the quality of translation provided. If this value is not provided, and not provided via the from= parameter in the tag, the translation service will attempt to determine the source language automatically.

Auto-Translate is licensed software. For the add-on to work correctly you will need to enter a valid license key and its associated email address into this panel.

Each of the License options are described below:

License Validation & Settings

JCOGS Auto-Translate License Key

Provides feedback on the current licensing status of the add-on, and an input box to enter a license key value. 

Note: For more information about JCOGS Auto-Translate Licensing and how the license status affects how JCOGS Auto-Translate operates, see the separate section on this topic.

Enter License Key email address

Your license key is linked to the email address used when you purchased the license - you must enter both the license and the email for the key to be validated. Use this input box to enter the appropriate email.

Register a staging domain

You can enter here the domain name used by a staging server linked to the live EE site used to register the JCOGS Image license. 

The staging server domain can be one open to the public internet. 

If copy of this add-on is installed on an EE server located at the domain entered into the staging domain field, that copy of JCOGS Image will be automatically validated - you will not need (or be able) to enter your license details a second time.

Note: This field only appears after you have successfully entered a valid license for JCOGS Auto-Translate.

JCOGS License Server Domain

Contains information about the domain being used by the JCOGS License server.

Changing this value to an invalid value (i.e. a domain that is not a JCOGS License server) will make it impossible to validate your license. 

It is strongly recommended that you do not change this value unless instructed to do so by someone from JCOGS Design support.