Form Versions Overview

   MaestroPreviously known as Transact Maestro.  |    Form Builder Platform Developer |   v17.10 This feature was updated in v17.10.

Note

If you are using Maestro 17.10.x with a Journey Manager 5.x environment, and your form version number is longer than 10 digits (e.g. "1.0-develop"), you will get an error when you attempt to import the Manager 17.10.x form to the Manager 5.x environment. In this case, it is recommended that you shorten the default suffix when creating new form versions in Maestro 17.10.x.

Form Versions are a great way to save a unique copy of a form. You may want to create a new form version each time the TM Form Version is built, or when you are making significant changes to a form.

Creating a new form version at these points may save you the hassle of fixing your form should something go wrong. For example, say you're adding a feature or changing the behavior of existing form items but while making these changes something goes wrong. Form versions allow you to easily return to a previous working version of the form.

Form versions can be deleted, exported and compared in Maestro.

Since v17.10, the Journey platform follows open source semantic versioning conventions. Following this convention, all new form version names are recommended to start at version 1.0-develop until they reach production. In versions of Maestro prior to 17.10, form versions are incremented by whole numbers (for example version 1, version 2, version 3, etc.).

When you create a new form, the initial form version depends on the Default Initial Version specified in the Project Details tab of a project. You can change the Default Initial Version at any time by switching to the Project Details tab and changing its value. However, this only impacts new forms and assets within this project; version numbers of existing forms are unaffected.

Note

Form versions are sorted and displayed in descending order based on major, minor and patch release numbers.

Semantic versioning provides the following benefits:

  • Standardize versioning of Maestro design artifacts which in turn makes management of different versions easier.
  • Align more closely with Manager's versioning scheme.
  • Assist Form Builders who are developing forms concurrently.
  • Lock down a form version (using tags).

When working on any form, it is recommended that you do all your work on version 1.0-develop (the initial form version) until the form is ready for production. When a form is ready for production, it is recommended that you create a tagged version of the form.

Next, learn how Manager handles form versions.