Enabling e‑mail notification for scheduled jobs
To enable e-mail notification when a scheduled job in Visualization Platform completes, you must perform the following tasks:
*Modify acserverconfig.xml to configure SMTP.
*Provide the user’s e-mail address in their user profile.
*Indicate that the user should receive an e-mail notification when you schedule a job.
The following topics explain how to perform these tasks.
How to modify acserverconfig.xml
1 .Activate BIRT iHub F-Type by providing a valid activation code.
2 .Stop BIRT iHub by doing one of the following:
*On a Windows platform, stop the BIRT iHub F-Type service.
*On a Linux platform:
1 Change the working folder to /home/server/BIRTiHubFType/BIRTiHub.
2 Execute ./stopiHub.sh.
3 .If you are working on a Windows platform, using Windows Explorer, navigate to AC_CONFIG_HOME. In a default BIRT iHub installation on Windows, performed using the installer, in which the install folder is C:\Actuate, AC_CONFIG_HOME represents the following path:
C:\Actuate\BIRTiHub\BIRTiHub\iHub\shared\config
4 .If you are working on a Linux platform, navigate to AC_CONFIG_HOME. In a default BIRT iHub installation on Linux, performed using the installer, in which the install folder is /home/server, AC_CONFIG_HOME represents the following path:
/home/server/BIRTiHubFType/BIRTiHub/iHub/shared/config
5 .Create a backup copy of acserverconfig.xml. Then, open acserverconfig.xml in a text editor such as Notepad. In acserverconfig.xml, locate the following string:
<SMTPServers/>
Create a child element of <SMTPServers> named <SMTPServer>. Using the following example, provide values for the attributes of the <SMTPServer> element:
<SMTPServers>
<SMTPServer
Name="mailhost.actuate.com"
SenderName="Notifications"
SMTPHostName="mailhost.actuate.com"
SenderAddress="support@actuate.com"/>
</SMTPServers>
The <SMTPServers> element appears in acserverconfig.xml:
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<Config>
<System>
KeyAlias="birtihub"
...
<
UsageAndErrorLogging/>
<
SMTPServers>
<
SMTPServer
Name="mailhost.actuate.com"
SenderName="Notifications"
SMTPHostName="mailhost.actuate.com"
SenderAddress="support@actuate.com"/>
</
SMTPServers>
</System>
Save acserverconfig.xml and exit the file.
6 .Review the email content for completed and failed jobs in this file:
*On a Windows platform:
C:\Actuate\BIRTiHub\BIRTiHub\iHub\shared\config\acnotification.xml
*On a Linux platform:
/home/server/BIRTiHubFType/BIRTiHub/iHub/shared/config/acnotification.xml
If necessary, modify the content in a text editor.
7 .Restart BIRT iHub by doing one of the following:
*On a Windows platform, restart the BIRT iHub F-Type service.
*On a Linux platform:
1 Change the working folder to /home/server/BIRTiHubFType/BIRTiHub.
2 Execute ./startiHub.sh.
8 .If your anti-virus software prevents processes from sending e‑mail, the anti‑virus software may block a notification e-mail. Configure your anti‑virus software to allow processes such as java.exe, ihub.exe, and ihubc.exe to send e‑mail.
How to provide a user’s e-mail address
1 .Log in to iHub Administration.
2 .On Users, left-click the arrowhead next to the user’s name and choose Edit.
Figure 1‑3 Choosing to edit a user
3 .In Email, provide the user’s e-mail address. Choose Save.
Figure 1‑4 Providing a user’s e-mail address
How to indicate that a user should receive an e-mail notification
1 .In Visualization Platform, in the display pane, left-click the arrowhead next to the appropriate file name and choose Schedule.
2 .In Save As, check Send me an email notification.
Figure 1‑5 Enabling email notification
Alternatively, if you use Advanced Scheduling, check Send email notification in the Notification tab. Override user preferences (For all notified users) must be checked.
Figure 1‑6 Enabling e-mail notification
3 .Confirm that the user receives an e-mail containing the URL for the report when the job completes.