Page Comparison

The Notificationstep sends a custom email notification to the user, group, or email address configured on the step. The email is sent using the configured mail server on the Administration - System Settings menu.

...

Field

Description

Name

The name of the step.

Description

An optional description for the step.

Pipeline Roles

Selects one or more roles from the pipeline definition to notify. Default role members are defined on the pipeline, and optional 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.

Subject

The subject line for the email notification. 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).

Message

The body for the email notification. 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).

Body to contain details on individual Project deployment status

Code Block

language	groovy

"<br/>" + 
"<b>Deployed Projects</b> : " + FD_Release.getSnapshotDeployedProjectsAsString() + "<br/>" + 
"<b>Failed Projects</b> : " + FD_Release.getSnapshotFailedProjectsAsString() + "<br/>" + 
"<b>Skipped Projects</b> : " + FD_Release.getSnapshotSkippedProjectsAsString() + "<br/>" + 
"<b>Not Attempted Projects</b> : " + FD_Release.getSnapshotNotAttemptedProjectsAsString()

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

gate
step is applicable, or false otherwise. If no script is provided, the default is to return true (applicable).
Template
Custom notification template to format the email. 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).
Notification templates that are not assigned to any event type, or are assigned to the Pipeline Notification Event will show up in the drop down.
Create
Users can create a custom notification template with the Pipeline Notification Step Event type
to prepare it using with a pipeline notification
for use with this step.
On Error
Continue
If checked, any failure will be ignored, and the pipeline execution will continue to next step.
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.

Script Variables

Include Page

	Pipeline Groovy Variables and Methods
	Pipeline Groovy Variables and Methods

Versions Compared

Old Version 3

New Version Current

Key

Script Variables

for use with this step.
On Error
Continue	If checked, any failure will be ignored, and the pipeline execution will continue to next step.
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.