Custom Merge [NVelocity]
- 07 Dec 2023
- 1 Minute to read
- Print
- DarkLight
Custom Merge [NVelocity]
- Updated on 07 Dec 2023
- 1 Minute to read
- Print
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Step Details | |
Introduced in Version | --- |
Last Modified in Version | 8.17.0 |
Location | Data > Text |
NVelocity is an open-source Java template engineering framework. The Custom Merge [NVelocity] step merges data into a text format according to a defined template. These templates generate a variety of structured text formats, including CSS, HTML, and XML. Due to its support of these languages, NVelocity has a high level of flexibility that limits the user's ability to code in the chosen language. Unlike the TextMerge step, which only merges to plain or HTML Text, NVelocity steps offer the utmost flexibility with data template merging and formatting to fit a user's needs.
Example Use Cases
- Building a custom email body with a button link.
- Applying custom CSS formatting of an email body, PDF, or Word Document.
- Implementing reference image links using HTML.
Properties
Inputs
Property | Description | Data Type |
---|---|---|
Template | This input expects a string containing the NVelocity template. The template includes placeholders (e.g., ${variableName}) that will be replaced with actual values during the merging process. | String |
Variables to Merge | Define variables to use within a Text Merge; each variable added will become available as input. | --- |
Use Brackets | Allows to define whether the placeholders are using curly brackets or not '{ }'. Note: Users must enable this setting when using curly brackets in the placeholders. Failure to do so may result in the variables not being saved during merging. Similarly, do not enable this if placeholders are not using any curly brackets. The step will also throw a warning if 'Use Brackets' is enabled and the template does not use any curly brackets. | Boolean |
Outputs
Property | Description | Data Type |
---|---|---|
Merged String | String with merged information. | String |
Feature Changes
Description | Version | Developer Task |
---|---|---|
Added a step-level warning to warn users that Variables to Merge do not save unless the 'Use Brackets' box is checked | 8.17 | [DT-039324] |
Was this article helpful?