Template helper functions

Connector templates are built on Trimou, a Java templating engine based on Mustache.

For more information, see: Trimou 2.3.0 Documentation

Connector templates support additional and custom functionality through helper functions. They allow for transforming data to make it easier to generate the exact format required by your vendor’s API.

castIntegers

This helper forces the output in collections to be integer values. Can be used with toJson.

encodeBase64

Encode content in base64.

encodeUrl

URL-encode content.

escapeHtml

Escape values for use in HTML documents.

escapeJson

Escape values for use in JSON objects/arrays.

escapeXml

Escape values for use in XML documents.

formatDate

Format a date variable according to specified pattern. Pattern syntax corresponds to Java’s Simple Date formatting. For full table listing, see the Java Simple Date Format documentation.

hash

Generate a hash-based message authentication code (HMAC) using a secret key. An HMAC is a small set of data that helps authenticate the nature of message; it protects the integrity and the authenticity of the message.

The secret key is a unique piece of information used to compute the HMAC and is known both by the sender and the receiver of the message. This key varies in length depending on the algorithm you use.

The following example assumes that testKey, timestamp, ip, and lang are mapped template variable for the template.

Template variables:

timestamp = "2020-08-20T08:45:33.412"
ip        = "127.0.0.1"
lang      = "en-US"
testKey   = "w8sZzy8EaPaxFKfaoTqUi6"

Template:

{{hash algorithm="HmacSHA256" encodingCharset="UTF-8" binaryEncoding="hex" joinOn="" useSecretKey="true" testKey timestamp ip lang}}

Rendered output:

a0afb572e3fc174c2dea112e1a9922fb9903caa65e6aa9e50e47758b8a611542

The following table lists the available options for the hash function:

if

Print the content if the variable exists and has content. The following example assumes that lang exist as valid input variables in the template.

isEq

Print the content if the values are equal.

isNotEq

Print the content if the values are not equal.

join

Join will convert a list into a string with an optional joiner. Assuming empty_list is an empty list, no value is rendered.

jsonMinify

If provided content that contains valid JSON, minifies it (removes all whitespace). If the content is not valid JSON, the original value is shown with no changes.

md5

MD5 hash the content.

sha1

SHA1 hash the content.

sha256

SHA256 hash the content.

substring

Print the substring that begins at the specified start index and ends at the specified end index - 1.

substringAfter

Print the substring after the specified separator string.

substringAfterLast

Print the substring after the last occurrence of the specified separator string.

substringBefore

Print the substring before the specified separator string.

substringBeforeLast

Print the substring before the last occurrence of the specified separator string.

substringBetween

Print the substring between the specified open and close strings.

sum

Sum the values in a list or tally.

toInteger

Convert a variable’s value to an integer.

toJson

Print the variable in a JSON format.

toList

Convert a JSON-formatted-array string into an array for additional operations.

For arrn: ["1","2","2"]:

toTimestamp

Convert a date variable’s value to the Unix seconds timestamp format.

toTimestampMs

Convert a date variable’s value to the Unix milliseconds timestamp format.

unixTimestamp

Print the connector fire time in seconds since Unix epoch. This is useful for authorization headers. Optionally, format the date variable according to a specified pattern. Pattern syntax corresponds to Java’s Simple Date formatting. For full table listing, see the Java Simple Date Format documentation.

unixTimestampMs

Print the connector fire time in milliseconds since epoch. This is useful for authorization headers. Optionally, format the date variable according to a specified pattern. Pattern syntax corresponds to Java’s Simple Date formatting. For full table listing, see the Java Simple Date Format documentation.

unless

Print the content if the parameter does not exist or has no content. This is the inverse of if.

uuid

Print a randomly generated UUID, which is a universally unique identifier commonly used for identifying resources or ensuring uniqueness in distributed systems.