In this guide, you will find information on how to install the Sitecore and configure it. Installation is recommended to be carried out by your IT team, while configuration can be handled by the content manager of your Sitecore environment.
How to install the extension to Sitecore
Installation Package
Installation Instruction
To install the Localization Hub please perform the following actions.
Items serialization
To deliver items to Sitecore you have two options: Push items via the Sitecore CLI command or deliver like a package
Sitecore CLI
Package delivery
- From the control panel in 'ADMINISTRATION' section click 'Install a package'
- In the 'Choose Package' dialog click the 'Upload' button
- In the 'Upload Files' dialog click 'Choose File' locate folder 'Packages', select file 'iLangl Localization Extension-x.zip' and click the 'Open' button
- Click 'Next', select 'Overwrite existing files' checkbox and press the 'Upload' button and when file is uploaded press the 'Close' button
- In the 'Choose Package' dialog select the package 'iLangl.Sitecore.Extension' and press the 'Open' button
- In the 'Install a package' dialog at the 'Select a package to install.' step press the 'Next' button
- In the 'Install a package' dialog at the 'Verify the package information before you click install' step press the 'Install' button
- In the 'Install a package' dialog at the final step select the 'Restart the Sitecore client' checkbox and press the 'Close' button.
Files deployment
Check if the installation was successful
When the iLangL Sitecore Extension is installed successfully you will see the Localization tab in the Ribbon in Content and Experience Editors.
Important: In case the Localization tab is not visible, access the contextual menu by right-clicking, and ensure that the 'Localization' option is checked.
If this doesn't work, check with your technical team to see if you have been provided with the relevant permissions.
How to configure the extension
Before you order content for translation, you'll need to set up the configuration.
1. Open the Content Editor, navigate to the Localization tab, and click on Settings.
2. Open the Connection tab.
In the Localization Hub connection, specify the following information:
1) Localization Hub URL — the URL of your Localization Hub. Insert the link from the Localization Hub URL field in the Instructions for Sitecore Extension Installation you received via email.
2) Contact Email — This email will be registered as a user in the Localization Hub and used by our team to reach out to you.
3) Contact name — the name of the contact person.
In Workspace connection, select an option:
a) Select I have the Workspace ID if you already have the Workspace for managing translation from Sitecore in Localization Hub.
Copy the Workspace ID from the Instructions for Sitecore Extension Installation you received via email.
Alternatively, you can go to the Localization Hub, copy the Workspace ID and enter it into the Workspace ID field. You can find the Workspace ID in the Workspace settings in Localization Hub.
b) Select I want to create a new Workspace if you need to create one and enter your preferred name in the Workspace Name field.
3. Open the Export tab. In this tab, you can apply settings related to making translation orders.
You will see 4 sub-tabs:
General — this tab contains general export settings
Component Templates — the list of templates that are used as folders to store page components
Field types to localize — the field types included in the localization scope
Fields to localize — the template fields included in the localization scope
General tab
Set up the following settings:
a) Show the warning if the content item is ordered for localization — if enabled, the information about the active localization jobs will be shown in the “Quick info” section of the selected item.
b) Lock master version when localization in progress — if enabled, the master version of the content is locked (unavailable for editing) when a new translation request is made. The master version in this case is automatically unlocked when all localization requests are completed and delivered back.
c) Lock target versions when localization in progress — if enabled, all language versions requested for localization are locked (unavailable for editing). The language version in this case is automatically unlocked when localization requests are completed and translations are delivered.
d) Set workflow and/or state for target versions — if enabled, the new target version is created during export and its workflow is set to the one selected in Workflow for ordered items and the workflow step will be set to the one selected in Workflow state for ordered items:
Workflow for ordered items — the language versions of the ordered content will use this workflow.
Workflow state for ordered items — the language version of the ordered content will be moved to this workflow state.
Note: If "Set workflow and/or state for target versions" is disabled, then a new target version is created during translation delivery.
Component Templates
Specify the page components template folder by choosing the item on the left side of the table and clicking the right arrow.
The items from the folders that are created with these templates will be treated like page components.
This will impact the following views in the Sitecore extension:
- Add Components view
- Included components of Add Subitems view
- Included components of the Check out view
- Components count in the info section of Basket Ribbon in Content and Experience Editors
To remove the items from the Page components templates, choose the item on the right side of the table and click on the left arrow.
Field types to localize
Select the content types you'd like to be localized by clicking on them at the left side of the table and then clicking on the right arrow. Only the fields of the specified content types will be included in the order.
To remove the item from the Field types to localize list, click on the item at the right side of the table and click on the left arrow.
Fields to localize
Specify the list of fields to localize per template. Only the fields for enabled content types from the Field types to localize tab will be listed for templates.
To review the list of fields for a specific template click on the button with the chevron-down icon.
The system will list all available fields included in localization. Each list will be presented as a button with the title - [Field Name](Field Type)
By clicking on the X icon of the field, you can move this field to the Excluded fields section. By pressing the All button you can move all fields from Included fields to Excluded fields section. The same rule works for the Excluded fields.
Use the search to quickly find the required template for configuration.
4. Open the Delivery tab. It contains the settings related to the content translation delivery.
Decide what you need to do with the delivered content. You have three options:
a) Do not apply any specific settings — the delivered content will be saved as a new version without additional actions.
b) Publish delivered translation — the delivered content will be saved as a new version and published to the 'web' database.
c) Set workflow and/or state — the delivered content will be saved in the target language version and for this version, the workflow and workflow state will be updated.
Workflow for delivered items. Select the workflow you'd like that all new language versions to follow.
Workflow state for delivered items. Select the workflow state to which all new language versions are moved when the translation is delivered to the website.
You also need to choose the structure that will be applied to the target page upon translation delivery. There are three options:
a) Current source version. The latest version of the source content at the time the translation is applied.
b) Source version at the time of the translation request. The version of the source content that was available when the translation request was made.
c) Latest target version. The most recent version of the target page.
5. Review all the settings and press Apply to save them.
Comments
0 comments
Please sign in to leave a comment.