Sitecore-ClayTablet Integration

 

Table of Contents

Table of Contents
Prerequisites for CT3 INSTALLATION
Environment specifics of our Case Study
Installation Steps
CT3 – BulK Translation
Troubleshooting

 

Prerequisites for CT3 INSTALLATION

1. Setting Your System Date, Time, & Time Zone Correctly
The Clay Tablet Connector sends content to and receives content from the Clay Tablet Platform, which is hosted in the Amazon Web Services (AWS) environment. AWS requires any machines that connect to its applications to have the correct system time and date settings.

NOTE: Before proceeding, ensure that the system date, time, and time zone are set correctly on any systems that will run the Clay Tablet 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.
2. Downloading the Delivery Package
Download the Clay Tablet Connector (“Connector”) delivery package from the link that Clay Tablet Technologies sends you. This is a .rar file, which is a zipped file that contains that contains the following four folders: Account, Documents, Sitecore Package and Workbox.

1
3. Setting Up the Translation Database
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.

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>

<!--

Sitecore connection strings.

All database connections for Sitecore are configured here.

-->

<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. Creating the Connector Folders
This section describes how to create folders that the Connector uses to store licensing information and translation data.

Under the Sitecore data folder, create the CT3 folder.

Important: Ensure that you create the CT3 folder under the Sitecore data folder, and not under the Sitecore website root folder. To locate the Sitecore data folder, check the Web.config file, searching for a line such as:

<sc.variable name="dataFolder" value="C:\Inetpub\wwwroot\Sitecore6\Data\"/>

. For the location in this example, you would create the CT3 folder as: “C:\Inetpub\wwwroot\Sitecore6\Data\CT3″.

Create two sub-folders under the CT3 folder you just created:

Accounts: Set folder security so that the Windows account used by IIS has read permission.

Data: Set folder security so that the Windows account used by IIS has full permission.

2
5. Installing the CMS Address Key and the Platform Key
Copy the file with the CMS address key (source.xml) and the file with the platform key (target.xml) from the <Delivery Package/Accounts> folder to the CT3/Accounts folder. This installs the license for one Sitecore instance and one translation provider.

3

Environment specifics of our Case Study:

Name Tool/Technologies
Operating System Windows 7 Professional (64 Bit)
Development Tool Visual Studio 2012, .net Framework 4.5
Web Server IIS 7.5
Database SQL Server 2008 R2 SP1
Framework .net Framework 4.5
Model View Controller MVC 5.2
Sitecore Sitecore Experience Platform 8.1 rev. 151207
ClayTablet CT_Sitecore-3.9.6

 

Installation Steps

1. Login Sitecore, go to Sitecore desktop -> Development Tools -> Click on Installation Wizard.

4

2. Upload the CT3 package that you have downloaded and click next.

5

3. While uploading check the “Overwrite Existing Files” checkbox.

6

4. Now click on next.

7

5. Select accept and click next.

8

6. Read the note and click Next.

9

7. Check the version detials and click “Install”

10

8. Click on “Install” and you will see a screen similar to the screen shot depicted below. It will take anywhere between 5-20 minutes to get installed. For me it took only 5 minutes.

11

9. Once installed, you will see a screen as below. It says “The package has been installed”. And you will be prompted with two options: choose “Restart Sitecore Client” and click “Close”.

12

10. Your installation part is complete, and you can now trace “CTC TRANSLATION” in  your content editor as shown below:

13

CT3 – BulK Translation

  1. In content Editor, go to “CTC TRANSLATION”, as shown below:

 13 

  1. Click on Bulk Translation

 14 

  1. Click Next:

 15

  1. Select source and target langauge as shown below:

16

  1. Click next and select item/items to translate

17

  1. Click Next

18

  1. Click Next

19

  1. Click Next
  1. Select “Send Items to Translation Provider”, give a name to the Job

20

  1. Click “Next”

21 

  1. Click on “Submit” and you will see a screen as below:

22

  1. Close this wizard and click on “Translation Status”

23

  1. Wait a few minutes and you will see the items you had sent are 100% complete:

24

  1. To verify go to the item in Sitecore content tree and you will find new version of the items in the translated language:

25

  1. See the translated content:

26

Troubleshooting 

Issue 1: The Upgrade Issue

 27

Resolution: The error that you have reported is usually due to three possible reasons:

  1. There is a mismatch between the file name of the key that is located in the \Data\CT3\Accounts folder and the path and file name as written to the CT3Translation.config file. Please verify the key name (default name is source.xml) and that it is being referenced correctly.
  2. When your environment is placed behind a proxy server. (see Below)
  3. When your environment is behind a Firewall and has not been configured correctly as per the Install and Config Guide, section “Configuring Network Settings for a Firewall

If it is placed behind a proxy:

The Clay Tablet connector communicates through the Sitecore instance. So you need to configure the Sitecore instance to communicate through the proxy. An example of how to do this type of configuration is provided below.

On the Sitecore server, navigate to the Web.config file and open it in a text editor. For example, the location of this file may be C:\inetpub\wwwroot\Sitecore66\Website.

Add the following....
 <system.net> <defaultProxy> <proxy proxyaddress="url:port" bypassonlocal="true" /> </defaultProxy> </system.net>

Or

<system.net> <defaultProxy useDefaultCredentials="true"> <proxy usesystemdefault="False" scriptLocation="http://<IIS Server or IP Address>/wpad.dat (http://%3cIIS%20Server%20or%20IP%20Address%3e/wpad.dat)" /> </defaultProxy> </system.net>
Also add
 <appSettings><add key="CT_AWSS3Connection_NeedProxy" value="True"/></appSettings>

(The url:port would be the location of the proxy server you’re using.)

Last thing: can you access the urls below using Firefox\Chrome from the box where Sitecore is installed and send me on a screen grabs of the results

HTTP Port 80 For access to Amazon’s AWS S3 XML namespace and XSD file http://s3.amazonaws.com
HTTP Port 80 For access to Amazon’s AWS SQS XML namespace and XSD file http://queue.amazonaws.com
HTTPS Port 443 For secure access to Amazon’s AWS S3 service https://s3.amazonaws.com
HTTPS Port 443 For secure access to Amazon’s AWS SQS service https://queue.amazonaws.com

 

Issue 2: Cannot Verify Key

 28

Resolution: Same as Issue 1.

Issue 3: Translation Status shows the translation percentage as 2%, 5% and never increases:

Resolution:

Go to CT3 folder -> Data

–  Create “FailedFiles”, “files” and “ManualFiles” folders as shown below:

 29

Go to files and create “source” and “target” folders as shown in the below screen shot.

 30

This was my experience working with Sitecore and CT3 :-)

Leave a Reply

Your email address will not be published. Required fields are marked *

You may use these HTML tags and attributes: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <s> <strike> <strong>