Migrate actions to the Velocity Template Engine from the Encode Engine

New
  • Updated on Nov 4, 2025
  • Published on Nov 4, 2025
  • 1 minute(s) read
  • BG
 Prev Next

We’re deprecating the Encode Engine. Use this guide to migrate old actions to the Velocity Template Engine from the Encode Template Engine.

From Encodify Version 22.0.0 and onwards, you can no longer create actions with the Encode Engine. To make the transition easy, new actions will be created automatically using Velocity, and old actions created with the Encode Engine will still function.

But we’re deprecating the Encode Engine, and in time, it will be disabled completely. We suggest you start migrating actions to Velocity now to ensure a smooth transition when the Encode Engine is completely disabled.

You can use this guide to migrate actions to the Velocity Engine from:

How to identify actions that use the Encode Template Engine

  1. Go to Site configuration

  2. Navigate to the health section

  3. Select the actions overview

  4. Apply a filter to show actions with warnings. Actions which still use the Encode Engine will show a warning message saying that “The ‘Encode’ template engine is deprecated and will be discontinued soon.“ as seen below.

How to migrate actions from the Encode Template Engine to the Velocity Template Engine

  1. Find the action you want to migrate

  2. Trigger the migration process by clicking the “Copy icon” of the action you want to change

  3. In the settings window for the copied action, you can see that the engine has been automatically changed to Velocity.

  4. The syntax for the Encode Engine has been copied, but you need to review the copied action to make sure it is using Velocity syntax (see the table below).

  5. Notice that the copied action is set to be disabled by default, if you want to test it after you’ve copied it, but before activating.

  6. Once you’ve updated the syntax, click “OK” in the top right corner of the window to copy the action, and that’s it, you’ve now successfully migrated an action from the Encode Engine to Velocity.

Encode Engine

Velocity Engine

${ModuleId}

${ModuleId}

${ModuleName}

${ModuleName}

${SiteId}

${SiteId}

${SiteUrl}

${SiteUrl}

${LoginUrl}

${LoginUrl}

${ActionId}

${ActionId}

${RuleId}

${RuleId}

${StatusFrom}

${StatusFrom}

${StatusTo}

${StatusTo}

${StatusComment}

${StatusComment}

${UserName}

${UserName}

${UserEmail}

${UserEmail}

${ItemLink}

${ItemLink}

${ID}

$CurrentItem.getId()

${DateTime}

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

${field}

$CurrentItem.fieldValue('field').value

${field.old}

$CurrentItem.changes().oldValue('field')

${field:field.old}

$CurrentItem.fieldValue('field').changes().oldValue('field')

${mediaHolder:holder}

$CurrentItem.findFirstFileInMediaHolder(holderId).toUrlLink(true)

${mediaHolder:holder - no Site URL}

$CurrentItem.findFirstFileInMediaHolder(holderId).toUrlLink(false)

${Fields}

#foreach($change in $CurrentItem.changes())$change.getValue()#if($velocityHasNext), #end#end

${FieldsOld}

#foreach($change in $CurrentItem.changes())$change.oldValue()#if($velocityHasNext), #end#end

${ChangedFields}

#foreach($change in $CurrentItem.changes())$change.getValue()#if($velocityHasNext), #end#end

${FieldsNew}

#foreach($change in $CurrentItem.changes())$change.newValue()#if($velocityHasNext), #end#end

${field.asArrayOfStrings}

#foreach($fieldVal in $CurrentItem.fieldValues('field'))$fieldVal.getValue()#if($velocityHasNext), #end#end


* You can also find syntax help below the action configuration, in the release notes for version 23.0.9 or in the documentation on how to insert field values from the linked modules into actions.

Related articles