Application Dependency Commands

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 Descriptions

projectName

Name of the project. This name must be unique among all projects.

Argument Type: String

Argument Type: String

applicationName

The name of the application that must be unique among all projects.

Argument Type: String

applicationDependencyName

(Optional) The name of the application dependency. If not specified, a system-generated GUID is used.

Argument Type: String

dependentApplicationName

(Optional) The name of the application which this application depends on.

Argument Type: String

dependentProjectName

(Optional) The name of the project containing the dependent application. If not specified, the value of projectName is used.

Argument Type: String

dependentSnapshotName

(Optional) The name of the snapshot of the application specified by dependentApplicationName.

Argument Type: String

effectiveDate

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

Argument Type: String

snapshotName

(Optional) The name of the snapshot of the application specified by applicationName. The name must be unique within the application.

Argument Type: String

Response

Returns an application dependency object.

ec-perl

Syntax:

$->createApplicationDependency(, , , , {});


Example:

To create a dependency between two component process steps in a master component:

$ec->createApplicationDependency('Default', 'Deploy', 'Get WAR file', 'Copy WAR file', {componentName => 'WAR file'});

To create a dependency between two component process steps in a specific application:

$ec->createApplicationDependency'Default', 'Deploy', 'Get WAR file', 'Copy WAR file',  {componentName => 'WAR file', componentApplicationName => 'Shopping Cart'});

To create a dependency between two application process steps:

$ec->createApplicationDependency('Default', 'Deploy', 'Get WAR file', 'Copy WAR file',  {applicationName => 'Shopping Cart'});

ectool

Syntax:

ectool createApplicationDependency     [optionals]

Example:

To create a dependency between two component process steps in a master component:

ectool createApplicationDependency 'Default' 'Deploy' 'Get WAR file', 'Copy WAR file' --componentName 'WAR file'

To create a dependency between two component process steps in a specific application:

ectool createApplicationDependency 'Default' 'Deploy' 'Get WAR file', 'Copy WAR file' --componentName 'WAR file' --componentApplicationName 'Shopping Cart'

To create a dependency between two application process steps:

ectool createApplicationDependency  'Default' 'Deploy' 'Get WAR file', 'Copy WAR file' --applicationName 'Shopping Cart'

deleteApplicationDependency

Deletes a dependency between two applications.

Arguments Descriptions

projectName

Name of the project. This name must be unique among all projects.

Argument Type: String

Argument Type: String

applicationName

The name of the application that must be unique among all projects.

Argument Type: String

applicationDependencyName

(Optional) The name of the application dependency. If not specified, a system-generated GUID is used.

Argument Type: String

dependentApplicationName

(Optional) The name of the application which this application depends on.

Argument Type: String

dependentProjectName

(Optional) The name of the project containing the dependent application. If not specified, the value of projectName is used.

Argument Type: String

dependentSnapshotName

(Optional) The name of the snapshot of the application specified by dependentApplicationName.

Argument Type: String

snapshotName

(Optional) The name of the snapshot of the application specified by applicationName.

Argument Type: String

Response

None or a status OK message.

ec-perl

Syntax:

$->deleteApplicationDependency(, , , , {});


Example:

To delete a dependency between two component process steps in a master component:

$ec->deleteApplicationDependency('Default', 'Deploy', 'Get WAR file', 'Copy WAR file', {componentName => 'WAR file'});

To delete a dependency between two component process steps in a specific application:

$ec->deleteApplicationDependency('Default', 'Deploy', 'Get WAR file', 'Copy WAR file',  {componentName => 'WAR file', componentApplicationName => 'Shopping Cart'});

To delete a dependency between two application process steps:

$ec->deleteApplicationDependency('Default', 'Deploy', 'Get WAR file', 'Copy WAR file',  {applicationName => 'Shopping Cart'});

ectool

Syntax:

ectool deleteApplicationDependency     [optionals]

Example:

To delete a dependency between two component process steps in a master component:

ectool deleteApplicationDependency 'Default' 'Deploy' 'Get WAR file' 'Copy WAR file' --componentName 'WAR file'

To create a dependency between two component process steps in a specific application:

ectool deleteApplicationDependency 'Default' 'Deploy' 'Get WAR file' 'Copy WAR file' --componentName 'WAR file' --componentApplicationName 'Shopping Cart'

To create a dependency between two application process steps:

ectool deleteApplicationDependency  'Default' 'Deploy' 'Get WAR file' 'Copy WAR file' --applicationName 'Shopping Cart'

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 Descriptions

projectName

Name of the project. This name must be unique among all projects.

Argument Type: String

Argument Type: String

applicationName

The name of the application that must be unique among all projects.

Argument Type: String

dependentApplicationName

(Optional) The name of the application which this application depends on.

Argument Type: String

dependentProjectName

(Optional) The name of the project containing the dependent application. If not specified, the value of projectName is used.

Argument Type: String

dependentSnapshotName

(Optional) The name of the snapshot of the application specified by dependentApplicationName.

Argument Type: String

snapshotName

(Optional) The name of the snapshot of the application specified by applicationName.

Argument Type: String

Response

Returns zero or more application dependency elements, including applicationDependencyId, applicationName, source, sourceApplicationName, target, and targetApplicationName.

ec-perl

Syntax:

$->getProcessDependencies(, , {});


Example:

To retrieve the dependencies between two component process steps in a master component:

$ec->getProcessDependencies('Default', 'Deploy', {componentName => 'WAR file'});

To retrieve the dependencies between two component process steps in a specific application:

$ec->getProcessDependencies('Default', 'Deploy', {componentName => 'WAR file', componentApplicationName => 'Shopping Cart'});

To retrieve the dependencies between two application process steps:

$ec->getProcessDependencies('Default', 'Deploy', {applicationName => 'Shopping Cart'});

ectool

Syntax:

ectool getProcessDependencies   [optionals]

Example:

To retrieve the dependencies between two component process steps in a master component:

ectool getProcessDependencies 'Default' 'Deploy' --componentName 'WAR file'

To retrieve the dependencies between two component process steps in a specific application:

ectool getProcessDependencies 'Default' 'Deploy' --componentName 'WAR file' --componentApplicationName 'Shopping Cart'

To retrieve the dependencies between two application process steps:

ectool getProcessDependencies  'Default' 'Deploy' --applicationName 'Shopping Cart'

modifyApplicationDependency

Modifies a dependency between two applications.

Arguments Descriptions

projectName

Name of the project. This name must be unique among all projects.

Argument Type: String

Argument Type: String

applicationName

The name of the application that must be unique among all projects.

Argument Type: String

applicationDependencyName

(Optional) The name of the application dependency. If not specified, a system-generated GUID is used.

Argument Type: String

dependentApplicationName

The name of the application which this application depends on.

Argument Type: String

dependentProjectName

The name of the project containing the dependent application.

Argument Type: String

dependentSnapshotName

The name of the snapshot of the application specified by dependentApplicationName.

Argument Type: String

effectiveDate

(Optional) The date when this application dependency rule should be applied. This implies that the dependency rule will be applicable for only snapshots (specified by snapshotName ) that were created on or after the effective date. For example, 2017-05-15.

Argument Type: String

newName

New name for the object.

Argument Type: String

snapshotName

(Optional) The name of the snapshot of the application specified by applicationName.

Argument Type: String

Response

Returns an updated application dependency object.

ec-perl

Syntax:

$->modifyApplicationDependency(, , , , {});


Example:

To modify a dependency between two component process steps in a master component:

$ec->modifyApplicationDependency('Default', 'Deploy', 'Get WAR file', 'Copy WAR file', {componentName => 'WAR file', branchConditionName => 'Create new WAR file'});

To modify a dependency between two component process steps in a specific application:

$ec->modifyApplicationDependency('Default', 'Deploy', 'Get WAR file', 'Copy WAR file',  {componentName => 'WAR file', componentApplicationName => 'Shopping Cart', branchConditionName => 'Create new WAR file'});

To modify a dependency between two application process steps:

$ec->modifyApplicationDependency('Default', 'Deploy', 'Get WAR file', 'Copy WAR file',  {applicationName => 'Shopping Cart', branchConditionName => 'Create new WAR file'});

ectool

Syntax:

ectool modifyApplicationDependency     [optionals]

Example:

To modify a dependency between two component process steps in a master component:

ectool modifyApplicationDependency 'Default' 'Deploy' 'Get WAR file', 'Copy WAR file' --componentName 'WAR file' --branchConditionName  'Create new WAR file'

To modify a dependency between two component process steps in a specific application:

ectool modifyApplicationDependency 'Default' 'Deploy' 'Get WAR file', 'Copy WAR file' --componentName 'WAR file' --componentApplicationName 'Shopping Cart' --branchConditionName  'Create new WAR file'

To modify a dependency between two application process steps:

ectool modifyApplicationDependency  'Default' 'Deploy' 'Get WAR file', 'Copy WAR file' --applicationName 'Shopping Cart' --branchConditionName  'Create new WAR file'