Sitecore Connector

Version History

Version 1.9.0

Important! This is a major release and requires you to perform some manual changes before installing the new version.

Pre-Installation Steps:

  1. Open Website\Web.config
  2. Find the following snippet:

    <assemblyIdentity name="Newtonsoft.Json" publicKeyToken="30ad4fe6b2a6aeed" />
    <bindingRedirect oldVersion="" newVersion="" />

  3. Update range: oldVersion<c/code> to "". It should look like this:

    <assemblyIdentity name="Newtonsoft.Json" publicKeyToken="30ad4fe6b2a6aeed" />
    <bindingRedirect oldVersion="" newVersion="" />

  4. Save Web.config.

    Now you can install the new version of the Smartling connector.

    If you installed the connector and see the following error when trying to submit any item, review that change in Web.config to make sure it's correct, and was saved.


Bug Fixes:

  • Fixed the list of Smartling jobs in the wizard. It can now show more than 500 jobs.

Version 1.8.0

This is a major release as this version changes the behavior of how original content is imported into Smartling. As well, in this release, the format of the XML file is changed. Therefore, newly uploaded files can't be handled with previous versions. Now, the connector processes old and new XML files.


  • Added support for TXT parser (in additional to HTML). By default, all content was parsed as HTML. But if you have content with unescaped HTML entities (&, <, >, etc) and want to avoid escaping them in translations,you can configure it to use TXT parser for a specific field in your templates.
  • Added the new Cancel button. You can cancel accidentally submitted items. This button will delete a file in Smartling. The connector will stop to track translation progress for the current item. You can submit the item once again at a later point.
  • Support fallback language for source language. If the item doesn't have a version for the source language, but there is a configured fallback language, then the connector will read values from the fallback language and submit them to Smartling.
  • Improved behavior for creating a target language version when the user submits original content to Smartling. By default, if there are no target language versions, then the connector creates the first version. Sitecore can then render some content for the target language. If you submit the item without the source language version, then nothing will be submitted to Smartling, and the first language will also not be created.
  • The deprecated field type memo was added into the default preset for Smartling profiles. This field type is used in the Sitecore Dictionary entry template. It fixes dictionary translation issues.

Bug Fixes:

  • Fixed issue with downloading translations: Item was submitted once to one set of locales, and later was renamed\moved, and resubmitted to another set of languages.

Version 1.7.1


  • Added additional options for discovering related items. There are now two additional options for how the connector will search for related items. (This may change with subsequent releases.)
  • Improved handling of Sitecore workflow. It now supports sites with a completely disabled workflow feature.
  • Added additional validation for job name on the Create New Job wizard.

Bug Fixes:

  • Fixed sorting of Languages on Translation Progress in case of multiple configuration profiles.
  • Fixed context in case an original page contains special unicode characters.

Version 1.7.0

In version 1.7.0, we made some key changes to the configuration of the Sitecore Connector. Additional steps are required only if you have non-empty Excluded Fields in the Smartling configuration profiles. After upgrading to the new version, the connector will remove the Excluded Fields configuration and will look for it in another place. See the features list for more information.


Changed the approach on how localization can be fine tuned at the fields level.

  • Removed Excluded Fields from the Smartling configuration profiles. If you need to exclude something, do it directly in your fields.
  • Replaced the Smartling option, Exclude from translation. in the Sitecore field configuration. Previously, it was:



Read more about the new options and behaviors in the documentation.

Improved flow and updated messages for the Test Connection button. Now it provides a meaningful message with what could be wrong with your configuration.


Bug Fixes:

  • Configuration Authorize Job was not used on submission wizard.
  • Submission wizard used wrong configuration profile in case of non default source language.
  • Fixed translation status after downloading translated content through callback. Previously, it updated just the percent, but not the status itself.

Version 1.6.1 

Bug Fixes:

  • Fixed how connector moves translated item version into Sitecore workflow step. Smartling profile settings allows configuration of Target Workflow States. At some point, this feature didn't work, and the connector wrote to log "Item workflow state cannot be resolved. Target item: /sitecore/content/Home...".

Version 1.6.0

You must complete the steps described in Upgrade to version 1.6. The new DB schema is not compatible with the previous version and the Connector will stop working if you do not follow these instructions.


  • Added Lock button. If you customized a translated item and want to preserve your changes, you can now "lock" the target language. Lock prevents downloading and applying translations from Smartling.
  • Updated design of Bulk submit wizard.
  • Updated Translation Progress screen:
    • Added Downloaded column: Time when translations were applied to an item.
    • Added filter by user name: The person who submitted the translation.
    • Added sorting for columns: Path, Submitted, Downloaded.
  • Removed Smartling workflow action.
  • Added compatibility with Sitecore 9.
  • The connector now uses TLS1.2 for all https requests.

Bug Fixes

  • Fixed item duplicates on the confirmation page of the submission wizard.
  • Fixed file deletion when item is being unpublished from web database. Connector should delete the file in Smartling only if the item is deleted in Sitecore.
  • Fixed strings authorization by job. (Job authorized all attached strings to all of the job's locales regardless of which locales were provided when attaching the file.)

Version 1.5.2


  • Improved handling of HTTP headers during context ingestion. Malformed HTTP headers are now ignored.
  • Fixed Smartling job authorizing step. Authorization will happen even if an error occurs during file attachment to a job (an example, limit of 300 files was reached).

Version 1.5.1 


  • Added new pipelines: searching related items; searching item with context. Now, both default implementations can be customized.

Bug Fixes:

  • Fixed error with jobs that don't have a due date.
  • Fixed Smartling job naming if user didn't specify it for the new job.

Version 1.5.0 


  • Added integration with Smartling jobs. Now you can submit content from Sitecore and organize it into a Smartling job. You can create a new job or add content into existing job.
  • Allow translating fields with the same names inside the same item (field ID are different). It requires changing the format of XML files, but it's fully backward compatible with previously submitted files.

    Now, the connector stores field ID in XML attribute fieldid instead of human-readable field name. Field name now will be stored in the new XML attribute fieldname. The connector doesn't use it, but it was added to simplify troubleshooting. Example of the new XML:

    <phrase path="/sitecore/content/Home/Team/Casey-Piket" key="Casey-Piket" itemid="{3E241E52-3767-464D-B994-A776C8A060C3}" fieldid="{5A5684BB-8B54-44F6-ABCC-2BADA05ADA5D}" fieldname="Body" updated="20150716T030813Z">
    <en><![CDATA[<p>Casey has an extensive background working with data. His background includes EDI administration, content migration, enterprise search, big data and content management.</p>]]></en>

  • Automatically submit referenced items. If a submitted item has outgoing references to other items, then all these items can be submitted together. Example:
    • ItemA has link to ItemB in text
    • ItemA has in presentation control with Data source = ItemC

      So if you submit ItemA then ItemB and ItemC can be submitted automatically.
  • Support item translation with two or more original languages. So if your content editors create an original content in different languages but on the same site, then you can configure different Smartling projects and list of target languages for each source language. There are no changes in configuration. Each configuration profile must be set with proper Source Path and Source Language. But when you try to submit an item from Content Editor, don't forget to choose a proper language. The connector will choose the appropriate configuration profile and display a configured set of languages.
    • Two profiles for English and French source languages. Each profile uses own smartling project and different set of target languages.
  • List of languages for English item.
  • List of languages for French item
  • For a while, Smartling was only present in the ribbon of the Content Editor application. Now, Smartling controls are also present on the Experience Editor ribbon.

  • Automatically reconnect context connection (if required) during submitting items to Smartling.

Versions 1.4.0

Important! You must complete the steps described in Upgrade to version 1.4. The new DB schema is not compatible with the previous version and the Connector will stop working if you do not follow these instructions.


  • Sitecore introduced presentation layout customization per language. It means that content editor can adjust presentation (add personalization and so on) for every language without involving developers. We added native support for this feature in our connector.
  • Starting from this release the connector copies Final layout from a source to a target language when the first revision is created. But if connector creates 2nd, 3rd, and so on revisions of target language then Final layout is not copied from a source. It’s done to preserve your possible changes of Final layout.
  • Added the new Sitecore Workflow action which allows to submit item to configured locales. So if you use Sitecore Workflow then upload to Smartling can be just a part of your Workflow and no need to send content to Smartling explicit. Every new content, or update in content will be submitted to Smartling automatically.
  • Updates in UI:
    • Multiple upload buttons are replaced with the single large button in Smartling toolbar.
  • New icons in menu.
  • Updated Translations Progress screen. Now completed and in progress items are present in the same table. Added more filters.

Bug Fixes:

  • Fixed issue with flag icon in Stecore 8.1.

Version 1.3.1 


  • Undisplayable unicode characters (codes \u0000-\u0008) are stripped before uploading content to Smartling.
  • Changed the way Smartling check’s progress of translations to prevent errors.
  • Added more detailed logs.

Bug Fixes:

  • We fixed an issue that caused errors checking and downloading translations in cases where the Sitecore language codes are different from Smartling’s locale codes.

Versions 1.3

Important! You must complete the steps described in Upgrade to version 1.3. The new DB schema is not compatible with the previous version and the Connector will stop working if you do not follow these instructions.


  • Switched to Smartling File API v2. Read more about the new File API here. The new File API uses the Oauth 2.0, so you must generate new credentials.
  • Retranslation detection. Previous connector versions downloaded an item once completed and stopped tracking changes in Smartling. The new Connector detects any changes in translation even after status is completed and keeps item’s translations up to date when you retranslate something in Smartling.
  • Changed callback HTTP response code from 202 to 200. This is what the Smartling Callback service expects.
  • Previous version required that Callback host didnt contain a trailing slash. The new one handles trailing slash if it’s present.
  • Simplified installation. The Remote package doesn’t ask question how to update items anymore.
  • The Connector now sets status to completed for items that were uploaded but don’t contain strings for translation.
  • Set maximum of concurrent requests to Smartling to 2.

Bug Fixes:

  • Fixed preview button.
  • Language field validator no longer crashes when value is empty.
  • Updated Word count column on Submissions Board.
  • Fixed errors that were caused if a file was manually deleted in Smartling.

Version 1.2.2 


  • Added handling for Context when item has no layout (configuration; dictionary; etc).
  • Improved logging in cases where ‘Translatable Fields’ in the settings profile are not configured or have no content.
  • Installing the Remote package no longer overrides your Context settings.
  • All fields in the Smartling settings profile are now shared among all languages.

Bug Fixes:

  • Connector now treats the language named in the settings profile as the source language.
  • Context connection doesn’t use actual settings from /sitecore/system/Modules/Smartling Connector/Context.

Version 1.2.1 


  • Added Context panel for all items eligible for translation.

Version 1.2.0 


  • Updated WebSocketNet library version to remove a bug which caused ping failure and subsequent connection timeouts.

Version 1.2 beta5


  • Extended Import\Export processors event args for Rewriting URLs demo processor.

Bug Fixes:

  • Wrote some smartling exceptions in smartling log (instead of general sitecore log).
  • Context connection doesn’t use actual settings from /sitecore/system/Modules/Smartling Connector/Context.

Version 1.2 beta4 


  • New Connector Audit Log application allows you to moniter upload/download background processes.
  • Code related to communication with Smartling File API was extracted to separate api-sdk-net library. Sitecore Connector now uses Smartling.Api from Nuget repository.
    Refactored logging to make logs more readable.

Bug Fixes:

  • Fixed impersonation for getting Context.
  • Removed sensitive information from sample application.

Known Issues

  • Context connection doesn’t re-establish connection with new settings after changing /sitecore/system/Modules/Smartling Connector/Context.

Version 1.2 beta2


  • Added logging exception when adding item to a database fails.
  • Write all exceptions (from pipelines) related to connector in smartling.log.
  • Added extra logging of context communication.
  • Updated documentation on Context.

Bug Fixes:

  • Removed 2nd copy of db SQL script from repository.
  • Added valid sql script to package.

Known Issues

Context connection doesn’t re-establish connection with new settings after changing /sitecore/system/Modules/Smartling Connector/Context.

Was this article helpful?