Administration Guide

Export and Import Configuration

On this page

The Settings App exports configuration to an XML file and imports configuration from one. The commands are on the File > Export and Import submenu. For what workflow configuration consists of, see Workflow Overview.

In the Settings App

Export configuration

  1. Start the export:
    • Export Selected Settings... exports the node that has focus in the navigation tree. On a class or process node, it exports the node that has focus in that node's sub-tree. When the item list has focus, it exports the selected item. The command is on the File > Export and Import submenu, on the Standard toolbar, and on the navigation tree's right-click menu.
    • Export All Settings... on the File > Export and Import submenu exports the whole configuration.
  2. If Create a complete workflow pack appears, choose Mark the output file as complete or Create a regular output file. A complete pack can replace the existing workflow on import; a regular file adds or updates items. See Choose the export mode.
  3. Select the file. The file picker is titled Export Configuration To, and the file name defaults to AlloyNavigatorSettings.xml.
  4. If the file already exists, select Overwrite or Append. Only Overwrite is available when the file already holds a complete workflow pack, or when you marked the output file as complete.
  5. Enter a description, and finish the wizard. A finished export shows "Export completed successfully."

Choose the export mode

If the Create a complete workflow pack page is available, select Mark the output file as complete (preselected) or Create a regular output file. The page is available when you export all settings, for all objects, or export selected settings on a class node, for that class. Otherwise the wizard skips it. Choose a complete file to replace the workflow of that class, or of all objects, in this or another database: only a complete file offers to overwrite the existing workflow when it is imported. Choose a regular file to add or update individual configuration items: its import adds new configuration records and updates existing ones, and deletes nothing.

Preview a file

Show File Content, on both the export wizard and the import dialog, opens a read-only window titled File Content with the file name, the file's version, and its description. A tree below lists the file's contents by settings area, showing only the areas that hold records. The top-level areas are General, Accounts and Roles, Domains, SSO Providers, Business Logic Configuration, Stock Rooms, E-mail Integration, Services, Self Service Portal Settings, and Other. This grouping differs from the groups of the navigation bar. Most entries show the number of records in parentheses after the name; grouping entries, HTML styles, and Self Service Portal Settings show the name alone.

Import configuration

  1. On the File > Export and Import submenu, or on the Standard toolbar, click Import Settings... and select an XML file in the Import Configuration From dialog.
  2. The Import Configuration Settings dialog shows the File, the Version, and the Description of the file. When the file comes from an earlier version than the database, a warning says that its contents may not be fully compatible with your current version. You can still import such a file. We recommend that you first import it into a test database and check the result there.
  3. If the file contains a complete workflow pack, a second page says "The file contains a complete workflow pack for <scope>." To replace the existing workflow, select Overwrite the existing workflow for <scope>.
  4. With overwrite selected, you can take a backup first: in the Backup group, Enable backup is already selected. In Back up to:, select the backup file (default name Backup.xml, in the Backup Configuration To dialog).
  5. Click Import.

What the import does depends on the mode:

  • An ordinary import adds the file's configuration records and updates the ones already in the database. Object records, such as tickets or persons, are never updated. A file with a complete workflow pack imports this way when Overwrite the existing workflow is cleared.
  • With Overwrite the existing workflow selected, an enabled backup of all settings is exported first as a complete pack. Then the non-system workflow configuration of the pack's class is deleted, or of every class when the class is not found, and the file is loaded.
  • In both modes, a security role that an imported record refers to is written from the file only when the database does not already hold it. An existing role is never overwritten.

What can block an import

  • The file is not a configuration export file.
  • The file's version is newer than the database.
  • The file was exported from Alloy Navigator Express.
  • The file was exported from the Web App. The message says it "was exported from the Web App".
  • With overwrite and backup both selected, the import cannot finish when the backup path is empty, when the backup file already exists and you decline to overwrite it, or when the backup path is the file you are importing.

Import from the command line

AlloyNavigatorMngr.exe /import-config="<file>" imports a configuration file before any window opens. It requires /AUTOLOGIN, /ACCESSKEY=, and either /WINAUTH or /USERNAME=. Add /overwrite to run the import in the overwrite mode. No progress window is shown. Errors are written to cli_import_config.log in the program's log folder, and the exit code reports the outcome:

Exit code Meaning
0 Success
1 Insufficient parameters
2 File not found
5 SQL connection failure
11 Invalid configuration file
12 Import failure

Files from Configurations_Adv

The XML files of a Configurations_Adv folder are administrative export files that both Import Settings... and /import-config accept. The installer does not include this folder.