Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The Manualstep creates a task for the assigned role group members and blocks the stage execution until the task is either approved or rejected (either through the release dashboard, tasks page, or via the REST API, or via Emails (pipeline roles and users can complete the task)).  This is useful when there are manual steps that must be performed in between automated steps executing within a stage.

Approve / Reject Action

  • Tasks can be approved from tasks page as well, but user members of Approval Role must approve step on release dashboard as there will be no task for them when gate is executed. If user member of Approval Role approves the step, then task is created and approved for any one of approver user's group for reference.

  • Note that even when more than one Groups are member of Approval Role, only one approval is needed to complete this step.

  • Administrator can approve or reject manual step.

  • Since FlexDeploy 7.0, manual step can be rejected, which would mean failure of manual activity and execution will stop.

  • When using Task page, user can claim the task to work on, at which point other users will see that someone else is working on it and they will not be able to approve or reject also.

...

  • When manual step is executed, email will be sent to members of Approval Role.

  • Individual email is sent for

    • One email for each Each group member of Approval Role. i.e. if there are two groups in Approval Role, two individual emails will be sent for each group’s users.

    • All user members of Approval Role

    • All email addresses member of Approval Role

...

Field

Description

Name

The name of the step.

Description

An optional description for the step.

Approval Role

The pipeline role which is assigned to this manual step. Optionally, use a Groovy expression to make this field dynamic based on some contextual value (e.g. a property defined on the pipeline, and specified on the release).

When using a role script you can dynamically return a key/value pair. For example return [type: 'groupName', value: 'FD Administrators']. Supported types are roleId, roleName, groupId, and groupName. You can return Map with single key/value pair or list of such single key/value maps.

Precondition

An optional Groovy script which determines whether the gate or step is applicable during execution. The script has access to variables and methods listed in Pipeline Groovy Variables and Methods. You can find these variables and methods while using the Groovy Editor.

The script must return true if the step is applicable, or false otherwise.  If no script is provided, the default is to return true (applicable).

On Error

Continue

If checked, any failure will be ignored, and the pipeline execution will continue.

Notify Pipeline Role

Selects one or more roles from the pipeline definition to notify in case of error.  Default role members are defined on the pipeline, and optionally overridden for each release. Optionally, use a Groovy expression to make this field dynamic based on some contextual value (e.g. a property defined on the pipeline, and specified on the release).

When using a role script you can dynamically return a key/value pair. For example return [type: 'groupName', value: 'FD Administrators']. Supported types are roleId, roleName, groupId, and groupName. You can return Map with single key/value pair or list of such single key/value maps.

...