Smart memoQ integration setup
Configure memoQ
memoQ cloud
No configuration is required. Proceed to the Configure XTRF section of this article.
memoQ on-premise
Download and install the memoQ software,
Open the Server Administrator window.
Connect to your memoQ TMS instance.
On the left-hand Category menu, select the Web Service interface.
Check the Enable the WS API box.
Make sure that the Base address is accessible from a public address and XTRF (e.g., https://localhost:8443/).
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.
Configure XTRF
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.
Check the Active box.
Provide the Webservice URL under which memoQ is available.
(Optional) If the API key is enabled in memoQ, enter the correct value in the API key field.
In the User ID field, provide the memoQ administrator's username.
Select which user should be assigned as a project manager to memoQ projects:
Check the Use Project PM box to assign project managers specified in XTRF projects.
Uncheck the box to assign the user provided in the User ID field to every memoQ project created within the integration.
(Optional) Check how the project names in memoQ will be generated by entering the Project Name Expression. The default expression is:
${task.idNumber.replaceAll('/', '-')} ${task.name.replaceAll('/', '-')}. It includes the XTRF task name and the XTRF task ID (all unsupported characters, including forward and back slashes, are replaced by underscores), e.g., Translation of documents (2014-123). To change this expression, go to the Configuration menu > Templates > Expressions and edit the Project name expression for CAT tools entry.(Optional) You can specify how the Vendor Aliases are generated by entering the expression. The default expression is
${provider.name}.In the Default memoQ User Groups section, provide the default groups to which new project managers and vendors will be assigned in memoQ.
Scroll down to the Other section. Here, you can decide whether to reserve dedicated licenses for project managers and vendors. To learn more about licenses, see the memoQ documentation.
Click the Save button at the bottom of the page.
(Optional) Click the Test button at the bottom of the page to check the connection with the memoQ server. If the memoQ version number is displayed, everything is fine. In case of errors, contact your XTRF Regional Growth Manager.
Now, the connection between memoQ and XTRF is established.
MemoQ project templates overwrite other settings available on the CAT Tool page, so there is no need to set them here. To learn more about using memoQ project templates, see the Select a memoQ project template in XTRF article.
Prepare memoQ-integrated process templates
Before you start a memoQ-integrated project, we recommend you prepare a memoQ-specific process template or familiarize yourself with the built-in memoQ templates.
Every XTRF instance with Smart projects has several default memoQ process templates included. You can use, edit, or copy the existing ones (we recommend this option for those who just started using the XTRF-memoQ integration) or create custom process templates for memoQ-integrated projects.
To access those process templates, go to the Configuration menu > Projects and Quotes > Process Templates(Smart).
MemoQ templates are tagged with (memoQ).
To edit a process template, simply open the selected template. The editing options are described below in the Add a new process template for memoQ section.
To copy a process template, open the selected template and click the Copy Process Template button in the top right-hand corner,
See the Projects and Quotes | Process Templates (Smart) article to learn more about process templates.
Add a new process template for memoQ
Click the Add Process Template button in the top right-hand corner. You will be directed to the Add Process Template page.
Provide the name of the new template.
Note: We recommend adding the word 'memoQ' to the process template name to help with future searches.Select the Integrated with memoQ type.
Select your memoQ Instance. To learn how to add a new instance, see the Smart memoQ integration setup article.
Click the Add Process Template button.
In the Main Data card, decide whether the process template should be active and thus selectable on the XTRF Home Portal.
In the CAT Tool Configuration card:
Select a memoQ Project Template. To learn more about using memoQ Project Templates, see the article.
In the memoQ Project Creating section, decide whether you want the projects to be created automatically or manually.
In the Process card, design your memoQ-integrated process:
You can create custom CAT tool steps using the following guide: Projects and Quotes - Project Steps (Smart) - Add a CAT tool step.Select steps from the Step to be Used in Process side panel on the right.
Drag and drop them in the desired order on the Process card.
Note: memoQ-integrated steps from the CAT Tool section can be placed only in the order required by memoQ.
Configure the steps used in the process. To do so, click on a step on the Process card. The step side panel appears on the right.
Configure work files for vendors (see the section below for detailed instructions).
(Optional) Turn on the automatic file delivery in each step. This option enables vendors to work offline: when vendors upload ready files, the selected documents can be delivered to memoQ. It also automatically scans the documents for any unverified segments, and if any are found, requires confirmation before delivering the documents and finalizing a job.
Go to the MemoQ integration section on the step side panel.
Select the Yes radio button for the Try to deliver files to the next memoQ step when Job is finished option.
Repeat for other steps.
(Optional) Configure the File Preparation step (see the section below for detailed instructions).
See the Smart projects | Step side panel article to learn about other step configuration options.
All the changes to the process template are saved automatically.
Configure work files for vendors
Apart from optional files (like auxiliary files or reference materials), newly added steps need to receive and share bilingual documents from the project manager or client. By assigning bilingual documents to the memoQ-integrated steps, we ensure that vendors will find the required work files in memoQ, Webtrans, or as a downloadable on the Vendor Portal.
To ensure the correct file flow for integrated steps, perform the following actions:
Click on the step in question. The step sidebar menu will appear on the right.
Scroll down to the Work Files for Vendor section.
Open the PM or Client drop-down list, and ensure the Bilingual Document box and other necessary file categories are checked.
Scroll down to the Files to be Delivered by Vendor section.
Open the drop-down list and ensure the Bilingual Document box and other necessary file categories are checked.
Configure the File Preparation step
Sometimes, you may need to preprocess the documents before sending them for actual translation. To do this, you need to add a File Preparation step, during which the first vendor in line can adapt or prepare documents that will later be analyzed by memoQ and turned into translatables.
To ensure that the vendor receives and delivers the correct files, perform the following steps:
Select the File Preparation step on the Process card. The step sidebar menu will appear on the right.
Scroll down to the Work Files for Vendor section.
Open the PM or Client drop-down list, and make sure the Source to be Prepared box is checked.
Scroll down to the Files to be Delivered by Vendor section.
Open the drop-down list and ensure the Source Documents box and other necessary file categories are checked.
Machine translation configuration
All the machine translation-related settings are configured solely on the memoQ side per project template. To learn more about those settings, see the memoQ documentation.