Process steps: Reference#
Application processes, component processes, and generic processes are created with the process editor.
UrbanCode™ Deploy provides several common process steps. Otherwise, application processes are assembled from processes that are defined for their associated components. Application processes, like component processes, are created with the process editor.
The following process steps are provided by the server. For information about steps that are provided by plug-ins, see the documentation for the individual plug-in on HCL® developerWorks®: HCL UrbanCode™ Deploy Plug-ins.
- Acquire lock
This step acquires a lock on a specified string value. You can use locks to prevent concurrent modification of resources.
- Add Inventory Status
With this process step, the component resource that the process is running against will have an inventory entry created for it with the specified status.
- Apply Configuration
This step runs a component process of the type Operational (No Version Needed) or Configuration Deployment.
- Apply to Live Configuration
This step is a wrapper step for applying configuration updates to an application server.
- Compare with Live Configuration
This step is a wrapper step for comparing the configuration of an UrbanCode Deploy resource to a live application server.
Ends processing. A process can have more than one Finish step. All processes must reach a Finish step to complete successfully.
- For Each Agent
This step creates a loop that iterates over the agents in the environment.
- For Each Tag
This step iterates over resource tags in application processes.
- Install Component
This step installs the selected component with one of the processes that are defined for the component.
- Install Multiple Components
Install multiple components that are based on component tags or resource tags.
- Inventory Update
This step updates the inventory and compliance for the environment.
The Join step merges a process so that only one step runs at a time. If any of the steps that connect to a Join step fail or do not run, the Join step causes the process to fail.
- Manual Application Task (Utility)
A manual task interrupts an application process until manual intervention is done. A task-interrupted process remains suspended until the targeted user or users respond. Typically, manual tasks are removed after the process is tested or automated.
The Note step adds a note to a process diagram.
- Operational component processes
Runs the specified operational (no version needed) component process.
- Release lock
This step releases a lock on a specified string value.
- Remove Inventory Status
With this process step, the component resource that the process is running against will have an inventory entry removed from it.
- Rollback Component
Use this process step to roll back a component version to the version in a snapshot or to the version that was deployed when the process began.
- Rollback Multiple Components
Use this step to roll back multiple component versions to versions in a snapshot or to versions that were deployed when the process began. The multiple components are based on component tags or resource tags.
- Run Component Process
You can run a component process as a part of a step.
- Run Generic Process
This step runs a generic process as a step in an application process.
- Run Generic Process for Each Affected Resource
Runs the specified generic process on each resource that is affected by the application process.
- Run Operational Process for Multiple Components
Runs the operational (no version needed) process for multiple components.
- Run Process for Each Version
Use this step to run the specified process once for each version of the specified component.
- Set Status
This step sets the ending status of the process. The step can specify that the process is completed or failed.
Use this step to create branches in the process that are based on the value of a property.
- Uninstall Component
Use this step to uninstall the selected component.
- Uninstall Multiple Components
Use this step to uninstall multiple components that are based on component tags or resource tags.
- Update from Live Configuration
This step is a wrapper step for updating a resource with the configuration information from an application server.
Parent topic: Processes