version 1.8.2 for magento 2 · linguistic review process the integration with magento 2 involves...

for Magento 2Version 1.8.2

Administrator Guide

This documentation is proprietary and is protected by U.S. and international copyright laws and trade secret laws. Copyright © 2020Translations.com, Inc. ("Translations.com") All rights reserved. No part of this documentation may be reproduced, copied, adapted, modified,distributed, transferred, translated, disclosed, displayed or otherwise used by anyone in any form or by any means without the express writtenauthorization of Translations.com. Other names may be trademarks of their respective owners.Copyright © 2020 Translations.com, Inc. Confidential of 34

Table of ContentsAbout this Guide..................................................................................................................................................... 3

Conventions.......................................................................................................................................................3

Typographical............................................................................................................................................ 3

Icons.......................................................................................................................................................... 3

1 About GlobalLink Connect................................................................................................................................ 4

Globalization Management Suite...................................................................................................................... 4

GlobalLink Connect for Magento 2...................................................................................................................4

Prerequisites..............................................................................................................................................5

Explore the User Interface........................................................................................................................5

2 Install Magento 2................................................................................................................................................ 6

3 Adaptor Configuration....................................................................................................................................... 7

Configure General Settings...............................................................................................................................7

Configure Classifier Settings...........................................................................................................................10

Configure Locale Mapping.............................................................................................................................. 11

4 Product Translation Configuration.................................................................................................................14

Configure Product Attributes...........................................................................................................................14

Configure Category Attributes.........................................................................................................................17

Configure CMS Page Fields........................................................................................................................... 19

Configure CMS Block Fields...........................................................................................................................21

Configure Product Reviews............................................................................................................................ 23

5 Queued Translation Management...................................................................................................................26

Manual Translation Submit and Retrieve....................................................................................................... 26

Submit Queued Submissions..................................................................................................................26

Receive Completed Submissions........................................................................................................... 26

Import Completed Submissions..............................................................................................................27

Synchronize Cancelled Submissions......................................................................................................27

Unlock Submissions................................................................................................................................27

Automatic Translation Submit and Retrieve................................................................................................... 27

Submission of Queued Translations.......................................................................................................28

Monitor Submissions...............................................................................................................................28

Manage Cancelled Submissions.............................................................................................................30

Copyright © 2020 Translations.com, Inc. Confidential of 34

About this GuideThe images and topics contained in this guide are not representative of every GlobalLink® product installation.Each GlobalLink product installation is configured to meet the needs of the intended users, who may or may notrequire certain features and options. Therefore, the features and options covered in this guide may differ fromthose available on your GlobalLink product installation.

Conventions

TypographicalThe following table explains the typographical conventions used in this guide.

Bold User interface controls, commands, and keywords in body text.

italic Represents an input field where user input is expected.

<…> Generic parameters that must be replaced by specific code or text.

IconsThe following table explains the icon conventions used in this guide.

Note:This icon designates a note or helpful suggestion or reference relating to the surrounding text.

Best Practice:This icon designates a suggestion for best practice relating to the surrounding text.

Alert:This icon designates a warning or alert relating to the surrounding text. In this situation, the usershould exercise caution to avoid an undesirable result.


1. About GlobalLink ConnectGlobalLink Connect serves as a bridge between your back-end systems and our industry-leading GlobalizationManagement Suite, allowing you to use the full functionality of your CMS, DMS, e-commerce, PIM, and databaseplatforms to manage multilingual content.

Globalization Management SuiteThe GlobalLink Globalization Management Suite (GMS) is a modular set of translation technology products thatprovide enterprise solutions for organizations. It consists of the following server components:

• GlobalLink Project Director—An automated translation workflow system that leverages andcommunicates with the other GlobalLink products through a published Web services API

• GlobalLink TM Server—A robust, scalable server-based translation memory solution

• GlobalLink Term Manager—A web-based terminology management tool that allows any translationmanager to modify, review, search, or delete existing terms

• GlobalLink TransStudio Online—A web-based translation tool that offers translators instant access totranslation memories and terminology lists

• GlobalLink TransStudio Review—A web-based translation review tool with an intuitive user interface thatallows translated content to be reviewed quickly and effectively

• GlobalLink Translation & Review Portal—A web-based, collaborative application that streamlines thelinguistic review process

The integration with Magento 2 involves Web services communication between Magento 2 and GlobalLink ProjectDirector (PD).

GlobalLink Connect for Magento 2GlobalLink Connect for Magento 2 is a module that permits users to initiate, automate, control, and track theentire translation process. The translation of web content can be managed directly from the Magento 2 userinterface using the custom interface elements, tables, and job scheduler that exchanges content between theCMS and GlobalLink. The combination of the Magento 2 CMS functionality and the workflow capabilities ofGlobalLink provide Magento 2 users with a comprehensive platform to manage web content for markets aroundthe globe. Magento 2 highlights:

• Leverages existing Magento user knowledge

• Supports scheduled or on-demand translation initiation through the Magento Admin Catalog

• Allows content authors to focus on updates to source-language content

• Eliminates hand-off delays and reduces translation turnaround times

• Automatic imports of translations into Magento catalogs

• Automatically handles custom product attributes

• One-click exports and imports of catalog content

1. About GlobalLink Connect GlobalLink® Connect for Magento 2


PrerequisitesGlobalLink Connect for Magento 2 is compatible with Magento 2 Community Edition, Enterprise Edition, andCommerce cloud Edition—2.3.x..

Explore the User InterfaceThe default view is the dashboard. You can move through the interface using the Admin Sidebar.

Element Description

Admin Sidebar The primary tabs of Magento 2 interface.

Body Pane The main dialog area.

System Messages The area where system messages are displayed.


2. Install Magento 2You can install the GlobalLink Connect for Magento 2 Adaptor, referred to as the Adaptor throughout, asdescribed.

To install the Adaptor:

1. Use Composer to request the package based on your Magento 2 version:

./composer require "transperfect/module-globallink:1.8.2"

2. Upgrade the setup.

./php bin/magento setup:upgrade

3. Compile the code.

./php bin/magento setup:di:compile

4. (Optional) Clear the cache.

./php bin/magento cache:flush

5. (Optional) Re-index Magento 2.

./php bin/magento indexer:reindex

The Adaptor is installed.


3. Adaptor ConfigurationYou can configure the Adaptor through the Magento 2 user interface.

Configure General SettingsTo configure General settings:

1. On the Admin Sidebar, click GLOBALLINK.

2. Under Configuration, click General.

3. On the General panel, enter the configuration settings.

3. Adaptor Configuration GlobalLink® Connect for Magento 2


Setting Action

Logging Level Select the logging levels you want reported from the available list:Debug—Provides additional debugging information.Info—Provides standard logging information related to the translationprocess.Error—Provides error information.

Download GlobalLink Log Click to download the available GlobalLink logs.

Re-index After ImportingTranslations

Select Yes to re-index the database after importing the translations.

Note: This is time consuming and can impact system performance; youshould contact your system administrator.

Automatic Submission andRetrieval of Translations

Select Yes to enable automatic submission and retrieval of translations.

Automatically Import AfterChecking for Translations

(Optional) Select Yes to enable automatically importing translations.This option should only be set to Yes when Automatic Submission andRetrieval of Translations is set to Yes.

Email Errors Select Yes to enable error notification emails.



Setting Action

Email Addresses Enter a comma separated list of email addresses to receive errornotifications.

GlobalLink Default Project Enter the project name provided by your GlobalLink representative. Thisdefault project name applies to submissions in Project Director (PD).

Files per Submission Enter the maximum number of files that a submission can contain. If thenumber of files exceeds this number, a new submission is created. Therecommended maximum is 100.

Max Target Count Enter the maximum number of translated files that can be retrieved fromPD at the same time. Your GlobalLink representative can assist you indetermining the appropriate setting.

4. Scroll down to the Connection section.

5. Enter the connection settings.

All settings must be provided.

Setting Action

Username Enter the Project Director (PD) user ID provided by your GlobalLink representative.

Password Enter the PD password provided by your GlobalLink representative.

GlobalLink Url Enter the PD URL provided by your GlobalLink representative.



6. Click Save Config.

The General and Connection settings are configured.

7. Click Test Connection.

If you experience any issues, verify your entries, and click Save Config, then retest the configuration.If you continue to experience issues, contact your GlobalLink representative.

Configure Classifier SettingsClassifiers are rules used to parse files submitted for translation and separate metadata from translatable content.

To configure classifier settings:


2. Under Configuration click Classifiers.

3. Select the appropriate classifier setting for each content type.

When the Project Director (PD) details are configured, the available classifiers for each content typeare dynamically retrieved from PD. If you experience any issues, verify your available PD classifiers.



4. Click Save Config.

The classifier settings are configured.

Configure Locale MappingYou must map locales to link Magento 2 languages to GlobalLink languages.

You can create a dedicated Store View for each target language to post translated content to the Store Viewassociated with each language.



To create a Store View and map locales:


2. Under Configuration, click Languages Mapping.

3. Click Create Store View.

4. Enter the Store View information.



Required fields are marked with a red asterisk.

Field Action

Store Select a store that the Store View is associated with from the drop-down list.

Name Enter the Store View name. Include the language in the name for bettertraceability.

Code Enter the Store View language code. Refer to the Magento 2 documentation forfurther information.

GlobalLink Locale Select the corresponding GlobalLink locale from the drop-down list. Availablevalues are dynamically retrieved from PD.

Status Select to enable or disable the store view.

Sort Order Specify an alternative sort order. By default, Store Views are sortedalphabetically. Refer to the Magento 2 documentation for further information.

5. Click Save Store View.

The store view is created and locales are mapped.


4. Product Translation ConfigurationYou can configure which products to translate using GlobalLink content element attributes.

The content elements attributes are:

• Product Attributes

• Category Attributes

• CMS Page Fields

• CMS Block Fields

• Customer Attributes

• Product Reviews

Configure Product AttributesYou can identify which products to translate by configuring the product attributes for inclusion.

To configure product attributes for inclusion:


2. Under Fields Configuration, click Products.

4. Product Translation Configuration GlobalLink® Connect for Magento 2


3. Select a product from the Select Attribute Set drop-down list.



4. Select the appropriate attribute for each attribute set in the drop-down list.

5. Click Update Configuration on the Actions drop-down menu.



6. Repeat Step 3 through Step 5 for each attribute set you are configuring.

The product attributes are configured for inclusion in the submissions.

Configure Category AttributesYou can choose categories for translation by configuring the category attributes.



To configure category attributes:


2. Under Fields Configuration, click Categories.

3. Select the appropriate attributes for the category.




5. Click OK.

The category attributes are configured for inclusion in the submissions.

Configure CMS Page FieldsYou can configure CMS page fields for inclusion in submissions through the CMS Pages tab.

You must add and configure each custom field in the Fields Configuration for CMS pages.



To configure page fields for inclusion:


2. Under Fields Configuration, click CMS Pages.

3. Select the appropriate field for the CMS page.




The page fields are configured for inclusion in the submissions.

Configure CMS Block FieldsThrough the CMS Blocks tab, you can limit the translation of the CMS block fields by configuring which to includein submissions.

You must add and configure each custom field in the Fields Configuration for CMS blocks.



To configure the block fields for inclusion:


2. Under Fields Configuration, click CMS Blocks.

3. Select the appropriate field for the CMS block.




The block fields are configured for inclusion in the submissions.

Configure Product ReviewsThrough the Product Reviews tab, you can configure Product Review fields for inclusion in submissions.

You must add and configure each custom field in the Fields Configuration for Product Reviews.



To configure the product review fields for inclusion:


2. Under Fields Configuration, click Product Reviews.

3. Select the appropriate field for the product reviews.




The Product Review fields are configured for inclusion in the submissions.


5. Queued Translation ManagementGlobalLink for Magento 2 provides two ways to manage Project Director (PD) queued translations:

• Manual—When Automatic Submission and Retrieval of Translations is disabled, you must manuallysubmit queued translation submissions to Project Director (PD). The completed or cancelled submissionsmust be retrieved from PD by running Submit, Receive and Import commands on the Magento 2 back-end.

• Automatic—When Automatic Submission and Retrieval of Translations is enabled, you mustautomatically submit queued translation submissions to Project Director (PD). The completed or cancelledsubmissions must be retrieved from PD by enabling the auto-submit and retrieval settings.

You can submit content for translation manually, or automatically, using your system scheduler.

Refer to your system documentation for further information on how to configure the scheduler.

Manual Translation Submit and RetrieveWhen automatic submission and retrieval is disabled, you must manually submit and retrieve your queuedtranslation submissions.

Submit Queued SubmissionsWhen you create submissions from the Magento 2 user interface, the submissions are added to a queue. Youmust then submit the queued submissions to Project Director (PD).

To submit a queued submission:

1. Open a Command console.

2. At the command prompt, enter:

php bin/magento globallink:translations:submit

The queued submission is submitted to PD.

Receive Completed SubmissionsYou must receive the list of completed submissions from Project Director (PD) to add them to the input queue.

You must run the Receive command before you can retrieve completed submissions using theMagento 2 user interface.

To receive completed submissions:



php bin/magento globallink:translations:receive

The completed submissions are received from PD and added to the input queue.

5. Queued Translation Management GlobalLink® Connect for Magento 2


Import Completed SubmissionsYou can import all completed submissions from Project Director (PD).

To import completed submissions:



php bin/magento globallink:translations:import

The completed submissions are imported from PD and applied to the store view.

Synchronize Cancelled SubmissionsYou must synchronize the list of cancelled submissions from Project Director (PD) to record the cancelled statusin the local Magento 2 database.

You can synchronize all cancelled submissions with the cancel command.

When Automatic Submission and Retrieval of Translations is disabled, you must run the Cancelcommand on the command console after cancelling submissions on the dashboard.

To synchronize cancelled submissions:



php bin/magento globallink:translations:cancel

The cancelled submissions are synchronized with PD and their status is recorded in the Magento 2 database.

Unlock SubmissionsYou can unlock queued, completed, and cancelled submissions using the Unlock command.

To unlock submissions:



php bin/magento globallink:translations:unlock

The locked submissions are unlocked.

Automatic Translation Submit and RetrieveWhen automatic submission and retrieval is enabled through the Automatic Submission and Retrieval ofTranslations setting, your translations are queued for submission to Project Director (PD). This queue is



processed immediately and the queued submissions are sent to PD. You must enable the setting Automaticallyimport after checking for Translations to have PD automatically import and update the completed Submissions.

Submission of Queued TranslationsWhen you create translation submissions they are queued for submission to Project Director (PD). This queue isprocessed automatically at regular intervals and translation requests are sent to PD.

Monitor SubmissionsYou can monitor the real-time status of your submissions on the Translations - Submissions dashboard.

To monitor your submissions:


2. Under Management, click Submissions.

3. Click Refresh Dashboard.

When Automatic Submission and Retrieval of Translations is set to Yes, only the Refresh buttonis visible.



Automatic import is optional.

Automatic import can only be activated when Automatic Submission and Retrieval of Translationsis set to Yes in Configure General Settings.

The submission status colors are:

• Blue—Translation complete

• Orange—Submission is queued or in-progress

• Grey—Submission cancelled or waiting to be cancelled

• Red—All error conditions

4. Click OK.



The status of each submission is retrieved from Project Director (PD) and updated. All Completedsubmissions are received from PD and the translations are applied to the target stores.

When a submission is complete, you can click on the link in the Source Language column to viewthe source and in the Target Language column to view the translated content.

Manage Cancelled SubmissionsThe list of submissions cancelled manually or by Project Director (PD), is automatically synchronized with PD anddisplay on the dashboard with the status of Cancelled. You can manually cancel incomplete submissions with theCancel Submissions command and delete all cancelled submissions from the dashboard with the Remove allcancelled items command.



To cancel submissions:



3. Select all submissions that are not Completed and you want to cancel.

4. Click Cancel Submissions in the drop-down menu.



The selected submissions are cancelled.

Remove All Cancelled SubmissionsYou can remove the cancelled submissions with the Remove all cancelled items option.



To remove cancelled submissions:



3. Click Remove all cancelled items.



The cancelled submissions are removed from the dashboard.

version 1.8.2 for magento 2 · linguistic review process the integration with magento 2 involves...

Documents