Dynamic Hyperlinks for Client-Side Document Generation

Using hyperlink tokens in Microsoft Word or Microsoft PowerPoint document templates, you can insert dynamic URLs in generated .docx and .pdf files. For example, with dynamic hyperlink tokens, you can insert a hyperlink for every product ordered that directs you to the product specification web page.

The hyperlink token must start with HYP_. The token format is {{HYP_<hyperlinktokenname>}}, for example, {{HYP_Salesforce Website}}. Place hyperlink tokens anywhere within a 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. A text for the URL can be defined in the Omnistudio Data Mapper, for example, Salesforce. If a text isn’t provided for the hyperlink, the URL appears blue and underlined in the generated document, for example, https://www.salesforce.com.

The hyperlink tokens support right-to-left languages. The font and the style of the hyperlink token in the document overrides the default hyperlink font and style in the generated document. Hyperlink tokens support URL formats such as https and http. Hyperlinks can pass through the rich text tokens using Data Mapper Transform, Custom Class, and Omniscripts.

Dynamic hyperlinks have several use cases:

• In a generated B2B insurance policy, a hyperlink that takes you to the corporate web page of the company.

• In a generated quote, a hyperlink for every product ordered that directs you to the product specification web page. Hyperlinks for products are stored in Salesforce.

The image shows an example of a Word document with a list of products, their names, and their images. For each product, a dynamic hyperlink is inserted that takes you to the product web page.

1. Create Custom Hyperlink Fields for Your Object in Omnistudio Document Generation
   Create a custom text field for any object. Map the text field in your object by using Omnistudio Data Mappers to render the hyperlinks in the generated document.
2. 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}}.