Configure Build Manifest notifications

You can configure Build Manifest notifications, such as the email address notification messages related to build completion.

To enable this feature, you configure:
  • The SMTP information related to the email
  • The email message sent to each email address
  • The target name initiated to send the email

You can configure this IXIA CCMS Output Generator information defined in the buildmanifest.smtp.properties file. You can configure the following properties in this file:

To configure the notify field and message:

  1. Open the %OutputGenDir%/data/resources/client/buildmanifest.smtp.properties.orig file and save it as buildmanifest.smtp.properties.
  2. Open the buildmanifest.smtp.properties file with a text editor.
    Standard defaults
    #
    # These properties control the SMTP configuration required to send emails at the end of the Build Manifest processing.  
    #
    bmanifest.smtp.mailhost = smtp.ixiasoft.local
    bmanifest.smtp.mailport = 25
    bmanifest.smtp.subject = This is an automated email from Skynet.
    bmanifest.smtp.from.address = no-reply@ixiasoft.com
    bmanifest.smtp.username =
    bmanifest.smtp.password =
    
    #You can create any property that you need for your SMTP mail library or 
    #that you can use in the template file. For example:
    bmanifest.smtp.ssl =
    
    #The property value will be expanded at runtime to match the destination.
    #The template can also include properties that will be expanded at runtime.
    bmanifest.smtp.message.file  = ${outgen.resources.dir.client}/notificationtemplate.html
    
    # This must be a valid target in your conductor file or one supplied with IXIA CCMS, as follows:
    # target name: Ixiasoft.SendEmail or Ixiasoft.SendEmailWithAuthentication
    bmanifest.smtp.ant.target = Ixiasoft.SendEmail
  3. Configure the file as described in Table 1.
    Table 1. buildmanifest.smtp.properties file

    Property

    Description

    bmanifest.smtp.mailhost

    SMTP server used to send the email build notification

    bmanifest.smtp.mailport

    SMTP port used to send the email build notification

    bmanifest.smtp.subject

    Email subject line sent with each email build notification

    bmanifest.smtp.from. address

    Email source address used for sending email build notifications

    Note: This is typically a no-reply email address.

    bmanifest.smtp.username

    SMTP username associated with source email

    Note: Specify this property only if authentication is enabled on the SMTP server.

    bmanifest.smtp.password

    Password associated with the SMTP username

    Note: Specify this property only if authentication is enabled on the SMTP server.

    bmanifest.smtp.ssl

    Unique property name, starting with bmanifest.smtp for use in your custom target properties

    Note: You can specify any property for use with your SMTP mail library or for use in the template file. You can enter as many properties as you need.

    bmanifest.smtp.message. file

    Path and name of the file that contains the notification template

    Note: By default, this is the %OutputGenDir%/data/resources/client/notificationtemplate.html file. To use another file, specify its path and file name.

    bmanifest.smtp.ant. target

    Target initiated at the end of Build Manifest processing

    The default provides two targets:

    • Ixiasoft.SendEmail sends an email using the properties configured in the buildmanifest.smtp.properties file without the SMTP username and password.
    • Ixiasoft.SendEmailWithAuthentication sends an email using all the properties configured in the buildmanifest.smtp.properties file.
    Note: You can write your own target instead of using those provided. If you write your own target, enter the target name in this property.
    Modification to the subject line for the related emails
    #
    # These properties control the SMTP configuration required to send emails at the end of the Build Manifest processing.  
    #
    bmanifest.smtp.mailhost = smtp.ixiasoft.local
    bmanifest.smtp.mailport = 25
    bmanifest.smtp.subject = This is an automated email notification from the Build Manifest process.
    bmanifest.smtp.from.address = no-reply@ixiasoft.com
    bmanifest.smtp.username =
    bmanifest.smtp.password =
    
    ...
  4. Save and close the file.
  5. Open the notificationtemplate.html.orig file defined at%OutputGenDir%/data/resources/client/notificationtemplate.html.orig and save it as notificationtemplate.html after removing the .orig suffix.
  6. Open the notificationtemplate.html file you just created with a text editor.
  7. Edit the notification text as required for your deployment.
  8. Save and close the file.
  9. Restart Ixiasoft Output Generator service.
If you specify an email address in the Notify field of the Build Manifest, it sends a notification email upon Build Manifest generation.