DA Environment plugin

Use the DA Environment plugin to create and manage Deployment Automation environments.

To add the plugin's steps, open your component or global process and navigate to DA > Environments in the Tools pane.

For details on creating and configuring environments, see Manage environments.

Create Environment step

Use this step to create a Deployment Automation environment for the specified application.

The following table describes the step's properties:

Property Description
Application Name The name of the application for which the environment is created.
Environment Name The name of the environment to be created.
Append Unique Suffix (Optional) Select this option if you want to guarantee your environment name is unique.
Description (Optional) A description of the environment to be created.
Require Approvals (Optional) Select this option if the environment requires approval from an approval process to install versions or snapshots.

Back to top

Create Component Mapping step

Use this step to create a component mapping.

The following table describes the step's properties:

Property Description
Component Name The name of the component to be mapped.
Environment Name The name or ID of the environment. If you specify an ID, you do not need to specify the application.
Application Name (Optional) The name of the application to which the environment belongs. This property is not required if you specify the environment ID, but is required if you specify the environment name.
Resource Name (Optional) The resource for which the component mapping is created. This property is not needed if you specify the resource group.
Resource Group (Optional) The path to the resource group for which the component mapping is created. This property is not needed if you specify the resource name, for example, /Groups/MyGroup.

Back to top

Create Environment Property step

Use this step to create a new property or update the value of an existing property for an application environment.

The following table describes the step's properties:

Property Description
Environment The name or ID of the environment. If you specify an ID, you do not need to specify the application.
Property Name The name of the property to set.
Application (Optional) The name or ID of the application to which the environment belongs. This property is not needed if you refer to the environment by ID instead of by name.
Property Value (Optional) The name of the property to set.
Secure? (Optional) Select this option if you want the property to be secure.

Back to top

Get Environment Properties step

Use this step to get the name-value pairs of all environment properties and set them as output properties. Secure property values cannot be resolved.

The following table describes the step's properties:

Property Description
Environment The name or ID of the environment. If you specify an ID, you do not need to specify the application.
Application (Optional) The name or ID of the application to which the environment belongs. This property is not needed if you refer to the environment by ID instead of by name.

Back to top

Get Component Environment Properties step

Use this step to get the name-value pairs of all component environment properties and set them as output properties. Secure property values cannot be resolved.

The following table describes the step's properties:

Property Description
Environment The name or ID of the environment. If you specify an ID, you do not need to specify the application.
Component The name or ID of the component.
Application (Optional) The name or ID of the application to which the environment belongs. This property is not needed if you refer to the environment by ID instead of by name.

Back to top

Inactivate Environment step

Use this step to inactivate the target environment.

The following table describes the step's properties:

Property Description
Environment The name or ID of the environment. If you specify an ID, you do not need to specify the application.
Application (Optional) The name or ID of the application to which the environment belongs. This property is not needed if you refer to the environment by ID instead of by name.

Back to top

Set Component Environment Property step

Use this step to set an environment-specific property value for a component. The property must already exist.

The following table describes the step's properties:

Property Description
Component The name or ID of the component to which the environment belongs.
Environment The name or ID of the environment. If you specify an ID, you do not need to specify the application.
Property Name The name of the property to set.
Application (Optional) The name or ID of the application to which the environment belongs. This property is not required if you specify the environment by ID instead of by name.
Property Value (Optional) The value of the property to set.
Secure? (Optional) Select this option if the property should be secure.

Back to top

Add User to Role for Environment step

Use this step to add a user to a role for a given application environment.

The following table describes the step's required properties:

Property Description
User The name of the user who is added to the role.
Role The user role to which the user is added.
Environment The name or ID of the environment.
Application The name or ID of the application to which the environment belongs.

Back to top

Add Group to Role For Environment step

Use this step to add a group to a role for a given application environment.

The following table describes the step's required properties:

Property Description
Group The name of the group that is added to the role.
Role The group role to which the group is added.
Environment The name or ID of the environment.
Application The name or ID of the application to which the environment belongs.

Back to top

Verify Inventory Status step

Use this step to verify that the environment has a component with a certain version in inventory.

The following table describes the step's properties:

Property Description
Environment The name or ID of the environment. If you specify an ID, you do not need to specify the application.
Component The name or ID of the component to verify.
Version The name of the version to verify.
Status The inventory entry must match this status (case sensitive). Default possible statuses are Active or Staged, but you can also add custom statuses.
Application (Optional) The name or ID of the application to which the environment belongs. This property is not needed if you refer to the environment by ID instead of by name.

Back to top

Check if Environment Exists step

This step succeeds if the environment exists, and fails if there is no environment.

The following table describes the step's properties:

Property Description
Environment The name or ID of the environment. If you specify an ID, you do not need to specify the application.
Application (Optional) The name or ID of the application to which the environment belongs. This property is not needed if you refer to the environment by ID instead of by name.

Back to top

See also: