Function Reference

Declares a named counter ("sequence") that you can then draw values from with getSeq. This is a setup step — it doesn't produce a value by itself.

<createSeq('orderNo', 'number', 1000, 1)>

Returns the next value from a sequence you've already declared with createSeq, advancing it each time it's called.

<getSeq('orderNo')>

Reads back a value previously stored under a variable name — either earlier in the same template, or a shared variable available across your account.

<getVar('customerName')>

Stores a value under a variable name so it can be read back later in the same template with getVar.

<setVar('discount', 10)>

Returns a random first name.

<getRandomName('en')>

Returns a random surname.

<getRandomSurname()>

Returns a random full name (first name and surname together).

<getRandomFullName('en')>

Returns a synthetic, realistic-looking email address built from random names.

<getRandomEmail('example.com')>

Returns a random number within a range — an integer by default, or a decimal number if requested.

<getRandomNumber(1, 5, 0)>

Returns a random true/false value.

<getRandomBoolean(0.7)>

Generates random placeholder-style text within a given length range.

<getRandomTextWithSpaces(10, 20)>

Picks one random value out of a list. Two ways to use it: pass a list of literal values directly, or pass the name of a variable that holds an array.

<getRandomElement('red', 'green', 'blue')>

Returns a random date and time between two bounds.

<getRandomDate('2020-01-01', '2020-12-31')>

Returns a random street name with a house number.

<getRandomStreet()>

Returns a random city name.

<getRandomCity()>

Returns a random country name.

No parameters.

<getRandomCountry()>

Returns a full composed address string (street, city, and country together).

<getRandomAddress()>

Pads a value on the left with a repeating character up to a target length — useful for zero-padded IDs and codes.

<appendBefore('0', getVar(idVar), 8)>

Pads a value on the right with a repeating character up to a target length.

<appendAfter('x', 'ab', 5)>

Converts a string to uppercase.

<toUpperCase(getVar(name))>

Converts a string to lowercase.

<toLowerCase('HELLO')>

Formats a date/time value using a custom pattern (for example YYYY-MM-DD).

<formatDate(getRandomDate(), 'YYYY-MM-DD')>

Formats a number with a fixed number of decimal places and custom separators.

<formatNumber(1234.5, 2, '.', ',')>

produces "1,234.50"

Reads a value that was passed in by the caller when requesting generation (a "generation parameter"), letting a single template be customized per-call without editing the template itself.

<getParam('customerName', 'Guest')>

Reads a value that ties the current document to others in the same batch — for example, a parent record's id when generating a batch of related child records. Fails with an error if no such value is available for the current document.

<getContext('orderId')>

getContext is grouped in the stateful cost tier for billing purposes, even though it doesn't itself perform an external storage lookup — it's simply classified that way under the platform's internal cost model for relational/batch generation.