Installation and Configuration Guidedocs-archive.clay-tablet.net/UCC/Clay_Tablet_Connector_UCC_Install… · you work through this document. Clay Tablet Platform The hosted (IaaS)

Clay Tablet Universal Content Connector

Installation and Configuration Guide

Version 1.7.5

October 6, 2016

CopyrightCopyright © 2005-2016 Clay Tablet Technologies Inc. All rights reserved.

All rights reserved. This document and its content are protected by Canadian copyright and intellectual property law, and are the exclusive property of Clay Tablet Technologies Inc. ("Clay Tablet").

This document and its content may not be copied, published, distributed, downloaded or otherwise stored in a retrieval system, transmitted or converted, in any form or by any means, electronic or otherwise, without the prior written permission of Clay Tablet. Information in this document is subject to change without notice and does not represent a commitment on the part of Clay Tablet.

Although the information in this document has been carefully reviewed, Clay Tablet does not warrant it to be free of errors or omissions. Clay Tablet reserves the right to make corrections, updates, revisions, or changes to the information in this document.

Clay Tablet Technologies is a registered trademark. All other brand and product names used in this document are the property of their respective owners. Clay Tablet disclaims any responsibility for specifying which marks are owned by which companies or organizations.

The contents of this document are the property of Clay Tablet Technologies.

Clay Tablet Universal Content Connector Installation and Configuration Guide Page 2

Version 1.7.5 October 6, 2016

Contents

1 Welcome to the Clay Tablet Universal Content Connector 4

1.1 Terminology 4

1.2 About the Clay Tablet Translation Platform 5

1.3 How the Connector Works with Microsoft Windows 5

1.4 Using this Guide 6

1.5 How to Contact Clay Tablet Support 7

2 Before You Install 10

2.1 System Requirements 11

2.2 Setting Your System Date, Time, and Time Zone Correctly 11

2.3 Creating Folders 11

2.4 Configuring the Connector 13

3 Installing the Clay Tablet Universal Content Connector 16

3.1 Installing the Connector Windows Service 16

3.2 Installing the Web Interface 16

3.2.1 Troubleshooting and Solving Web-Interface Installation Issues with Windows Server 2012 19

3.2.1.1 Translation Status Page does not Display Translation Projects 20

3.2.1.2 HTTP Error 404.17 20

4 Post-Installation Tasks 21

4.1 Setting Folder Permissions 21

4.2 Running the Connector 22

4.3 Specifying Connector Settings 23

4.3.1 Configuring the Notification Schedule 24

4.3.2 Managing Email Subscribers 24

4.3.3 Configuring the Email Server 25

4.3.4 Configuring Full Scans 26

5 Pre-Production Testing 28

6 Uninstalling the Connector 29



1 Welcome to the Clay Tablet Universal Content ConnectorWelcome to the Clay Tablet Universal Content Connector ("Connector"). This is Clay Tablet’s connector between any content system and the Clay Tablet Platform.

1.1 Terminology

Amazon AWS Amazon Web Services. A suite of web application products developed and sold by Amazon.com. Clay Tablet uses various AWS offerings in order to leverage their infrastructure and build rich, dynamic solutions for its customers, specifically, the Clay Tablet Platform. For details, see http://aws.amazon.com.

Amazon S3 Amazon Simple Storage Service. For details, see: http://aws.amazon.com/s3/. The Connector and the Clay Tablet Platform use Amazon S3 to provide temporary storage services for the content sent to and from translation.

Amazon SQS Amazon Simple Queue Service. For details, see: http://aws.amazon.com/sqs/. The Connector uses Amazon SQS to provide Message Queue Services.

Clay Tablet (CTT)

Clay Tablet Technologies, the corporate entity that publishes the Clay Tablet Connector and the Clay Tablet Platform.

Clay Tablet Universal Content Connector ("Connector")

The connector software that Clay Tablet Technologies has developed and provides, which runs as a Windows service to provide connectivity to our hosted Platform. In this document it is referred to as the Connector. This is the software you are installing and configuring as you work through this document.

Clay Tablet Platform

The hosted (IaaS) connectivity platform that receives and routes content from content systems, including content management systems (CMSs), to translation providers and back during implementation. Clay Tablet Technologies configures the Platform based on the number and nature of systems involved in your system architecture.

FTP Server File Transfer Protocol (FTP) is a standard network protocol used to transfer files from one host to another host over a TCP-based network, such as the Internet. Translation providers may receive and send files for translation using an FTP server.

IaaS Infrastructure as a Service. The Clay Tablet Platform is an IaaS, because it is a hosted platform.



1 Welcome to the Clay Tablet Universal Content Connector 1.1 Terminology

http://aws.amazon.com/

http://aws.amazon.com/s3/

http://aws.amazon.com/sqs/

Keys The Connector uses keys to establish a secure, discrete connection between the Connector instance and the Platform.Very important: Do not copy the translation address keys to multiple instances of your Connector installation, because this is a violation of the Clay Tablet License Agreement. Using the same translation address keys on multiple instances will cause the Connector to behave unexpectedly, which can result in lost translation content, orphaned projects, and inaccurate translation status reports. Clay Tablet will only support technical issues caused by duplicating or incorrectly installing translation address keys on a time and materials basis.

MT Machine translation. The translation provider can be a machine translation service, such as Google Translate.

On-Premise Platform

A version of the Clay Tablet Platform that is hosted on the premises of the Clay Tablet client, instead of on AWS.

Producer CMS or another content system that sends content or documents out for translation. In this case, this is Windows Explorer.

Provider A provider of translation services. The delivery of assets to the provider may be via an FTP server or a TMS connector.

Support Asset

Supporting documents and their metadata. Support assets are not translated by the translation provider, but they provide helpful context for the translator.

TMS Translation management system that the translation provider uses.

1.2 About the Clay Tablet Translation PlatformClay Tablet’s translation connectivity platform is the easiest, most flexible way to integrate content systems, including content management systems (CMSs) and other content producers, with translation providers and translation technologies.

Clay Tablet Platform is the hosted (IaaS) connectivity platform that receives and routes content from content management systems to translation providers and back. It is hosted on Amazon Web Services (AWS). During implementation, Clay Tablet Technologies configures the Platform for your translation solution, based on the translation providers or systems you use. The Clay Tablet Platform uses the following services on AWS:

S3 (Amazon Simple Storage Service), which provides storage services for the content sent to and from translation.

SQS (Amazon Simple Queue Service), which provides message queue services.

1.3 How the Connector Works with Microsoft WindowsThe Clay Tablet Connector ("Connector") is an important part of the Clay Tablet translation solution.



1 Welcome to the Clay Tablet Universal Content Connector 1.2 About the Clay Tablet Translation Platform

The Connector is installed on your system as a Windows service. It does not have a user interface.

Your translation systems architecture might look like the configuration above. It may have additional content systems or translation providers, but the core concepts remain the same.

During implementation, Clay Tablet works with you and your translation providers to configure and test the other elements of your translation solution, which are the Clay Tablet Platform's connections to your translation providers' systems.

1.4 Using this Guide

Purpose of this guide

This guide describes everything you need to know to install and configure the Clay Tablet Universal Content Connector ("Connector"). It describes the delivery package contents, system requirements, installation instructions, and configuration procedures.

Recommendation: Review the user guide to fully understand the powerful features of the Connector.

Who should use this guide

This guide is intended for system administrators and system integrators.

What you should already know

This document assumes that your company already has an installed instance of Microsoft Windows. It assumes that you have a strong working knowledge of Microsoft Windows Explorer and its features.

How to find out more about the Clay Tablet Universal Content Connector

For information on using the Clay Tablet Connector to send and receive content for translation from Microsoft Windows Explorer, read the Clay Tablet Universal Content Connector User Guide.

Documentation conventions

This guide uses the following conventions:

Convention Description

Bold Highlights screen elements such as buttons, menu items, and fields.



1 Welcome to the Clay Tablet Universal Content Connector 1.4 Using this Guide

Convention Description

Courier Highlights input, file names, and paths.

Italics Highlights terms for emphasis, variables, or document titles.

> Indicates a menu choice. For example, "Select Admin Tools > Configuration."

1.5 How to Contact Clay Tablet SupportEmail @: [email protected]

Telephone: +1-416-363-0888

You can submit a support ticket either:

by email

from the Clay Tablet Zedesk page, using your web browser

To submit a support ticket:

1. Do one of the following:

Email [email protected], and cc (carbon copy) anyone to include in the ticket correspondence.

Important: Include the information and attachments in your email that are listed in the sub-sections below.

Create a ticket in Zendesk:

a. Open the Clay Tablet Zendesk page in your browser: https://claytablet.zendesk.com. b. Sign in to Zendesk. If you do not have sign-in credentials, see "To view and update your support ticket

in Zendesk:" below.

Important: Include the information and attachments that are listed in the sub-sections below.

c. Click Submit a request. d. In the CCs field, add anyone to include in the ticket correspondence.

Zendesk automatically creates a ticket and responds to everyone included in the cc field.

2. Everyone in the original cc receives updates unless they request to be removed from the ticket.

Important: Check your email spam folder (especially first-time Zendesk users) as sometimes email notifications from Zendesk are marked as spam.

When the issue is resolved, Clay Tablet closes the ticket.



1 Welcome to the Clay Tablet Universal Content Connector 1.5 How to Contact Clay Tablet Support

mailto:[email protected]

mailto:[email protected]

https://claytablet.zendesk.com/

Information to include in the support ticket:

client name

CMS or content system name and version

Connector or App version installed

name of job for which the issue occurs

date of job submission

detailed description of the issue

any error text–copy and paste, if applicable

Files to attach to the support ticket:

CMS log files for the date the issue occurred

Clay Tablet log files for the date the issue occurred

screen capture of the issue

To view and update your support ticket in Zendesk:

Important: You must log into Zendesk to view your support tickets there.

1. Open the Clay Tablet Zendesk page in your browser: https://claytablet.zendesk.com.

2. In the top-right corner, click Sign in, and enter your credentials.

Note: If you do not have sign-in credentials yet, then click either Sign up or Get a password, and follow the onscreen instructions.




https://claytablet.zendesk.com/

3. After signing in, click My activities to view the tickets you opened or where you are cc’d.

4. To update tickets, you can reply or attach files.

For more information, refer to "Submitting and tracking support requests" in Zendesk's Help Center guide for end-users, at: https://support.zendesk.com/hc/en-us/articles/203664386-Help-Center-guide-for-agents-and-end-users.

Important: Zendesk refers to a support ticket as a support request. These terms are interchangeable.




https://support.zendesk.com/hc/en-us/articles/203664386-Help-Center-guide-for-agents-and-end-users

https://support.zendesk.com/hc/en-us/articles/203664386-Help-Center-guide-for-agents-and-end-users

2 Before You InstallBefore you begin to install the Clay Tablet Universal Content Connector ("Connector"), please review the system requirements, described below, and perform the following pre-installation procedures:

Note about installing on Windows Server 2012: When installing on Windows Server 2012, an active SmartScreen filter blocks the execution of the files required to install the service. To resolve this issue, disable the SmartScreen filter while installing the Connector. To access the SmartScreen settings, click Start, type SmartScreen in the search box, and then click Change SmartScreen settings in the search results.

1. Download the Connector delivery package from the link that Clay Tablet Technologies sends you. This is a .zip file, which is a zipped file.

Note: On some systems, files downloaded from the Internet are placed in a low trust category, which prevents installing the Connector. To resolve this issue, right-click the downloaded .zip file and click Properties. The General tab of the Properties dialog box opens. Select the Unblock check box in the bottom right corner, and then click OK to save this change.

2. Unzip the package into the directory where you want to install the Connector.

3. In Windows Explorer, open the <installation directory>\UCC folder.

4. Copy the source.xml file (the translation address key) provided by Clay Tablet Technologies to the following folder: <installation directory>\UCC\accounts.

Very important: Do not copy the translation address keys to multiple instances of your Connector installation, because this is a violation of the Clay Tablet License Agreement. Using the same translation address keys on multiple instances will cause the Connector to behave unexpectedly, which can result in lost translation content, orphaned projects, and inaccurate translation status reports. Clay Tablet will only support technical issues caused by duplicating or incorrectly installing translation address keys on a time and materials basis.

5. If the content producer is using the On-Premise Platform, please contact Clay Tablet Technologies Support to obtain a platform-key file. For details, see "How to Contact Clay Tablet Support" on page 7.

Notes: If the content producer is using the Clay Tablet Platform hosted on Amazon Web Services (AWS), you can skip this step. The translation provider must use the same platform as the content producer.

6. Set the system date, time, and time zone correctly on the Windows machine where you will install the Connector. For details, see "Setting Your System Date, Time, and Time Zone Correctly" on page 11.

7. The Connector monitors Windows folders: it sends files from certain folders for translation, and it returns translated files to other folders. You create the root folder, and optional sub-folders for multiple companies and departments. Then you run a utility to create the rest of the required folders. For detailed instructions, see "Creating Folders" on page 11.



2 Before You Install 1.5 How to Contact Clay Tablet Support

8. Edit the Connector configuration settings in <installation directory>\UCC\ClayTabletUniversalContentConnectorService.exe.config, as described in "Configuring the Connector" on page 13.

2.1 System RequirementsThe Clay Tablet Universal Content Connector ("Connector ") is a Windows service application. It has the following system requirements:

Operating System Any version of Microsoft Windows.

.NET Framework Version 3.5 or higher.

There is an optional Web interface, which displays the Translation Status and Settings pages. This Web interface is an ASP.NET Web application. It has the following system requirement:

Web Server Microsoft Internet Information Services (IIS) for Windows Server.Notes: The Default Document component is required.Recommendation: Install the Static Content and HTTP Errors components, which enable troubleshooting. Note about IIS Management Console: If you know how to set up and configure a Web site using the command prompt, the you can install and configure the UCC Web Server without installing the IIS Management Console. However, to follow the steps in this document, you must install the IIS Management Console.All the above components are included in a default IIS installation, but you can install IIS without them.

2.2 Setting Your System Date, Time, and Time Zone CorrectlyThe 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.

Important: 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.3 Creating FoldersThe Connector monitors Windows folders: it sends files from certain folders for translation, and it returns translated files to other folders.



2 Before You Install 2.1 System Requirements

Note: When choosing folder names, ensure that you do not exceed your system-specified maximum file name length (260 characters), which is composed of each sub-directory along the path and the final file name. The translated files will have a maximum file name length of 40 characters.

1. Create a root folder anywhere on the file system. This will be the top level folder for all files you send out for translation, using the Connector. This folder can have any name. Later, you will specify the path to this folder in the RootFolderPath option in the configuration file. When you run the utility to create the rest of the required folders (step 5, below), the Connector will create all the folders for source and target files under this folder.

2. Optional. You can create sub-folders under the root folder, for example, for multiple company units. Later, you will specify the description for these second-level folders in the Level2 option in the configuration file.

3. Optional. You can create sub-folders under the second-level folders, for example, for multiple departments. Later, you will specify the description for these third-level folders in the Level3 option in the configuration file.

Important: Do not create any additional levels of sub-folders below these sub-folders.

4. In Windows Explorer, open the <installation directory>\UCCStructureBuilderUtility folder.

5. Select UCCStructureBuilderUtility.exe, right-click, and select Run as administrator from the context menu. This will run the utility and create the rest of the required folders. When asked if you want to allow this program to make changes to your computer, click Yes.

A Command Prompt window opens, displaying:Folder structure creation utility launched.

Please enter root folder path.

6. In the Command Prompt window, type the path to the root folder you created in step 1. For example, type: C:\Clay Tablet, and press Enter.

The Command Prompt window displays:Creating folder structure as per your input.

Started creating folder structure. <mm:ss:ms>

where mm:ss:ms refer to the system start time in minutes:seconds:milliseconds.

The utility creates a folder for each language under the lowest-level folder. These are the source folders. Within each source folder, the utility then creates additional folders for each language. These are the target folders. Users will put files they want to send out for translation in the appropriate target sub-folder within the appropriate source folder. For more information, refer to the Clay Tablet Universal Content Connector User Guide.

When the utility finishes creating the folders, the Command Prompt window displays:Done creating folder structure. <mm:ss:ms>

Press any key to exit.

7. Press any key to close the Command Prompt window.



2 Before You Install 2.3 Creating Folders

2.4 Configuring the Connector

1. Open <installation directory>\ClayTabletUniversalContentConnectorService.exe.config for editing.

2. Specify the following configuration options.

Configuration Option DescriptionDefault Value

CTT2_SourceAccount The absolute or relative path of source.xml, which is the translation address key. This file points to the location where the Connector retrieves the files for translation.

CTT2_TargetAccount The absolute or relative path of target.xml, which is the platform-key file. This file points to the location where the Connector submits translated files.

CTT2_ConnectionContext_Folder

The absolute or relative path of the data folder that the Connector uses to store translation data.

Level2 Optional. If you created sub-folders under the root folder, for example, for multiple company units, enter the description for these second-level folders, for example "SubCompany". Otherwise, leave this setting blank.

Level3 Optional. If you created sub-folders under the root folder, for example, for multiple departments, enter the description for these second-level folders, for example "Department". Otherwise, leave this setting blank.

RootFolder The name of the top-level folder you created for all files you send out for translation, using the Connector.

RootFolderPath The path and name of the top-level folder you created for all files you send out for translation, using the Connector.

ReferenceFolder The name of the sub-folder under the folder specified by the RootFolder option, described above, where users can place support assets for delivery to your translation provider. A support asset is a document that you send to the translation provider to provide helpful context for the translator.

Reference



2 Before You Install 2.4 Configuring the Connector


CrawlIntervalInMinutes This is the frequency, in minutes, that the Connector checks all folders under the root folder for newly copied or pasted files to send out for translation.

60

PollingIntervalInMinutes This is the frequency, in minutes, that the Connector checks the Clay Tablet Platform for translated files, and downloads them.

1

ProcessedFolder When the Connector collects the files for translation from under the root folder to send out for translation, it temporarily stores them in the ProcessedFiles folder. By default, this folder is here: <installation directory>\UCC\ProcessedFiles. You can use this option to specify another path for this folder.

ReturnedAssetsPath This option determines where the Connector returns the translated files. By default, this folder is here: <installation directory>\UCC\ReturningTranslations. You can use this option to specify another path for this folder.

OverwriteTranslatedFile This option enables you to save multiple versions of translated files in the location specified by the ReturnedAssetsPath option, described above.

true: The Connector always overwrites a pre-existing translated file with a newly received translated file.false: The Connector does not overwrite a pre-existing translated file the newest translated file. The pre-existing translated file retains its name. The name of the newly received translated file includes a time stamp.

true

WEBAPPCONFIG The path to the configuration file for the UCCAdministration web application, which runs the Settings page described on page 23 and the Connector Job Status page described in the Clay Tablet Universal Content Connector User Guide.





FullScan Specifies whether the Connector checks all folders under the specified Rootfolder (described above) for new files to send out for translation, both:

whenever the ClayTabletUniversalContentConnectorService service starts on a day specified by the user

This is useful in case the service stops unexpectedly before checking all folders. The user can change this setting and select the day of the week for the scan in the Enable Full Scan check box and dropdown list in the Settings page. For details, refer to the Clay Tablet Universal Content Connector User Guide. This option can have the following values:

true false

false

DatabasePath The path to the Connector data source, for example: Data Source=C:\UCC\UccDb.sdf

SubjectLine The subject line for the summary email notifications. These are configured in the Settings page. For details, refer to the Clay Tablet Universal Content Connector User Guide.

UCC Project Submission Notification

Note: If the Default Value column, above, is blank, then there is no default value in the file for the corresponding configuration option.

3. Save your changes and close the file.




3 Installing the Clay Tablet Universal Content ConnectorThe Universal Clay Tablet Connector has two components:

The Windows service application is a mandatory component that manages translation files. For installation instructions, see "Installing the Connector Windows Service" below.

The Connector includes an optional Web interface that displays the following pages:

Translation Status page: for monitoring the status of translation jobs.

Settings page: for configuring email notifications and configuring an optional weekly scan for files to send to translation.

For installation instructions, see "Installing the Web Interface" on page 16.

System requirements for both components are described on page 11.

3.1 Installing the Connector Windows ServiceThis section describes how to install the Connector installation package you downloaded earlier as a Windows service.

Before you install the Connector, verify that you have reviewed the system requirements and followed all the pre-installation procedures described in "Before You Install" on page 10.

To install the Connector:


2. Select install_ucc.bat, right-click, and select Run as administrator from the context menu. When asked if you want to allow this program to make changes to your computer, click Yes.

A Command Prompt window opens, and the installation program runs. When it is complete, the following message is displayed:

The Commit phase completed successfully.

The transacted install has completed.

------------------------------------

Press any key to continue...

3. Press any key to close the Command Prompt window.

3.2 Installing the Web InterfaceThis section describes how to install the optional Connector Web interface from the installation package you downloaded earlier. This Web interface is an ASP.NET Web application, and it runs on the Microsoft Internet Information Services (IIS) for Windows Server.



3 Installing the Clay Tablet Universal Content Connector 3.1 Installing the Connector Windows Service

Before installing the Web interface, review the IIS system requirements described in "System Requirements" on page 11.

Important: You may encounter issues while installing the Web interface on Windows Server 2012. For detailed troubleshooting information, see "Troubleshooting and Solving Web-Interface Installation Issues with Windows Server 2012" on page 19.

The optional Web interface displays the following pages:

Translation Status page: for monitoring the status of translation jobs.

Settings page: for configuring email notifications and configuring an optional weekly scan for files to send to translation.

Important: The Web interface uses the same local database as the Connector Windows service application. Before installing the Web interface, ensure that in the installation package, in UCCAdministration\web.config, the DatabasePath setting points to the path of the database file UccDb.sdf, which is in the root UCC folder, the Connector Windows service installation directory.

To install the Web interface:

1. On the Start menu, click All Programs, click Accessories, and then click Run.

2. In the Open box, type inetmgr and then click OK.

The IIS console window opens.

3. In the Connections pane on the left, select Sites, right-click, and select Add Web Site from the context menu.

The Add Web Site dialog box opens.



3 Installing the Clay Tablet Universal Content Connector 3.2 Installing the Web Interface

4. Enter the following information in the dialog box:

Site name: Your name for the Web site.

Physical path: The path to the UCCAdministration directory.

Port: The port number to use for the Web site.

5. Click OK.

6. In the central pane of the IIS console, select Default Document.

7. In the Actions pane on the left, click Add.

The Add Default Document dialog box opens.

8. Enter Report.aspx, and click OK.




9. In the Actions pane, click the Browse link.

The Web site opens in a browser.

10. Bookmark the URL in the browser's address bar for future use.

3.2.1 Troubleshooting and Solving Web-Interface Installation Issues with Windows Server 2012

Issue Description

"Translation Status Page does not Display Translation Projects" on page 20

The Translation Status page (Report.aspx) is empty. It does not display information about translation projects.




Issue Description

"HTTP Error 404.17" on page 20 The HTTP Error 404.17 is displayed with the user runs the Web application in IIS with any .NET target framework.

3.2.1.1 Translation Status Page does not Display Translation Projects

Issue: The Translation Status page (Report.aspx) is empty. It does not display information about translation projects.

Explanation: The application does not have access to the database file.

Workaround: In IIS, set the application pool identity for UCC_Admin to network service.

3.2.1.2 HTTP Error 404.17

Issue: The HTTP Error 404.17 is displayed with the user runs the Web application in IIS with any .NET target framework.

Explanation: The .NET version is not registered.

Workaround: Follow the instructions here: http://www.codeproject.com/Tips/882774/Fix-HTTP-Error-The-requested-content.




http://www.codeproject.com/Tips/882774/Fix-HTTP-Error-The-requested-content

http://www.codeproject.com/Tips/882774/Fix-HTTP-Error-The-requested-content

4 Post-Installation TasksAfter installing the Connector, you complete the tasks.

Set the folder permissions so that Network Service has full control for the folders that the Connector uses, described below.

Run the Connector, as described on page 22.

Specify Connector settings for email notifications, including schedule and subscriptions and additional options, as described on page 23.

4.1 Setting Folder PermissionsYou must set the folder permissions so that Network Service has full control for the following folders, which the Connector uses:

Folder Description Default Path

root The top level folder for all files you send out for translation, using the Connector. This is the folder you created in step 1 of "Creating Folders" on page 11.

No default name or path.

data The folder that the Connector uses to store translation data. This is specified by the CTT2_ConnectionContext_Folder option in <installation directory>\ClayTabletUniversalContentConnectorService.exe.config.

No default path.

ProcessedFiles The folder where the Connector temporarily stores the files it collects to send out for translation. An alternative path is specified by the ProcessedFolder option in <installation directory>\ClayTabletUniversalContentConnectorService.exe.config.

<installation directory>\UCC\ProcessedFiles

ReturningTranslations

The folder where the Connector returns the translated files. An alternative path is specified by the ReturnedAssetsPath option in <installation directory>\ClayTabletUniversalContentConnectorService.exe.config.

<installation directory>\UCC\ReturningTranslations



4 Post-Installation Tasks 4.1 Setting Folder Permissions

To set folder permissions:

1. In Windows Explorer, navigate to the folder whose properties you want to modify, select it, and right-click Properties from the context menu.

The Properties dialog box for that folder opens.

2. In the Group or user names list, select NETWORK SERVICE.

Note: If NETWORK SERVICE is not displayed in the list, click Edit. The Permissions for dialog box opens. Click Add. The Select Users or Groups dialog box opens. In the text box, type NETWORK SERVICE and click Check Names. NETWORK SERVICE is now underlined. Click OK. Repeat the previous step.

3. In the Permissions for NETWORK SERVICE list below, click the Allow check box for Full control. This automatically selects all the check boxes below.

4. Click OK twice to save your changes.

Note: When you apply these changes to your root folder, which has many sub-folders, the Windows Security box opens after the first time you click OK, setting security settings, and displaying the sub-folders to which it is applying the new settings.

Important: Repeat these steps for each folder listed in the table above.

4.2 Running the ConnectorTo run the Connector, you must start the corresponding Windows service.

To start the service:

1. Do one of the following to open the Services window:

Click the Windows Start button, and type services in the Search box. Then under Programs, click Services.

Click the Windows Start button, and type run in the Search box. Then under Programs, click Run. In the Run box, type services.msc, and click OK.

2. In the Services window, scroll down to ClayTabletUniversalContentConnectorService and select it.

3. Right-click, and select Start from the context menu.



4 Post-Installation Tasks 4.2 Running the Connector

4.3 Specifying Connector Settings

To configure Connector settings, do one of the following:

In your Web browser, navigate to /Configuration.aspx on the Windows machine where the Connector is running. For example, navigate to localhost:1234/Configuration.aspx.

If the Connector Job Status page is already open in a Web browser, select Options > Settings from the menu.

The Settings page opens.

The configuration options are organized into the following sections, which follow below:

Configuration Section Purpose

"Configuring the Notification Schedule" on page 24

specify the frequency for email notifications from the Connectorspecify which jobs to include in these notifications

"Managing Email Subscribers" on page 24

add and remove email addresses for email notifications

"Configuring the Email Server" on page 25

configure the connection to the mail server that sends out email notificationsspecify the email address that sends out these notifications

"Configuring Full Scans" on page 26 instruct the Connector to run additional checks for new files to send out for translation



4 Post-Installation Tasks 4.3 Specifying Connector Settings

4.3.1 Configuring the Notification Schedule

You use the Notification Schedule section of the Settings page to specify the frequency for email notifications from the Connector, and to specify which jobs to include in these email notifications.

For information on opening the Settings page, see "Specifying Connector Settings" on page 23.

Configuration Setting

Description

Notification Schedule

Select the frequency of the notification emails:Daily: The Connector sends a notification email approximately every 24 hours.Weekly: The Connector sends a notification email every seven days.

Filter Criteria Select which jobs will be included in the notification emails:Active Jobs: All active jobs sent by the Connector. These are jobs that are in progress, and they do not have Completed status.From Start Date: All active jobs sent by the Connector on or after the specified start date, below.

Start Date If you selected From Start Date in Filter Criteria, above, this specifies the start date (in MM/DD/YYYY format) for jobs to include in notification emails. By default, the start date is today's date. To change the date, click in the field, and select a date from the pop-up calendar that opens.

When you are done, click Subscribe to save your changes.

4.3.2 Managing Email Subscribers

You use the Email Subscribers section of the Settings page to manage subscriptions for email notifications from the Connector. This section is required if you configure the Connector to send notification emails in the Notification Schedule section, described in "Configuring the Notification Schedule" on page 24.


All configured email subscribers receive email notifications in the following scenarios:




when files are submitted for translationwhen translated files return from translationdaily or weekly summaries of either all active translation jobs or all active jobs created on or after a certain datewhen errors occur while creating, sending, and retrieving translation jobs

To subscribe an email address to notifications from the Connector, enter it in the text box at the top of the section, and click Add.

The email address is displayed in the read-only list at the bottom of the section.

To stop an email address from receiving notifications from the Connector, select it in the read-only list at the bottom of the section, and click Remove.

4.3.3 Configuring the Email Server

You use the SMTP Configuration section of the Settings page to manage subscriptions for email notifications from the Connector. The settings in this section specifies the mail-server settings for notification emails that the Connector can send. This section is required if you configure the Connector to send notification emails in the Notification Schedule section, described in "Configuring the Notification Schedule" on page 24.





Configuration Setting Description

Server The IP address or domain name of your SMTP server.

Email From The email address from which Connector notification emails will be sent.

User ID The login name or account if your SMTP server needs authentication.

Password The password to log in to your SMTP server if it needs authentication.

Enable SSL Select this check box to enable SSL encryption to and from your SMTP server.

Port The port of your SMTP service.

4.3.4 Configuring Full Scans

You use the Enable Full Scan section of the Settings page to instruct the Connector to run an additional check for new files to send out for translation once a week.





You can select the Enable Full Scan check box to instruct the Connector to check all folders under the root folder for new files to send out for translation on a day specified by the user.

By default this check box is cleared, unless otherwise specified in the configuration file.

Note: The Connector automatically checks all folders under the root folder for new files to send out for translation whenever the ClayTabletUniversalContentConnectorService service starts. This is useful in case the service stops unexpectedly before checking all folders.




5 Pre-Production TestingAfter you complete the configuration, your Clay Tablet Universal Content Connector installation is ready for testing. We recommend sending only a few pages for translation in one language as an initial test. For detailed instructions, refer to the Clay Tablet Universal Content Connector User Guide. Once successful, you can send as many languages as required.

Please coordinate with your translation provider for this test process.

If you have any concerns or questions, please contact Clay Tablet Support. For details, see "How to Contact Clay Tablet Support" on page 7.



5 Pre-Production Testing 4.3 Specifying Connector Settings

6 Uninstalling the ConnectorTo install the Connector:


2. Select uninstall_ucc.bat, right-click, and select Run as administrator from the context menu. When asked if you want to allow this program to make changes to your computer, click Yes.

A Command Prompt window opens, and the uninstallation program runs. When it is complete, a message displays that the Connector was successfully uninstalled.

3. Press any key to close the Command Prompt window .



6 Uninstalling the Connector 4.3 Specifying Connector Settings

Installation and Configuration Guidedocs-archive.clay-tablet.net/UCC/Clay_Tablet_Connector_UCC_Install… · you work through this document. Clay Tablet Platform The hosted (IaaS)

Documents