Map Hyperlink Tokens in the Omnistudio Data Mappers

Using hyperlink tokens in the Microsoft Word or Microsoft PowerPoint document templates, you can insert dynamic URLs in the generated .docx and .pdf files.

1. Create a Microsoft Word document with hyperlink tokens.

   For more information, see Tokens in Microsoft Word or Microsoft PowerPoint Documents.

   You can place hyperlink tokens anywhere within the document template, such as in paragraphs, tables, and text boxes. Use a token in a header or 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.

   For more information, see Creating a Microsoft Word or Microsoft PowerPoint Template.

   1. From the 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 that identifies the image to be used in tokens.

3. Click icon next to the Data Extract Data Mapper Bundle Name field to open the Data Mapper Extract in a new browser tab.
   1. Create a Data Mapper Extract.

      For more information, see Data Mapper Extract Overview.

   2. Define the Initial Extraction.

      For more information, see Define the Initial Extraction.

   3. Define Data Mapper Extract Output.

      For more information, see Data Mapper Extract Output.

   4. In the Extract JSON Path field, select the source field for extraction.
   5. In the Output JSON Path field, specify the desired output path.
   6. Repeat the steps d and e to add all the hyperlink tokens source fields.
   7. In the Preview tab, enter the Salesforce object Id and execute to verify that the response pane displays a JSON structure containing the desired output.
   8. Go to the Output tab, copy the Current JSON Output, and save to use it later in your Data Mapper Transform.

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

4. Click icon next to the Mapping Data Mapper Bundle Name field to open the Data Mapper Transform in a new tab.
   

   Note

   You can map data on the Transforms tab in one of two ways: If the input and output names match, use Quick Match to Map Data , else specify each mapping individually. For more information see, Data Mapper Transform Data Mappings.

   1. Create a Data Mapper Transform.

      For more information, see Data Mapper Transform Overview

   2. In the Transform tab, paste the Current JSON Output code that you copied from the Data Mapper Extract into the Input JSON panel.
   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. Click Auto Match to match the input and output fields.

      If fields don’t match automatically, drag fields from the Input column to the Output column.

   5. Click Save.
   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).

      For more information, see Use Formulas in Data Mappers.

   7. Click Quick Match.

      The fields in the Input Mappings column come from the data you defined in the Formulas tab. The fields in the Output Mappings column come from the tokens in the document template.

   8. If fields don’t match automatically, drag fields from the Input column to the Output column.
   9. Click Save.
   10. Go to the Preview tab.

       Based on the mapping you provided, notice that for some hyperlink tokens, only the URL is listed, and for some hyperlink tokens both URL and text are available.

5. Verify that the Data Mappers pull the information from the sObject and populate the document template.
   1. In the Document Template Designer, click Test Template.
   2. In the Object ID box, enter the object ID from where you want to pull the information and then click Next.

      The document is generated and the tokens are replaced with the hyperlink content.

      You can download the generated document either in .docx, or .pdf format by using the Download Word, or Download PDF button, respectively.