Import Forms

   Journey Manager (JM) Previously known as Transact Manager (TM). |   Platform Developer |   19.11 This feature was updated in 19.11.

Manager allows you to export and import a current form version or all versions of a selected form. After you build a form in Maestro, you usually deploy it to Manager using this import functionality.

This process is also used to migrate forms from one environment to another. You can use this functionality to:

  • Rollback one or several forms
  • Re-create one or several forms in another Manager
  • Promote one or several forms to other environments

In Manager prior to version 17.10, Import Form was named Import Form Version.

Manager also allows you to import a form as an application. The main difference between these imports is an archive file format that contains application XML configuration for applications or form XML configuration for forms.

To import one or several forms:

  1. Select Forms > Forms, and then click Import Form.
  2. Click Choose File and choose a form archive ZIP file.
  3. Click Upload.
    Manager import a form
  4. Select an organization to add the form to from the Add to Organization dropdown, or leave it blank.

    The Add to Organization dropdown menu is shown only if you have access to more than one organization.

  5. Select the Update an Existing Form checkbox if the form already exists in Manager and you want to update it with the new version.
  6. Select the Create a Form checkbox if the form doesn't exist in Manager, so it will be created.
  7. Update a form code in the New Form Code text field, which uniquely identifies the form across all the organizations in the current server environment. Manager automatically prefills the form code.

    The form code is an alphanumerical string that can't include spaces.

  8. Click Proceed To Import to import the form. Clicking this button will display the options screen for the form. It is on this screen that you can select or unselect any options that you may want to override. Ensure that you select the option, Make Current Version, if you want to make the form that you are uploading the "current version" of the form that is the form your form users will be completing.
  9. Review the Import Options.
  10. Select the appropriate Form – Import Options, which are associated with all versions of the form. They are all selected by default.
  11. Select the appropriate Form Version – Import Options, which are applied to a selected version of the form, normally the current version.
  12. Select the Form Functions checkbox to import form functions used by the form version. The existing form functions on the target server will be updated with that of from the imported archive. The form functions are referenced by the name and version, so they must exist on the target server prior to the import, otherwise they can't be imported.  |  19.11 This feature was introduced in 19.11.
  13. Click Import to complete the process.

    If the Create a New Form option was selected during the import process, and there was a form naming conflict (ie a form with the same name already existing on the server), the form will be renamed, and a message will be displayed in the Detail Message tab.

  14. Check the import status and message in the Import Action tab.
  15. Select the Detailed Messages to see whether there were any errors or warnings during the import.
  16. If errors are sever, you may want to update Manager configuration to fix the error and import the form again.

  17. Click Close and check the list of forms to verify the imported forms have been added.

You can also import and export Maestro forms using the Maestro dashboard.

When importing a form that has come from a more recent version of Manager, you may get an IllegalArgumentException error. To resolve this error:

  1. Log onto Manager you have imported the form into.
  2. Select Forms > Forms and locate the form.
  3. Click the Current Version of the form and change the Form Type to Composer Smart Form . This allow you to render this form correctly now.

Next, learn how to export forms.