Miscellaneous

21 minute readReference

changeOwner

Changes the owner of an object.

The Modify privilege on the admin system access control list is required to change the owner of an object. For email notifiers, the owner can be changed if the current user has sufficient privileges to delete and recreate the object.

Arguments

Argument Name Type Description

applicationName

String

The name of an application.

applicationTierName

String

The name of an application tier.

archiveConnectorName

String

The name of an archive connector.

artifactName

String

The name of the artifact container of the property sheet which owns the property.

artifactVersionName

String

The name of the artifactVersion container of the property sheet which owns the property.

catalogName

String

The name of the catalog of the property sheet which owns the property.

ciBuildDetailName

String

The name of the CI build detail of the property sheet which owns the property.

clusterName

String

The name of the cluster which owns property sheet.

componentName

String

The name of a component.

configName

String

The name of the email configuration.

credentialName

String

The name of the credential.

dashboardName

String

The name of a dashboard.

dataRetentionPolicyName

String

The name of a data retention policy.

environmentName

String

The name of an environment.

environmentTemplateName

String

The name of an environment template.

environmentTemplateTierName

String

The name of the environment template tier container of the property sheet which owns the property.

environmentTierName

String

The name of an environment tier.

flowName

String

The name of the flow container of the property sheet which owns the property.

flowRuntimeId

String

The ID of the flow runtime container of the property sheet which owns the property.

flowRuntimeName

String

The name of the flow runtime container of the property sheet which owns the property.

flowRuntimeStateId

String

The primary key or name of the flowRuntimeState container of the property sheet which owns the property.

flowRuntimeStateName

String

The name of the flow state container of the property sheet which owns the property.

flowStateName

String

The name of the flow state container of the property sheet which owns the property.

flowTransitionName

String

The name of the flow transition container of the property sheet which owns the property.

gateType

GateType

The type of the gate which owns property sheet.

gatewayName

String

The name of the gateway container of the property sheet.

groupName

String

The name of a group.

jobId

String

The primary key or name of the job container of the property sheet which owns the property.

jobStepId

UUID

The primary key of the job-step container of the property sheet which owns the property.

microserviceName

String

The name of the microservice container of the property sheet.

newOwnerName

String

The name of the new owner.

notifierName

String

The email notifier name.

objectId

String

The object ID as returned by FindObjects.

path

String

Property path string.

pipelineName

String

The name of the pipeline container of the property sheet which owns the property.

pluginConfigurationName

String

The name of the plugin configuration container of the property sheet which owns the property.

pluginName

String

The name of a plugin.

procedureName

String

The name of a procedure.

processName

String

The name of a process.

processStepName

String

The name of a process step.

projectName

String

The name of a project.

propertySheetId

UUID

The primary key of the property sheet.

recursive

Boolean

The argument applies ownership changes of pipeline, release, and flowRuntime objects to associated child objects. When set to the default value, false, ownership changes are applied only to the selected object. If set to true, ownership changes are applied as follows: Pipeline and release: Changes are applied to stages, gates, tasks, associated flow and flow state objects, and common objects. Common objects are properties, email notifiers, event subscriptions, and formal parameters. flowRuntime: Changes are applied to flowRuntimeState, nested flowRuntime objects, and common objects. Common options are properties, email notifiers, event subscriptions.

releaseName

String

The name of the release container of the property sheet which owns the property.

reportName

String

The name of a report.

reportObjectTypeName

String

The name of a report object type.

repositoryName

String

The name of the repository container of the property sheet which owns the property.

resourceName

String

The name of a resource.

resourcePoolName

String

The name of the resource pool container of the property sheet which owns the property.

resourceTemplateName

String

The name of the resource template container of the property sheet which owns the property.

scheduleName

String

The name of a schedule.

scmSyncName

String

The name of the Scm Sync container of the property sheet which owns the property.

snapshotName

String

The name of the snapshot container of the property sheet which owns the property.

stageName

String

The name of the stage container of the property sheet which owns the property.

stateDefinitionName

String

The name of a workflow state definition.

stepName

String

The name of a procedure step.

taskName

String

The name of the task which owns property sheet.

transitionDefinitionName

String

The name of a workflow transition definition.

triggerName

String

The name of the trigger which owns property sheet.

userName

String

The name of a user.

widgetName

String

The name of a widget.

workflowDefinitionName

String

The name of a workflow definition.

workflowName

String

The name of the workflow container of the property sheet which owns the property.

workspaceName

String

The name of a workspace.

zoneName

String

The name of the zone container of the property sheet.

Positional arguments

None.

Usage

ec-perl

$cmdr->changeOwner({<optionals>});

ectool

ectool changeOwner [optionals]

clone

Makes a copy of an existing CloudBees CD/RO object.

  • You cannot clone parameters, artifacts, or artifact versions.

  • To find the entity you want to clone, you must specify the following arguments:

    • A new name for the cloned object. For example, cloneName.

    • Locator arguments for the objects that can be cloned. For example, if you want to clone a project, you must specify the name of the project that you want to clone.

Arguments

Argument Name Type Description

applicationName

String

The name of the application container of the property sheet that owns the property.

applicationTierName

String

The name of the application tier container of the property sheet that owns the property.

archiveConnectorName

String

The name of the archive connector of the property sheet that owns the property.

artifactName

String

The name of the artifact container of the property sheet that owns the property.

artifactVersionName

String

The name of the artifactVersion container of the property sheet that owns the property.

catalogItemName

String

The Catalog Item name.

catalogItemRunId

String

The primary key of the CatalogItemRun container of the property sheet that owns the property.

catalogName

String

The name of the catalog of the property sheet that owns the property.

ciBuildDetailName

String

The name of the CI build detail of the property sheet that owns the property.

cloneName

String

New name to use for a cloned copy of an object.

cloneTaskGroup

String

The name of the group of task.

clusterName

String

The name of the cluster which owns property sheet.

componentName

String

The name of the component container of the property sheet that owns the property.

configName

String

The name of the emailConfig container that owns the property.

credentialName

String

The name of the credential container of the property sheet that owns the property.

credentialProviderName

String

The credential provider name.

dashboardName

String

The name of the dashboard of the property sheet that owns the property.

dataRetentionPolicyName

String

The name of the data retention policy of the property sheet that owns the property.

disableProjectTracking

Boolean

If set to true, when copying a project, even if the original project has change tracking enabled, make change tracking of the new copy of the project be disabled from its creation. If you don’t need to track changes to the new copy, this avoids the change tracking overhead that would otherwise slow down the copying operation, and also saves having to subsequently disable change tracking of the new copy of the project.

environmentName

String

The name of the environment container of the property sheet that owns the property.

environmentTemplateName

String

The name of the environment template container of the property sheet that owns the property.

environmentTemplateTierName

String

The name of the environment template tier container of the property sheet that owns the property.

environmentTierName

String

The name of the environment tier container of the property sheet that owns the property.

flowName

String

The name of the flow container of the property sheet that owns the property.

flowRuntimeId

String

The primary key or name of the flowRuntime container of the property sheet that owns the property.

flowRuntimeName

String

The name of the flow runtime container of the property sheet that owns the property.

flowRuntimeStateId

String

The primary key or name of the flowRuntimeState container of the property sheet that owns the property.

flowRuntimeStateName

String

The name of the flow state container of the property sheet that owns the property.

flowStateName

String

The name of the flow state container of the property sheet that owns the property.

flowTransitionName

String

The name of the flow transition container of the property sheet that owns the property.

gateType

GateType

The type of the gate which owns property sheet.

gatewayName

String

The name of the gateway container of the property sheet.

groupName

String

The name of the group container of the property sheet that owns the property.

jobId

String

The primary key or name of the job container of the property sheet that owns the property.

jobStepId

UUID

The primary key of the job-step container of the property sheet that owns the property.

linkNewPersona

Boolean

Set to 1 to associate users and groups to the cloned persona.

microserviceName

String

The name of the microservice container of the property sheet.

notifierName

String

The name of the notifier container of the property sheet that owns the property.

objectId

String

The object ID as returned by FindObjects.

path

String

Property path string.

personaName

String

The persona name.

pipelineName

String

The name of the pipeline container of the property sheet that owns the property.

pluginConfigurationName

String

The plugin configuration name.

pluginConfigurationName

String

The name of the plugin configuration container of the property sheet that owns the property.

pluginName

String

The name of the plugin container of the property sheet that owns the property.

procedureName

String

The name of the procedure container of the property sheet that owns the property.

processName

String

The name of the process, if the container is a process or process step.

processStepName

String

The name of the process step, if the container is a process step.

projectName

String

The name of the project container of the property sheet that owns the property.

propertySheetId

UUID

The primary key of the property sheet that owns the property.

providerName

String

The unique name of the directory provider.

reducedDetailChangeHistory

Boolean

Set to 0 or false to prevent copying of a large project that has change tracking enabled from automatically reducing the level of detail that it tracks for the change history of the copy — this will make the copy 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 copy of the project that were created by the copy operation.

releaseName

String

The name of the release container of the property sheet that owns the property.

reportName

String

The name of the report of the property sheet that owns the property.

reportObjectTypeName

String

The name of the report object type of the property sheet that owns the property.

repositoryName

String

The name of the repository container of the property sheet that owns the property.

resourceName

String

The name of the resource container of the property sheet that owns the property.

resourcePoolName

String

The name of the resource pool container of the property sheet that owns the property.

resourceTemplateName

String

The name of the resource template container of the property sheet that owns the property.

scheduleName

String

The name of the schedule container of the property sheet.

scmSyncName

String

The name of the SCM Sync container of the property sheet that owns the property.

searchFilterName

String

The name of the search filter container of the property sheet.

serviceAccountName

String

Retrieves the name of the service account container of the property sheet.

snapshotName

String

The name of the snapshot container of the property sheet that owns the property.

stageName

String

The name of the stage container of the property sheet that owns the property.

stateDefinitionName

String

The name of the state definition container of the property sheet that owns the property.

stateName

String

The name of the state container of the property sheet that owns the property.

stepName

String

The name of the step container of the property sheet that owns the property.

systemObjectName

SystemObjectName

The system object.

taskName

String

The name of the task which owns property sheet.

transitionDefinitionName

String

The name of the transition definition container of the property sheet that owns the property.

transitionName

String

The name of the transition container of the property sheet that owns the property.

triggerName

String

The name of the trigger which owns property sheet.

unlinkOriginalPersona

Boolean

Set to 1 to disassociate users and groups from the original or the persona being cloned.

userName

String

The name of the user container of the property sheet that owns the property.

widgetName

String

The name of the widget of the property sheet that owns the property.

workflowDefinitionName

String

The name of the workflow definition container of the property sheet that owns the property.

workflowName

String

The name of the workflow container of the property sheet that owns the property.

workspaceName

String

The name of the workspace container of the property sheet.

zoneName

String

The name of the zone container of the property sheet.

Positional arguments

None.

Usage

ec-perl

$cmdr->clone({<optionals>});

ectool

ectool clone [optionals]

evalDsl

Evaluates and runs a CloudBees CD/RO domain-specific language (DSL) script.

Arguments

Argument Name Type Description

dsl

String

(Required) The DSL text.

applicationName

String

The name of the application container of the property sheet that owns the property.

applicationTierName

String

The name of the application tier container of the property sheet that owns the property.

archiveConnectorName

String

The name of the archive connector of the property sheet that owns the property.

artifactName

String

The name of the artifact container of the property sheet that owns the property.

artifactVersionName

String

The name of the artifactVersion container of the property sheet that owns the property.

catalogItemRunId

String

The primary key of the CatalogItemRun container of the property sheet that owns the property.

catalogName

String

The name of the catalog of the property sheet that owns the property.

ciBuildDetailName

String

The name of the CI build detail of the property sheet that owns the property.

clusterName

String

The name of the cluster which owns property sheet.

componentName

String

The name of the component container of the property sheet that owns the property.

configName

String

The name of the emailConfig container that owns the property.

credentialName

String

The name of the credential container of the property sheet that owns the property.

dashboardName

String

The name of the dashboard of the property sheet that owns the property.

dataRetentionPolicyName

String

The name of the data retention policy of the property sheet that owns the property.

debug

Boolean

True to include debug output.

describe

Boolean

True to return help description for the DSL text.

environmentName

String

The name of the environment container of the property sheet that owns the property.

environmentTemplateName

String

The name of the environment template container of the property sheet that owns the property.

environmentTemplateTierName

String

The name of the environment template tier container of the property sheet that owns the property.

environmentTierName

String

The name of the environment tier container of the property sheet that owns the property.

flowName

String

The name of the flow container of the property sheet that owns the property.

flowRuntimeId

String

The primary key or name of the flowRuntime container of the property sheet that owns the property.

flowRuntimeName

String

The name of the flow runtime container of the property sheet that owns the property.

flowRuntimeStateId

String

The primary key or name of the flowRuntimeState container of the property sheet that owns the property.

flowRuntimeStateName

String

The name of the flow state container of the property sheet that owns the property.

flowStateName

String

The name of the flow state container of the property sheet that owns the property.

flowTransitionName

String

The name of the flow transition container of the property sheet that owns the property.

format

DslFormat

Format to use for the DSL. Defaults to groovy format.

gateType

GateType

The type of the gate which owns property sheet.

gatewayName

String

The name of the gateway container of the property sheet.

groupName

String

The name of the group container of the property sheet that owns the property.

helpFormat

DslHelpFormat

Format to use for the DSL help content.

jobId

String

The primary key or name of the job container of the property sheet that owns the property.

jobStepId

UUID

The primary key of the job-step container of the property sheet that owns the property.

microserviceName

String

The name of the microservice container of the property sheet.

notifierName

String

The name of the notifier container of the property sheet that owns the property.

objectId

String

The object ID as returned by FindObjects.

overwrite

Boolean

True to use overwrite mode. If the object exists, all existing attributes of the object will be overwritten by the values in the DSL.

parameters

String

JSON text which is parsed and passed to the DSL as a map.

path

String

Property path string.

pipelineName

String

The name of the pipeline container of the property sheet that owns the property.

pluginConfigurationName

String

The name of the plugin configuration container of the property sheet that owns the property.

pluginName

String

The name of the plugin container of the property sheet that owns the property.

procedureName

String

The name of the procedure container of the property sheet that owns the property.

processName

String

The name of the process, if the container is a process or process step.

processStepName

String

The name of the process step, if the container is a process step.

projectName

String

The name of the project container of the property sheet that owns the property.

propertySheetId

UUID

The primary key of the property sheet that owns the property.

releaseName

String

The name of the release container of the property sheet that owns the property.

reportName

String

The name of the report of the property sheet that owns the property.

reportObjectTypeName

String

The name of the report object type of the property sheet that owns the property.

repositoryName

String

The name of the repository container of the property sheet that owns the property.

resourceName

String

The name of the resource container of the property sheet that owns the property.

resourcePoolName

String

The name of the resource pool container of the property sheet that owns the property.

resourceTemplateName

String

The name of the resource template container of the property sheet that owns the property.

scheduleName

String

The name of the schedule container of the property sheet.

scmSyncName

String

The name of the SCM Sync container of the property sheet that owns the property.

searchFilterName

String

The name of the search filter container of the property sheet.

serverLibraryPath

String

Path to the server directory that contains jar files and classes to be added to the classpath when evaluating the DSL text.

serviceAccountName

String

Retrieves the name of the service account container of the property sheet.

sessionPassword

String

Session user’s password. Used to re-verify identity before changing user passwords in the system.

snapshotName

String

The name of the snapshot container of the property sheet that owns the property.

stageName

String

The name of the stage container of the property sheet that owns the property.

stateDefinitionName

String

The name of the state definition container of the property sheet that owns the property.

stateName

String

The name of the state container of the property sheet that owns the property.

stepName

String

The name of the step container of the property sheet that owns the property.

systemObjectName

SystemObjectName

The system object.

taskName

String

The name of the task which owns property sheet.

timeout

Long

Maximum duration of execution for the given DSL, in seconds. Defaults to maxDslDuration server setting.

transitionDefinitionName

String

The name of the transition definition container of the property sheet that owns the property.

transitionName

String

The name of the transition container of the property sheet that owns the property.

triggerName

String

The name of the trigger which owns property sheet.

userName

String

The name of the user container of the property sheet that owns the property.

widgetName

String

The name of the widget of the property sheet that owns the property.

workflowDefinitionName

String

The name of the workflow definition container of the property sheet that owns the property.

workflowName

String

The name of the workflow container of the property sheet that owns the property.

workspaceName

String

The name of the workspace container of the property sheet.

zoneName

String

The name of the zone container of the property sheet.

Positional arguments

dsl

Usage

ec-perl

$cmdr->evalDsl(<dsl>, {<optionals>});

ectool

ectool evalDsl dsl [optionals]

evalScript

Evaluates a script in the specified context. This API is similar to expandString except it evaluates the value argument as a Javascript block, without performing any property substitution on either the script or the result. The string value of the final expression in the script is returned as the value element of the response.

Arguments

Argument Name Type Description

value

String

(Required) The string to expand in the specified context.

applicationName

String

The name of the application container of the property sheet that owns the property.

applicationTierName

String

The name of the application tier container of the property sheet that owns the property.

archiveConnectorName

String

The name of the archive connector of the property sheet that owns the property.

artifactName

String

The name of the artifact container of the property sheet that owns the property.

artifactVersionName

String

The name of the artifactVersion container of the property sheet that owns the property.

catalogItemRunId

String

The primary key of the CatalogItemRun container of the property sheet that owns the property.

catalogName

String

The name of the catalog of the property sheet that owns the property.

ciBuildDetailName

String

The name of the CI build detail of the property sheet that owns the property.

clusterName

String

The name of the cluster which owns property sheet.

componentName

String

The name of the component container of the property sheet that owns the property.

configName

String

The name of the emailConfig container that owns the property.

credentialName

String

The name of the credential container of the property sheet that owns the property.

dashboardName

String

The name of the dashboard of the property sheet that owns the property.

dataRetentionPolicyName

String

The name of the data retention policy of the property sheet that owns the property.

environmentName

String

The name of the environment container of the property sheet that owns the property.

environmentTemplateName

String

The name of the environment template container of the property sheet that owns the property.

environmentTemplateTierName

String

The name of the environment template tier container of the property sheet that owns the property.

environmentTierName

String

The name of the environment tier container of the property sheet that owns the property.

flowName

String

The name of the flow container of the property sheet that owns the property.

flowRuntimeId

String

The primary key or name of the flowRuntime container of the property sheet that owns the property.

flowRuntimeName

String

The name of the flow runtime container of the property sheet that owns the property.

flowRuntimeStateId

String

The primary key or name of the flowRuntimeState container of the property sheet that owns the property.

flowRuntimeStateName

String

The name of the flow state container of the property sheet that owns the property.

flowStateName

String

The name of the flow state container of the property sheet that owns the property.

flowTransitionName

String

The name of the flow transition container of the property sheet that owns the property.

gateType

GateType

The type of the gate which owns property sheet.

gatewayName

String

The name of the gateway container of the property sheet.

groupName

String

The name of the group container of the property sheet that owns the property.

jobId

String

The primary key or name of the job container of the property sheet that owns the property.

jobStepId

UUID

The primary key of the job-step container of the property sheet that owns the property.

microserviceName

String

The name of the microservice container of the property sheet.

notifierName

String

The name of the notifier container of the property sheet that owns the property.

objectId

String

The object ID as returned by FindObjects.

path

String

Property path string.

pipelineName

String

The name of the pipeline container of the property sheet that owns the property.

pluginConfigurationName

String

The name of the plugin configuration container of the property sheet that owns the property.

pluginName

String

The name of the plugin container of the property sheet that owns the property.

procedureName

String

The name of the procedure container of the property sheet that owns the property.

processName

String

The name of the process, if the container is a process or process step.

processStepName

String

The name of the process step, if the container is a process step.

projectName

String

The name of the project container of the property sheet that owns the property.

propertySheetId

UUID

The primary key of the property sheet that owns the property.

releaseName

String

The name of the release container of the property sheet that owns the property.

reportName

String

The name of the report of the property sheet that owns the property.

reportObjectTypeName

String

The name of the report object type of the property sheet that owns the property.

repositoryName

String

The name of the repository container of the property sheet that owns the property.

resourceName

String

The name of the resource container of the property sheet that owns the property.

resourcePoolName

String

The name of the resource pool container of the property sheet that owns the property.

resourceTemplateName

String

The name of the resource template container of the property sheet that owns the property.

scheduleName

String

The name of the schedule container of the property sheet.

scmSyncName

String

The name of the SCM Sync container of the property sheet that owns the property.

searchFilterName

String

The name of the search filter container of the property sheet.

serviceAccountName

String

Retrieves the name of the service account container of the property sheet.

snapshotName

String

The name of the snapshot container of the property sheet that owns the property.

stageName

String

The name of the stage container of the property sheet that owns the property.

stateDefinitionName

String

The name of the state definition container of the property sheet that owns the property.

stateName

String

The name of the state container of the property sheet that owns the property.

stepName

String

The name of the step container of the property sheet that owns the property.

systemObjectName

SystemObjectName

The system object.

taskName

String

The name of the task which owns property sheet.

transitionDefinitionName

String

The name of the transition definition container of the property sheet that owns the property.

transitionName

String

The name of the transition container of the property sheet that owns the property.

triggerName

String

The name of the trigger which owns property sheet.

userName

String

The name of the user container of the property sheet that owns the property.

widgetName

String

The name of the widget of the property sheet that owns the property.

workflowDefinitionName

String

The name of the workflow definition container of the property sheet that owns the property.

workflowName

String

The name of the workflow container of the property sheet that owns the property.

workspaceName

String

The name of the workspace container of the property sheet.

zoneName

String

The name of the zone container of the property sheet.

Positional arguments

value

Usage

ec-perl

$cmdr->evalScript(<value>, {<optionals>});

ectool

ectool evalScript value [optionals]

export

Exports part or all server data to an XML file. By default, all data in the system is exported. Use the path parameter to limit the output to a single tree of objects.

The export is executed by the CloudBees CD/RO service user.

Before you perform an export, ensure the CloudBees CD/RO server is inactive and cannot accept jobs, by completing the following steps on the server:

  1. Disable the ECSCM:SentryMonitor schedule and all project schedules.

    1. Navigate to DevOps Essentials  Platform Home page.

    2. Select Electric Cloud from the Projects tab.

  2. Select the Schedules tab and disable all schedules, including the ECSCM-SentryMonitor schedule that runs the ECSCM:ElectricSentry procedure.

  3. Ensure all jobs are stopped.

    1. Navigate to DevOps Essentials  Platform Home page.

    2. Select the Jobs tab.

    3. Review the jobs list and take action to stop all jobs.

  4. Disable all resources so that no new job steps can run.

    1. Navigate to DevOps Essentials  Resources.

    2. Disable each resource by clearing its state from the Enabled column.

A quiescent database ensures a complete XML database file is exported. As a best practice, exporting individual projects is preferred to exporting the full database. If it is necessary to perform a full export, do it during a quite period noting the following:

  • It is memory intensive.

  • It can perform slowly possibly taking days depending on the amount of data to export.

  • 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.

Arguments

Argument Name Type Description

fileName

String

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

compress

Boolean

If true, the output will be compressed.

disableProjectTracking

Boolean

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

Boolean

Export file will be available to download.

excludeJobs

Boolean

True to exclude jobs from the export.

objectId

UUID

Object ID.

objectType

String

Object type.

path

String

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

reducedDetailChangeHistory

Boolean

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

Boolean

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

revisionNumber

Integer

Revision number.

safeMode

SafeMode

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.

withAcls

Boolean

True to emit ACLs in relocatable exports.

withNotifiers

Boolean

True to emit emailNotifiers in relocatable exports.

withVersionNumbers

Boolean

True to emit version numbers (ignored on import).

Positional arguments

fileName

Usage

ec-perl

$cmdr->export(<fileName>, {<optionals>});

ectool

ectool export fileName [optionals]

generateDsl

Generates a domain-specific language (DSL) script for the specified object including all nested objects, parameters, and custom properties, subject to arguments passed in with the command.

Arguments

Argument Name Type Description

path

String

(Required) A property path indicating a single object for which DSL will be generated.

format

DslFormat

Format to use for the DSL. Defaults to groovy format.

includeChildren

String

A comma-separated list of collection types to include in generated DSL, all other children will be suppressed.

suppressChildren

Boolean

True to suppress all child entities in the generated DSL for the object.

suppressDefaults

Boolean

True to suppress system default in the generated DSL for the object.

suppressEmpty

Boolean

True to suppress properties with empty values in the generated DSL for the object.

suppressNulls

Boolean

True to suppress properties with null values in the generated DSL for the object.

suppressParent

Boolean

True to remove object parent reference from DSL output.

useFileReferences

Boolean

True replace specific properties with file references.

withAcls

Boolean

True to emit ACLs in the generated DSL for the object.

Positional arguments

path

Usage

ec-perl

$cmdr->generateDsl(<path>, {<optionals>});

ectool

ectool generateDsl path [optionals]

import

Imports data from an XML export file.

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.

Arguments

Argument Name Type Description

fileName

String

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

batchSize

Integer

The number of objects that are imported before they’re committed to the database.

disableProjectTracking

Boolean

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

Boolean

If true, imported schedules will be disabled.

force

Boolean

True to replace existing object when doing a single-object import.

path

String

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

preserveId

Boolean

If true, import will attempt to preserve the object ID during a single-object import.

preserveNames

Boolean

If true, will attempt to preserve names during a single-object import.

reducedDetailChangeHistory

Boolean

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.

Positional arguments

fileName

Usage

ec-perl

$cmdr->import(<fileName>, {<optionals>});

ectool

ectool import fileName [optionals]

logStatistic

Prints (emits) a statistics value to StatsD.

Arguments

Argument Name Type Description

name

String

(Required) The name of the statistic to emit.

type

StatisticType

(Required) The type of statistic to emit.

value

Long

(Required) The value of the statistic to emit.

Positional arguments

name, type, value

Usage

ec-perl

$cmdr->logStatistic(<name>, <type>, <value>);

ectool

ectool logStatistic name type value