Sitecore Connector

by | Apr 2, 2022 | article

Available for

Enterprise editions

Get in touch with Sales for licensing questions.

Sitecore is a web content management service that helps users build and manage websites.

url and other non-translatable attributes in General Links and non-translatable attributes in Image stay unchanged in Sitecore after updating existing translation

Sitecore connector allows the downloading of source content and uploading of translations to/from Sitecore for the following field types:

  • Single-Line Text (and Limited)

  • Rich Text

  • Multi-Line Text (and Limited)

  • HTML

  • Text

  • Name Value List

  • General Link

  • Image

  • Checklist (Referenced items are included in the job if not translated.)

  • Multilist (Referenced items are included in the job if not translated.)

  • Treelist (Referenced items are included in the job if not translated.)

Supported Versions

Sitecore – XP (Experience Platform): 8.2 and higher

Use Cases

There are a number of use cases for the connector:

  • Project Managers can add files directly to projects from an online repository.

  • Set up the Automation Widget to allow Submitters to add files to requests directly from the online repository.

  • Use Automated Project Creation (APC) to have inwhatlanguage  automatically create new projects when a change in the last modified date is detected for monitored files or a folder.

    • Selected files are imported the very first time APC runs. All files are imported when a folder is monitored.

    • If using Automatic Project Creation and the main page to be translated contains sub-items, changes made to those sub-items do not automatically create a new project. These sub-items will need to be translated manually.

  • The Connector API can be used to automate steps otherwise performed manually through the UI. Webhooks can be used to have inwhatlanguage notify 3rd party systems about certain events (for example, a job status change).

Restrictions

  • The Default Language set in the Sitecore server must be the same language as the source language in the inwhatlanguage account.

Configure In-Context Preview

The In-context Preview feature offers a real-time preview of original or translated text in both the inwhatlanguage  Editor for Web and inwhatlanguage Editor for Desktop.

In order for inwhatlanguage to offer the real-time preview, it must have access to unpublished pages in an on-premise author node.

inwhatlanguage Requirements:

  • Pass through the enterprise firewall to access the on-premise installation.

  • Authenticate into the authoring environment.

Firewall Configuration for On-premise installation:

  • Installation must be accessible from the following IP addresses:

    34.243.87.13, 34.248.197.209, 108.129.22.31, 3.248.158.93

  • Domain name must be able to be resolved externally.

Note

Some HTML tags present a risk and the inwhatlanguage Editor removes them from this HTML when displaying the preview. This is to ensure user’s data privacy and security.

Examples of removed tags include FORM, IFRAME, SCRIPT, SVG, VIDEO, EMBED, OBJECT or background-image CSS properties.

Sitecore Settings

In order to set up the connector, the Sitecore Administrator must enable SSL and the Rest API.

To enable the Rest API, follow these steps:

  1. In the file {SITECORE_ROOT}Website\App_Config\Include\Sitecore.ItemWebApi.config set itemwebapi.mode and itemwebapi.access: 
    <site name="website">
    <patch:attribute name="itemwebapi.mode">StandardSecurity</patch:attribute>
    <patch:attribute name="itemwebapi.access">ReadWrite</patch:attribute>
</site>
  2. Set the security policies:

    In the file {SITECORE_ROOT}Website\App_Config\Include\Sitecore.Services.Client.config set the value Sitecore.Services.SecurityPolicy to Sitecore.Services.Infrastructure.Web.Http.Security.ServicesOnPolicy, Sitecore.Services.Infrastructure.

  3. Restart the server/service.
  4. Open/sitecore/admin/showconfig.aspx and validate that the configuration was correctly applied:
    • Item REST API enabled: <site name="website" itemwebapi.mode="StandardSecurity" itemwebapi.access="ReadWrite" patch:source="Sitecore.ItemWebApi.config"/>
    • Security policy applied: <setting name="Sitecore.Services.SecurityPolicy" value="Sitecore.Services.Infrastructure.Web.Http.Security.ServicesOnPolicy, Sitecore.Services.Infrastructure" patch:source="Sitecore.Services.Client.config"/>

Access Roles and Permissions

The Sitecore connector does not require specific roles.

Apply these settings:

  • Add Read and Write access rights to items that to be translated.

    For more information, see Sitecore access rights.

  • Add Read access right to items that are parents of items to be translated.
  • Add Read access right to languages items using /System/Languages/**
  • Add Read access right to workflow items using /System/Workflows/**