Create a Text Merge
  • 19 Oct 2021
  • 3 Minutes to read
  • Dark

Create a Text Merge

  • Dark


Pre-defined Text Merges can be created in a Designer Project or Flow to merge written text and data together. This operates the same as the Merge Plain/HTML Text input mapping type, except that feature is only applicable per each input value. When a custom Text Merge is created and referenced in a Flow, the Text Merge inputs can be defined with Flow data for dynamic mapping. This allows for more flexibility when Text Merges require access to different pieces of data in the project.


The Text Merge Designer is its own interface, similar to how it would appear when using the input mapping type. There are several pre-built Calculated Fields that can be used in the custom merge if applicable. This example will explore the Text Merge interface and how Calculated Fields functions at runtime. 

  1. In a Designer Project, select the Other button from the bottom Action Bar. Hover the cursor over Text Merge, then select Create Text
  2. When the window appears, enter a Name and keep the Use as Behavior
  3. Once complete, select CREATE.

  4. The Designer interface for Text Merge has a large text area in the center, the Data and Calculated Fields listed on the left, and the configuration options on the right. 
  5. For data to be usable in the Text Merge, it must be added as Input Data in the PROPERTIES configurations. 
  6. Even though it is added in the Text Merge, the input will still need value definition at runtime. 
  7. Select the Add New button under the Input Data box, then define the input data member being added with a name and type. 
  8. The added input data will appear under the Data section on the left. 
  9. Items from the left can be added to the Text Editor by hovering the cursor over the name of the item, then selecting the plus icon. 
  10. This example uses Capitalize from the Calculated Field section. When this item is added to the Text Editor, it will appear as a gray label. 
  11. Select the label and choose the Edit option from the menu. 
  12. When the window appears, choose the text that should be capitalized at runtime (only input data will appear in this list). 
  13. Use the SAVE button once complete.

  14. In the Designer Project, right-click the name of the Text Merge and choose the Preview TextMerge option from the menu. 
  15. Enter a name and select OK to see that the text has been capitalized as the function intended. 
  16. This result can be saved as HTML, a PDF, or a DOC file. 
  17. Select CLOSE once complete.

  18. The example below removes the use of the Calculated Field and instead merges data with text in the editor. 
  19. There are two pieces of input data, Name (String) and Email (String). 
  20. The text is merged to say [Name]'s email is: [Email], where those two inputs can be dynamically mapped for definition as shown in the next section. 
  21. The preview of the updated Text Merge shows that the sample input data provided was merged with the text as expected.

  22. Select the CREATE FLOW button from the top Action Bar in the Designer Project. 
  23. Choose the CREATE NEW button and select Flow. 
  24. Provide a name then select CREATE. 
  25. In the Flow Designer, connect the Start and End Step, then hover over the connecting line and select the plus icon. 
  26. Type the name of the custom Text Merge into the search bar and choose it as an added Flow step. 
  27. The Flow step will have input values that correlate with what was configured in the Text Merge Designer. 
  28. These inputs can be mapped with Flow data, as shown in the GIF below, or they can be mapped with constant data for a similar effect as previewing the merge. 
  29. Use the Select From Flow mapping type to define the Text Merge input data values with data from the Flow (Flow Data > Current Account Name).
  30. Select the Debug button from the Top Action Bar, then select the FULL option when the Debugger appears. 
  31. Select the Text Merge step icon, then select Execution > View Input/Output Data
  32. As shown, the name that was pulled from the Flow data has been capitalized. 

Was this article helpful?

What's Next