Application Note
Device ManageR
Report Generator Plugin
Instructions For Conguring To Run As A Scheduled Task
AVTECH’s Report Generator Plugin, for use with AVTECH’s Device MangeR soware, will allow users to send detailed
reports automatically on a schedule from Device ManageR to an unlimited number of contacts via email regarding
specied Room Alert, TemPageR and sensor devices on the network. is plugin is especially useful with the ‘Scheduled
Tasks’ functionality, however can also be used to send report emails when alerts occur. See the instructions below for
Conguring The Report Generator Plugin To Run As A Scheduled Task
1. Go to the ‘Downloads’ section on the AVTECH website (AVTECH.com/Downloads). Login using the Username
and Password emailed to you when you purchased your Room Alert or TemPageR monitor. Request this online if
needed. Click to download the Report Generator Plugin (purchased separately) onto the host PC that is running
AVTECH’s Device ManageR application software. Follow the download instructions as prompted.
2. The Report Generator Plugin works by using a set of keywords that can be used within your report emails. These
keywords will be replaced by Device ManageR with information regarding the current status of the discovered
devices. Below is a list of keywords and a short description on what they will be replaced with:
» [Keyword] - Description
» [ALERT_COUNT] - Total number of alerts detected.
» [ALERT_COUNT_TODAY] - Total number of alerts detected within the last 24 hours.
» [ALERT_COUNT_THIS_WEEK] - Total number of alerts detected within the past 7 days.
» [ALERT_COUNT_THIS_MONTH] - Total number of alerts detected within the past 30 days
» [ALERT_COUNT_THIS_YEAR] - Total number of alerts detected within the past 365 days.
» [CURRENT_ALERTS] - Number of alerts currently in progress.
» [CONFIGURED_ALERT_COUNT] - Number of alerts currently congured.
» [ALERT_LIST] - List of alerts and their current status.
» [ALL_VALUES] - List of discovered devices and the current values for all connected sensors.
» [CURRENT_VALUES] - List of discovered devices and current values on all connected sensors.
» [CURRENT_TEMPERATURES] - List of discovered devices and the current temperature values on
built-in and connected sensors.
» [TOTAL_DEVICES] - Total number of devices currently discovered.
» [AVTECH_DEVICE_COUNT] - Total number of AVTECH devices that have been discovered
(Room Alert and/or TemPageR).
» [AXIS_DEVICE_COUNT] - Total number of Axis cameras devices discovered.
» [PING_COUNT] - Total number of Pings that have been congured and are currently being monitored.
» [SERVER_IP] - IP address of the host system running Device ManageR.
» [SERVER_PORT] - Port used by the web interface of Device ManageR.
» [DATETIME] – Current date and time on host system running Device ManageR.
AVTECH Software • Phone 401.628.1600 • Sales 888.220.6700 • Support 401.628.1650 • Web AVTECH.com
These keywords can be used in both the subject and body of an email, however it is suggested to only use the
short keywords within a subject (keywords that only return a number instead rather than a list) due to space
limitations. To begin using the Report Generator Plugin you must rst set up a schedule for receiving reports.
3. To create a ‘Schedule’ click on the ‘Alerts/Tasks’ tab in AVTECH’s Device ManageR software. Then click the
‘Add’ button under the ‘Optional Schedules’ section. An ‘Add new Optional Schedule’ screen should pop up.
Name your schedule as desired (e.g.‘Every Day At Noon’, ‘Weekly at 5:00’, etc.), then set the range for the
desired times you wish to receive these reports for. Once this time range is set you can then click on the ‘Copy
To’ drop down to set this same time range for the desired days of the week. Click ‘Save’ to save this schedule.
AVTECH’s Device ManageR (ADM)
Application Software - Alerts / Task Tab
(ADM) - ‘Optional Schedule’ (Day / Time)
4.
Next you will need to make sure that the person who should be receiving these reports is set up as a contact
under the ‘Alerts/Tasks’ tab. Click on ‘Contacts’ –
Add’ and ll in the name and email address for the
> ‘
contact you would like to add. This could also be an alias for a group such as ‘IT Team’. Make sure to set up
each contact separately if more than one contact is desired.
ADM - Add New ‘Contact’
5.
Now that your schedule and contacts are set up, will need to create the action that will send the desired
Report. Click on the ‘Actions’ section under the ‘Alerts/Tasks’ tab, then click ‘Add’. This will take you to
the ‘Add New Action’ screen. Name your new action, add a description if desired, then select the ‘Send
Email Report To Congured Contact’ option from the ‘Action Type’ drop down. Once you have the action
AVTECH Software • Phone 401.628.1600 • Sales 888.220.6700 • Support 401.628.1650 • Web AVTECH.com
type selected, select the contact recipient for this action. If you would like to send a report to more than
one contact, make sure to create separate actions for each contact or use an alias as the contact where the
alias forwards to the desired group of recipients. Click ‘Save’ to save this action.
ADM - Add New ‘Action’
6.
Your Action is now congured with the default settings. This will give you a very good start to your data reporting.
The default email body contains most of the major keywords. You may however, want to update the [CURRENT_
VALUES] keywords for either [ALL_VALUES] or [CURRENT_TEMPERATURES] in order to receive the
information you desire. To do this, click in the email body box and edit your keywords. See a list and add keywords
by clicking the ‘Click To Insert Keyword’ button just below the email body. Click the ‘Test’ button to send a test
report. This will show you what the generated reports will look like with the current conguration.
ADM - Sample Keywords
ADM - Add New ‘Action’ (Click To Insert Keywords)
AVTECH Software • Phone 401.628.1600 • Sales 888.220.6700 • Support 401.628.1650 • Web AVTECH.com
7. The nal step in setting up your Report Generator plugin to send reports on a schedule is to set up your ‘Scheduled
Task’. Click the ‘Add’ button under the ‘Scheduled Tasks’ section. When the ‘Add New Scheduled Task’ screen
pops up, enter a name then select the schedule task you previously set up from the ‘Schedule’ drop down menu.
Click the add button under that section to access the ‘Add Task Item’ screen. Select the created task action from the
drop down and specify the start, repeat and perform action elds. Your nal task item should look like this:
Add New ‘Scheduled Task’
Add Scheduled ‘Task Item’
Click ‘Save’ for this task item then ‘Save’ the Scheduled Task. See sample of the Report Generator output report
below:
Sample Email Report - Corresponding Keywords
Sample Email Report
* If you have feedback on this application note or any AVTECH product, please email to: Feedback@AVTECH.com
** If you need technical assistance regarding the Report Generator Plugin or AVTECH’s Device ManageR (ADM) please contact Technical Support
online at: AVTECH.com
AVTECH Software • Phone 401.628.1600 • Sales 888.220.6700 • Support 401.628.1650 • Web AVTECH.com
Loading...