Translating Altify Max Insights and Email Notifications

You can translate Altify Max insights and email notifications. This means that, for example, Brazilian users get insights and Max emails in Brazilian Portuguese rather than in English.

Translating insights and Max emails involves the use of Max Translation records.

The process is very similar to that of sales methodology text translation.

Prerequisite

Before you begin, ask Altify for the SOQL query and the "field mappings" file.

Note: The Max Translation records have IDs specific to the org you are working in. This means that the entire translation process must be carried out in your production org. You can't generate translation records in sandbox and then import them into production.

Enabling a Language for Max Translation

To enable Altify Max to generate Max Translation records for a particular language:

  1. In Setup, go to the Max Content Translation custom object.
  2. In the Fields & Relationships section, open the object's Language picklist.
  3. The picklist contains languages supported by Salesforce. It also includes the Translation off value.
  4. When you Activate a language in the picklist, it becomes available for selection on the Max Content Translation tab.

    If you don't want any languages to be available, make sure they're all inactive in the picklist, and activate Translation off instead.

    In this example, Brazilian Portuguese is active.

  5. Click Save.

The languages you activate become available for selection on the Max Content Translation tab:

Generate the Max Translation Records

To generate Max Translation records for Brazilian Portuguese translations of Altify sales methodology text:

  1. Open the Max Content Translations tab.
  2. Select pt_BR in the Language drop-down. (The languages available here are the ones you enabled in the previous section.)
  3. Click Go.
  4. The page lists all the relevant Altify custom objects, and specifies how many "missing" Max Content Translation records there are for Brazilian Portuguese. Click Generate.
  5. When the records have been generated, the number of 'missing translations' for each type changes to 0. This means that all the necessary Max Content Translation records for Brazilian Portuguese have been built.

    Note: The "class" type is for Max email-notification templates.

You have generated a full set of translation records for Brazilian Portuguese. These can now be exported from the org and then translated.

Exporting the Max Translation Records

Initially, the Max Translation records contain the default English text.

So at this stage a Brazilian Altify user continues to see English text. For a Brazilian user to see the text in Portuguese, translated text must be added to each Max Translation record, and then these must be imported back into the org.

To export all the translation records to a single CSV file:

  1. Open the Salesforce Data Loader app.
  2. Note: You'll need to install this on your computer if you have not done so already. It's available for download from Setup in your org.

  3. Click Export.
  4. Log into the Data Loader with System Administrator credentials.
  5. Click Next.
  6. In the Select Salesforce Object list, select Max Content Translation.
  7. Specify the location and name of the CSV file to export Max Translation records to.
  8. Click Next.
  9. Paste the SOQL query shown below into the query field. This tells the Data Loader which data to extract from the records.
  10. Note: You can obtain the query from Altify or copy it from below. Note, however, that if you copy it from below the query may include a number of end-of-line markers that need to be removed before you run it.

    In the query's WHERE clause, specify the language code that's relevant to you. In this example, the language code is for Brazilian Portuguese, so the WHERE clause ends with ='pt_BR'

     

    SELECT Id, DMMAX__Type__c, DMMAX__Text1__c, DMMAX__RefText1__c, DMMAX__Text2__c, DMMAX__RefText2__c, DMMAX__Text3__c, DMMAX__RefText3__c, DMMAX__TextLong1__c, DMMAX__RefTextLong1__c, DMMAX__Version__c, DMMAX__TargetVersion__c FROM DMMAX__Content_Translation__c WHERE DMMAX__Language__c = 'pt_BR'
  11. Click Finish.
  12. Click Yes.
  13. When the export is complete, click OK.
  14. Review the CSV file to make sure that you're happy with the content it includes. We recommend OpenOffice as the best software to use for this.
  15. Note: Do not open the file in Microsoft Excel. This may add extraneous characters that corrupt the file.

    Viewed in a spreadsheet, you can see that there are a number of columns in the CSV file.

    Each record has its own row, and each column represents a field in the record. For each field that needs to be translated, there's also a "ref" column where you can always see the default English text.

    In this example, the TEXT1 column must be translated, and the REFTEXT1 column shows the English default text.

  16. Provide the CSV file to the translator. Make sure they're clear about which columns need to be translated.
  17. Where fields include HTML markup tags, ensure that these are retained in the translation so that formatting is preserved.

    "Numeric character references" such as ', which represents an apostrophe character, should also be preserved.

    The "class" rows in the CSV file provide the HTML structure of Max notification emails. Within these tables, the entities listed below must be preserved in the translated text. Do not edit anything between the $ and the } in any of these entities. (When the text is rendered in an email, these entities are replaced by information from your org):

    • ${classname} : Name of the relevant class, such as “Opportunities”.
    • ${username} : Name of the user the insights are being sent to.
    • ${managername} : The user's manager’s name.
    • ${firstname} : The user's first name.

    Tags with the format {!value} must also be preserved. These map to object signals, and so are integral to the insights shown to the user.

  18. Instruct the translator that when each row in the CSV file is translated, they must change the value in the "Version" column to match the value in the "Target Version" column. This number is how the software detects whether the translation is for the current English version of the insight. (In the Insight Editor tab, an insight translation that's not for the current English version gets a red tag, and an translation for the current English version gets a green tag.)

Import the Translated Content

When the translator returns the CSV file to you with all the translations completed, you are ready to import it into your org.

  1. In the Data Loader, click Update.
  2. Select the Max Content Translation object.
  3. Select the CSV file you received back from the translator.
  4. Click Next.
  5. You should see an 'initialization succeeded' message. Click OK.
  6. Now you need to map the fields in the CSV file to the fields in the Altify Translation object. To do this, we recommend selecting Choose an Existing Map. Then you can browse to the .SDL mapping file provided by Altify. When you select it, the field mappings specified in the .SDL file are listed.
  7. Alternatively, you can choose to "auto-match" the fields. As long as the columns in your CSV file are correctly titled, this should map the fields successfully.

  8. Specify the folder where you want the success/failure report file to be saved.
  9. Click Finish.
  10. Click Yes to confirm that you want to proceed with the update operation.

When the update is complete, you should get a success message:

In the Insight Editor, each insight now has a tag showing that it has a Brazilian Portuguese translation. When the tag is green, it means there is a translation for the most recent revision of the default English version of the insight. When the tag is red, it means the translation has not been updated since the last time the English version was revised.

You can click the tag to see the Brazilian Portuguese version of the insight.

A Brazilian user will see the Portuguese version of this Max insight whenever it is triggered.

Email Encoding

When email templates are translated into certain languages, you may need to change the Email Encoding setting on each relevant user record.

  1. Open the user record.
  2. Click Edit.
  3. In the Email Encoding drop-down, select the encoding that matches the user's language.
  4. Click Save.