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.

Exporting Data

Exporting Data

Exporting Data Using Maven

The Import-Export tool provides a maven profile, do-export, to export data easily. Exporting using the maven command is preferable in a local development environment. The maven profile allows for debugging of the Import-Export tool using mvnDebug and the creation of environment specific exportconfiguration.xml and searchconfiguration.xml files if needed. When using the maven profile, there is no need to specify database connection details.

To export data via maven, use the following command from the target directory:

mvn clean package -Pdo-export

Optionally, you can specify:

  • A directory to exported data into using the data.location system property:

    mvn package -Pdo-import -Ddata.location=./exported-data

    Where ./exported-data is the directory containing exported data. The directory can be specified as relative path (i.e., using ./../) to the target directory or as an absolute path.

  • The search server URL using the ep.search.default.url system property. If not specified, then the default URL from the COMMERCE/SYSTEM/SEARCH/searchHost setting is used. 

    mvn package -Pdo-import -Dep.search.default.url=SEARCH_HOST_URL

Exporting Data Using the Batch Script

Note:

Before running the batch script, ensure that the Elastic Path database server and web applications are running.

To export data via the batch script, navigate to the directory you extracted the Import-Export tool distributable to and run the following command:

importexport.bat -e <search_config_file> [-c <export_config_file>] [-l <locale>]

where:

  • <search_config_file> is the path to the file that contains the search criteria
  • <export_config_file> is the path to the file that contains the export configuration. This parameter is optional. If it is not specified, the Import-Export tool will look for a file named exportconfiguration.xml in the Import-Export tool installation directory
  • <locale> is the code of the locale for which you want to export data. This only affects localized data. If no locale is specified, the corresponding data for all locales is exported

During the export operation, information and error messages are printed to the console. Errors are also logged in a file in the logs directory.

If you experience problems during export, see Appendix E - Troubleshooting.