Map Hyperlink Tokens in Omnistudio Data Mapper for Omnistudio Document Generation

Use hyperlink tokens in Microsoft Word or Microsoft PowerPoint document templates to insert dynamic URLs in the generated DOCX and PDF files. The hyperlink token must start with HYP_. The token format is {{HYP_<hyperlinktokenname>}}, for example, {{HYP_Salesforce Website}}.

1. Create a Microsoft Word document with hyperlink tokens.

   Place link tokens anywhere in the document template, such as in paragraphs, tables, and text boxes. Use a token in a header or a footer or within a repeating content section to pass an array of hyperlinks. Here's an example of a DOCX document with hyperlink tokens.

   
2. Create a Microsoft Word template.
   1. In Token Mapping Method, select Data Mapper.
   2. Enter a mapping Data Mapper bundle name.
      The Data Mapper Transform maps the field with the ID to the token in the document template. The Data Mapper Transform then transforms the tokens with actual data in the document.
   3. Enter a data extract Data Mapper bundle name.
      The Data Mapper Extract retrieves the field with the ID of the image to be used in tokens.
3. To open the Data Mapper Extract on a new browser tab,click the icon next to the Data Extract Data Mapper Bundle Name field.
   1. Create a Data Mapper Extract.
      See Data Mapper Extract Overview.
   2. Define the Initial Extraction.
      See Define the Initial Extraction.
      
   3. Define Data Mapper Extract Output.
      See Data Mapper Extract Output.

      The Current JSON Output pane shows the structure that your output mappings specify.

   4. In Extract JSON Path, select the source field for extraction.
   5. In Output JSON Path, specify the output path.
      
   6. Add all hyperlink token source fields.
   7. On the PREVIEW tab, enter the Salesforce object ID and click Execute to confirm that the response pane shows a JSON structure containing the desired output.
      
   8. On the OUTPUT tab, copy the Current JSON Output, and save it to use it later in your Data Mapper Transform.
4. To open the Data Mapper Transform on a new tab, click the icon next to the Mapping Data Mapper Bundle Name field.
   

   Note

   Map data on the Transforms tab in one of these ways: If the input and output names match, use Quick Match to Map Data. See Use Quick Match to Map Data. Else, specify each mapping individually. See Data Mapper Transform Data Mappings.

   1. Create a Data Mapper Transform.
      See Data Mapper Transform Overview.
   2. On the Transform tab, in the Input JSON panel, paste the Current JSON Output code that you copied from the Data Mapper Extract.
   3. Click Quick Match.
      The fields in the Input Mappings column come from the JSON code (Current JSON Output of the extractor). The fields in the Output Mappings column come from the tokens in the document template.
      
   4. To match the input and output fields, click Auto Match.
      If the fields don't match automatically, drag fields from the Input column to the Output column.

      
   5. Save your changes.
   6. Additionally, you can define formulas in a Data Mapper to add text for the hyperlinks or to add text and hyperlinks. When you define a formula, you map its output to the output JSON (for extracts and transforms).
      See Use Formulas in Data Mappers​.
      
   7. Click Quick Match.
      The fields in the INPUT MAPPINGS column come from the data you defined on the FORMULAS tab. The fields in the OUTPUT MAPPINGS column come from the tokens in the document template.
      
   8. If the fields don't match automatically, drag fields from the INPUT MAPPINGS column to the OUTPUT MAPPINGS column.
      
   9. Save your changes.
      
   10. On the PREVIEW tab, verify the hyperlink tokens.
       Based on the mapping that you provided, notice that for some hyperlink tokens, only the URL is listed, and for some hyperlink tokens, both the URL and text are available.