Overview

Persona objects like Inquiry Templates, Verification Templates, and Workflows have visible and controllable version management.

For the purposes of this article, we'll refer to Persona objects that have versioning capabilities as templates. The below tables summarize which Persona objects have versioning and how you may identify them in the Persona dashboard or via API:

Persona objects without versioning

When changes are made to objects without versioning, the changes are immediately active once saved and change management features like restoring to previous instances or logs of changes are unavailable.

This rest of this article covers the general behavior of following Persona Objects with versioning capabilities. For more specifics on each object’s versioning features, refer to the appropriate section in the Help Center.

When changes to a Persona template are published, they are captured in a new version of that template. Previous versions of the template are available to be restored, if needed, and are useful in comparing optimizations or improvements to your Solutions

When updating a template, an intermediate draft is created allowing you to make multiple edits and saves before you commit that draft as a formal new version by publishing it. Once a draft is published as a new version, the draft becomes the new version and is no longer editable. To make new edits, you’ll need to create a new draft based on an existing version.

The live version

When a template is first Published, that version is live. For Inquiry Templates, as an example, that means any new Inquiries generated, will be created from that new version with the new changes..

As new versions of the template are Published, those new versions will replace the existing live template with the newly published version of that template.

When a new Inquiry is generated, it will be linked to the currently Live version of the template and will always be linked to that version. Even as new versions of the template are published and themselves set to Live, those previously generated Inquiries will still only use the Live version of the template from when they were generated.

Version History

Each and very version of a template is captured in the Version History. To access a template's Version History, select the template from your dashboard and in the top right corner, you can find an overflow menu with Version History.

Reverting to a previous version

One upside of Version History is the ability to quickly revert to a more stable previous version when your live version produces errors or unintended results. To revert to a previous version, navigate to the template’s Version History, and select a previous version to revert to. This will become the current live version.

Object-specific features and nuances

Workflows Versions and Rollouts

Workflows, additionally, have the concept of a Rollout. Rollouts allow you to set a percentage of Workflow runs that will be affected by the new Workflow Version. The remaining percentage will still be handled by the old version. Setting to a Rollout to 100% is equivalent to fully enabling the new Workflow Version and replacing the old version.

Since making changes to Workflows can have a big impact on how the subject(s) of that workflow are handled, some customers prefer to use the Workflow Rollout feature. A common and safe practice is to test a new Workflow Version on just 5% of Workflow runs instead of all runs. After some testing you can raise the percentage incrementally up to a 100% or rollback entirely to the old version if there are issues with the new one.

Verification Template Versions

Verification Templates are unique within Persona as they can be used within an Inquiry Template or standalone through a Workflow (often, with a Transaction-based trigger) and API call.

When the Verification Template is associated or included in an Inquiry Template

Verification Templates are automatically versioned for you under the hood when simultaneously making changes to an Inquiry Template within Flow Editor. The changes captured for a Verification Template Version draft are typically found when viewing a specific Inquiry Template in Flow Editor and updating the Verification Template configurations within Configure.

When the Verification Template is not associated or included in an Inquiry Template

For solutions where a Verification Template is used in a standalone manner, changes are captured in Verification Template Versions drafts when updating a specific Verification Template's configurations in the Dashboard in Verifications > Templates.