Application dependency

2 minute readReference

createApplicationDependency

Defines a dependency of an application (or its snapshot) on another application (or snapshot). At runtime, the deployment process checks for the dependent applications on the environment. The deployment stops if dependent applications or their versions are not present and you have requested enforcement of the dependency check. Otherwise, the deployment continues with a warning.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

applicationName

String

(Required) The name of the application.

applicationDependencyName

String

The name of application dependency. If not specified, a system generated GUID is used.

dependentApplicationName

String

The name of application which this application depends on.

dependentProjectName

String

The name the project containing the dependent application.

dependentSnapshotName

String

The name of snapshot of the dependent application.

effectiveDate

String

The date when this dependency is applicable (for example, 2023-05-15).

snapshotName

String

Name of the snapshot; must be unique within the application.

Positional arguments

projectName, applicationName

Usage

ec-perl

$cmdr->createApplicationDependency(<projectName>, <applicationName>, {<optionals>});

ectool

ectool createApplicationDependency projectName applicationName [optionals]

deleteApplicationDependency

Deletes a dependency between two applications.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

applicationName

String

(Required) The name of the application.

applicationDependencyName

String

The name of application dependency. If not specified, a system generated GUID is used.

dependentApplicationName

String

The name of application which this application depends on.

dependentProjectName

String

The name the project containing the dependent application.

dependentSnapshotName

String

The name of snapshot of the dependent application.

snapshotName

String

Name of the snapshot; must be unique within the application.

Positional arguments

projectName, applicationName

Usage

ec-perl

$cmdr->deleteApplicationDependency(<projectName>, <applicationName>, {<optionals>});

ectool

ectool deleteApplicationDependency projectName applicationName [optionals]

getApplicationDependencies

Retrieves a list of dependencies of an application based on the specified filters in its arguments. For instance, if you use the dependentApplicationName argument, it returns all dependencies between the two applications regardless of their snapshot names.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

applicationName

String

(Required) The name of the application.

dependentApplicationName

String

The name of application which this application depends on.

dependentProjectName

String

The name the project containing the dependent application.

dependentSnapshotName

String

The name of snapshot of the dependent application.

snapshotName

String

Name of the snapshot; must be unique within the application.

Positional arguments

projectName, applicationName

Usage

ec-perl

$cmdr->getApplicationDependencies(<projectName>, <applicationName>, {<optionals>});

ectool

ectool getApplicationDependencies projectName applicationName [optionals]

modifyApplicationDependency

Modifies a dependency between two applications.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

applicationName

String

(Required) The name of the application.

applicationDependencyName

String

The name of application dependency. If not specified, a system generated GUID is used.

dependentApplicationName

String

The name of application which this application depends on.

dependentProjectName

String

The name the project containing the dependent application.

dependentSnapshotName

String

The name of snapshot of the dependent application.

effectiveDate

String

The date when this dependency is applicable (for example, 2023-05-15).

newName

String

The new name for an existing object that is being renamed.

snapshotName

String

Name of the snapshot; must be unique within the application.

Positional arguments

projectName, applicationName

Usage

ec-perl

$cmdr->modifyApplicationDependency(<projectName>, <applicationName>, {<optionals>});

ectool

ectool modifyApplicationDependency projectName applicationName [optionals]