Using FormSync with a CLI

You can perform many FormSync operations using a Command Line Interface (CLI). This is especially useful when you must upgrade Mongoose in a cloud environment and must use FormSync to synchronize an upgrade with previous configurations.

When using FormSync by means of a CLI, you must, at the least, use either an upgrade command or a patch command. Without one of these commands, FormSync does not function.

You can also add other, modifying, switches to instruct FormSync as to how to perform various operations:

  • Specify email notifications to users regarding FormSync synchronization operations.
  • Import and use synchronization settings from an XML file.
  • Export or import configuration data using an XML file format.
  • Scan and optionally fix potential problems with a target configuration.

Depending on the outcome of a command, the system returns one of these codes:

  • 0 - Successful
  • 1 thru 15 - XML parsing errors:
    • 1 - Failed
    • 2 - File not found
    • 3 - Invalid XML file
    • 4 - Invalid XML version
    • 5 - No settings
    • 6 - No configuration
    • 7 - Invalid output type
    • 8 - Invalid path
    • 9 - No scope
    • 10 - Invalid scope
    • 11 - Invalid setting
    • 12 - No objects
    • 13 - Invalid object group
    • 14 - Invalid object type
    • 15 - Transaction failed
  • 50 - Invalid configuration
  • 51 - Patch file not found
  • 52 - Invalid contact information
  • 60 - Exception generating backup tables
  • 61 - Exception during synchronization
  • 62 - Exception checking for prompts and warnings
  • 63 - Exception during patch cleanup
  • 70 - Exception parsing patch file
  • 101 - Upgrade/Patch conflict (specified for both upgrades and patches)
  • 102 - Patch file not specified
  • 103 - No patch file found
  • 104 - Exception missed by run patch

In addition to the error codes returned when running in the CLI, you can find more information in the log files. Information normally stored in FormSync’s internal log, as well as messages that would have appeared in pop-up windows using the graphic mode are located in log files in the executable directory (where formsync.exe is located). These files are named FormSyncExport.log or FormSyncImport.log, depending on the function.

Related topics