Announcement: You can find the guides for Commerce 7.5 and later on the new Elastic Path Documentation site. This Developer Center contains the guides for Commerce 6.13.0 through 7.4.1.Visit new site

This version of Elastic Path Commerce is no longer supported or maintained. To upgrade to the latest version, contact your Elastic Path representative.

Command Line Reference

Command Line Reference

synctool {-e|-l|-f} [-a <adapter_name>] [-d <subdir>] [-p <parameter>] [-r <root_dir>]
         [-s <source_config_file> [-t <target_config_file>]
      

Parameter

Description

-a, --adapter <adapter_name>

Not currently implemented. Specifies the adapter to use to perform the data sync. The adapter must be configured in the Data Sync Tool's service.xml configuration file.

-d, --subdir

Specifies the directory that contains the data file to be imported as well as the corresponding jobdescriptor.xml and jobunit.dat files. This parameter is required if you are performing an import (-l).

-e, --export

Performs an export operation. The -r and -p parameters must also be specified.

-f, --full

Performs a complete sync operation. The data from the source instance is transferred into the target instance directly. The -r parameter can be set if you want to create a copy of the exported data on the file system.

-l, --load

Performs an import operation. The -d parameter and the -r parameter must also be specified.

-p, --param <parameter>

Contains adapter specific parameters. For the default adapter, this must be set to the change set GUID.

-r, --root <root_dir>

Specifies the directory where data files will be exported. This parameter is required if you are performing an export (-e without -f). If it is not specified, a data file is not created. This parameter is also required if you are performing a load from an export (-l).

-s, --source <source_config_file>

Specifies the file that contains the configuration for the source database. If this parameter is not specified, the default is sourceconfig.xml.

-t, --target <target_config_file>

Specifies the file that contains the configuration for the target database. If this parameter is not specified, the default is targetconfig.xml. This option does not need to be specified when performing an export (-e)