Test

Whatfix enables you to add a custom translation tool based on your requirements and internal processes.

Use the following steps to add a translation tool based on an API request:

2. Click Translation tools.

   

3. On the Translation tools page, click the Add icon.  
   

4. In the Integrating with Custom tool dialog box, enter the name of the tool, and then select API as the translation method.
   

   
   

5. Click Continue.
   

Translation tools use codes to distinguish languages and translate content. In the Map Languages section, configure language codes to set the to and from language. You must map the language code used in the translation tool with the language supported by Whatfix. For example, Fr: fr (french) and De: de (German).

Note:

• You must also map the Primary Language used to create Whatfix content. Otherwise, Whatfix cannot detect and send the content for translation.

• Once you have integrated the tool, add languages directly from the Translations page in the Configurations section:
  

After you have added a translation tool, use the following steps to add languages and map them between Whatfix and the custom translation tool:

1. In the Map Languages section, use the dropdown and select the input language.

2. Enter the language code as recognized by the translation tool.

3. To map other languages, click + Add language code.

4. Select the input language and add the language code.  

Whatfix content must be converted into a format so that the translation tool can receive and interpret the data. This includes to and from language, translation attributes and other details to uniquely identify the content and the fields in the content that require translation.

Use the following steps to convert Whatfix data to a format accepted by the custom tool:

Note:

Refer to the Translation Tool Guidelines to learn about Javascript and Request parameters while configuring the steps for the custom translation tool.

1. In the Convert Whatfix data to format accepted by the custom tool section, enter a Description (Optional). By default, the Configuration type is set to Javascript.
   

2. In the Script field, enter the Javascript code to convert Whatfix data into a format accepted by the custom translation tool.
   

   Here’s an example Javascript code for Microsoft Azure:
   

   function convertToMicrosoftTranslationInput(original_data) {
       var inputForMs = [];
       for (var i = 0; i < original_data.length; i++) {
           var item = original_data[i];
           inputForMs.push({
               "Text": item.value
           });
       }
       return inputForMs;
   }
   
   var microsoftTranslationInput = convertToMicrosoftTranslationInput(attributes.translationStrings);
   // Here we can see that strings that need to be translated can be accessed by attributes.translationStrings
   output.data = microsoftTranslationInput;

   Note:

   The JS Script code editor only supports versions earlier than ES6. For more information about specifying variables and parameters, see Translation Tool Guidelines.

   The preceding Javascript code reads the translationStrings from Whatfix, formats it into a structure that Microsoft accepts, and saves the result in a variable called output.data for the next step.

This step enables you to request translated content from the custom translation tool through an API request.

Use the following steps to configure the API request:

1. In the Configure Custom tool section, enter a Description (Optional) and select the Configuration type. Choose either Javascript or Request type.
   

   Note:

   Refer to Translation Tool Guidelines to learn about Javascript and Request parameters while configuring the steps for the custom translation tool.

   
   Based on the Configuration type, perform the steps in the following accordion:

   Request

   A. In the Method dropdown, select POST.

   

   B. Enter the URL.

   
   Example URL:

   https://api.cognitive.microsofttranslator.com/translate?api-version=3.0&to=${attributes.targetLocale}&from=${attributes.sourceLocale}&textType=html
   // Here we can see that in order to access source and target locale we are using attributes.sourceLocale , attributes.targetLocale
   

   C. Specify parameter details in the Headers field. Due to security reasons, click the Unhide icon and then add the Headers.  

   

   Here’s an example code for Headers:

   {
       "Content-Type": "application/json",
       "Ocp-Apim-Subscription-Key": "YOUR_SUBSCRIPTION_KEY",
       "Ocp-Apim-Subscription-Region": "Global"
   }
   

   
   Note: You must specify the Subscription-Key for the custom tool.

   Javascript

   In the Script field, enter the Javascript code to request translated content from the custom translation tool.

Additional Configurations

In certain scenarios, based on the custom tool, additional configuration steps might be required to receive content. Use the + Add configuration icon to provide additional steps for the API request.

Similar to the steps highlighted above, enter the details in the Configuration 2 section:

The translated content received from the translation tool needs to be restructured to align with Whatfix's data format.

Use the following steps to convert the format from the custom translation tool to Whatfix data:

1. In the Convert format from custom tool to Whatfix data section, enter a Description (Optional). By default, the Configuration type is set to Javascript.
   

   
   

2. In the Script field, enter the Javascript code to convert the format from the custom tool to Whatfix accepted format.
   
   Here’s an example Javascript code:

   function mergeTranslatedValues(original_data, translated_data) {
       var result = [];
       for (var i = 0; i < original_data.length; i++) {
           var originalItem = original_data[i];
           var translatedItem = translated_data[i];
           result.push({
               key: originalItem.key,
               value: translatedItem.translations[0].text
           });
       }
       return result;
   }
   
   var mergedData = mergeTranslatedValues(attributes.translationStrings, input);
   // Output of previous step can be accessed by using input keyword
   output.data = mergedData;
   

   The preceding Javascript code merges the translated text from Microsoft Azure with the original keys from Whatfix, and can display the translated text correctly.

3. Click Save.