Before You Install
Before you begin to install the Lionbridge Connector for Sitecore, please review the system requirements, described in System Requirements, and perform the following pre-installation procedures:
- Setting Your System Date, Time, and Time Zone Correctly.
- Downloading the Delivery Package. This describes the contents of the Connector delivery package Lionbridge sends you.
- Setting Up the Translation Database. This section includes information about database size requirements as well as detailed instructions for Oracle and Microsoft SQL Server databases.
- Preparing the Connector for Scheduled Tasks (Upgrade only from version 4.0.8 or lower). This is required only if upgrading from version 4.0.8 or lower of the Connector. This section includes required steps for upgrading from the UploadService and DownloadService services, which were used in versions 4.0.8 and lower of the Connector to the Upload Schedule and Download Schedule Sitecore scheduled tasks, supported in versions 4.1.0 and higher of the Connector.
- Setting Up Sitecore Reflection authorization for the connector methods. As from June 20, 2023. According to the security meassures applied by Sitecore, and described in the Security Bulletin SC2023-003-587441. Sitecore configuration requires adding an explicit list of the connector methods that are allowed to be invoked using reflection.
1 - System Requirements
The Lionbridge Connector for Sitecore (Connector) must be installed on the machine where Sitecore is installed. The Connector supports Sitecore versions 9.0 to 10.3.
The Connector has no additional hardware or software requirements beyond those of Sitecore XP. For detailed requirements, refer to the appropriate version of the Sitecore CMS Installation Guide. This guide is in the documentation section available at https://doc.sitecore.net.
Note about Sitecore Azure: The Connector installation is supported for Sitecore installed via the Sitecore Azure Toolkit 8.2 and higher. For guidance on installing the Connector with the Sitecore Azure Module, please contact Lionbridge Connector Support.
The Connector supports the Mozilla Firefox, Google Chrome, and Microsoft Internet Explorer 11 web browsers.
2 - Setting Your System Date, Time, and Time Zone Correctly
The Connector sends content to and receives content from the Content API Platform, which is hosted in the Lionbridge environment and requires any machines that connect to its applications to have the correct system time and date settings.
Important: Before proceeding, ensure that the system date, time, and time zone are set correctly on any systems that will run the Connector. If these settings are incorrect, the following error message is displayed: Error. The difference between the request time and the current time is too large.
4 - Setting Up the Translation Database
You set up the database so that the Connector can use it to store translation-related data.
4.1 - Translation Database Size Requirements
The required size of the database depends on the volume of translation you anticipate. When the database is used only for translation-related data, 100MB is usually adequate. However, by default, the Lionbridge Connector backs up translation data, which it uses to support the Translation Correction and Update Remote TM features. For descriptions of these features, refer to the Lionbridge Connector for Sitecore User Guide.
- If you keep the default setting of backing up data so that you can use these features, you may need to increase the size of the database by 50 to 100 percent to support the backup.
- If you do not want to back up data, you do not need to increase the size of the database.
Note: To prevent the Connector from backing up translation-related data, you modify the ClayTablet.BackupTranslationData setting, described in Configuring Database Settings.
You can use the Connector to delete the translation-backup database at any time from the Sitecore Content Editor, however the relevant Connector features will not work properly. For instructions on deleting the backup, refer to the Lionbridge Connector for Sitecore User Guide.
4.2 - Setting Up a Microsoft SQL Server-Based Translation Database
This section describes how to set up a Microsoft SQL Server database to use with the Connector. For information on database size requirements, see Translation Database Size Requirements.
- Use Microsoft SQL Server Management Studio to create an empty database. For detailed instructions, refer to the Microsoft SQL Server documentation.
Recommendation: Name the new database CT3Translation.
Note: Set your default database collation to SQL_Latin1_General_CP1_CI_AS.
- Configure the Connector database connection string. The Website_root/App_Config/ConnectionStrings.config file defines the database connections.
Important: The database part of the connection string must match the database name you created in the previous step.
Typically, it should be:
<?xml version=“1.0” encoding=“utf-8”?>
<connectionStrings>
<add name=“core” connectionString=“user id=xxx;password=xxxt;Data Source=xxx;Database=XXX_Core”/>
<add name=“master” connectionString=“user id=xxx;password=xxxt;Data Source=xxxx;Database=XXX_Master”/>
<add name=“web” connectionString=“user id=xx;password=xxx;Data Source=xxx;Database=XXX_Web”/>
</connectionStrings>
You must add one more connection string called CT3Translation for the Connector database. This is the name of the database from above:
<add name=“CT3Translation” connectionString=“user id=xxx;password=xxx;Data Source=xxx;Database= CT3Translation “/>
Note: Do not use any name other than CT3Translation for the connection string.
The User ID, password, and Data Source values are usually the same as those used for the other connection strings.
Note: The user specified in the connection string must have permission to modify the table structure in the database. This user must have permission to run ALTER TABLE statements.
4.3 - Setting Up an Oracle-Based Translation Database
This section describes how to set up an Oracle database to use with the Connector. For information on database size requirements, see Translation Database Size Requirements.
Recommendation: Create a separate Oracle database user for Content API data. Alternatively, you can use an existing Oracle database user for Content API data.
- Optional. Create a Oracle database user for Content API data, using SQL statements similar to the following:
CREATE USER ctttrans IDENTIFIED BY xxxxxxxx
DEFAULT TABLESPACE users TEMPORARY TABLESPACE temp;
GRANT UNLIMITED TABLESPACE TO ctttrans;
GRANT CONNECT, CREATE TABLE TO ctttrans;
- Add a CT3Translation.Oracle connection to the Sitecore connection string configuration. Add the following to the Sitecore connection string configuration:
<add name=“CT3Translation.Oracle” connectionString=“user id=ctttrans;password=xxxxxxxx;Data Source=XE”/>
Depending on the active configuration in the user’s setup, this is one of the following:
- Website/App_Config/ConnectionStrings.config
- Website/App_Config/ConnectionStringsOracle.config
Note: The user specified in the connection string must have permission to modify the table structure in the database. This user must have permission to run ALTER TABLE statements.
- Ensure that the right version of Oracle.DataAccess.dll is in the Website/bin directory or in the right path. The DLL should match the Oracle database that the user is using. If the user is already using Oracle as the database for the Sitecore content, this should already be set up correctly.
4.4 - Setting Up a Microsoft Azure SQL-Based Translation Database
This section describes how to set up a Microsoft Azure SQL database to use with the Connector. For information on database size requirements, see Translation Database Size Requirements.
- Create an empty Azure database. For detailed instructions, refer to the Microsoft Azure documentation.
Recommendation: Name the new database CT3Translation.
Note: Set your default database collation to SQL_Latin1_General_CP1_CI_AS.
- Configure the Connector database connection string. The Website_root/App_Config/ConnectionStrings.config file defines the database connections.
Important: The database part of the connection string must match the database name you created in the previous step.
Typically, it should be:
<?xml version=“1.0” encoding=“utf-8”?>
<connectionStrings>
<add name=“core” connectionString=“user id=xxx;password=xxxt;Data Source=xxx;Database=XXX_Core”/>
<add name=“master” connectionString=“user id=xxx;password=xxxt;Data Source=xxxx;Database=XXX_Master”/>
<add name=“web” connectionString=“user id=xx;password=xxx;Data Source=xxx;Database=XXX_Web”/>
</connectionStrings>
You must add one more connection string called CT3Translation for the Connector database. This is the name of the database from above:
<add name=“CT3Translation” connectionString=“Data Source=tcp:SERVER.database.windows.net;Initial Catalog=DB_NAME;Integrated Security=False;User ID=USER_NAME@SERVER;Password=PASSWORD;Encrypt=True”/>
For example:
<add name=“CT3Translation” connectionString=“Data Source=tcp:mpr0fb9mzh.database.windows.net;Initial Catalog=CTT;Integrated Security=False;User ID=CTT@mpr0fb9mzh;Password=csct@blet99;Encrypt=True”/>
Note: Do not use any name other than CT3Translation for the connection string.
The User ID, Password, and Data Source values are usually the same as those used for the other connection strings.
Note: The user specified in the connection string must have permission to modify the table structure in the database. This user must have permission to run ALTER TABLE statements.
4.5 - Configuring Database Settings
You configure the Connector’s database settings by modifying the following configuration file: Website_root/Website/App_Config/Include/CT3Translation.config. You can specify the following settings:
| Setting Name |
Description |
Supported Values |
Default Value |
ClayTablet.
Translation
Database |
The location of your Sitecore content. If your Sitecore content is not in the master database, then you must change this value to match the name of your content database. |
a database name |
master |
ClayTablet.
Backup
TranslationData |
Determines whether or not the Connector stores backup translation data on the Content Editor server to support the Translation Correction and Update Remote TM features. For descriptions of these features, refer to the Lionbridge Connector for Sitecore User Guide. If you do not want to use these features, you can change this setting to False. This prevents substantial amounts of data from being stored on your Sitecore server, but it also prevents your company from accessing these useful features.
Recommendation: Initially keep the default setting of True in case you want to use any of the features that rely on this data. |
* True
* False |
True |
5 - Preparing the Connector for Scheduled Tasks (Upgrade only from version 4.0.8 or lower)
Version 4.1.0 or higher of the Connector uses the Upload Schedule and Download Schedule Sitecore scheduled tasks to send content for translation to the Clay Tablet Platform and to retrieve translated content from there. These scheduled tasks replace the UploadService and DownloadService services, which were used in versions 4.0.8 and lower of the Connector.
Important: If you are upgrading from versions 4.0.8 or lower of the Connector to version 4.1.0 or higher, you must complete the following steps before installing the Connector package.
To prepare the Connector for scheduled tasks during an upgrade:
- Open
Sitecore.Processing.config for editing.
- In Sitecore 8.x, this file is in the following location: \Website\App_Config\Include.
- In Sitecore 9.x and above, this file is in the following location: \App_Config\Sitecore\CMS.Core.
- Locate the following section in the file:
<!-- An agent that processes scheduled tasks embedded as items in the master database. –>
<param desc=“database”>master</param>
<param desc=“schedule root”>/sitecore/system/tasks/schedules</param>
<LogActivity>true</LogActivity>
</agent>
- Modify the run interval of the
Master_Database_Agent, bolded in the sample above, to the same or less than the interval previously configured for the UploadService and DownloadService services. For example, if the previously configured interval for these services was every two minutes (the Connector default setting), then change:
interval=“00:10:00”
to
interval=“00:02:00”
- Save your changes.
Recommendation: Open Website_root/Website/App_Config/Include/CT3Translation.config for editing. Remove the entire <scheduling> section from the file. This step will prevent obsolete entries in the Connector log files. Save your changes.
Important notes about previous configurations of the Upload Service and Download Service in CT3Translation.config in version 4.0.8 or lower of the Connector
- Polling interval: Any previous modifications to the default polling intervals of the Upload Service and Download Service in
CT3Translation.config are not automatically upgraded. To change the polling interval, you must configure the Upload Schedule and Download Schedule scheduled tasks in:
- /sitecore/system/Tasks/Schedules/Lionbridge/Download Schedule
- /sitecore/system/Tasks/Schedules/Lionbridge/Upload Schedule
For detailed instructions, see Modifying the Polling Interval of the Scheduled Tasks.
- Configuring the Connector to send all items in the Queue for translation: Any previous configuration in
CT3Translation.config to automatically send out items in the Translation Queue for translation is not automatically upgraded. You must configure the /sitecore/system/Tasks/Schedules/Lionbridge/Upload Schedule/Upload Service Options item to recreate this functionality. For detailed instructions, see Configuring the Connector to Send All Items in the Queue for Translation.
6 - Setting Up Sitecore Reflection authorization for the connector methods
As from June 20, 2023. According to the security meassures applied by Sitecore, and described in the Security Bulletin SC2023-003-587441. Sitecore configuration requires adding an explicit list of the connector methods that are allowed to be invoked using reflection.
To prepare Sitecore to allow the connector methods being invoked using reflection:
- Open
Sitecore.Reflection.Filtering.config for editing.
- In Sitecore 8.x, this file is in the following location: \Website\App_Config\Include.
- In Sitecore 9.x and above, this file is in the following location: \App_Config\Sitecore\CMS.Core.
- Add the explicit inclusion of the connector methods as following:
<configuration xmlns:role="http://www.sitecore.net/xmlconfig/role/" xmlns:security="http://www.sitecore.net/xmlconfig/security/" xmlns:patch="http://www.sitecore.net/xmlconfig/">
<sitecore>
<reflection>
<allowedMethods>
<descriptor type="ClayTablet.SC.CT3_BulkTranslation" methodName="Add_Branch_Click" assemblyName="ClayTablet.SC" hint="CT3Add_Branch_Click"/>
<descriptor type="ClayTablet.SC.CT3_BulkTranslation" methodName="Add_Item_Support_Click" assemblyName="ClayTablet.SC" hint="CT3Add_Item_Support_Click"/>
<descriptor type="ClayTablet.SC.CT3_BulkTranslation" methodName="Add_Rootonly_Click" assemblyName="ClayTablet.SC" hint="CT3Add_Rootonly_Click"/>
<descriptor type="ClayTablet.SC.CT3_BulkTranslation" methodName="OnFieldClicked" assemblyName="ClayTablet.SC" hint="CT3OnFieldClicked"/>
<descriptor type="ClayTablet.SC.CT3_BulkTranslation" methodName="OnSourceChanged" assemblyName="ClayTablet.SC" hint="CT3OnSourceChanged"/>
<descriptor type="ClayTablet.SC.CT3_BulkTranslation" methodName="Add_Branch_Support_Click" assemblyName="ClayTablet.SC" hint="CT3Add_Branch_Support_Click"/>
<descriptor type="ClayTablet.SC.CT3_BulkTranslation" methodName="Remove_Branch_Click" assemblyName="ClayTablet.SC" hint="CT3Remove_Branch_Click"/>
<descriptor type="ClayTablet.SC.CT3_BulkTranslation" methodName="CreationDateFilter_ClearFilter" assemblyName="ClayTablet.SC" hint="CT3CreationDateFilter_ClearFilter"/>
<descriptor type="ClayTablet.SC.CT3_BulkTranslation" methodName="ModificationDateFilter_ClearFilter" assemblyName="ClayTablet.SC" hint="CT3ModificationDateFilter_ClearFilter"/>
<descriptor type="ClayTablet.SC.CT3_BulkTranslation" methodName="PublishFilter_ClearFilter" assemblyName="ClayTablet.SC" hint="CT3PublishFilter_ClearFilter"/>
<descriptor type="ClayTablet.SC.CT3_BulkTranslation" methodName="OnSelectAllToggle" assemblyName="ClayTablet.SC" hint="CT3OnSelectAllToggled"/>
<descriptor type="ClayTablet.SC.CT3_BulkTranslation" methodName="OnUnSelectBranchFromTree" assemblyName="ClayTablet.SC" hint="CT3OnUnSelectBranchFromTree"/>
<descriptor type="ClayTablet.SC.CT3_BulkTranslation" methodName="OnRemoveItems" assemblyName="ClayTablet.SC" hint="OnRemoveItems"/>
<descriptor type="ClayTablet.SC.CT3_BulkTranslation" methodName="OnChangeSendTo" assemblyName="ClayTablet.SC" hint="CT3OnChangeSendTo"/>
<descriptor type="ClayTablet.SC.CT3_BulkTranslation" methodName="OnSelectBranchFromTree" assemblyName="ClayTablet.SC" hint="CT3OnSelectBranchFromTree"/>
<descriptor type="ClayTablet.SC.CT3_BulkTranslation" methodName="RefreshSendStatus" assemblyName="ClayTablet.SC" hint="CT3RefreshSendStatus"/>
<descriptor type="ClayTablet.SC.CT3_BulkTranslation" methodName="OnItemUpdate" assemblyName="ClayTablet.SC" hint="CT3OnItemUpdate"/>
<descriptor type="ClayTablet.SC.CT3_BulkTranslation" methodName="OnChangeProvider" assemblyName="ClayTablet.SC" hint="CT3OnChangeProvider"/>
<descriptor type="ClayTablet.SC.CT3_BulkTranslation" methodName="chooseSelectItemByJob" assemblyName="ClayTablet.SC" hint="CT3chooseSelectItemByJob"/>
<descriptor type="ClayTablet.SC.CT3_BulkTranslation" methodName="sortJobsByDate" assemblyName="ClayTablet.SC" hint="CT3sortJobsByDate"/>
<descriptor type="ClayTablet.SC.CT3_AddFilter" methodName="OnFieldClicked" assemblyName="ClayTablet.SC" hint="CT3AFOnFieldClicked"/>
<descriptor type="ClayTablet.SC.CT3_AddFilter" methodName="OnOptionFieldClicked" assemblyName="ClayTablet.SC" hint="CT3AFOnOptionFieldClicked"/>
<descriptor type="ClayTablet.SC.ItemTnsStatusForm" methodName="OnClickReload" assemblyName="ClayTablet.SC" hint="CT3ITSFOnClickReload"/>
<descriptor type="ClayTablet.SC.CT3_Translation" methodName="OnChangeSendTo" assemblyName="ClayTablet.SC" hint="CT3Translation_OnChangeSendTo"/>
<descriptor type="Sc.ClayTablet.WorkboxEx.ExWorkboxForm" methodName="LanguageChange" assemblyName="Sc.ClayTablet.WorkboxEx" hint="CT3LanguageChange"/>
<descriptor type="Sc.ClayTablet.WorkboxEx.ExWorkboxForm" methodName="SortChange" assemblyName="Sc.ClayTablet.WorkboxEx" hint="CT3SortChange"/>
<descriptor type="Sc.ClayTablet.WorkboxEx.ExWorkboxForm" methodName="OrderChange" assemblyName="Sc.ClayTablet.WorkboxEx" hint="CT3OrderChange"/>
<descriptor type="ClayTablet.SC.CT3_Translation" methodName="OnChangeLng" assemblyName="ClayTablet.SC" hint="CT3Translation_OnChangeLng"/>
<descriptor type="ClayTablet.SC.CT3_Translation" methodName="OnChangeProvider" assemblyName="ClayTablet.SC" hint="CT3Translation_OnChangeProvider"/>
<descriptor type="ClayTablet.SC.CT3_BatchTmUpdate" methodName="RefreshPrepStatus" assemblyName="ClayTablet.SC" hint="CT3RefreshPrepStatus"/>
</allowedMethods>
</reflection>
</sitecore>
</configuration>
- Save your changes.