Skip to main content

XTM Connect – Sitecore 3.3

Sitecore Settings tab screen

The Sitecore Settings tab screen, in the Settings configuration page, contains these sections:

These sections are described below. Select one to jump straight to information about it. In them, field names with an asterisk at the end are mandatory. All others are optional.

URLs section

UI label

Description

Base Sitecore URL

The URL of your Sitecore instance. This is required to generate interactive WYSIWYG previews in XTM Visual mode, in XTM Workbench. Example: "https://mysite.com" (the first part of the URL when you have logged into Sitecore). Only HTTPS URLs are supported.

Note

A Translation requester can enable XTM Visual mode when they generate a project. XTM Visual mode can also be enabled in the project template used for a Sitecore project.

XTM Visual mode will not be available for interactive WYSIWYG previews if the file join feature is enabled in XTM Connect – Sitecore.

For details of how to configure XTM Visual mode for XTM Connect – Sitecore, see Configuring XTM Visual mode for Sitecore content in XTM Workbench.

Base URLs field

Base URLs have the same purpose as the Base Sitecore URL. They can, for example, be specified here if the Client only has a few pages to which content is published. Then, when a Translation requester adds a project to the Translation queue, or sends it for translation, this setting can be used to predefine which of the base URLs the Translation requester chooses. The preview in XTM Visual mode, in XTM Workbench, is generated on the basis of the URL that the Translation requester chooses.

Entry format in this field: it can only contain one base URL. However, you can set more than one base URL: see "Plus" button in the next table row.

"Plus" button

To set more than one base URL, select the "Plus" button. Then, enter a different base URL in the new Base URLs field. You can set as many base URLs as you require.

Use Translation site URL checkbox

Select this checkbox to use the Base URL specified in the field above, for the translation of unpublished content in XTM Visual mode.

Note

You must specify a Base URL in the field above, to use it. The URL you specify here must match the site defined in the <site name>="website" definition in the Sitecore web.config configuration file, and the site specified in the hosts file in the Sitecore server's MS Windows configuration.

If you do not specify the Base URL URL, and select this checkbox, the Base Sitecore URL is used for generating HTML or asset output for XTM Visual mode instead.

XTM Visual mode will not be available for WYSIWYG interactive previews if:

  • the file join feature is enabled in XTM Cloud during project creation or

  • the file join feature is enabled in the project template used for Sitecore projects.

Settings section

UI label

Description

Fields to exclude: All box

The dropdown in this box contains all content fields that are present in this instance of Sitecore.

To specify fields, in project templates, that you want to globally exclude from translation:
  1. In the All box, select the fields that you want to exclude. Examples: "Foundation" and "_Standard Values".

    • You can select several fields at once. If you do so, they are highlighted.

    • Some fields are at the top level (example: "Foundation"). Others are located in folders. (Example: the Linked item field in the System > Alias > Data folder. These folders enable copies of the same field to be used in different ways.

  2. When you have selected all the fields that you want to exclude from translation, select the right arrow chevron_right_blue.png between the All and Selected boxes. The fields that you selected are copied to the Selected box. They will be excluded from translation projects created using this instance of Sitecore.

Fields to exclude: Selected box

The dropdown in this box contains all content fields that are present in this instance of Sitecore, and have previously been excluded from translation.

To reinclude excluded fields, in project templates, in translation:
  1. In the Selected box, select the fields that you want to reinclude in translation. When you do so, they are highlighted. Their contents will then be translated:

    • automatically, when they are updated.

    • when they are selected for translation manually (in the Add to queue popup).

  2. When you have selected all the fields that you want to reinclude in translation, select the left arrow chevron_left_blue.png between the All and Selected boxes. The fields that you selected are copied to the Selected box. They will be included in translation projects created using this instance of Sitecore.

Field types to exclude: All box

The dropdown in this box contains all content field types that are present in this instance of Sitecore.

To specify field types that you want to globally exclude from translation:
  1. In the All box, select the field types that you want to exclude. Examples: "Checkbox" and "Date".

    • You can select several field types at once. If you do so, they are highlighted.

    • Unlike fields, field types are always at the top level.

    Different categories of that field are displayed.

  2. When you have selected all the field types that you want to exclude from translation, select the right arrow chevron_right_blue.png between the All and Selected boxes. The field types that you selected are copied to the Selected box. They will be excluded from translation projects created using this instance of Sitecore.

Field types to exclude: Selected box

The dropdown in this box contains all content field types that are present in this instance of Sitecore, and have previously been excluded from translation.

To reinclude excluded field types in translation:
  1. In the Selected box, select the field types that you want to reinclude in translation. When you do so, they are highlighted. Their contents will then be translated:

    • automatically, when they are updated.

    • when they are selected for translation manually (in the Add to queue popup).

  2. When you have selected all the field types that you want to reinclude in translation, select the left arrow chevron_left_blue.png between the All and Selected boxes. The field types that you selected are copied to the Selected box. They will be included in translation projects created using this instance of Sitecore.

Do not show the option to send the same items for translation multiple times checkbox

Use this checkbox to specify how XTM Connect – Sitecore Users (Translation requesters) can add language versions to projects: they can either add one version after another or add several versions at once. Select the checkbox, or not, as required:

  • Checkbox selected: when an item is sent to XTM Cloud, for translation into several target languages, it will not be possible to also send the same item for translation in a new project. A User will only be able to send the same item to XTM Cloud once it has been finished and imported to Sitecore.

  • Checkbox not selected: when an item is sent to XTM Cloud, it can be included in many projects and translated into many languages at the same time.

Hide Estimated price in Translation queue checkbox

Use this checkbox to specify whether the Estimated Price is to be displayed for a translation item, in the XTM Connect – Sitecore Translation queue window.

  • Checkbox selected: the Estimated Price is displayed in the Translation queue window.

  • Checkbox not selected: the Estimated Price is not displayed in the Translation queue window.

In XTM Cloud, Users can select Project > Estimates > Proposal to display this price.

Item name separator in a queued project

In this field, you can specify a separating character which is used in the Item name field when new projects are added to a translation queue.

This is especially helpful if the use of particular special characters in the Item name field has been blocked in Sitecore for security reasons. If there are no restrictions of this kind, in Sitecore, we recommend that you use the default separator shown in the field (for example, "_").

Show DisplayName in URL checkbox

This checkbox is selected by default. Use it to specify that, when content containing accented characters that cannot be used in URLs returns from XTM Cloud, Sitecore replaces those characters with similar, permitted characters. For example, "pączek" will be replaced by "paczek".

Layout settings: Copy final layout settings to target languages slider

This slider configures a translation project creation function in the Add for translation popup. It controls whether the Copy final layout settings from source language version to all language versions checkbox is selected by default in the Add for translation popup.

If you want source language final layout settings to be copied to target languages, by default, in the Add for translation popup, select this slider.

Layout settings: Allow editor to modify the setting slider

This slider configures a translation project creation function in the Add for translation popup. It controls whether a Translation requester can change the setting of the Copy final layout settings from source language version to all language versions checkbox there.

  • If you move this slider, so it is active (blue), a Translation requester can change the layout settings.

  • If you do not move this slider, so it is inactive (green), a Translation requester cannot change the layout settings.

Workflow settings section

UI label

Description

Workflow for content in translation dropdown

If required, specify which workflow is to be set for content that is in translation. Select one of these options:

  • Use the workflow state from the workflow marked as "In Translation" in the XTM Connector node.

  • Use initial state from existing workflow.

  • Workflow step for content in translation. If you select this option, a Workflow step for content in translation field is displayed. It contains the current workflow step. Example: Workflows / XTM Translation / In Translation.

    To change the current workflow step for content in translation:
    1. Select the Workflow step for content in translation field. A values tree is displayed.

    2. Select the required workflow from it. You do not need to save your selection: it will be saved automatically.

Workflow for imported content dropdown

If required, specify which workflow is to be set for content that has been reimported into Sitecore after translation. Select one of these options:

  • Use the workflow state from the workflow marked as "Imported" in the XTM Connector node.

  • Use initial state from existing workflow.

  • Workflow step for imported content. If you select this option, a Workflow step for imported content field is displayed. It contains the current workflow step. Example: Workflows / XTM Translation / In Translation.

    To change the current workflow step for imported content:
    1. Select the Workflow step for imported translation field. A values tree is displayed.

    2. Select the required workflow from it. You do not need to save your selection: it will be saved automatically.

Workflow Action Project Name field

In this optional field, specify the project name that is to be used when items are sent for translation from the XTM Cloud "translation" workflow action.

Content view options in Add to queue section

UI label

Description

Filter subitems dropdown

If required, restrict the subitems that are displayed to Translation requesters in the Add to queue popup. Select one of these options:

  • Show all items

  • Deselect items without presentation. These items are then displayed in the Add to queue popup, but not selected by default.

    Note

    In Sitecore, the Presentation filter is used by Translation requesters to filter out sub-items, based on their visual layout, in the Add for translation popup.

  • Hide items without presentation. These items are then not displayed in the Add to queue popup.

Include related content (components) and linked content in the main item source file checkbox

Select this checkbox if required.

Hierarchy level for subitems dropdown

To set a hierarchy level for sub-items, enter a value in this field. Example: if you enter "3", the top level and the next two levels down will be displayed.

Hierarchy level for related content (components) dropdown

To set a hierarchy level for related content (components), enter a value in this field. Example: if you enter "2", the top level and the next one down will be displayed.

Hierarchy level for items linked in across databases dropdown

To set a hierarchy level for items linked in across databases, enter a value in this field. Example: if you enter "2", the top level and the next one down will be displayed.

Include components and their subitems checkbox

Select this checkbox if required. If you do not, component sub-items will not be sent for translation.

Include items linked across databases checkbox

Select this checkbox if required. If you do not, content that is linked across databases will not be sent for translation.

Only include components and linked items the first time they occur checkbox

Select this checkbox to send linked items for translation only once, the first time that they occur.

Detect changes section

UI label

Description

Detect changes from which version? dropdown

Use this dropdown to specify how to handle changes that are made in source content items. If you select one of the first two values listed below, the Translation requester will be notified that the content has changed (in the Translation queue). They can then then resend the changed content for translation manually.

Select one of these options:

  • latest version.

  • latest modified version.

  • same as sent.

Note

When the Translation requester selects a content item after being notified that its content has changed, the Detecting changes in content popup is displayed. In it, they can decide how to handle translation of the changed (updated) content.

If they select the Send as new option, a new project that contains the changed content for the item is sent to XTM Cloud. If a project that contains the original content for a content item (before changes are made in it) is finished (in XTM Cloud) before a project containing changed content, for the same item, then only the project finished first is reimported back into Sitecore.

For this reason, we recommend that Translation requesters cancel the original translation project for changed items, if still possible, before using this method.

Only detect changes for a specific workflow state" checkbox

To select a specific workflow state in which source content changes are to be detected, select this checkbox. A dropdown is then displayed below it. Select the relevant workflow state from the dropdown.

Developer tools section

UI label

Description

Enable debugging checkbox

Use the debugging function to generate projects and check their source files, if required. This provides a way to analyze potential errors in source files.

  • To enable debugging, select the checkbox.

    You should only do so if XTM Connect – Sitecore is not generating translation projects correctly. If you do so:

    • The project will not be generated in XTM Connect – Sitecore.

    • Project source files will be generated, but not sent to XTM Cloud. Instead, they will be inserted in the Translation Files folder for you to check.

  • To generate projects and send them to XTM Cloud for translation, in the normal way, do not select the checkbox. Translation files are removed from the Sitecore Translation Files and Translated Files folders.

Now save your settings and close the Settings configuration page, or close it without saving them:

  • To save any settings or changes you have made in a tab, in the Settings configuration page, select the Save button. You can do this at any time. If you do so, the Settings configuration page, with the currently open tab, does not close.

  • To close the entire Settings configuration page without saving your settings, select the "close" icon x-solid.svg in the top right-hand corner of the page. You can do this at any time. The page closes and you return to the main XTM page.