memoQ integration setup
memoQ configuration
Download and install the memoQ software,
Open the Server Administrator window.
Connect to your memoQ TMS instance.
On the left-hand Category pane, select the Web Service interface.
Check the Enable the WS API.
Make sure that the Base address is accessible from a public address and from XTRF (it should NOT stay as this: http://localhost:8080/ ).
Note: If this field is not editable, open the Deployment Tool, go to the ‘Advanced’ > ‘Configure server’ > ‘Web Service API’ tab, and change the Base address there.Restart the memoQ server.
Check the connection by opening this link:Â http://yourAddressHere:8080/memoqservices/tm?WSDL
If memoQ has no users added yet, go to the User management category and add a user that belongs to the Project managers group.
XTRF Platform configuration
Log in to the XTRF Home Portal.
Go to the Configuration menu > Integration > CAT Tools.
Click the Add button on top of the CAT Tools table. You will be directed to the Add CAT Tool page.
From the CAT Tool drop-down list, select memoQ.
In the Name field, provide the desired name for the integration.
Click the Save button. You will be directed to the newly created CAT tool page.
Provide the Webservice URL under which memoQ is available.
Provide the User ID.
Select which user should be used to create projects in memoQ: either check the Use Project PM or uncheck it. In the latter case, the user from the previous field will be used.
You can specify the way the project names in memoQ will be generated by entering the Project Name Expression. The default expression is:${this.name} (${this.idNumber.replaceAll('/', '-')}), which includes the XTRF task name and the XTRF task ID (with slashes replaced by hyphens, since memoQ doesn't allow for slashes in project names), e.g., Translation of documents (2014-123).
You can specify the way the Vendor Aliases are generated by entering the expression. The default expression is:
${provider.name}.You can also specify a number of additional memoQ-specific settings. For more information about them, please refer to memoQ documentation.
(These settings can be changed for each workflow and for each XTRF task, if necessary.)Click the Save button. Now the connection between memoQ and XTRF is established.
Workflow Configuration
To automate the integration, you should establish special workflows that will manage the communication between XTRF and memoQ. You can create as many workflows as you wish. To do so, perform the following steps:
Go to Configuration Menu → Projects and Quotes → Workflow Definitions (Classic) and click the Add button on top of the list. You will be directed to the Add Workflow Definition page.
From the Type drop-down list, select Task Workflow.
Provide a unique name for the new workflow.
(Optional) Add a Description.
Check the Active, Preferred Item, and Default boxes according to your preferences.
Click the Save button.
You will be directed to the Workflow Graph tab of the new workflow definition page. Here you need to configure the steps included in the workflow. The Project phase of your workflow must have the following structure:
External project preparation → The jobs you want to perform in this workflow (for example, translation and proofreading) → External project finalization.Add the ‘external’ jobs:
Click the icon in the Project jobs section. The Workflow Job pop-up window appears.
From the Job Type drop-down list, select external project preparation / external project finalization.
In the Default Vendor section, select the Automatic Action radio button > External Project Preparation / External Project Finalization.
Click the Save button.
Go to the CAT Tools tab
From the CAT Tool drop-down list, select memoQ.
Check the Start Workflow after Completing CAT Receivable Using CAT Tool box if you want the workflow to automatically start after you create (automatically or manually) the CAT receivable.
Decide whether you want to download the preview files with the Download Preview Files after Each External Job checkbox.
Scroll down to the Job Mapping subtab. To ensure the correct information exchange between the two systems, you should match the jobs in XTRF with the corresponding workflow steps in memoQ. There are three workflow step types available in memoQ (for more information on memoQ workflow steps order, please refer to memoQ documentation):
Translation
Review 1
Review 2
Click the Save button.
Switch to the Advanced Settings subtab.
Decide whether to Add CAT Receivable during project creation.
Decide whether to create CAT Payables for specific jobs or all of them.
If a package preparation job is included in your workflow, select which type of bilingual file should be created by this job from the File Type for Package Preparation drop-down list.
In the fields below, you can specify a number of additional memoQ-specific settings. For more information, please refer to memoQ documentation.
Note: These settings can be changed for each XTRF task if necessary.Click the Save button.
Go to the Bundles tab and create as many bundles as you require. To learn more about bundles, see the Manage files in task workflow definitions and Projects and Quotes - Workflow Definitions (Classic) - Bundles tab articles.
Click the Save or Save and Exit button.