Back to index
Summary
Import data from an XML export file. If--disableSchedules
is 1
, any imported schedules will be disabled. --path
can be used to import a single object to a different location from where it was exported. --force
can be provided to replace a single object at the provided path.fileNameStringrequiredThe filename from/to which the import/export is done. batchSizeIntegeroptionalThe number of objects that are imported before they're committed to the database. disableProjectTrackingBooleanoptionalIf 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. disableSchedulesBooleanoptionalIf true, imported schedules will be disabled. forceBooleanoptionalTrue to replace existing object when doing a single-object import. pathStringoptionalA property path indicating a single object to be exported (for export) or the location at which to import (for import). preserveIdBooleanoptionalIf true, import will attempt to preserve the object ID during a single-object import. preserveNamesBooleanoptionalIf true, will attempt to preserve names during a single-object import. reducedDetailChangeHistoryBooleanoptionalSet 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. |
Usage
Groovy
import com.electriccloud.client.groovy.ElectricFlow import com.electriccloud.client.groovy.models.* ElectricFlow ef = new ElectricFlow() def result = ef.import( fileName: "test-fileName" /* optional arguments */ )