Event Notification Configuration in netflow.cfg

To configure event notifications from AgilePoint Server, do the procedure in this topic.

Event notifications are configured in the <notification> node of the AgilePoint Server configuration file netflow.cfg.

Prerequisites

How to Start

  1. On the AgilePoint Server machine, in a text editor, open the file netflow.cfg.

XML Node Format

<notification
    mode="[true or false]"
    format="[text or html]"
    smtpService="[SMTP service assembly name]:[SMTP service class name]:
        [email address],[password]"
    mailServer="[your mail server]"
    sender="[sender email address]"
    sysadm="[AgilePoint administrator email address. 
        If blank, the system uses the sender email address.]"
    maxRetryFailedMail="[integer that specifies how many times 
        the server needs to send mail if it is failed]"
    emailEncoding="[encoding format]"
    sendMailSeparately="[true or false]"
/>

XML Node Example

<notification
    mode="true"
    format="text"
    smtpService="Builtin::username@sbcglobal.net,mypassword"
    mailServer="smtp.sbcglobal.yahoo.com"
    sender="apnotifier@mycompany.com"
    sysadm="adminuser@mycompany.com"
    maxRetryFailedMail="35"
    emailEncoding="UTF-8"
    sendMailSeparately="false"

/>

Attributes

Field NameDefinition

mode
Function:
Specifies whether AgilePoint Server sends notifications for system events to the AgilePoint System Account.
Accepted Values:
  • true - AgilePoint Server sends administrator notifications.
  • false - AgilePoint Server does not send administrator notifications.
Default Value:
true
Example:
<notification mode="true" ... />

format
Function:
Specifies the format of the notification emails from AgilePoint Server.
Accepted Values:
  • html - Shows the email in HTML format.
  • text - Shows the email in text-only format.
Default Value:
text
Example:
<notification format="text" ... />

smtpService
Function:
Specifies the credentials for your SMTP email server or Exchange Server.
Accepted Values:
  • Basic Authentication - Credentials for your SMTP email server in this format:

    [smtp service assembly name]:[smtp service class name]:[email address],[password]

  • OAuth 2.0 Authentication for Exchange Server - A reference to a global access token for Exchange Server in this format:

    [Exchange Server name]:[global access token name]

Default Value:
None
Example:
  • Basic Authentication:

    <notification smtpService="Builtin::username@sbcglobal.net,mypassword" ... />

  • OAuth 2.0 Authentication:

    <notification smtpService="FaybayExchangeServer1::Asia Region Emails" ... />

Limitations:
OAuth 2.0 authentication for Exchange Server is available in these releases:

mailServer
Function:
Specifies the domain and server name for your SMTP email server.
Accepted Values:
One line of text (a string) in email address format.
Default Value:
None
Example:
<notification mailServer="smtp.sbcglobal.yahoo.com" ... />

sender
Function:
Specifies the email address of the sender for email notifications from AgilePoint Server.
Accepted Values:
One line of text (a string) in email address format.
Default Value:
None
Example:
<notification sender="apnotifier@mycompany.com" ... />

sysadm
Function:
Specifies the email address for the AgilePoint System Account.
Accepted Values:
One line of text (a string) in email address format.
Default Value:
None
Example:
<notification sysadm="adminuser@mycompany.com" ... />

maxRetryFailedMail
Function:
Specifies the maximum number of times to send an email notification from AgilePoint Server if the email attempts fail.
Accepted Values:
An integer.
Default Value:
32
Example:
<notification maxRetryFailedMail="35" ... />

emailEncoding
Function:
Specifies encoding format your email supports.
Accepted Values:
  • UTF-8
  • UTF-32
  • UTF-7
Default Value:
UTF-8
Example:
<notification emailEncoding="UTF-8" ... />

sendMailSeparately
Function:
Specifies whether to send an email notifications to each recipient as separate messages.
Accepted Values:
  • true - Sends an email to each recipient as a separate message.
  • false - Sends one email message to all recipients.
Default Value:
false
Example:
<notification sendMailSeparately="false" ... />

Related Topics