software user guide - temp°track revf.pdf · sensor reading . . . . . . . . . . . . . . . . . . ....

Copyright © 2011 All rights reserved. Software User Guide Rev.E of 76

Software User Guide

IMPORTANT The TempoTrack™ software (the Software) is provided under a Software Licence Agreement. By opening or using the Software, you agree to this Software Licence Agreement with E2E IT Solutions Pty Ltd. Unauthorised use of the Software and documentation or the related materials can result in civil damages and criminal penalties. Please read through the Software Licence Agreement before proceeding with the Software installation and software activation. If more than one copy of the TempoTrack™ application software is required, please contact your distributor.

N13750

http://www.atcb.com/images/FCC-logo.gif


Contents

Contents 2

1 Starting Temp°Track™ for the first time 4

1.1 Setting preferences for local host or remote client 4

1.2 Setting Administration Rights 6 2 Add New Logger/s, Configure Logger/s, Delete Logger/s 7

2.1 Adding One Logger 7

2.2 Adding and Configuring Multiple Loggers 12

2.3 View New Loggers 13

2.4 Delete Logger/s 14 3 Logger Setup 16

3.1 Initial Logger Setup 16

3.2 General Settings 17

3.3 Sensor Limits Settings 19

3.4 Sensor Timing Settings 19

3.5 Sensor Zone Settings 20

3.6 About – Summary of Settings 20

4 System Setup 21

4.1 General Settings 22

4.2 Display Units Settings 22

4.3 Audible Alert Settings 23

4.4 Command Alert Settings 24

4.5 Email Settings 31

4.6 Email Alert Settings 31

4.7 SMS Settings 34

4.8 SMS Alert Settings 36

4.9 Network Alert Settings 37

4.10 SNMP Alert Settings 38

4.11 Status Report Settings 39

4.12 Reminder Settings 40 5 Real-Time Monitoring 41

5.1 Main Screen Information 41

5.2 Main Screen Menu Bar 42

5.3 Main Screen Functions 43 6 View Events 45

6.1 To view chart of an event 46

6.2 To add and view comments 47

6.3 To close an event 48 7 View Floor Plan 50

7.1 Access Floor Plan Screen 50 7.2 Add/Edit Floor Plan 50

8 View Charts 54

9 Acknowledge Alarms 57 10 Reports 58

10.1 Basic reports 58

10.2 Detailed PDF reports 64

10.3 CSV reports 69


10.4 Generating manual reports 73 11 System backup 75

12 Check for Updates 75 13 Customer Support 76

Preface

This user guide provides step-by-step instructions on how to use the TempoTrack™ application on your PC for the Wireless Battery Powered System.

Before you can use the TempoTrack™ application on your PC, you must install the relevant software and hardware. Please refer to the “Detailed Installation Guide” supplied with your purchase of the TempoTrack™ software for instructions on how to install the application.

Note: All trademarks mentioned or used in this document belong to their respective manufacturers and owners.


1 Starting Temp°Track™ for the first time

By this stage TempoTrack™ is installed, the licence agreement is accepted, and you are now reading the user guide accessed from the Help menu from the main screen.

Note: The TempoTrack™ application supports screen resolution settings from a minimum of 800 x 600 pixels. Set the screen resolution to suit screen size and required display size.

1.1 Setting preferences for local host or remote client a. The following screen appears Unable to contact the server! The user needs to specify server

preferences (server address, port and password).

b. Click on File and Preferences.


c. Select the Server tab and enter the IP address and port of the PC Server. Enter the Server password, then OK. This will enable connection to the server.

d. When the connection is successful, the following screen will appear.


1.2 Setting Administration Rights

Without administration rights, the client software will have “Read Only” capability and will not be able to change any system/logger configuration settings.

a. To log in as an administrator, select Setup and Administrator.

b. The following screen will appear. Enter the administrator password and select OK.

c. New loggers can now be defined.


2 Add New Logger/s, Configure Logger/s, Delete Logger/s

2.1 Adding One Logger

From the main screen, select Setup and Add Logger.

a. The following Add Logger screen will appear. Enter a name for the logger in field ‘Logger Name’. Ensure the name is relevant to the location or application, and a name that will easily identify the logger location. Note: To ensure data integrity, the logger name cannot be changed once the logger has been successfully defined.

Static IP address mode DHCP enabled mode

b. Enter the serial number in field ‘Serial Number’. The serial number can be found on the rear of

the logger, ie. AU000003-OJ.

c. Select ‘Network’ for wireless system or ‘Serial’ for loggers with serial port connection.

d. Enter the Ethernet IP address or host/domain name and the port number of the wireless receiver

in the field ‘Address’ and ‘Port’, ie. 192.168.40.157. The default port number of 47770 is used. If


the wireless receiver is DHCP enabled, enter the serial number of the wireless receiver instead of

the IP address.

e. Select Next. The following screen will appear.

f. Enter a different name for each sensor. Sensors will be referred to by name during real-time monitoring and in all reports and charts. Once the sensor names are successfully entered the sensor names cannot be changed. Examples: Vaccines-Travel, Vaccines-Fluvax, Fridge-Kitchen1, Freezer –Kitchen2, Warehouse1, Bainmarie.

h. Select the type of sensor ie. Temperature, humidity, pressure.

i. Click on Erase existing log data to clear the logger of any old/test data.

j. Select Next. The logger setup screen will appear. Enter the ‘Site Name’ and ‘Site Location’

in the corresponding fields (optional).

k. The software can generate logger specific alarms for No communication, No Mains Power

(emulated) and Low Battery. The default settings are for ‘No Communication’ and ‘Low Battery’


alarms to be generated with ‘Auto-acknowledge’. No Mains Power detection is turned off. Select

the appropriate settings as required.

No Communication Allows the user to enable alarm and alerting messages to be sent when ‘no communication’ is detected with this logger. If the PC software does not receive any communication from the logger within 4 refresh intervals, the logger status is changed to “No Communication” and the status icon will be yellow. The number of refresh intervals before a No Communication alarm is raised can be changed in the System Setup. If no further communications is received from the logger within 10 minutes, the icon will be red. Selecting ‘Auto-acknowledge’ for no communication ensures that when communications returns, the alarm condition closes and the alarm flag is cleared .

No Mains Power

Allows the user to detect no mains power condition and to send an alert message. This mechanism assumes that failure to contact the wireless receiver continuously for 2 mins is caused by loss of mains power to the wireless receiver, and an alert message for No Mains Power will be sent. The wireless receiver should not be connected to a back-up power supply. Note that a continuous loss of IT connectivity for 2 minutes will generate a No Mains Power alarm as well. Select the Emulated by Gateway check box on any one logger connected to the wireless receiver to be “monitored for No mains power” to activate No Mains power detection. If activated on multiple loggers on the same wireless receiver, multiple alert messages will be sent when No mains power is detected.

Low Battery Allows the user to enable alarm and alerting messages to be sent when low battery is detected. Selecting ‘Auto-acknowledge’ for low battery ensures that when the batteries are replaced with fully charged batteries, the alarm condition closes and the alarm flag is cleared. Without ‘Auto-acknowledge’, The user will have to manually acknowledge the alarm to clear the alarm flag.

External Input Allows the user to enable alarm and alerting messages to be sent when an external input trigger is detected. When the external input is set to ‘Normally Open’, a closed contact on the input will trigger the alarm. When the external input is set to ‘Normally Closed’, an open contact on the input will trigger the alarm. The user will have to manually acknowledge the alarm to clear the alarm flag.

l. Select the Sensor Limits Tab. The following screen will appear.


m. Enter the required lower and upper alarm limits for each sensor. Note: The upper limit must be higher than the lower limit.

n. Select the Sensor Timing Tab. The following screen will appear.

o. Select the required in range ‘Log Interval’ and ‘Time of Day’ for each sensor. E.g. if the logging interval is set to log once every 4 hours and the logging time is set to 02:00, the logging will occur at 02:00, 06:00, 10:00, 14:00, 18:00 and 22:00 daily.

p. Select the required out of range ‘Log Interval’ and ‘Alarm Delay’ for each sensor. The out of

range log interval allows the user to log at a higher interval to capture the temperature profile of any alarm event. The alarm delay sets the duration a sensor reading can be out of range before it is considered an alarm condition. This prevents temporary excursions outside the alarm limits from triggering alarm alerts messages.


q. Select the Sensor Zone Tab. The following screen will appear.

r. Each sensor can be assigned a zone (Zone 1 to 8) for alerting purposes. The different zones enable off-line processing of alerting messages to be sent to a different contact person in the event of alarms.

s. The About Tab provides information about the logger. Select Create to create the logger when all logger settings have been set. All logger settings (eg Sensor Limits, Sensor Timing, Sensor Zone) can be changed by selecting Setup, Logger Setup.


2.2 Adding and Configuring Multiple Loggers

To configure additional loggers, the configuration setting of any existing logger can be copied and assigned to the new logger.

a. Select the logger from which the configuration is to be copied. The sensor readings from this logger will be displayed in the main screen.

b. Select Setup, and Add Logger. Type in the logger name and serial number. The IP address and Port used by the selected logger will be copied by default and can be changed as required.

c. Click on Copy compatible settings from selected logger and select Next. The site location and all logger configuration will be copied. Proceed to modify any configuration settings in the General, Sensor Limits, Sensor Timing and Sensor Zone Tabs as required and add the logger.


2.3 View New Loggers

a. The main screen will display the last logger that was added/created.

b. To view sensor reading(s) of another logger, click the logger of interest.


2.4 Delete Logger/s

a. From the main screen, select Logger and from the list of loggers select the logger for deletion.

b. From the main screen, select Setup and Delete Logger.


c. The following screen will appear. Select Yes or No.


3 Logger Setup

Logger setup is used to review/edit parameters for existing loggers. Logger setup includes: Logger site name, site location, network/port address and alarm settings for ‘no

communication’ and ‘low battery’ (“General” screen) Lower and upper limits for the sensors (“Sensor Limits” screen) In range logging interval, out of range logging interval and alarm delay for the sensors

(“Sensor Timing” screen) Sensor zones to enable the forwarding of multiple sensor alerts to various SMS (“Sensor

Zone” screen) Summary of logger settings (“About” screen)

3.1 Initial Logger Setup

From the main screen, select Setup and Logger Setup.

The Logger Settings screen will appear. From this general screen, four other screens can be selected to set, review and edit the various parameters as described.


3.2 General Settings

Enter or change the Site Name and Site Location in the corresponding fields (optional).

l. The software can generate logger specific alarms for No communication, No Mains Power

(emulated) and Low Battery. The default settings are for ‘No Communication’ and ‘Low Battery’

alarms to be generated with ‘Auto-acknowledge’. No Mains Power detection is turned off. Select

the appropriate settings as required.

No Communication Allows the user to enable alarm and alerting messages to be sent when ‘no communication’ is detected with this logger. If the PC software does not receive any communication from the logger within 4 refresh intervals, the logger status is changed to “No Communication” and the status icon will be yellow. The number of refresh intervals before a No Communication alarm is raised can be changed in the System Setup. If no further communications is received from the logger within 10 minutes, the icon will be red. Selecting ‘Auto-acknowledge’ for no communication ensures that when communications returns, the alarm condition closes and the alarm flag is cleared .

No Mains Power

Allows the user to detect no mains power condition and to send an alert message. This mechanism assumes that failure to contact the wireless receiver continuously for 2 mins is caused by loss of mains power to the wireless receiver, and an alert message for No Mains Power will be sent. The wireless receiver should not be connected to a back-up power supply. Note that a continuous loss of IT connectivity for 2 minutes will generate a No Mains Power alarm as well. Select the Emulated by Gateway check box on any one logger connected to the wireless receiver to be “monitored for No mains power” to activate No Mains power detection. If activated on multiple loggers on the same wireless receiver, multiple alert messages will be sent when No mains power is detected.


Low Battery

Allows the user to enable alarm and alerting messages to be sent when low battery is detected. Selecting Auto-acknowledge for low battery ensures that when the batteries are replaced with fully charged batteries, the alarm condition closes and the alarm flag is cleared. Without Auto-acknowledge, the user will have to manually acknowledge the alarm to clear the alarm flag.

External Input Allows the user to enable alarm and alerting messages to be sent when an external input trigger is detected. When the external input is set to ‘Normally Open’, a closed contact on the input will trigger the alarm. When the external input is set to ‘Normally Closed’, an open contact on the input will trigger the alarm. The user will have to manually acknowledge the alarm to clear the alarm flag.


3.3 Sensor Limits Settings

Enter the required lower and upper limits for alarms, for each sensor. Note: The upper limit must be

higher than the lower limit.

3.4 Sensor Timing Settings

Select the required in range Log Interval and Time of Day for each sensor. E.g. if the logging interval is set to log once every 4 hours and the logging time is set to 02:00, the logging will occur at 02:00, 06:00, 10:00, 14:00, 18:00 and 22:00 daily.

Select the required out of range Log Interval and Alarm Delay for each sensor. The out of range log interval allows the user to log at a higher interval to capture the temperature profile of any alarm event. The alarm delay sets the duration a sensor reading can be out of range before it is considered an alarm condition. This prevents temporary excursions outside the alarm limits from triggering alarm alerts messages.


3.5 Sensor Zone Settings

Each sensor can be assigned an alert zone (Zone 1 to 8) for alerting purposes. The different zones enable alerting messages to be sent to a different contact person in the event of alarms.

3.6 About – Summary of Settings

The About Tab provides information about the logger. Select OK to update the logger when all logger settings have been set.


4 System Setup

When Logger Setup is complete, the user can commence System Setup if additional alerting functionality is required. System setup is used to:

Set the refresh interval for the mains powered and/or battery powered systems, and the low battery threshold % (“General” screen);

Set the display units for temperature (°C/°F), humidity, pressure (kPa), CO2 concentration. (“Display Units” screen);

Enable and disable audible alerting, to set the number of times the audible alert is repeated for an alarm, and to select a sound for the audible alert (“Audible Alert” screen);

Command alerting (“Command Alert” screen) Enable and disable email alerts, and to set the recipients of alarm alerts and the frequency

of email alerts (“Email Alert” screen) Enable and disable SMS alerts, and to set the recipients of alarm alerts and the frequency

of SMS alerts (“SMS Alert” screen) Network alerts allows the user to enable external alerting via their own network ports

(“Network Alert” screen) SNMP alerts allows the user to enable external alerting using their own SNMP (Simple

Network Management Protocol) (“SNMP Alert” screen) Set up status reports to enable the forwarding of status reports to people via email at

specific times (“Status Report” screen) Set up reminder to enable the forwarding of reminder messages to people via email at

specific times (“Reminder” screen) Configure email settings – senders email address, outgoing server, username/password

(“Email” screen) Configure SMS gateway settings – SMS username/password (“SMS” screen)

From the main screen, select Setup and System Setup.

From this general screen, twelve other screens can be selected to set the various parameters as described above.


4.1 General Settings

The Refresh Interval allows the user to specify the rate at which real time sensor readings are updated from the logger(s). Note that a quick refresh interval increases the load on the PC and wireless network as the sensor readings are updated more frequently to the PC. For battery powered loggers, the power consumption will also be affected and will reduce the lifespan of the batteries. The Low Battery Threshold setting determines the threshold below which the low battery alarm will be raised. The default setting is 30%.

4.2 Display Units Settings

Allows the user to select the appropriate units for the various sensor types.


4.3 Audible Alert Settings

Allows the user to select the Repeat Limit (and Repeat Interval if more than once) as well as an end of alarm (select Report End of Alarm) audible alert. Audible alert is always enabled for the Server. To enable/disable audible alert for the Client go to File, Preferences from the main screen and select the Audible Alert Tab. The user can select or create a sound file to be played on the PC’s speakers when an alarm has been detected.


4.4 Command Alert Settings

Allows the user to issue Command(s) to be executed when an alarm is detected. This interface allows the TempTrack software to enable offline processing of SMS alerts, interface to paging systems or trigger hardware output(s) for alarm alerts. The command script file name is strictly limited to alpha numeric characters and the underscore character, and must be placed in the Alert Scripts directory within the TempTrack Server data directory. The following parameters can be passed; %t Time %l Logger serial number %s Sensor Port %m Message. The format of the message is TempTrack alarm on Logger “logger name”,

sensor(“sensor number”) “sensor name”. Current Reading: “sensor reading” sensor unit”

%L Logger name %S Sensor name %z Zone

These parameters enable the inclusion of useful information in the alarm alert messages. The user can select the Repeat Limit (and Repeat Interval if more than once) as well as an end of alarm (select Report End of Alarm) Command alert.


4.4.1 Example SMS alert using Traitel command interface.

Alarm notification via SMS is possible through the TraiTel SMS message service. With a valid SMS account the user will be issued a username and password which enables SMS alarm messages to be sent via the SMSSender.exe command.

a. Copy the MultiSMS.bat file from c:\Program Files\TempTrack\Alert Scripts to the Alert scripts directory within the TempTrack Server Data directory (Note: This step is important as the TempTrack Server Data directory stores all system data and will not be overwritten when new software updates are installed). The TempTrack Server Data directory can be accessed by clicking on Start, All Programs, TempTrack as shown below.


b. Right click on the MultiSMS.bat file located in the alert scripts directory and select Edit. The file content is as follows;

:begin C: CD <path to SMSsender.exe directory> smssender.exe userID password phone1 “%1” sleep 5 smssender.exe userID password phone2 “%1” :end

C: CD <path to SMSsender.exe directory>– path to the SMSSender.exe command file which is to be executed. Update according to installed directory path. userID, password – username and password of the Traitel SMS account. Phone1 - mobile number of SMS destination. Format of the phone number is country code (Australia = 61) followed by last 9 digits(less leading 0) of local mobile numbering plan. “%1” - message string “%m” which is to be sent in SMS.

c. In the command line, type in the command to be executed, eg MultiSMS.bat %m %G

The %G parameter filters any non GSM character set in the string specified in %m. “%m” parameter is the default message string to be included in the SMS text message. The example command in the MultiSMS.bat file below smssender.exe userID password 61414123456 “%1” will send the following SMS alarm message to mobile number 0414 123 456.

TempTrack alarm on Logger Immunisation, sensor(1) Fridge 1. Current Reading: 20.4 C


4.4.2 Example Zone SMS alert.

SMS alert messages can be sent to different recipients based on the sensor zones. The sensor zone (1 to 8) can be set from Logger Setup, Sensor Zone Tab.

a. Copy the ZoneSMS.bat file from c:\Program Files\TempTrack\Alert Scripts to the Alert

scripts directory within the TempTrack Server data directory (Note: This step is important as the TempTrack Server data directory stores all system data and will not be overwritten when new software updates are installed). The TempTrack Server data directory can be accessed by clicking on Start, All Programs, TempTrack as shown below.


b. Right click on the ZoneSMS.bat file located in the alert scripts directory and select Edit. The file content is as follows;

:begin C: CD <path to SMSsender.exe directory> if %1 ==1 goto zone1 if %1 ==2 goto zone2 goto end :zone1 smssender.exe username password phonenumber1 %2 goto end :zone2 smssender.exe username password phonenumber2 %2 :end

The example command in the ZoneSMS.bat file above will send an SMS to phonenumber1 if any alarms are detected with Zone 1, phonenumber2 for alarms detected with Zone 2 Edit the batch file as required to define the number of zones and SMS recipient(s) for that zone.

4.4.3 Example Zone Alarm Output on Hardware interface board.

It is possible to trigger up to 8 different hardware output corresponding to the different zones using the K8055 USB Interface board connected to the PC server.


a. Copy the ZoneAlarm.bat script from c:\Program Files\TempTrack/Alert Scripts to the

Alert scripts directory within the TempTrack Server data directory (Note: This step is important as the TempTrack Server data directory stores all system data and will not be overwritten when new software updates are installed). The TempTrack Server data directory can be accessed by clicking on Start, All Programs, TempTrack as shown below.

b. Right click on the Zonealarm.bat file located in the alert scripts directory and select Edit. The file content is as follows;

:begin

C:

CD <path to K8055_multitrigger.exe directory>

if %1 ==1 goto zone123



if %1 ==-4 goto mains_failure

goto end

:zone123

K8055_multitrigger.exe %1

goto end

:mains_failure

K8055_multitrigger.exe 4

:end

The example command in the Zonealarm.bat file above will provide a closed contact output

on port 1 if any alarms are detected on Zone 1, port 2 for zone 2, port 3 for zone 3. It will also

provide a closed contact output on port 4 for zone -4 (mains power failure alarm)

Edit the batch file as required to define the number of zones and it’s corresponding output

port.


4.5 Email Settings

Prior to using any email services, the sender’s email address, outgoing mail server, user

name(optional) and password(optional) needs to be defined. Select the Email Tab and enter

the required information.

4.6 Email Alert Settings


a. Allows the user to issue email alerts when an alarm is detected. The user can select the

Repeat Limit (and Repeat Interval if more than once) as well as an end of alarm (select

Report End of Alarm) Command alert. It can also report if the TempTrack software

application has restarted (select Report Application Restart). Email addresses of multiple

recipients can be typed in.

b. When a new alarm is detected, the following email message will be generated.

a. If repeat alert message(s) have been selected, the following email message will be

generated for ongoing alarms.

f. If Report End of Alarm is selected, the following email message will be generated when

the alarm ends.


g. If alarms are detected on multiple sensors, only one email message will be generated

which will list each sensor that has triggered an alarm.


4.7 SMS Settings

a. Prior to using any SMS services, the sender’s SMS account details (eg user name,

password, API Id) needs to be defined. Select the SMS Tab and create an account with

Clickatell (~$0.08/SMS to Telstra, ~$0.04 to other networks) or BulkSMS (~$0.03/SMS).

b. To create a Clickatell account, click on the web link to the Clickatell website. Choose the

product type : Central API. On successful registration, a username, password, client ID will

be allocated.

c. Create a connection by clicking on the “Click here to create a connection(API UD)” and

select HTTP/S.


d. Select the Replace Leading Zero Check box and click on Submit and Get API ID. The API

ID is required. Note that the Username and password are case sensitive.

e. To create a BulkSMS account, click on the web link to the BulkSMS website. Register an

account with BulkSMS and purchase SMS credits.

Note that the Username and password are case sensitive.

f. The SMS feature allows both BulkSMS and Clickatell accounts to be enabled to provide

redundancy. BulkSMS would be the preferred gateway used to send SMS and Clickatell

would be the fallback gateway if the BulkSMS gateway is unavailable.


4.8 SMS Alert Settings

a. Allows the user to issue SMS alerts when an alarm is detected for alarm Zones 1-8 as well

as for the following logger alarms;

M - No Mains Power

C - No Communications

L - Low Battery

I - Input1

D - Door Ajar

b. The user can select the Repeat Limit (and Repeat Interval if more than once) as well as an

end of alarm (select Report End of Alarm) Command alert. It can also report if the

TempTrack software application has restarted (select Report Application Restart).

c. Phone numbers of multiple recipients can be typed in by separating each number with a

semi-colon.

d. It is also possible to specify different SMS recipients for different alarm zones as indicated

by the example below;

+61414123456\1357* : This will send a SMS alert message to SMS recipient 0414123456

when alarms are detected in Zones 1, 3, 5, 7 and all logger alarms M, C, L, I & D.

+61414123456\1357M;+61400123456\2; : This will send a SMS alert message to SMS

recipient 0414123456 when alarms are detected in Zones 1, 3, 5, 7, & No Mains Power and

to SMS recipient 0400123456 when alarms are detected in Zone 2 only.

e. When a new alarm is detected, the following example SMS message will be generated.

TempTrack alarm on Logger Immunisation, sensor(1) Fridge 1. Current Reading: 20.4 C


4.9 Network Alert Settings

a. Allows the user to contact a network connection once an alarm occurs. The network socket

may be passed a string which can include the identity of the logger and sensor that caused

the alarm, etc.

b. The user can select the Repeat Limit (and Repeat Interval if more than once) as well as an end of alarm (select Report End of Alarm) Network alert.

c. The following parameters can be passed;

%t Time %l Logger serial number %s Sensor Port %m Message. The format of the message is TempTrack alarm on Logger “logger name”, sensor(“sensor number”) “sensor name”. Current Reading: “sensor reading” “sensor unit” %L Logger name %S Sensor name %z Zone %n New line % % symbol These parameters enable the inclusion of useful information in the alarm alert messages.


4.10 SNMP Alert Settings

a. Allows the user to monitor the network for SNMP (Simple Network Management Protocol) traffic and to convey alarm information.

b. The user can select the Repeat Limit (and Repeat Interval if more than once) as well as an end of alarm (select Report End of Alarm) Network alert.


4.11 Status Report Settings

a. Allows the user to issue periodic email status reports. The user can select the Interval.

b. Email addresses of multiple recipients can be typed in.

c. If this feature is enabled, Status Reports of all connected loggers and sensors will be

sent to the email userID’s informing the user of the sensor readings and logger status. An example of an email status report is attached below.


4.12 Reminder Settings

a. Allows the user to issue periodic email maintenance reminder.

b. Email addresses of multiple recipients can be typed in. The user can select the Interval and type in the email message to be sent.

c. If this feature is enabled, a maintenance reminder email will be sent.


5 Real-Time Monitoring

Once configuration of the loggers and the system is complete, the real-time monitoring screen below will appear. It will also appear with subsequent launches of the TempoTrack™ software.

5.1 Main Screen Information

The following information will be shown on the main screen.

New events and Open events

Displays the number of new events and open events currently in the event list. Event List

This is the shortcut to launch the event list. Any new alarms and system events eg low battery, Sensor alarms will be displayed in the event list until the event is closed by the user.

Floor Plan This is the shortcut to launch the Floor Plan. The floor plan allows users to create floor plan(s) and to monitor the status of all loggers from the floor plan.

Logger list and Status All loggers that are connected will be displayed together with a colour coded status indicator.


Sensor Name & Sensor Reading All sensors and the real-time readings will be listed and updated according to the refresh interval set in System Setup.

Time Stamp The time stamp indicates the time and date of the most recently received readings. The description for the different Icons and logger status can be viewed by selecting Help, Icon Legend.

5.2 Main Screen Menu Bar

The menu bar is situated at the top of the main screen real-time monitoring window and provides the user with several options.

Click on to minimise the application into the tool tray. Click on to minimise the window. Note that the application is still running in both instances, until the user selects File and Exit, at which point the application will close.


5.3 Main Screen Functions

a. The File menu provides access to the following features;

View Loggers – Allows the user to view the loggers from any screen. View Events – Allows the user to view all events and the relevant status, time,

duration, source, alarm type and comments, and print and save the event list to pdf for reporting.

Preferences - Allows the user to:- View settings for viewing the sensor chart. The default View Period of 2

weeks will load logged data for the last 2 weeks and the default Zoom Period of 1 day will plot logged data for the last day only when the chart is viewed.

Enable audible alarm alert for the PC on which the Client software is running.

The user can select a sound file to be played when alarms are detected. Define the IP address and port of the PC on which the server software is

running. The server password will also be required to connect to the server.

Exit-Allows the user to terminate the software application.

b. The Logger menu allows the user to select the logger to be displayed where multiple loggers are installed. It also allows the user to select “Show List” which will expand the main screen to list all loggers, and provide of summary of ‘New events’ and ‘Open

Events’.

c. The Chart menu allows the user to view charts for specified sensors. It provides the user with the ability to compare two sensors graphically, print and save charts as pdf documents for reporting. The chart for a sensor can also be launched by clicking on the sensor name in the main screen real-time monitoring window.

d. Ack Alarms allows the user to acknowledge generated alarms. Logger alarms can be

acknowledged individually or by selecting All to acknowledge all alarms. e. The Setup menu provides access to the following features:

Administrator – Provides access to approved users to configure the system. System Setup – Allows the user to :-

Select the Refresh Interval for Mains Powered Loggers, Battery Powered Loggers and the Low Battery Threshold for generating a low battery alarm. Note that a quick refresh interval increases the load on the PC and wireless network as the sensor readings are updated more frequently to the PC.

Select the Display Units for the various sensor types. Enable Audible alert. Enable Command alert Enable Email alert Enable Network Alert Enable SNMP alert Enable Status Report messages to be sent periodically


Enable maintenance email Reminder message to be sent periodically Enable mail server and email account settings for all email features.

Logger Setup – To view and/or edit the logger/sensor configuration setting. Allows the user to update the site name, Site Address, IP address and port number of Ethernet loggers or Ethernet wireless receivers in the software in the event that the logger or wireless receiver is relocated to a different IP address on the network. Add Logger – To add new logger/s Delete Logger – To delete existing logger/s

f. The Help menu provides: Legend for the icons Software version information


6 View Events

Allows the user to view all events and the relevant status, time, duration, source, alarm type and comments.

a. From the main screen, click on Event List or select File and View Events.

b. The following screen will be displayed.

c. Any opened alarm events within the View Period will be displayed. If Closed Events is selected, all events in the event list will be displayed. The event list can be sorted by ‘State’, ‘Start Time’, ‘Logger’, ‘Source’, ‘Event Type’, and ‘Comments’.


6.1 To view chart of an event

a. From the Events screen, double click on the event or select Actions, View Chart.

b. The chart will be displayed and zoomed in on the event. The details of the event will be displayed when the mouse cursor is moved across the chart.


6.2 To add and view comments

a. To add comment/s to an event, double click in the comment column of the event. The

Add Comments screen will appear.

b. Type in the relevant comment in New Comment and select Add Comment. An icon will now appear in the comment column indicating that user comments has been entered for the event.


c. Double click on the icon. The following screen will appear and will show the new comment added to Comment History.

6.3 To close an event

a. From the Events screen, right click on the event and select close event.

b. The following screen will appear showing any comment history.


c. Enter the necessary comments and select Close Event. The event will now be closed (coloured status flag reset) and will be removed from the events list unless the Closed Events flag is set. Only acknowledged events can be closed.


7 View Floor Plan

The Floor Plan tool is a graphical tool designed to assist the user in monitoring their overall system.

To add or edit a floor plan, enable administrator mode (eg select Setup, Administrator).

The Floor Plan tool will allow the user to load an image of the floor plan of their site/s and then

overlay an icon representing each sensor in the system onto the image. The user is able to move the

sensor icons into position. The sensor icons will convey status information for the sensor.

7.1 Access Floor Plan Screen

From the main screen, click on Floor Plan or select File and View Floor Plan. The following screen will be displayed.

7.2 Add/Edit Floor Plan

Select Edit, Add Floor plan. The following screen will be displayed. The Floor Plan Name: field

allows the user to allocate a name to the floor plan which will be displayed on the Tab.


Load a floor plan image by clicking Select and locating the image file in the directory where it is

stored. The types of image files supported are GIF, JPG, PNG and BMP. Images can be created in

Microsoft PowerPoint and saved as a GIF, JPG, PNG or BMP image file.

The floor plan image can be replaced by clicking on Clear to remove the existing image and Select to

load the new image. The image frame background colour can be changed by clicking on Colour. The Sensor image size and Reading font size can be changed by selecting the appropriate size.

Once the image and parameters have been defined, click on OK to proceed.

The logger and sensor list will appear (as below) and the user can now proceed to select and place the

sensor/s of interest on the floor plan. It is a ‘drag and drop’ process to place the sensor/s on the floor

plan.


By default the sensor reading text box appears on the right of the sensor icon but can be placed

anywhere on the floor plan. The text box outline and icon outline will appear in red if the text

box/icon is located outside of the useable image area and needs to be corrected.

To remove a sensor from the floor plan, select the edit floor plan mode, right place the cursor on the

sensor on the floor plan, right click the mouse, and select remove.

Clicking on Edit setup on the logger/sensor list window will return the user to the image

configuration screen where the image, background and sensor/font size can be adjusted. Click on OK

to save the floor plan.


When the mouse hovers over a sensor icon on the floor plan, the sensor name (logger name) will be

displayed together with the sensor reading, upper limit and lower limit.

Multiple floor plans can be created by selecting Edit, Add Floor Plan. A sensor can be displayed on

more than 1 floor plan.

Each sensor is represented on the Floor Plan by a coloured circle. The colour of this circle denotes

the status of this sensor.

Target sensor is editable and can be moved on the floor plan

Grey status of this sensor is unknown – ( no communications )

Orange sensor reading is OOR (Out Of Range).

Red sensor has an unacknowledged alarm.

Green Sensor reading within normal operating limits.


8 View Charts

Over time, large amounts of data will be collected and charting all these data will consume significant processing capacity. The software becomes less user responsive and the data of interest normally resides within the past 2 weeks. The amount of data to be read from the database (View Period) and the actual data to be plotted (Initial Zoom) can be set from the File, Preferences menu. Under the General Tab, the View Period and Initial Zoom settings can be customised as required. The default settings will load 2 weeks worth of data and plots only data logged on the last day, eg chart will zoom in on last day.

a. From the main screen, click on the sensor name or select Chart and the required sensor.

b. The following screen will appear.


c. Logged data for the specified View Period is represented in the blue bar above the chart. This data range can be changed from the Select Range option and selecting the date and period of interest.

d. The Zoom settings can be changed by clicking on the quick zoom buttons, Default, 6hours, 1day, 2day, 1week and All(entire view period). The Zoom settings can also be changed by dragging on the window cursors on the blue bar.

e. The lower and upper limits can be displayed on the chart by selecting Show limits. f. For specific chart data, move the cursor over the data points. The data is displayed for the

selected point.

g. To compare 2 charts, select Compare and select the logger/sensor for comparison.


The chart for the 2 sensors will be plotted.


9 Acknowledge Alarms

Once an alarm is registered (i.e. a sensor has been out of range exceeding the Alarm Delay period), an Alarm flag will appear next to the sensor reading that triggered the alarm. The Alarm flag remains (even if temperature return back within range) until the alarm is acknowledged by selecting Ack Alarms.

a. From the main screen, select Ack Alarms, to acknowledge an alarm. Alarms can be acknowledged individually by selecting the logger or globally by selecting the All alarms option.


10 Reports

The reporting function enables the user to generate reports as required. Basic reports that can be generated are as follows:

Event list can be printed and/or saved as PDF reports. Charts can be printed and/or saved as PDF reports.

Detailed PDF report(s) can also be generated per sensor, per logger, a group of sensors/loggers or for all loggers within a zone. The report content can be configured to include Logger level events, Event comments, sensor data and sensor chart. The report(s) can be generated periodically or manually, and can be saved as a file or sent via email. CSV reports can also be generated per sensor, per logger, a group of sensors/loggers or for all loggers within a zone. The report content can be configured to include one file per sensor or for all data in one file. The report(s) can be generated periodically or manually, and can be saved as a file or sent via email.

10.1 Basic reports

10.1.1 Save Event List as a pdf report

a. To save an event list as a pdf document, from the Events screen, select Actions, Save as

PDF, and either with comments or without comments.


b. The Save screen will appear. Type in a filename and directory to save the pdf document to.

c. The following is an example of the saved pdf report of events.


10.1.2 Print Event List

a. To print an event list, from the Events screen, select Actions, Print, and either with comments or without comments.

b. The following Print screen will appear. Set print options required and print list.


10.1.3 Save Chart as a pdf report

a. To save a chart as a pdf document, from the Sensor screen, select File, Save as PDF, and either With Data or Without Data.

b. The Save screen will appear. Type in a filename and directory to save the pdf document to.


c. The following is an example of the saved pdf chart report.


10.1.4 Print Chart

a. To print a chart from the Sensor screen, select File, Print, and either With Data or Without Data.

b. The following Print screen will appear. Set print options required and print chart.


10.2 Detailed PDF reports

Detailed report(s) can be configured. The report format is as follows;

Report Name, User to define

Reporting Interval, User to define

Optional field, User selectable

Sensor Name, Logger name of sensor selected

for inclusion in report

Optional field, User selectable

Optional field, User selectable – no. of data points displayed

Optional field, User selectable, no. of events displayed


a. To configure report(s) select File, Reports.

b. The following screen appears;


c. Click on Setup and select Add Report, Basic (PDF) (Log in as administrator if not in admin mode). Under the General Tab, the following parameters can be set:-

Name : This string will be printed as the title on the report

Enabled Enable or disables the automatic report generation feature

Interval Defines the period for the automated reports. User selectable from 1, 2,

3, 4, 6, 8, 12 hours, 1, 2 days, 1, 2, 4, weeks, 1 month.

Offset Defines the time offset for the reports.

For interval setting of hours and days, the offset can be set from

Midnight and every hour thereafter. Data included in the report will

start from this time, eg if Interval of 1 day and offset from 1.00am is

selected, the report will contain any data logged starting from 1.00am

for 24 hours.

For interval setting of Week(s), the offset can be set to any day of the

week. Data included in the weekly report will start from this day, eg if

interval of 1 week and offset from Monday is selected, the report will

contain all data logged starting from Monday to Sunday.

File Output Specifies the location where the report will be stored. If the Use default directory check box is selected, the report will be stored as a file in the

TempTrack Reports directory on the TempTrack Server.

Email Recipients Specifies the recipients of this automated email report.


d. Click on the Options Tab. The report generated will always contain any new events during the reporting period. The report can be customised to include the following information by selecting the check box:-

Show Logger events Report will include logger level events eg, Low battery.

Show Sensor events Report will include sensor events eg, sensor limits exceeded

Show Sensor chart The chart will be included in the report.

Show Sensor data All logged sensor data during the reporting period will be included in

the report

Show comments Comments for all Logger and/or sensor events will be included in the

report.


e. Click on the Sensors Tab. The report can be configured to include all loggers within 1 or more zones by expanding on the zone tree and selecting the zone(s) of interest. Alternatively, the report can be configured to include any logger or sensor by expanding on the Logger tree and selecting the logger(s) or sensor(s) of interest.

f. Click on OK when all selections have been made. This new report configuration will now be added to the main Reports page with the reporting schedule displayed.


10.3 CSV reports

a. CSV reports can be configured by selecting File, Reports. Click on Setup and select Add

Report, Sensor Data (CSV). Under the General Tab, the following parameters can be set:- Name : Used to create the directory name where the CSV report will be stored.

Also used to create the file name if a single file output option is

selected.

Enabled Enable or disables the automatic report generation feature

Interval Defines the period for the automated reports. User selectable from 1, 2,

3, 4, 6, 8, 12 hours, 1, 2 days, 1, 2, 4 weeks, 1 month.

Offset Defines the time offset for the reports.

For interval setting of hours and days, the offset can be set from

Midnight and every hour thereafter. Data included in the report will

start from this time, eg if Interval of 1 day and offset from 1.00am is

selected, the report will contain any data logged starting from 1.00am

for 24 hours.

For interval setting of Week(s), the offset can be set to any day of the

week. Data included in the weekly report will start from this day, eg if

interval of 1 week and offset from Monday is selected, the report will

contain all data logged starting from Monday to Sunday.

File Output Specifies the location where the report will be stored. If the Use default directory check box is selected, the report will be stored as a file in the

TempTrack Reports directory on the TempTrack Server.

Email Recipients Specifies the recipients of this automated email report.


g. Click on the Options Tab. The following output options can be selected;

Single file All data will be stored in a single file with the file naming convention [Report

name timing interval.CSV], eg if Report name is Hourly CSV output and

timing interval of 1 hour is selected, file name is Hourly CSV output

yymmdd_hhhh.csv. If Report name is Weekly CSV output and timing interval

of 1 week is selected, File name is Weekly CSV output yymmdd.CSV

The file format is as follows;

timestamp logger sensor value process active

low threshold high threshold


dd/mm/yyyy hh:mm

Logger 1 serial no.

sensor no., 1

sensor reading

Process active or inactive

lower limit higher limit

Logger 1 serial no.

sensor no., n

sensor reading



. . . . . . .

. . . . . . .

. . . . . . .

dd/mm/yyyy hh:mm

Logger x serial no.

sensor no., 1

sensor reading



dd/mm/yyyy hh:mm

Logger x serial no.

sensor no., n

sensor reading



File per sensor All data will be stored in a single folder with the folder naming

convention [Report name timing interval.zip], eg if Report name is

Hourly CSV output and timing interval of 1 hour is selected, folder

name is Hourly CSV output yymmdd_hhhh.zip. If Report name is

Weekly CSV output and timing interval of 1 week is selected, Folder

name is Weekly CSV output yymmdd.CSV

The data for each sensor is then stored in the file

loggername_sensornumber.csv.

The file format is as follows;

timestamp logger sensor value process active

low threshold high threshold

dd/mm/yyyy hh:mm

Logger serial no.

sensor no.

sensor reading 1



dd/mm/yyyy hh:mm

Logger serial no.

sensor no.

sensor reading 2



. . . . . . .

. . . . . . .

. . . . . . .

dd/mm/yyyy hh:mm

Logger serial no.

sensor no.

sensor reading n



h. Click on the Sensors Tab. The report can be configured to include all loggers within 1 or more zones by expanding on the Zones tree and selecting the zone(s) of interest. Alternatively, the report can be configured to include any logger or sensor by expanding on the Logger tree and selecting the logger(s) or sensor(s) of interest.


i. Click on OK when all selections have been made. This new report configuration will now be added to the main Reports page with the reporting schedule displayed.


10.4 Generating manual reports

a. Open the Reports screen by clicking File, Reports. Select the report to generate manually

b. Select Setup, Generate Report.


c. The following screen appears.

d. Click on the Time range drop box and select the period of interest to report. Select the Output options. As defined in report(s) generates a report according to the report configuration eg as email to predefined recipients or as file to the TempTrack Server Report location, Save to disk generates report to a file stored in the default client report location or to a user specified location using the Choose... option.


11 System backup A system backup is generated every 24 hours at the time set in the options.txt file. backupTime=hh:mm, where hh =0-24, mm=0-59 The backup file is Backup/Backup.zip and contains all files in the server data directory except: - Backup and Reports directories - All *log.txt, *.log, *.bak and *RetryQueue.dat files Should the backup fail to be created for any reason, up to two retries will be attempted (5 minutes apart). The backup generation should be coordinated with an external backup regime where the back-up folder is saved remotely so that the system can be restored in case of PC/server corruption.

12 Check for Updates

To check for software updates for potential fault fixes or minor functional improvements, click on Start menu, All Programs, TempTrack and select Check for updates. The software will then search the internet for any updates applicable. Click on Next to download the updates and follow the screen instructions to install the update.


13 Customer Support

For assistance with the installation and/or use of Temp°Track™, please contact us.

Address

E2E IT Solutions Pty. Ltd. Unit 19, 3 Westside Avenue, Portside Business Park, Port Melbourne, Victoria 3207 Australia

Telephone

+61 3 96819118

Email

[email protected]

www

www.temptrack.com.au

mailto:[email protected]?subject=TempTrack%20Technical%20and%20Product%20Support

http://www.temptrack.com.au/

software user guide - temp°track revf.pdf · sensor reading . . . . . . . . . . . . . . . . . . ....

Documents