Application process steps

Deployment Automation provides a set of built-in steps for designing application processes. The steps are divided into groups based on general, snapshot, and utility functions. This topic describes the general steps for application processes.

For other steps, see Snapshot steps for applications processes and Utility steps for application processes.

To use the steps, open an application process and drag the steps from the Tools pane onto the design space.

Finish step

The Finish step ends processing. A process can have more than one Finish step.

Back to top

Install Component step

Use the Install Component step to install the selected component.

The following table describes the step's properties.

Property Description
Name Enter a name for the step. The name can be referenced by other process steps.
Component

Select the component to be used by the step.

A step affects a single component. All components associated with the application are available.

To install more components, add more install steps to the process or use the Install Multiple Components step.

Use Versions Without Status This option restricts the components that the step can use. By default, currently deployed components with the Active status are ignored.
Component Process

Select a process for the component selected above.

All processes defined for the component are available. You can select only one process per step.

Ignore Failure (Optional) If this option is selected, the step will always be considered to have run successfully.
Limit to Resource Role Select a user-defined resource role that the agent running the step must have.
Max # of Concurrent Jobs

Enter the maximum number of component processes that can run at the same time.

For an unlimited number, accept the default value -1.

Fail Fast (Optional) If this option is selected, the step will not start any more component processes if one fails.
Run on First Online Resource Only (Optional) If this option is selected, the step will only run on the first online agent identified by Deployment Automation instead of using all agents mapped to the application. The mechanism for identifying the first agent is database-dependent (thus indeterminate).
Precondition (Optional) Enter a JavaScript script to define a condition that must exist before the step can run. The condition resolves to true or false.
Hint (Optional) Add a comment to the step. To view the comment, point to the step in the design space.

Back to top

Install Multiple Components step

Use the Install Multiple Components step to install a selection of template-based components.

The following table describes the step's properties.

Property Description
Name Enter a name for the step. The name can be referenced by other process steps.
Component Template

Select the template from which the components were created.

All templates used in the application's components are available. You can select only one component template per step.

The template is always displayed using the name of its latest version.

Component Template Version

Select the version of the template. You can specify only one component template version per step.

Note: If the application process uses a snapshot, the step will ignore your selection and use the component template version configured in the snapshot.

Component Template Process

Select the component template process that the components will run.

The list includes all processes defined for the specified component template version. You can select only one process per step.

Components

Select the components to be used by the step.

The list includes all application's components created from the specified component template version.

To select all components, click Select All. You can use search and then click Select All to select only the search results.

Note: If you run the step for one or more components that no longer use the selected component template version, the step fails.

Use Versions Without Status This option restricts the components that the step can use. By default, currently deployed components with the Active status are ignored.
Ignore Failure (Optional) If this option is selected, the step will always be considered to have run successfully.
Limit to Resource Role Select a user-defined resource role that the agent running the step must have.
Max # of Concurrent Jobs

Enter the maximum number of component processes that can run at the same time.

For an unlimited number, accept the default value -1.

Fail Fast (Optional) If this option is selected, the step will not start any more component processes if one fails.
Run on First Online Resource Only (Optional) If this option is selected, the step will only run on the first online agent identified by Deployment Automation instead of using all agents mapped to the application. The mechanism for identifying the first agent is database-dependent (thus indeterminate).
Precondition (Optional) Enter a JavaScript script to define a condition that must exist before the step can run. The condition resolves to true or false.
Hint (Optional) Add a comment to the step. To view the comment, point to the step in the design space.

Back to top

Uninstall Component step

Use the Uninstall Component step to uninstall the selected component.

The following table describes the step's properties.

Property Description
Name Enter a name for the step. The name can be referenced by other process steps.
Component

Select the component used by the step.

A step affects a single component. All components associated with the application are available.

To uninstall more components, add more uninstall steps to the process or use the Uninstall Multiple Components step.

Remove Versions With Status This option restricts the components affected by the step. By default, currently deployed components with the Active status are affected.
Component Process

Select a process for the component selected above.

All processes defined for the component are available. You can select only one process per step.

Ignore Failure (Optional) If this option is selected, the step will always be considered to have run successfully.
Uninstall Type

Select which component versions to uninstall:

  • All existing. Uninstalls all component versions.
  • All selected for process. Uninstalls only the versions you select in the application process wizard. For details, see Run application processes.

Max # of Concurrent Jobs

Enter the maximum number of component processes that can run at the same time.

For an unlimited number, accept the default value -1.

Limit to Resource Role Select a user-defined resource role that the agent running the step must have.
Fail Fast (Optional) If this option is selected, the step will not start any more component processes if one fails.
Run on First Online Resource Only (Optional) If this option is selected, the step will only run on the first online agent identified by Deployment Automation instead of using all agents mapped to the application. The mechanism for identifying the first agent is database-dependent (thus indeterminate).
Precondition (Optional) Enter a JavaScript script to define a condition that must exist before the step can run. The condition resolves to true or false.
Hint (Optional) Add a comment to the step. To view the comment, point to the step in the design space.

Back to top

Uninstall Multiple Components step

Use the Uninstall Multiple Components step to uninstall a selection of template-based components.

The following table describes the step's properties.

Property Description
Name Enter a name for the step. The name can be referenced by other process steps.
Component Template

Select the template from which the components were created.

All templates used in the application's components are available. You can select only one component template per step.

The template is always displayed using the name of its latest version.

Component Template Version

Select the version of the template. You can specify only one component template version per step.

Note: If the application process uses a snapshot, the step will ignore your selection and use the component template version configured in the snapshot.

Component Template Process

Select the component template process that the components will run.

The list includes all processes defined for the specified component template version. You can select only one process per step.

Components

Select the components to be used by the step.

The list includes all application's components created from the specified component template version.

To select all components, click Select All. You can use search and then click Select All to select only the search results.

Note: If you run the step for one or more components that no longer use the selected component template version, the step fails.

Remove Versions With Status This option restricts the components affected by the step. By default, currently deployed components with the Active status are affected.
Ignore Failure (Optional) If this option is selected, the step will always be considered to have run successfully.
Limit to Resource Role Select a user-defined resource role that the agent running the step must have.
Uninstall Type

Select the option for uninstalling component versions:

  • All existing. Uninstalls all component versions.
  • All selected for process. Uninstalls only the versions selected in the application process wizard. For details, see Run application processes.
Max # of Concurrent Jobs

Enter the maximum number of component processes that can run at the same time.

For an unlimited number, accept the default value -1.

Fail Fast (Optional) If this option is selected, the step will not start any more component processes if one fails.
Run on First Online Resource Only (Optional) If this option is selected, the step will only run on the first online agent identified by Deployment Automation instead of using all agents mapped to the application. The mechanism for identifying the first agent is database-dependent (thus indeterminate).
Precondition (Optional) Enter a JavaScript script to define a condition that must exist before the step can run. The condition resolves to true or false.
Hint (Optional) Add a comment to the step. To view the comment, point to the step in the design space.

Back to top

Roll Back Component step

Use the Roll Back Component step to roll back a component version and replace it with an earlier one.

The following table describes the step's properties.

Property Description
Name Enter a name for the step. The name can be referenced by other process steps.
Component

Select the component used by the step.

A step affects a single component. All components associated with the application are available.

To roll back more components, add more rollback steps to the process or use the Roll Back Multiple Components step.

Remove Versions Without Status This option restricts the components affected by the step. By default, currently deployed components with the Active status are affected.
Component Process

Select a process for the component selected above.

All processes defined for the component are available. You can select only one process per step.

Ignore Failure (Optional) If this option is selected, the step will always be considered to have run successfully.
Limit to Resource Role Select a user-defined resource role that the agent running the step must have.
Rollback Type

Select the type of rollback from the following options:

  • Remove Undesired Incremental Versions
  • Replace with Last Deployed
Max # of Concurrent Jobs

Enter the maximum number of component processes that can run at the same time.

For an unlimited number, accept the default value -1.

Fail Fast (Optional) If this option is selected, the step will not start any more component processes if one fails.
Run on First Online Resource Only (Optional) If this option is selected, the step will only run on the first online agent identified by Deployment Automation instead of using all agents mapped to the application. The mechanism for identifying the first agent is database-dependent (thus indeterminate).
Precondition (Optional) Enter a JavaScript script to define a condition that must exist before the step can run. The condition resolves to true or false.
Hint (Optional) Add a comment to the step. To view the comment, point to the step in the design space.

Back to top

Roll Back Multiple Components step

Use the Roll Back Multiple Components step to roll back versions for the selected template-based components, replacing them with earlier versions.

The following table describes the step's properties.

Property Description
Name Enter a name for the step. The name can be referenced by other process steps.
Component Template

Select the template from which the components were created.

All templates used in the application's components are available. You can select only one component template per step.

The template is always displayed using the name of its latest version.

Component Template Version

Select the version of the template. You can specify only one component template version per step.

Note: If the application process uses a snapshot, the step will ignore your selection and use the component template version configured in the snapshot.

Component Template Process

Select the component template process that the components will run.

The list includes all processes defined for the specified component template version. You can select only one process per step.

Components

Select the components to be used by the step.

The list includes all application's components created from the specified component template version.

To select all components, click Select All. You can use search and then click Select All to select only the search results.

Note: If you run the step for one or more components that no longer use the selected component template version, the step fails.

Remove Versions Without Status This option restricts the components affected by the step. By default, currently deployed components with the Active status are affected.
Ignore Failure (Optional) If this option is selected, the step will always be considered to have run successfully.
Limit to Resource Role Select a user-defined resource role that the agent running the step must have.
Rollback Type

Select the type of rollback from the following options:

  • Remove Undesired Incremental Versions
  • Replace with Last Deployed
Max # of Concurrent Jobs

Enter the maximum number of component processes that can run at the same time.

For an unlimited number, accept the default value -1.

Fail Fast (Optional) If this option is selected, the step will not start any more component processes if one fails.
Run on First Online Resource Only (Optional) If this option is selected, the step will only run on the first online agent identified by Deployment Automation instead of using all agents mapped to the application. The mechanism for identifying the first agent is database-dependent (thus indeterminate).
Precondition (Optional) Enter a JavaScript script to define a condition that must exist before the step can run. The condition resolves to true or false.
Hint (Optional) Add a comment to the step. To view the comment, point to the step in the design space.

Back to top

Run Process for Each Version step

Use the Run Process for Each Version step to run a selected component process for each component version.

The following table describes the step's properties.

Property Description
Name Enter a name for the step. The name can be referenced by other process steps.
Component

Select the component used by the step.

A step affects a single component. All components associated with the application are available.

To run a process for another component, add another Run Process for Each Version step to the process.

Component Process

Select a process for the component selected above.

All processes defined for the component are available. You can select only one process per step.

Ignore Failure (Optional) If this option is selected, the step will always be considered to have run successfully.
Limit to Resource Role Select a user-defined resource role that the agent running the step must have.
Max # of Concurrent Jobs

Enter the maximum number of component processes that can run at the same time.

For an unlimited number, accept the default value -1.

Fail Fast (Optional) If this option is selected, the step will not start any more component processes if one fails.
Run on First Online Resource Only (Optional) If this option is selected, the step will only run on the first online agent identified by Deployment Automation instead of using all agents mapped to the application.
Precondition (Optional) Enter a JavaScript script to define a condition that must exist before the step can run. The condition resolves to true or false.
Hint (Optional) Add a comment to the step. To view the comment, point to the step in the design space.

Back to top

Apply Configuration step

Use the Apply Configuration step to apply configuration properties to a selected component version.

The following table describes the step's properties.

Property Description
Name Enter a name for the step. The name can be referenced by other process steps.
Component

Select the component used by the step.

A step affects a single component. All components associated with the application are available.

To apply a configuration to another component, add another Apply Configuration step to the process.

Component Process

Select a process for the component selected above.

All processes defined for the component are available. You can select only one process per step.

Note: You can only use processes set as Operational (No Version Needed) or Configuration Deployment.

Ignore Failure (Optional) If this option is selected, the step will always be considered to have run successfully.
Limit to Resource Role Select a user-defined resource role that the agent running the step must have.
Max # of Concurrent Jobs

Enter the maximum number of component processes that can run at the same time.

For an unlimited number, accept the default value -1.

Fail Fast (Optional) If this option is selected, the step will not start any more component processes if one fails.
Run on First Online Resource Only (Optional) Select this option to run the step only on the first online agent identified by Deployment Automation instead of using all agents mapped to the application.
Precondition (Optional) Enter a JavaScript script to define a condition that must exist before the step can run. The condition resolves to true or false.
Hint (Optional) Add a comment to the step. To view the comment, point to the step in the design space.

Back to top

Run Component Process step

Use the Run Component Process step to run a preconfigured component process that doesn't use versions.

If an application component has a process set as Configuration Deployment or Operational (No Versions Needed), such process becomes available as a step that your can run in application's processes.

To access the step, open your application process and click the component's name in the Tools pane.

Note: If a component process is not displayed as a step in the Tools pane, make sure that the process doesn't use versions and the component is associated with the application.

The following table describes the step's properties.

Property Description
Name Enter a name for the step. The name can be referenced by other process steps.
Ignore Failure (Optional) If this option is selected, the step will always be considered to have run successfully.
Limit to Resource Role (Optional) Select a user-defined resource role that the agent running the step must have. By default, any role is used.
Max # of Concurrent Jobs

Enter the maximum number of component processes that can run at the same time.

For an unlimited number, accept the default value -1.

Fail Fast (Optional) If this option is selected, the step will not start any more component processes if one fails.
Run on First Online Resource Only (Optional) Select this option to run the step only on the first online agent identified by Deployment Automation instead of using all agents mapped to the application.
Precondition (Optional) Enter a JavaScript script to define a condition that must exist before the step can run. The condition resolves to true or false.
Run if Component(s) Change

(Optional) Select this option to run the step only if at least one of the selected components changes the inventory on a given resource.

Before running the process, verify that the process will trigger inventory changes.

Hint (Optional) Add a comment to the step. To view the comment, point to the step in the design space.

Back to top

See also: