FormSync commands, switches, and options

This table lists and describes the commands and switches you can employ while using FormSync in a Command Line Interface (CLI):

Command/Switch Description
-u:[upgradeConfig.xml]

OR

-upgrade:[upgradeConfig.xml]

 Use this option if you are synchronizing an upgrade. In conjunction with this option, you must also provide one of these additional sets of specifications:
  • You can use a combination of additional switches:
    • You must use, at the least, the -t or -target switch.
    • If the Source is in temporary tables in the Target database, then you need specify only the Target. Otherwise, you must also use the -s or -source switch.
    • Optionally, you can also use the -m or -mail switch.
  • Use the upgradeConfig.xml file option only if you are not using the switches as described in the previous item.

    The optional upgradeConfig.xml file (where upgradeConfig is the filename) is a file that specifies the Source and Target configurations for the upgrade.

    Optionally, you can use the upgradeConfig.xml file to instruct FormSync to use temporary tables in the Target database as the upgrade Source.

    This file can be located in the same folder as the formsync.exe file, or it can be located elsewhere. If it is located elsewhere, you must provide the full path to it.

-p:patchInfo.xml

OR

-patch:patchInfo.xml

 Use this option if you are performing a patch synchronization. When using this command, these switches also apply:
  • You must use, at the least, the -t or -target switch.
  • If the Source is in temporary tables in the Target database, then you need specify only the Target. Otherwise, you must also use the -s or -source switch.
  • Optionally, you can also use the -m or -mail switch.

The required patchInfo.xml file (where patchInfo is the filename) is the control file that specifies what, exactly, has been patched and needs to be synchronized. This control file provides a list of the forms and other objects that need to be updated. This file can be located in the same folder as the formsync.exe file, or it can be located elsewhere. If it is located elsewhere, you must provide the full path to it.

-t:targetConfig

OR

-target:targetConfig

 Required. This switch specifies the name of the Target configuration (targetConfig).

This can be provided within the upgrade or patch configuration file.

-s:sourceConfig

OR

-source:sourceConfig

 This switch specifies the name of the Source configuration (sourceConfig).

If the Source is in temporary tables in the Target database, then this switch is not required. Otherwise, it is required.

In the case of an upgrade operation, this information can be provided within the upgrade configuration XML file.

-m:email@address

OR

-mail:email@address

 Optional. This switch specifies the email address for the individual who is to receive notification of the synchronization (email@address).

Email notification can also be specified in the Target database process defaults.

-o:[syncSettings.xml]

OR

-options:[syncSettings.xml]

 Optional. Use this switch to make sychronization settings in FormSync before synchronization begins. The settings in this file are saved in the syncSettings.xml file (where syncSettings is the filename) when a user clicks either the Export Settings button in the form version or the Export button in the application version of FormSync. The settings in this file can then be used to make FormSync settings prior to performing a synchronization using the CLI.

If the file is not specified or not found, then FormSync uses the Default synchronization settings.

start /wait formsync -switch[:controlFile] Use this command to instruct the system to wait for the FormSync operation to finish and FormSync to terminate before proceeding and presenting the next command prompt.

When using this command line, -switch refers to the switch used, and [:controlFile] refers to the control file associated with that switch.

We recommend that you use this command line in conjunction (especially) with the -e/-export and -i/-import switches and their associated control files.

-e:exportConfig.xml

OR

-export:exportConfig.xml

 Use this switch to export the contents of a configuration to an XML control file (exportConfig.xml, where exportConfig is the filename). You can then import the configuration data to another system.

This control file specifies these elements for export:

  • The configuration
  • The format to use for the data (XML or SQL)
  • The location where the output file is to be saved
  • Whether the output path should be cleaned
  • A list of forms and/or objects to be included in the exported data

This allows you to selectively export XML versions of forms, Explorer objects, or global objects from a configuration using this control file and the XML format (useful when operating in the cloud).

The path can begin with default\, which causes the system to look for the defaults that FormSync normally uses. It tries these paths in order:

  • CurrentUser\Documents\Infor
  • CurrentUser\Documents
  • Whatever other temporary path Windows picks

If the path does not begin with default\, you can specify an actual path or the local folder.

We recommend that you use the start /wait formsync command in conjunction with this switch.

-i:importConfig.xml

OR

-import:importConfig.xml

 Use this switch to import the data from an export configuration control file to a Target configuration. (See the previous entry in this table.)

The importConfig.xml file (where importConfig is the filename) specifies the import settings. These import settings include these specifications:

  • The target configuration
  • The path to a folder which contains one or more files to process
  • Default global settings for licenses and templates

This option is especially useful when operating in the cloud.

We recommend that you use the start /wait formsync command in conjunction with this switch.

Parent topic: Using FormSync with a CLI
Related topics