NexJ Logo

Exporting and importing flow templates

Export and import flow templates when you want to move them between instances of  NexJ CRM , or when you want to create a backup of a template.

Your company might require that you develop a new flow in a test system before you can deploy it to a production system. To avoid having to recreate the flow in each of your company's environments, you can export a flow template from your test system, then import it into your production system.

When you export a flow template, you download the file that is generated by the system to your computer. This file contains all of the components from the template, including the form and its associated flow. You can then import the file into another system to create a new copy of the flow template.

You can also keep an exported file as a backup of a flow template. This is useful when you are making changes to a flow template and you want to be able to revert to a known version of the template if something goes wrong.

If you want to import or export Scheme files, you must be assigned the appropriate privileges in the NexJ Admin Console. For more information, see the flow:ExportImportSchemeAdmin privilege description.

Exporting flow templates

Export a flow template when you want to generate a file that you can use to copy the template into a different instance of  NexJ CRM , or when you want to create a backup of it.

When you export a flow template, a  .dump  file is generated that contains all of the components from the template, including the form and its associated flow.

To export a flow template:

  1. Navigate to the  Customize  workspace.
  2. Click the Form Library tab. A list of all flow templates is displayed.
  3. In the list, click the  Action  button  for the flow template that you want to export, then select  Export . The Export confirmation  dialog opens.
  4. Click  Yes  to generate and download the   .dump  file. The file will be automatically downloaded by your web browser. The  Export confirmation  dialog closes.

The flow template is exported as a file on your computer. The original template remains in the system, so you can continue to use it or make changes to it.

If you want to use the exported template in another system, you must import the file into that system to create a copy of the template.

Importing flow templates

Import a flow template when you want to create a copy of a template from an exported file.  When you export a flow template, a file is generated that contains all of the components from the template, including the form and its associated flow. You can import this file into a system in order to create a new flow template, or to modify an existing flow template.

Before starting this task, ensure that you have the exported   .dump  file for the flow template that you want to import.

If you are importing a flow template to modify an existing template, you must ensure that you have deactivated the existing template.

To import a flow template:

  1. Navigate to the  Customize  workspace.
  2. Select the  Form Library tab. A list of all flow templates is displayed on the left.
  3. At the top of the list, click  Import . The Import Library Form  dialog opens.
  4. Click  Browse . A new attachment field with a new Browse button appears on the  Import Library Form  dialog.
  5. Click the new  Browse  button. Your browser upload dialog opens.
  6. Select the   .dump  file for the template that you want to import, then click  Open . The selected file is checked to ensure that it can be imported. In the  Import Library Form  dialog, one of the following outcomes will be displayed:
    • If the file is validated successfully, a green check mark is displayed.
    • If any problems are found, a red X is displayed. You can view more information about the import, including errors and warnings, by clicking  View Report .

  7. Click  Import .

    If any problems were found, the  Import  button is disabled.

    The  Import Library Form  dialog closes.

  8. In the confirmation dialog that appears, click  OK . The confirmation dialog closes.

The flow template is imported from the file. If you imported the file as a new template, an entry is created in the list of flow templates. If you imported the file as a modified version of an existing template, the existing template is replaced.

When you import a modified version of an existing template, the system also preserves a copy of the previous version of the template in case it is currently being used. However, the copy is not available for you to view or modify.

Imported flow templates are inactive by default. Before the imported template can be used, you must activate it.

Activating flow templates