Create and design component processes

This topic explains how to create and design a component process, connect the process steps in the process designer, and view or edit the process details.

For each component, you must create at least one process.

Tip: Save frequently used processes in component templates and later apply these templates to other components. For details, see Component templates.

Create a component process

When creating a component process, you specify its basic details.

To create a component process:

  1. Navigate to Management > Components > [select component] .

  2. Select the Processes tab.

  3. Click Create. The Create Component Process dialog box opens.

  4. Enter the following information:

    Field Description
    Name Enter a meaningful name that reflects the component's content or process type.
    Description (Optional) Specify additional information about the process.
    Process Type

    Select the process type:

    • Deployment: Deploys a component version to the target resource and updates the inventory after a successful execution.

    • Configuration Deployment: Configuration-only deployment with no component version or artifacts. It applies the configuration (using properties, or configuration templates) to the target agent and then updates the resource configuration inventory.

    • Uninstall: Standard uninstall that removes a component version from a target resource and the resource's inventory.

    • Operational (With Version): Operational process that does not add or remove any artifacts or configuration. It runs arbitrary steps given a component version. Use it when you want to start or stop some service for a previously deployed component version.

    • Operational (No Version Needed): Same as the Operational (With Version) type but does not require a component version.

    Inventory Status Set the status to be applied to component versions after the process runs successfully. By default, the system applies the Active built-in status, indicating that the component version is deployed to its target resource.

    You can define custom inventory statuses. For example, the Staged status could indicate that the component version is in a predeployment location. The status is displayed under the Inventory tabs for the component and the environments that ran the process.
    For details on how to create custom statuses, see Define and use statuses.
    Default Working Directory Specify the location for temporary file storage, to be used by the agent running the process.

    The default directory is ${p:resource/work.dir}/${p:component.name},
    which resolves to <agent_directory>\work\<component_name_directory>.

    The default location works for most components. You might need to change it if you cannot run the component process at the agent's location.
    Required Component Role (Optional) Determine who can run the process. The available options are derived from the Deployment Automation security system.

    By default, the option is set to None, which means that anyone can run the process. For details on security roles, see Security Administration.
    Execution Timeout Specify how long (in hours and minutes) the process runs until it times out.

    To run the process indefinitely, accept the default value, 00:00.
  5. Click Save.

    To create another component process, click Save and New.

After creating a process, design its flow.

Back to top

Design a component process

After creating a component process, you design its flow to tell Deployment Automation how to deploy components.

Use the process designer to drag process steps from the Tools pane onto the design space, configure the steps' properties, and visually define the sequence of steps.

For details on available steps, see Plugin steps for component processes and Utility steps for component processes.

Here's an example of a designed component process:

image

To design a component process:

  1. From the list of component processes, select the process you just created. The process designer opens.
  2.  (Optional)  In the process designer's toolbar, you can:
    • Adjust the view using the Zoom In, Zoom Out, or Actual Size icons.
    • Move the process around in the design space by selecting Show Outline Box. In the Outline Map box that opens, drag the outline corner inward or outward.
    • View available options for all connections between steps by selecting Show Connection Options.
    • Hide annotations. The annotations you have added to the process are displayed by default. If you want to hide them, clear the Show Annotations check box.
  3. In the Tools pane, select process steps.

    Use Search to find steps by name.

  4. To add a step to the process, drag the step onto the design space. You can place the step anywhere on the design space and reposition it later.
  5. In the Properties pane, configure the step.
  6. Join the process steps in a sequence as described next in Connect process steps.

    Tip: If Show Connection Options is not selected in the toolbar, select each connection manually to view its options. Connections are color-coded for the process path: Success (green), Failure (red), and Always (gray).

Back to top

Connect process steps

When designing a process, you connect its steps into a sequence in the process designer. Connections control the order in which the process runs the steps.

You can connect steps immediately after placing them, or place multiple steps before defining the connections. Connections are created one at a time between two steps, the originating step and the target step.

To connects the steps in a process:

  1. After you have added the steps onto a design space, point to the originating step to view the connection tool, drag the connection tool over the target step, and release it.

    Note: The Start step cannot be deleted or edited.

  2. In connection's Properties, select a type to set a condition on the connection. By default, the type is set to Success. For details, see Use conditions and switch steps in processes.

  3. (Optional) To add a conditional transition, select Conditional and enter properties. Use arithmetical (+, -, %, /, *) and logical operators (==, !=, >, <).

    The transition is successful only if the condition is resolved to true. You cannot add conditional properties to Switch transitions and the transition from the Start step.

    Note: The system uses the Spring Expression Language (SpEL) for evaluating properties. Strings are delimited by single quotes. To put a single quote in a string, use double quote characters, for example, "Hello World". For more information about SpEL, see the SpEL documentation.

  4. Continue with additional steps as needed.
  5. After configuring and connecting the steps, click Save .

Back to top

Manage component process details

To manage a component process, navigate to Management > Components > [select component] > Processes and click the Details icon next to the relevant process.

On the process details page, you can modify the process, add or edit properties, and view process changes.

To manage component process details:

  1. To add and edit process steps, click the Design button.
  2. To change basic information, click the Edit icon next to the process details.
  3. To view change history for the process, select the Changes tab.
  4. To add process properties, select the Properties tab and click Add Property. For details, see Add or edit component properties.
  5. To edit or delete a property, click the relevant icon next to it.

Back to top

See also: