export

Summary

Export part or all of the server data to an XML file. --compress can be used to compress the XML output. --excludeJobs can be used to exclude jobs from the export data. --path exports the single object specified by the path. The default is to export all data in the system.

fileName

Stringrequired

The filename from/to which the import/export is done.

compress

Booleanoptional

If true, the output will be compressed.

disableProjectTracking

Booleanoptional

If set to true when importing or exporting a project, even if the original project had change tracking enabled, make change tracking of the newly imported or exported project be disabled from its creation. If you don't need to track changes to the new project, this avoids the change tracking overhead that would otherwise slow down the import operation, and also saves having to subsequently disable change tracking of the reimported project.

download

Booleanoptional

Export file will be available to download.

excludeJobs

Booleanoptional

True to exclude jobs from the export.

objectId

Stringoptional

Object ID.

objectType

Stringoptional

Object type.

path

Stringoptional

A property path indicating a single object to be exported (for export) or the location at which to import (for import).

reducedDetailChangeHistory

Booleanoptional

Set to 0 or false to prevent importing a large project that has change tracking enabled from automatically reducing the level of detail that it tracks for the change history of the import -- this will make the import operation take longer and put more load on the database, but will allow the Change History feature to still show the full detail of entities owned by the imported project that were created by the import operation.

relocatable

Booleanoptional

True to emit relocatable content (no IDs, ACLs, or times).

revisionNumber

Integeroptional

Revision number.

safeMode

Stringoptional

Determines the mode to use during a full export. If set to none, the default behavior applies. If set to restart, then the server will be stopped during the full export and restarted on completion. If set to shutdown, then the server will be stopped during the full export and shutdown on completion.

Possible values: "none", "restart", "shutdown"

withAcls

Booleanoptional

True to emit ACLs in relocatable exports.

withNotifiers

Booleanoptional

True to emit emailNotifiers in relocatable exports.

withVersionNumbers

Booleanoptional

True to emit version numbers (ignored on import).

Usage

Perl

$cmdr->export(
  "test-fileName" # fileName
  # optionals
);▼

ectool

ectool export \
  "test-fileName" `# fileName` \
  # optionals▼