Configuring component processes

A component process is created in two steps: first, you configure basic information, such as name; second, you use the process editor to assemble the process.

Procedure

  1. Display the Create New Process dialog (Home > Components > Component: component_name > Create New Process).
    Figure 1. Create New Process dialog
  2. Complete the following fields:
    Field Description
    Name Identifies the process; appears in many UI elements. Required.
    Description The optional description can be used to convey more information about the process.
    Process Type Defines the process type. Available values are:
    • Deployment: deploys a component version to the target resource and updates the inventory after a successful run.
    • Configuration Deployment: configuration-only deployment with no component version or artifacts. This setting applies the configuration (using properties, or configuration templates) to the target agent and updates the resource configuration inventory afterward.
    • Uninstall: standard uninstall that removes a component version from a target resource and the resource inventory.
    • Operational (With Version): operational process that does not add or remove any artifacts or configuration; runs arbitrary steps given a component version. Useful when you want to start or stop some service for a previously deployed component version.
    • Operational (No Version Needed): same as the previous type, but does not require a component version.
    Required.
    Inventory Status Status that is applied to component versions after being successfully run by this process. Active indicates that the component version is deployed to its target resource; Staged means that the component version is in a pre-deployment location. The status appears on the Inventory panes for the component itself and environments that ran the process. Required.
    Default Working Directory Defines the location that the agent uses to run the process (for temporary files, and so on). The default value resolves to agent_directory\work\component_name_directory. The default properties work for most components; you might need to change it if a component process cannot be run at the agent's location. Required.
    Required Component Role Restricts who can run the process. The available options are derived from the IBM® UrbanCode Deploy security system. The default value is None, meaning anyone can run the process. For information about security roles, see Security.
  3. Save your work when you are finished. The process is listed on the Processes pane for the associated component.

What to do next

Customize the process. See Process editor.

Feedback