We've launched a new support center at help.smartling.com. This site will continue to be maintained into January 2017. Please update your bookmarks.

Sitecore Connector Installation and Configuration

The following article applies to CMS Connector project types. 

 Use the following procedures to install, configure or uninstall The Sitecore connector.

Installing Sitecore Connecter Module

To install the Sitecore Connector module:

  1. Create a new database, and at the SQL Server, execute the script Sitecore_Data.sql (can be found in %website root%/sitecore modules/Shell/Smartling.Connector folder).
    Note: Don't forget to update first line of the script (USE [%your database name%]).
  2. Add new conneciton string to /Website/App_Config/ConnectionStrings.config, name should be "SitecoreLocalization", here's the example:

    <add name="SitecoreLocalization" connectionString="user id=sa;password=Password12345;Data Source=.\SQLEXPRESS;Database=SitecoreLocalization_Data"/>

  3. Go to the Sitecore Desktop, open Installation Wizard, and upload and then install the Smartling.Connector.ver.[version].zip package.

  4. Add the following to the Web.config section:

    <appender name="SmartlingLogFileAppender" type="log4net.Appender.SitecoreLogFileAppender, Sitecore.Logging">
        <file value="$(dataFolder)/logs/SitecoreLocalization.log.{date}.txt" />
        <appendToFile value="true" />
        <layout type="log4net.Layout.PatternLayout"><conversionPattern value="%4t %d{ABSOLUTE} %-5p %m%n" />
    <logger name="Smartling.Connector.Diagnostics.SmartlingLogger" additivity="false">
        <level value="INFO" />
        <appender-ref ref="SmartlingLogFileAppender" />

Configuring Sitecore Connector Module

Modify the following settings to configure Sitecore for use with Smartling.


  • Under the main settings item, Profiles contains one or more profiles that you can use for different content tree nodes, controlled by the Source Path setting.

    Each profile should also contain one or more locales (target languages), that you can add using insert options.

    Target Path and Smartling Locale fields are optional and can be left empty.
    Smartling Locale field allows you to override the Sitecore languages code when sent to Smartling.

Retrieval Type

You can also specify how Smartling retrieves and displays the content.

The following options are available:

  • Published - Replace the original string with translations that are reviewed and authorized for publishing
  • Pending - Translator finished translation, but the translation is waiting for authorization from Editor and Reviewer roles
  • Pseudo - Replace characters on the fly. For example, "Translate it" can be converted to something like this "~Tpa~nc~la~те ит~"
    This is useful for testing and faster than machine translation.

Callback Domain

  • In the Callback Domain field, ensure that you specify a valid URL. It must be accessible from the Internet, for example:

Translatable Fields

  • Translatable Fields contains commons field types.
    If you will translate Dictionary then you should add the memo field type to this list.

Target Workflow States

  • By default, Target Workflow States contains a workflow step for Sample Workflow.
    If your items use another workflow, then you should add this step.

Target Languages

  • Use Target Languages to specify the languages to which you want to translate your content.

Excluding Fields from Translation

  • By default, the connector will not submit all Shared fields with textual information for translation. You can skip some fields by selecting Exclude from translation on the field item.

    Or skip by field name.


Check the Auto Authorize Content box to automatically Authorize your content into the default workflow for each language in the Smartling Dashboard, rather than sending it to your Awaiting Authorization queue.

Test Connection

  • Browse to module settings (/sitecore/system/Modules/Smartling Connector) and verify your connection by clicking Test Connection.

Installing Sitecore Remote Connector (Optional)

To install the Sitecore Remote Connector:

  • Go to Sitecore Desktop, and install Smartling.Connector.Remove.ver.[version].zip package.

Configuring Sitecore Remote Connector (Optional)

To configure the Sitecore Remote Connector:

  1. Open Sitecore Content Editor and browse to /sitecore/system/Modules/Smartling Connector/Context . It contains the following settings:
    • Server Url - the remote module uses this URL for requesting HTML and resources such as CSS\JS\Img. In general, it should contain the domain of your site. Please don't use 'localhost' as the Server Url. If you test the connector on a local environment, then register the name in a hosts file and use it in the browser. 
       Only 'http://' URLS are supported. You cannot use 'https'
    • Impersonated User - User account that used for getting HTML. If you didn't provide an user account, then Sitecore uses anonymous access.
    • Enabled - You can enable\disable Context for translation

  2. Browse to each of your settings profiles (items under /sitecore/system/Modules/Smartling Connector/Profiles).
  3. Click Connect, and the remote module will use the Api Key + Project Id for connecting to the Smartling context Service.

Installing Extended Support for the General Link Field (Optional)

This package allows you to translate the Link Description property of General Link. By default, the connector doesn't send it for translation.

To install extended support for the General Link field (optional):

  1. Go to Sitecore desktop.
  2. Install the Smartling.Connector.LinkFieldTranslator.ver.[version].zip package.

Configuring Translation of General Link

In general, the LinkFieldTranslator package doesn't require additional configuration.

Uninstalling Sitecore Connector Module

To uninstall the Sitecore connector:

  1. Remove the following sections from Web.config:
    <appender name="SmartlingLogFileAppender" type="log4net.Appender.SitecoreLogFileAppender, Sitecore.Logging">
      <file value="$(dataFolder)/logs/SitecoreLocalization.log.{date}.txt" />
      <appendToFile value="true" />
      <layout type="log4net.Layout.PatternLayout">
        <conversionPattern value="%4t %d{ABSOLUTE} %-5p %m%n" />
    <logger name="SitecoreLocalization.Module.Diagnostics.SmartlingLogger" additivity="false">
      <level value="INFO" />
      <appender-ref ref="SmartlingLogFileAppender" />
  2. Remove SitecoreLocalization _connection string from /Website/AppConfig/ConnectionStrings.config.
  3. Remove the module configuration file: /Website/App_Config/Include/SitecoreLocalization.config.
  4. Remove the /Website/sitecore modules/Shell/SitecoreLocalization folder.
  5. Remove items (and subitems) at the following locations:

    Master Database
    \sitecore\system\Modules\Smartling Connector

    \sitecore\system\Settings\Validation Rules\Field Rules\System\SitecoreLocalization Api Key

    \sitecore\system\Settings\Validation Rules\Field Rules\System\SitecoreLocalization Api Url

    \sitecore\system\Settings\Validation Rules\Field Rules\System\SitecoreLocalization Project Id

    \sitecore\templates\User Defined\SitecoreLocalization
    Core Database
    \sitecore\content\Applications\Translation Status

    \sitecore\content\Applications\Content Editor\Ribbons\Chunks\Translate\Translate

    \sitecore\content\Applications\Content Editor\Ribbons\Chunks\Translate\Translate\Run Agents

    \sitecore\content\Applications\Content Editor\Ribbons\Contextual Ribbons\SitecoreLocalization Settings

    \sitecore\content\Documents and settings\All users\Start menu\Left\Smartling Translate.item

    \sitecore\content\Documents and settings\All users\Start menu\Left\Smartling Status



Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request
Powered by Zendesk