Skip to main content

Version Control

OSPROV Form Builder includes version control to manage changes to published forms. This system ensures that existing workflows continue to function while allowing for form improvements over time.

How Version Control Works​

The OSPROV version control system works as follows:

  1. When you edit a published form that has submissions, a new draft version is created
  2. The original published version remains unchanged and continues to be used for existing workflows
  3. Once you publish the new version, it becomes the active version for new workflows
  4. Previous versions are marked as "Unpublished" but remain accessible for historical reference

This approach ensures that:

  • Existing workflows continue to function without disruption
  • Form submissions maintain their integrity
  • Changes can be tracked and audited
  • Previous versions can be referenced if needed

Viewing Form Versions​

To view all versions of a form:

  1. From the Forms list, click on the version number of a form
  2. You will see all versions of that form, including:
    • The current published version
    • Any draft versions in progress
    • Previous unpublished versions
  3. You can view, but not edit, previous versions

Creating a New Version​

To create a new version of a published form:

  1. Edit a published form
  2. Make your changes
  3. Click Create New Version
  4. The new version will be saved as a draft
  5. Publish the new version when ready

When creating a new version, consider documenting the changes in the form description or in a separate change log.

Version Numbering​

OSPROV automatically assigns version numbers to forms:

  • The initial version is 1.0
  • Major updates increment the first number (e.g., 2.0, 3.0)
  • Minor updates increment the second number (e.g., 1.1, 1.2)

You cannot manually set version numbers, but you can include version information in the form name or description for additional clarity.

Impact on Workflows​

When you publish a new version of a form:

  • Existing workflow instances continue to use the version they were created with
  • New workflow instances use the latest published version
  • Workflow definitions that reference the form automatically use the latest version

This ensures that in-progress workflows maintain consistency while new workflows benefit from improvements.

Best Practices for Version Control​

  • Create new versions for significant changes only
  • Test new versions thoroughly before publishing
  • Document changes between versions
  • Consider the impact on existing workflows before publishing new versions
  • Use descriptive form names that indicate the purpose and version
  • Review and clean up old versions periodically
  • Maintain a change log for complex forms with frequent updates