Index
addResourcePoolToEnvironmentTieraddResourceTemplateToEnvironmentTemplateTieraddResourceToEnvironmentTemplateTiercreateEnvironmentTemplatecreateEnvironmentTemplateTiercreateEnvironmentTemplateTierMapcreateHookcreateResourceTemplatedeleteEnvironmentTemplatedeleteEnvironmentTemplateTierdeleteEnvironmentTemplateTierMapdeleteEnvironmentTemplateTierMappingdeleteHookdeleteResourceTemplategetAvailableResourcesForEnvironmentgetEnvironmentTemplategetEnvironmentTemplatesgetEnvironmentTemplateTiergetEnvironmentTemplateTierMapsgetEnvironmentTemplateTiersgetHookgetHooksgetProvisionedEnvironmentsgetResourcePoolsInEnvironmentTiergetResourcesInEnvironmentTemplateTiergetResourceTemplategetResourceTemplatesgetResourceTemplatesInEnvironmentTemplateTiermodifyEnvironmentTemplatemodifyEnvironmentTemplateTiermodifyEnvironmentTemplateTierMapmodifyEnvTemplTierResourceTemplMappingmodifyHookmodifyResourceTemplateprovisionEnvironmentprovisionResourcePoolremoveResourceFromEnvironmentTemplateTierremoveResourcePoolFromEnvironmentTierremoveResourceTemplateFromEnvironmentTemplateTier
getPluginCatalog
getServerSettingsCategories
processWebhookTrigger
getWorkItems

import

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.

  • The default timeout is 10800 seconds (180 minutes or 3 hours).

  • A full export/import preserves job IDs, but a partial import preserves names only, not IDs. Use the preserveId option for a partial import if you need to retain the same (existing) job or workflow ID number.
Incomplete/running jobs and pipeline runtimes are not exported.
fileName
Stringrequired
The filename from/to which the import/export is done.
batchSize
Integeroptional
The number of objects that are imported before they're committed to the database.
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.
disableSchedules
Booleanoptional
If true, imported schedules will be disabled.
force
Booleanoptional
True to replace existing object when doing a single-object import.
path
Stringoptional
A property path indicating a single object to be exported (for export) or the location at which to import (for import).
preserveId
Booleanoptional
If true, import will attempt to preserve the object ID during a single-object import.
preserveNames
Booleanoptional
If true, will attempt to preserve names during a single-object 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.

Usage

Perl

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

ectool

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

Examples

Perl

$cmdr->import("/opt/TestProg.xml");

$cmdr->import({file => "c:\r.xml", path => "/projects[Test]");
▼

ectool

ectool import /mnt/backups/fullBackkup.xml

ectool "c:\project.xml" --path "/projects[Test]"
▼