Configure the notify field and message for the Build Manifest
The Build Manifest lets you configure an email address that will be notified when the build is completed as well as the message that will be sent.
To enable this feature, you configure:
- The SMTP information so that the email can be sent
- The email message sent to the email address
- The target name that is executed to send the email
This information is configured in the IXIA CCMS Output Generator, in the buildmanifest.smtp.properties file. The following code shows the default buildmanifest.smtp.properties file:
#
# 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 may need to support for your smtp mail library
#For example:
bmanifest.smtp.ssl =
#The property value will be expanded at run time to match the destination.
#Also the template can 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 by IXIASOFT
# target name: Ixiasoft.SendEmail or Ixiasoft.SendEmailWithAuthentication
bmanifest.smtp.ant.target = Ixiasoft.SendEmail
You can configure the following properties in this file:Property | Description |
---|---|
bmanifest.smtp.mailhost |
SMTP server that will be used to send the email. |
bmanifest.smtp.mailport |
SMTP port that will be used to send the email. |
bmanifest.smtp.subject |
Subject of the email. |
bmanifest.smtp.from. address |
Address that will be used as the From address when the email is sent. |
bmanifest.smtp.username |
SMTP user name. Specify this property only if authentication is enabled on the SMTP server. |
bmanifest.smtp.password |
Password for the SMTP user name. Specify this property only if authentication is enabled on the SMTP server. |
bmanifest.smtp.ssl |
This section allows you to specify any property that you need for your SMTP mail library or that you can use in the template file. Specify a unique property name starting with
You can enter as many properties as you need. |
bmanifest.smtp.message. file |
Path and name of the file that contains the notification template. By default, the %OutputGenDir%/data/resources/client/notificationtemplate.html file is used. To use another file, specify its path and file name. |
bmanifest.smtp.ant. target |
Target that is executed at the end of the Build Manifest processing. By default, MadCap Software provides the following two targets:
|
To configure the notify field and message:
If an email address is specified in the Notify field of the Build Manifest, a notification email will be sent when the Build Manifest is generated.