Use > Automate Release > Release pipeline > Release gate actions > Create a custom release gate action

Create a custom release gate action

You can create a custom release gate action at any stage in a lifecycle.

To create a custom release gate action:

  1. Navigate to Release Automation > Release Pipeline.
  2. Select the design type (topology or sequenced) from the drop-down list in the left pane. (Topology is selected by default).

  3. Select the application and the version where you want to create a custom release gate action.
  4. Click the gear icon next to the lifecycle stage in which you want to create the custom action and click Configure Gate Actions.
  5. Click Add Action > Custom Action to create a custom action.
    1. In the Add Custom Action dialog box, fill in the following fields:

      Field Description
      Display Name Name of the custom action
      Description Description of the action you are creating
      Select Deployment

      Optionally, select the deploy action that you need to associate with the custom action. All the deploy actions that have been created for the selected package are displayed.

      Note: If you do not select a deployment action here, then you will be able to map a constant value or a context property in the Parameters tab. Whereas if you select a deploy action, you will have an additional option to map a component property.
    2. In the Success and Failure Configuration area, select the check boxes as applicable:

      Check box Description
      Notify on Success Select this check box for a notification message to be sent if the custom action executes successfully. The notification message is sent to the user who initiated the promotion request.
      Notify on Failure Select this check box to receive a notification email if the custom action fails to execute successfully. The notification message is sent to the user who initiated the promotion request.
      Reject on Failure (Blocking) Select this check box to reject the package if the custom action fails to execute successfully.
      Ignore on Failure Select the check box to mark the specified action optional (non-blocking). The execution will move to the next release gate action even if the action fails to execute successfully.
      You can select more than one check box. However, for the Reject on Failure and the Ignore on Failure options, you can select only one of them at the same time.
  6. Click Next.

  7. In the Custom Action dialog box, select an OO workflow for the custom action. The OO workflow defines the course of your custom action and is invoked by passing the relevant parameters during the execution of the custom action.

  8. Click Next.
  9. The Parameters dialog box displays the name and path of the OO workflow, and the list of parameters present in it. You need to map these parameters to the context property or constant value present in the design. To map the parameters:
    1. Select the gear icon next to the parameter you want to map to and click Edit.
    2. In the Edit Parameter Mapping dialog box, fill in the following fields:

      FieldDescription
      Display NameName of the parameter. You can change the default name to a name of your choice.
      DescriptionDescription of the parameter
      Mapping Type

      Object that you want to map the parameter to. You can either map the parameter to a component property, context property or constant value.

      If you select Context Property as the Mapping Type, you must select any of the following Context properties from the Value field.

      If you select Constant Value as the Mapping Type, you ,must provide a constant value in the Value field.

      For a password parameter, if you set the Mapping Type as Constant Value, then the password that you type in the Value field will be masked. This ensures the safety of your password.
      If a deploy action is not associated with this custom action, then you can map either a constant value or a context property only. Whereas if a deploy action is associated with it, then you will have an additional option to map a component property.
      Components

      Displayed only if you selected Component Property in the Mapping Type field.

      Select the component that you want to map the parameter to. All the components that are displayed are a part of the Codar design.

      Component Property

      Displayed only if you selected Component Property in the Mapping Type field.

      Select the component property for the component you selected. This is a dynamic list whose values change depending on the component you selected. The value of the property is obtained from the deployed instance selected for this custom action.

      This option only lists concrete components for partial designs. It does not include any server capability components.

      Mapping of parameters marked with an asterisk is mandatory. If you do not map such parameters, an error message is displayed when you try to add a custom action.

    You can also unmap a parameter that is already mapped to a component. To unmap a parameter from a component, select the gear icon next to the parameter and click Unmap.

    1. Click Save.
  10. Click Add Action.

The action that you added is listed in the Configure <stage> Gate Actions dialog box.