Inquiry Template Versions and Change Management
Overview
Inquiry Templates in Persona support version management, allowing you to draft, publish, and maintain multiple versions over time. This enables safe iteration, controlled releases of changes, and the ability to audit or revert prior configurations as needed.
Persona Object | Object ID syntax | Object ID versioning syntax |
---|---|---|
Inquiry Template | Begins with itmpl_ |
Begins with itmplv_ |
Drafting and Publishing
When you update an Inquiry Template, Persona creates a draft version. Drafts allow you to make incremental changes and save progress before committing those changes live. You can edit a draft multiple times. Once you are satisfied with your changes, publishing the draft will create a new version of the Inquiry Template.
After publishing, the new version becomes the live version used to generate any new Inquiries. Published versions are locked from further editing. To make additional changes, you must create a new draft based on any existing version.
In this way an Inquiry Template can have many Inquiry Template versions associated to it. For a given Inquiry Template, only one version is currently live and in a published
state , and there may be one that you are actively editing and is in a draft
state.
Publishing an Inquiry Template
Once you’ve got your draft in a state you’re satisfied with and Saved, you can use the following process to review and then publish your draft as the new live version.
To start, click the Publish button at the top right.
Summary of Changes
Before Publishing, you’ll be presented with the Summary of Changes view allowing you to review all the changes between your previously published version and your current draft version. At the Flow level, you’ll see any steps from the previous version highlighted if changes have been made to them in the current draft.
In this example we have made the following changes in the draft:
- Removed Bermuda as an option in the Country Select screen
- Lowered the allowed attempts for the GovID verification in it’s branching logic from 5 to 3
- In GovID we required the Electronic Replica check
- For GovID we disabled Bermuda as an allowed country
You can see these changes reflected in the multiple sections below in the Summary of Changes.
In the Screen section you’ll be able to scroll through all the screens in the flow for any individual changes.
If you make any changes that would affect the associated Verification templates, like removing Bermuda as an allowed country, then it will also highlight that change in the Run "Verification Name" section.
And Publish
Once you’ve completed your review of the draft, you can scroll back to the top right and click Publish. Or if you’ve realized you need to make some changes click “Back to Draft” instead.
Live version behavior
Once published, an Inquiry Template version is considered live. Any new Inquiry created after publication uses the latest live version.
- Each Inquiry is permanently linked to the version of the Inquiry Template that was live when it was generated.
- When you publish additional versions, any new Inquiries will use the latest live version, while previously generated Inquiries will continue to reference the version from which they were originally created.
This ensures that existing Inquiries maintain their integrity and are not affected by changes made to newer template versions.
Version History
All published versions of an Inquiry Template are recorded in Version History. This provides a full audit trail of changes over time.
How do you view Version History?
- Navigate to the Dashboard, and click on Inquiries > Templates.
- Select the Inquiry Template you want to review.
- Click the "Versions" button in the top right corner.
- The Version History will show in the overflow menu on the right.
Reverting to a previous version
If you need to undo changes or roll back to a stable configuration, you can revert to any prior version in Version History. Reverting publishes the selected version as the new live version without altering the content of prior versions. Existing Inquiries already linked to earlier versions remain unaffected.