Velocity Syntax: Variables and Functions

${UserName}

${UserEmail}

${SiteUrl}

${LoginUrl}

${SiteId}

${ModuleId}

${ModuleName}

${ActionId}

${CurrentItem}

${comment}

${reply}

${reaction}

${commentStatus}

${previewText}

${StatusFrom}

${StatusTo}

${StatusComment}

${BatchId}

${BatchType}

${TotalItems}

${ActionName}

${RequestBody}

${ResponseBody}

${GuestUserLoginUrl}

${GuestUserEmail}

${ShareReceiver}

${ShareReceiverName}

${ShareReceiverEmail}

${SharedEntityComment}

#set($variableName = 'sometext')

$tools.join( <list of values>, 'delimiter', true/false)

#foreach($<Variable With Item> in <list of items>) $<Variable With Item>.<operation> #end

$<Variable With Item>.getId()

$<Variable With Item>.id

$<Variable With Item>.fieldValue(<Field Id>)

$<Variable With Item>.fieldValue('<Field Name>')

$<Variable With Item>.fieldValues(<Field Id>)

$<Variable With Item>.fieldValues('<Field Name>')

$<Variable With Value from Field>.getId()

$<Variable With Value from Field>.id

$<Variable With Value from Field>.getValue()

$<Variable With Value from Field>.value

$<Variable With Value from Field>.getStringValue()

$<Variable With Value from Field>.stringValue

$<Variable With Item>.changes()

$<Variable With Item>.changes().oldValue(' <field name>')

$<Variable With Item>.changes().newValue(' <field name>')

$<Variable With Item>.findFirstFileInMediaHolder(<Media Holder Id>)

$<Variable With Item>.findFilesInMediaHolder(<Media Holder Id>)

$<File Option Value>.toSignUrlLink()

$<File Option Value>.toUrlLink(<absolute>)

$<File Option Value>.toPublicRedirectLink()

$<File Option Value>.findFirstFileInMediaHolder(<Media Holder Id>)

$<File Option Value>.findFilesInMediaHolder(<Media Holder Id>)

$tools.base64Encode('<value>')

$date.get('yyyy-M-d H:m:s')

$number.toNumber('#,###,###.###','<number string>')

$tools.aesGenerateKey('<password>', '<salt>', <iterations>, <key length>, '<algorithm>')

$tools.aesEncrypt('<value>', '<key>', '<init vector>')

$tools.aesEncrypt('<value>', '<key>', '<init vector>', '<cipher name>')

$danishLocale

$usLocale

$zuluTimeZone

#set($originalDate = ${<Variable With Item>.fieldValue('Added')}) // 25/05/2024, 19:30 - string

#set($parsedDate = $date.toDate('dd/MM/yyyy, HH:mm', $originalDate)) // date object

$date.format('MMM/dd/yyyy hh:mm a', $parsedDate, $usLocale) // May/25/2024 07:30 PM

$date.format('dd/MMM/yyyy HH:mm', $parsedDate, $danishLocale) // 25/maj/2024 19:30

$date.format('yyyy-MM-dd''T''HH:mm:ss.SSSXX', $originalDate.value, $usLocale) // 2024-05-25T19:30:00.000+0200

$date.format('yyyy-MM-dd''T''HH:mm:ss.SSS''Z''', $originalDate.getValue(), $usLocale, $zuluTimeZone) // 2024-05-25T17:30:00.000Z

#set($originalDecimal = ${<Variable With Item>.fieldValue('Decimal')}) // 12.345.678,90 - string

#set($parsedDecimal = $number.toNumber('###,###.00', $originalDecimal, $danishLocale)) // number object

$number.format('###,###.00', $parsedDecimal, $usLocale)} // 12,345,678.90

$number.format('###,###.00', $originalDecimal.value, $danishLocale)} // 12.345.678,90

#set($multiSelectFieldValues = ${CurrentItem.fieldValues('Multiselect Field Name')})

#set($multiSelectFieldValuesSortedAsc = $collection.sort($multiSelectFieldValues))

#set($multiSelectFieldValuesSortedDesc = [])

#foreach($item in $multiSelectFieldValuesSortedAsc)

#set($void = $multiSelectFieldValuesSortedDesc.add(0, $item))

#end

Multiselect Sorted Default: #foreach($arrValue in $multiSelectFieldValuesSortedAsc)$arrValue#if($foreach.hasNext), #end#end

Multiselect Sorted Default Reversed: #foreach($arrValue in $multiSelectFieldValuesSortedDesc)$arrValue#if($foreach.hasNext), #end#end

Multiselect Sorted Id Default: #foreach($arrValue in $collection.sort($multiSelectFieldValues, ['id']))$arrValue#if($foreach.hasNext), #end#end

Multiselect Sorted Id Asc: #foreach($arrValue in $collection.sort($multiSelectFieldValues, ['id:asc']))$arrValue#if($foreach.hasNext), #end#end

Multiselect Sorted Id Desc: #foreach($arrValue in $collection.sort($multiSelectFieldValues, ['id:desc']))$arrValue#if($foreach.hasNext), #end#end

Multiselect Sorted StringValue Default: #foreach($arrValue in $collection.sort($multiSelectFieldValues, ['stringValue']))$arrValue#if($foreach.hasNext), #end#end

Multiselect Sorted StringValue Asc: #foreach($arrValue in $collection.sort($multiSelectFieldValues, ['stringValue:asc']))$arrValue#if($foreach.hasNext), #end#end

Multiselect Sorted StringValue Desc: #foreach($arrValue in $collection.sort($multiSelectFieldValues, ['stringValue:desc']))$arrValue#if($foreach.hasNext), #end#end

Multiselect Sorted Value Default: #foreach($arrValue in $collection.sort($multiSelectFieldValues, ['value']))$arrValue#if($foreach.hasNext), #end#end

Multiselect Sorted Value Asc: #foreach($arrValue in $collection.sort($multiSelectFieldValues, ['value:asc']))$arrValue#if($foreach.hasNext), #end#end

Multiselect Sorted Value Desc: #foreach($arrValue in $collection.sort($multiSelectFieldValues, ['value:desc']))$arrValue#if($foreach.hasNext), #end#end

$tools.aesDecrypt('<enctypted value>', '<key>', '<init vector>')

$tools.aesDecrypt('<enctypted value>', '<key>', '<init vector>', '<cipher name>')

$tools.fetchAll()

$tools.fetchFirst()

$tools.fetchFirst().fieldValue('field name')

$tools.fetchFirst().fieldValue('field name').fieldValue('field name')

$tools.fetchUnique('field name') $tools.fetchUnique('field name', 'sub field name')

$tools.report( templateId, 'filterValue', 'customName' )

#set($targetPathGrid = "/site/${SiteId}/home/module/${ModuleId}/view/list?batchId=${BatchId}")${LoginUrl}?targetPath=$tools.base64Encode($targetPathGrid)

#set($targetPathGallery = "/site/${SiteId}/home/module/${ModuleId}/view/gallery?batchId=${BatchId}")${LoginUrl}?targetPath=$tools.base64Encode($targetPathGallery)

#set($customValue = "$tools.fetchFirst().fieldValue('Campaign')")

#set($customName = "Report_$date.get('yyyy-M-d H:m:s')")

${SiteUrl}/<worker>$tools.report( 26, $customValue, $customName)

#set($emails = $tools.fetchUnique('User Link field', 'Email'))

$tools.join($emails, ',', true)

#foreach($<Variable With Item> in $tools.fetchAll())

$<Variable With Item>.fieldValue('Created By')

#end

$tools.fetchFirst().fieldValue('user field').fieldValue('email')

$tools.fetchFirst().fieldValue('module link field').fieldValue('field in linked module')

#set($allItems = $tools.fetchAll())

#foreach($<Variable With Item> in $allItems )

#set($valuesInMultiUserField = $<Variable With Item>.fieldValues('MultiUserField'))

#foreach($value in $valuesInMultiUserField)

$value.fieldValue('Name') - $value.fieldValue('Email')

#end

#end