Define and use statuses

This topic explains how to create custom statuses and use them in your implementation.

Define custom statuses

Create your own inventory, component version, and snapshot statuses, and then use them in your implementation to do the following:

  • Apply inventory statuses to component versions when they are successfully deployed to resources.
  • Apply and enforce conditions on application gates based on the statuses of component versions and snapshots.

To define a new status:

  1. In Deployment Automation, navigate to Administration > Automation > Statuses.
  2. On the Statuses page, select one of the tabs depending on what status you want to create:
    • Inventory
    • Version
    • Snapshot

      Note: While you can add as many statuses as you need, you cannot create new status types. Only Inventory, Version, and Snapshot status types are available.

  3. Click Create. The Create Status dialog box opens.
  4. Enter the following properties for the new status:

    Property Description
    Name Enter the name to identify the status. With this name, the status is displayed in the user interface. Use it for creating gates and in process steps.
    Color Select the color identifier for the status. The color icon is displayed next to the status name in the user interface.
    Unique Select this option to make sure that the status is used only once, for example, if you need to apply the status to only one component version or snapshot.
    Required Component Role (Version statuses only) Select the security role that will enable a user to add this status to a component version.
    Required Application Role (Snapshot statuses only) Select the security role that will enable a user to add this status to a snapshot.
  5. Click Save.

Note: The Process Completion status is built in and cannot be changed. Do not confuse it with these other status types.

Back to top

Use inventory statuses

Use inventory statuses in component processes to apply statuses to versions upon successful deployment to a target environment or resource.

The built-in Active status is the default setting, which indicates that a component version has been successfully deployed to its target resource.

To apply an inventory status:

  1. Define the status as described earlier in this topic. See Define custom statuses.

    For example, your new inventory statuses could be INT_Ready, UAT_Ready, PROD_Ready.

  2. When creating or editing a component process, select the Inventory Status you want to set for this process. For details, see Create and design component processes.
  3. Run the process request.

    When the component process completes successfully, the selected status is applied to component versions for which you ran the process. To view the inventory status, open the Inventory tab for the component and the environments that ran the component process. For details, see Run application processes.

    Note: To check the inventory status of an environment as part of component and global processes, you can use the Verify Inventory Status step of the DA Environment plugin. For details, see DA Environment plugin.

Back to top

Use version statuses

Use version statuses with environment gates to ensure that the system deploys or processes components with a designated status only.

Select version statuses when you create gates for applications. There is no default setting.

To apply a version status:

  1. Define the status as described earlier in this topic. See Define custom statuses.

    For example, your new version statuses could be INT_Ready, UAT_Ready, PROD_Ready.

  2. Add gate conditions. For details, see Create gates.

  3. Set the status for your component version. For details, see Adding Statuses to Component Versions.

    Note: You can also set a version status as part of component and global processes using the DA Version plugin.

  4. Run the process request to deploy the component.

    The process does not run if any of the included component versions are not set to the statuses specified in the application environment's Gates tab. For details, see Run deployment processes.

Back to top

Use snapshot statuses

Use snapshot statuses with environment gates to ensure that the system deploys or processes snapshots with a designated status only.

Select snapshot statuses when you create gates for applications. There is no default setting.

To apply a snapshot status:

  1. Define the status as described earlier in this topic. See Define custom statuses.

    For example, your new snapshot statuses could be INT_Ready, UAT_Ready, PROD_Ready.

  2. Add gate conditions. For details, see Create gates.

  3. Set the status for the snapshot. For details, see Adding Statuses to Snapshots.

  4. Run the process request to deploy the snapshot.

    The process does not run if the snapshot is not set to the status specified in the application environment's Gates tab. See Run deployment processes.

Back to top

See also: