Migrate and validate existing forms

This step is not required for new installations.

The Web Form Designer generates forms in JSON format and stores the forms in new database tables. To use existing forms in the Web Form Designer, validate that the forms can be converted from XML to JSON format, and then migrate the forms to the new database tables.

The following tools are used to migrate and validate existing forms:

  • Entity Migration tool: Validates existing forms for duplication and data corruption issues, and then copies the data (forms, shared data, shared components, and templates) in XML format to new database tables, while preserving existing entity assignments.

  • Form Designer Validation tool: Verifies the format and properties of existing forms in XML format to ensure they can be converted to JSON. The actual conversion only takes place when a user accesses the data in the Web Form Designer.

During the validation and migration process, users can continue using the Desktop Form Designer, but any changes made during this time will not be migrated to the Web Form Designer.

Before you begin 

Procedure 

Migrate and validate existing forms during a maintenance window (migration mode).

  1. Run the Entity Migration tool on the Database Management Server (estimated duration: ~1 minute for 450 forms):

    1. From a command line, go to:

      Impact360\Software\EntityMigrationTool

    2. Run EntityMigrationTool.exe /ForceFeature=FormDesignerWebApplication /AllowOverride

      migration tool

    3. If the migration tool window shows an error, contact Support.

      After the issue is resolved, run the migration tool again until it completes without errors.

  2. Run the Form Designer Validation tool on the Application Servers (estimated duration: ~6-8 seconds per form):

    1. From a command line, go to:

      Impact360\Software\WebApplications\WebFormDesigner\ValidationTool

    2. Run FormDesigner.ConversionValidationTool.exe

      While the tool is running, the window displays progress information.

      When the form validation is complete, the window displays the total number of forms that were processed, and the number of forms that passed or failed validation.

      validation tool window

    3. If the validation failed for one or more forms, verify the log and contact Support:

      Impact360\Software\WebApplications\WebFormDesigner\ValidationTool\ConversionValidationTool.log

      After the issue is resolved, run the validation tool again until it successfully validates all forms.

What to do next 

Turn on the Web Form Designer feature flag