Execute Utility Step

The Execute Utility step executes a named utility project. Utility project need not be present in Release. Although, if utility project is part of release then it’s input can be dynamically controlled using stage execution information.

If the utility project being executed does not have a mapped target that is associated with the pipeline stage's environment, the execution of the project will fail.

Field

Description

Field

Description

Name

The name of the step.

Description

An optional description for the step.

Project

The name of the utility project in the release to execute.  This project must be in the release, or the execution will fail.

FlexFields

If Utility Request FlexFields are configured on the selected project, entry will be prompted for on the step configuration (not shown above).  If the information is provided in the stage execution info, it will override the data entered on the step configuration. Optionally, use a Groovy expression to make these fields dynamic based on some contextual value (e.g. a property defined on the pipeline, and specified on the release).

Inputs

If the utility workflow for the project has inputs, entry will be prompted for on the step configuration (not shown above).  If the information is provided in the stage execution info, it will override the data entered on the step configuration. Optionally, use a Groovy expression to make these fields dynamic based on some contextual value (e.g. a property defined on the pipeline, and specified on the release).

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 Roles

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.

Script Variables

The following macros are not currently supported in the footer:
  • style