Notification Section

Top Previous Next

A notification section is used to standard notification values to indicate whether notifications are required, and if so whether by Email, SMS, or both. It is strongly recommended that this section should be set as the second section in the script, immediately after the Setup section.

Depending upon the entries in this section other variable values may be needed. For example, if you choose to send an email at the point of completion it would be necessary to set values for the SMTP server, Port, Credentials and any other information required to send the message at the appropriate point.

Command Syntax

If you wish to create a Notification section, you simply type the word Notification into the script surrounded by square brackets.

[Notification]

Once the section has been created you can create variables and values or assign values to predefined Notification Section Variables which can be used to control any notifications sent by the Pipeline Runner.

IMPORTANT: The Notification section should follow any Setup section and appear before any other sections.

Example

The following example demonstrates the creation of an SMS Notification that will be sent on Error or on Success:

[Notification]

Var:NotificationType=SMS

Var:Notify=OnErrorAndSuccess

Var:ReportFileName=%%TempFolder%%\%%FileNameVersion%%.log

Var:SmsApiMode=Live

Var:SmsOriginator=Software

Var:SmsErrorMessage=Something went very wrong with the pipeline!

Var:SmsToNumber=<The required mobile phone number>

Var:SmsPassword=<Your Password>

Var:SmsUsername=<YourUsername>

Var:SmsSuccessMessage=The pipeline completed successfully!