Manual de Ingenieria 963
Manual de Ingenieria 963
Manual de Ingenieria 963
Manufactured for and on behalf of the Environmental & Energy Solutions Division of Honeywell Technologies Srl,
ZA, La Pice, 16, 1180 Rolle, Switzerland by its Authorized Representative, Trend Control Systems Limited.
For information contact:
Trend Control Systems Limited
Albery House
Springfield Road
Horsham
West Sussex
RH12 2PQ
England
NOTICE: Trend Control Systems Limited makes no representations or warranties of any kind whatsoever with respect
to the contents hereof and specifically disclaims any implied warranties of merchantability or fitness for any particular
purpose. Trend Control Systems Limited shall not be liable for any errors contained herein or for incidental or
consequential damages in connection with the furnishing, performance or use of this material. Trend Control Systems
Limited reserves the right to revise this publication from time to time and make changes in the content hereof without
obligation to notify any person of such revisions or changes.
Windows is a trademark of Microsoft Corporation. BACnet is a trademark of ASHRAE. The Java Runtime
Environment (JRE) is a product of Sun Microsystems, Inc.
Please send any comments on this or any other Trend technical publication to techpubs@trendcontrols.com
About This Manual
TABLE OF CONTENTS
1 ABOUT THIS MANUAL ............................................................................................................................... 13
1.1 Conventions Used in this Manual .............................................................................................................. 13
1.2 Contacting Trend........................................................................................................................................ 14
INDEX...................................................................................................................................................................... 377
3 ABOUT 963
963 is a Windows based software package designed to provide a complete management interface for the supervision
of buildings where IQ system building control systems are installed. It enables the user to monitor HVAC
equipment/building services, and make changes to the way the building is controlled using colour graphics displays.
Fault reporting, analysis, and data recording features promote efficient HVAC equipment operation and effective
energy use.
The information and adjustments available to a user can be exactly tailored to that users needs. This means that an
operator is never presented with more data or options than he requires, thus eliminating a major source of potential
confusion. However, for those whose job function demands it, access can be provided to every point on the BMS.
It provides features such as strong passwords, and calculation of mean kinetic temperature that assist with compliance
to the FDAs regulation 21 CFR Part 11.
There are four different variants of 963 each offering slightly different features for individual types of users.
963 Lite
963 Lite is the basic variant of 963 and provides the ability for monitor an IQ system, make adjustments, and
monitor alarms.
963 Server
963 Server provides exactly the same facilities as 963 Lite but allows information to be accessed over a
TCP/IP network, with a web browser.
963 SMS Direct
963 SMS Direct provides features of as 963 Lite, or 963 Server if the server version is licensed. In addition,
it provides the ability to retransmit alarms to a GSM phone using SMS text messaging. To use 963 SMS the
personal computer running 963 must be connected to the supplied GSM modem.
963 SNMP
963 SNMP provides features of as 963 Lite, or 963 Server if the server version is licensed. In addition, it
provides the ability to retransmit alarms in SNMP format.
The version of 963 is determined by the licence that is purchased. The different versions can be purchased in
conjunction with each other with exception of 963 Lite, and 963 Server, i.e. it is possible to have 963 Lite with SMS.
All variants of 963 are compatible with the Trend Open Protocol Server (TOPS) which enables 963 to communicate
with BACnet devices.
3.1 963 Lite
963 Lite is the basic version of 963 and provides the ability to monitor an IQ system, make adjustments, and monitor
alarms. It provides features such as strong passwords, and calculation of mean kinetic temperature that assist with
compliance to the FDAs regulation 21 CFR Part 11.
Schematic Page Display
The Schematic Page Display provides information in a graphics form, allowing the user to view information and
make adjustments to HVAC equipment or control parameters simply by clicking the mouse button. Other actions such
as data recording or the display of graphs can also be initiated from a schematic page. Each page can include text,
buttons, and graphics to ensure that the display is easy to understand. 963 also has a built in web browser that enables
any HTML, or web page to be displayed, this facility can be integrated with the schematic pages to increase the amount
of information available to the user e.g. CCTV etc.
Access to Entire IQ System
Access to the devices on the IQ network is available from the Device Viewer which display enables inputs, outputs,
adjustments, time zones, and critical alarms from the selected part of the system without the need for any engineering.
Adjustments can be made, and graphs accessed from this display enabling the engineer to adjust system parameters
not available on schematic pages quickly and easily.
Alarm Handling
The 963s advanced alarm handling facilities process incoming alarms and decides what action is to be taken, ensuring
immediate notification of alarm conditions. Different actions can be taken on receipt of an alarm. Alarms can be
displayed in the Alarm Viewer, categorised, logged, and retransmitted e.g. using email, pager, or SMS.
Control of Operating Times
System operating times can be defined using the Diary Display. It easily handles both large and small systems,
automatically downloading the occupation times to different areas, allowing different working areas to use different
operating times. The facility for global setting of holidays and non occupation allow particular days to be easily set
up to operate different times from the standard.
Data Recording
Data logged in IQ controllers can be recorded to an SQL Server database for long term review. Recording can be
carried out manually, or automatically to ensure that data is regularly recorded. It is also possible to record the live
data from a schematic page automatically.
Compatibility with TOPS
963 can be used in conjunction with the Trend Open Protocol Server (TOPS) to provide the usual 963 functionality
plus communications with BACnet devices. Values from BACnet devices can be included in schematic pages,
adjustments made, and alarms received from the BACnet devices.
3.1.1 Schematics
Schematics provide the main interface between the user and the IQ system in the form of colour graphics displays that
enable the user to look at HVAC equipment parameters, or make adjustments. Each schematic page can display values
and parameters obtained from one or more IQ system devices on the system along with graphic representations of the
building/HVAC equipment etc. that they come from.
Each page can contain a backdrop, which is a graphic over which all the other objects are displayed. Live values from
the IQ system are included by adding a dynamic object to the page, and other information such a static text, and
graphics are added by inserting static objects.
Dynamic objects can be represented on the pages, either as text, or as a graphic (using analogue graphic files). When
the object is displayed as text, if the user has the authority to make an adjustment, or the parameter can be graphed the
text will appear as a button to indicate that the object can be selected.
Static objects enable text, and graphics to be displayed on the page. They can also allow the user to perform a particular
action such as go to another page, log in, or enter configuration mode on a particular controller. If they have been
configured in this way, they will also appear as a button to indicate that the object can be selected.
System variables such as date and time can be included on the page by using variables in the codes that defined the
objects on the page. It is also possible to include a map of a particular LAN or the internetwork in a similar way.
Movement between pages can be performed either using button on the page, or using the Navigator which displays a
tree structure that enable the user to navigate to all the pages that have access to.
3.1.2 Alarm Handling
963s alarm handling receives alarms and other error indications from other devices on the IQ system, and internal
alarms from itself and deals with them according to the way in which the alarm handling has been configured. When
the 963 receives an alarm it can log the alarm, print it out, and perform a particular action. The action taken can be
different for users viewing the alarm on the 963 itself, or from a web browser.
Alarms from other devices are generated when a device that has been configured to send its alarms to the 963 goes
into an alarm condition or an alarm condition is cleared. An internal alarm occurs when something occurs on the 963
that is worth noting. It may be something normal such as a user has logged on, or it could indicate that data recording
has failed, or an adjustment that effects the way in which 963 operates has been made.
When the 963 receives an alarm either from another device, or an internal alarm is generated it uses filters to catch
alarms, each filter contains a definition of the alarms it will catch. Each filter is then assigned to the groups that specify
the actions that are to be carried out when the alarms caught by the filter occur. Filters can be associated with more
than one group, allowing several different actions to be triggered by the same alarm. Alarms that are not caught by
any filter will cause the actions defined in the Default Alarm Group to be carried out.
The diagram below illustrates what happens when 963 receives an alarm.
The diagram below illustrates what happens when 963 receives an alarm.
An alarm sent to 963 is received by 963s comms handler (TCCOMSRV), which sends the alarm to its alarm buffer
(alarmbuf.x). Once this has been successfully completed, the comms handler sends a low-level acknowledgement to
the controller to tell it that the alarm has been received.
Once this has occurred, the alarms are read from the comms handlers alarm buffer by 963s alarm handler, and
displayed in the Incoming Alarms list in the Alarm Viewer.
When the alarms have been displayed in the Incoming Alarms list in the Alarm Viewer they are placed in the alarms
handlers buffer (dbbuf.x) until they can be processed.
At this point, if the alarm handling has been disabled, i.e. the Check this box to perform alarm actions and display
alarm panels check box is cleared, no further action will be taken. If alarm handling is enabled; which is normally
the case, the alarms will be processed as quickly as possible. The alarm handler will take each alarm from buffer and
process it before moving on to the next one. Once the alarm has been processed, it will be visible in the Alarm
History.
If alarm logging is enabled, i.e. the Check this box to log alarm to the database check box selected, the alarm will
be stored in the database before the further alarm processing is performed.
Next, the alarm is then matched against all the filters that have been set up. If any matches are found the actions
defined for each of the groups associated with the filters that caught the alarm will be carried out. If an alarm group
has more than one filter associated with it if any one of the filters catches an alarm, the actions defined by the group
are carried out.
If the alarm is not caught by a filter it will be caught by the default alarm group, and the action defined carried out.
3.1.3 Users and Workgroups
Access to 963 is controlled by users and workgroups. Users enable 963 to provide different information to different
users, and prevent unauthorised people from accessing certain information, and making changes to the system. Every
person who is to use 963 must have a user name and password.
The 963 is shipped with a two users 'System Administrator' and 'Default'. The 'Default' user is logged onto the system
when all other users have logged off, timed out, or the 963 is run. When the 963 is first installed this user has limited
access. The first time 963 is run the 'System Administrator' user is created in the 'System Administrator' workgroup.
This user has access to everything.
A password is not required to log in as the 'Default' user. The password generated for the 'System Administrator user
is generated randomly.
The page displayed when the 'Default' user is logged on is very important because it is the page displayed when no
one is using 963. This page should allow each user to log in. It may also provide information such as the temperature
in the location of 963, or perhaps the date and time.
Each user of 963 is in a workgroup. The workgroup specifies the users access rights. It determines what displays the
user has access to, and what they can change. It also specifies a PIN level, which is used to decide if they have access
to objects on a page, or values on the Device Viewer. This PIN level is compared with the PIN Level of objects on a
page (static objects, or dynamic objects, or values on the Device Viewer). If the users PIN level is equal to or greater
than the PIN attribute of the object or parameter they will have access to the object. In the case of static objects this
means that the object is visible to the user, in the case of dynamic objects, and values on the Device Viewer the user
can adjust them. Initially the PIN attribute of dynamic objects and values on the Device Viewer come from the
controller. The PIN attribute of dynamic objects can be edited as required, but if the PIN attribute of values on the
Device Viewer is changed; their value in the controller strategy is changed.
Another level of security is the ability to restrict the access to top-level folders to particular users. This means that
pages of sensitive information can be hidden from those who should not or do not need to access them.
These two things prevent users from seeing or changing information for which they do not possess authority. PINs
(users) in the controllers give another level of protection. These are set up in the controllers themselves, and are used
to prevent unauthorised changes to parameters within the controller. Any device (such as 963) wishing to adjust data
in a controller set up with its own PINs (PIN protection enabled) must know the 4 digit PIN. It is therefore necessary
to tell 963 what this PIN is. Although it can be specified individually for each device on the system, most sites will
normally share a common PIN in the controllers.
There are three different approaches to configuring users and workgroups; a different user can be created for each
person who is going to use 963, for each top-level folder, or for each type of use. Whatever approach is taken, it is
recommended that the number of users with configuration rights be kept to a minimum (i.e. 1 or 2).
To ensure that details of users etc remain secure, only users with System Administrator access rights are able to
make any changes to users on the system. Details of passwords etc are encrypted to ensure that even if someone
accesses the password storage location they will be unable to understand the password information.
963 maintains an audit trial of changes that are made which effect system performance; it records who made the
change, what the change was and when it occurred. This auditing cannot be turned off, and the events can be
configured to generate an alarm action to ensure that an attempt to breach of security does not go undetected. The
table below lists the events that are recorded in the audit trail.
Area Event Logged
Alarm Filters Adding, removing and editing.
Alarm Groups Adding, removing and editing.
Automatic data recording Any automatic data recording function also raises events on success and failure.
Diary Downloads Automatic downloads.
Exceptions Adding, removing and editing.
IQ parameters Changes through the 963-user interface.
Normal times Adding, removing and editing.
Program Start up, and shutdown.
Retransmission Adding, removing and editing.
Scheduled action Adding, removing and editing
Security Logging in, logging out, when a user is locked out an alarm is reported.
Site, LAN, Controller or Item. Deleting and editing.
Diary groups Adding, removing and editing.
Users Adding, removing and changing the password.
Workgroups Adding, removing and editing.
Note that changes made in the IQ configuration through 963 are not logged. Configuration mode can be disabled by
the System Administrator. The controllers themselves can raise alarms when users make changes.
To ensure maximum security it is recommended that the PC running 963 be configured prevent unauthorised access
both to the PC, and files on it using standard Windows security features. This is described in the Configure Windows
Security section of this manual.
3.1.4 Mean Kinetic Temperature Calculation
The Mean Kinetic Temperature (MKT) is defined as the isothermal temperature that corresponds to the kinetic effects
of a time-temperature distribution. It is used to monitor the average temperature of drugs whilst being stored in the
pharmaceutical industry. The calculation of MKT by 963 can be performed using one of two 963 actions either on a
scheduled basis, or on demand. The following formula is used for the calculation.
In order to perform the calculation the sensor must be logged in the IQ controller and the data must be recorded by
963. If the data recorded by 963 is not complete e.g. only the last 4 days of readings are available, or there is a gap in
the data, the MKT will not be calculated and an alarm (MKFL) will be raised. 963 cannot detect if data has been lost
due to the controller being turned off and the MKT will be calculated using the available data and an alarm is not
generated. If the calculation is performed correctly an MKOK alarm is generated.
Note that the action is only compatible with data logged in the IQ controller using synchronised logs.
The virtual sensor used to store the result of the calculation can either be specified manually, or you can allow 963 to
choose it. The virtual sensor has High and Low Alarm Limits that enable an alarm (HMKT, and LMKT) to be
generated if the MKT value is outside the required range. The high and low alarm limits are tested against the new
MKT value when the scheduled MKT calculation is executed. If the MKT value is found to exceed the alarm limits
an alarm is triggered.
Once a scheduled MKT action has been executed the result it can be viewed in the Device Viewer or placed upon a
schematic page.
On Demand MKT Calculations
In order to calculate the MKT in this way, a static object on a schematic page must be set up to perform the
CALCULATEMKTDATE action when it is selected. This action calculates the MKT for the specified sensor
between two dates. The calculated value is displayed in a message box. The action never writes the value to a database.
If any parameters are left out of the action, 963 will ask the user for the parameters when the action is executed.
In order to perform the calculation the sensor must be logged in the IQ controller and the data must be recorded by
963. If the data recorded by 963 is not complete e.g. only the last 4 days of readings are available, or there is a gap in
the data, the MKT will not be calculated and an alarm (MKFL) will be raised. 963 cannot detect if data has been lost
due to the controller being turned off and the MKT will be calculated using the available data and an alarm is not
generated. If the calculation is performed correctly an MKOK alarm is generated.
Note that the action is only compatible with data logged in the IQ controller using synchronised logs.
The result of an on demand MKT calculation can also be displayed as part on a schematic page by using the
CALCULATEMKTDATE variable in the To Display attribute. The calculation will be recalculated every time the
schematic page is reactivated.
3.2 963 Server
963 Server provides exactly the same facilities as 963 Lite plus the ability to act as a web server enabling a client to
display information from the 963 in a web browser. When viewing a page in a web browser, the user may make
adjustments, view graphs, move from page to page, enter configuration mode on a device, make changes to Diary
groups, or carry out other actions in a similar way to working on the 963 itself. The 963 allows full client-server
operation. This means the 963 can provide information to a number of client machines over a TCP/IP network.
When operating as a server, the 963 automatically converts the information and passes it to the client machine for
display in a web browser when requested. This means that no additional engineering is required to provide the benefits
of the 963 across the business. Client machines do not require any additional software to be installed, providing they
have a connection to a TCP/IP network, and a web browser installed.
963 Server operates in two modes, graphic mode and text mode depending on the type of web browser accessing the
server. Graphic mode requires Microsoft Internet Explorer version 8 greater, or Firefox 3.5 or greater, and the Java
runtime environment J2SE 7.0 or greater. The browser must have JAVA script enabled. Other browsers are only able
to access the server in text mode. The server can be accessed from web browsers on PCs, PDAs (running Windows
Mobile 2003 Second Edition or greater), Smartphones (running Window Mobile 5 or greater), and the Nokia 9210i
although full client functionality is only available on PCs that meet the requirements for graphic mode. Other devices
are only able to use text mode.
Note that the 963 has not been tested with all devices and Trend cannot guarantee a particular devices compatibility
with the 963 server.
Schematics
The schematic display enables access to any of the 963s schematic pages subject to their security. When in graphics
mode they will appear virtually the same on the client as they do on the 963 server. There is no Navigator on the
client; navigation must be provided through buttons engineered directly on the pages.
In text mode graphics are not displayed, the page is reproduced as 3 tables containing live data (dynamic objects),
actions, and additional information (static objects). There are a number of different text mode layouts to allow for
different device types. The appropriate layout for the client device is automatically selected. Each layout provides the
same functionality, but data displayed varies to accommodate different screen sizes and aspect ratios.
Alarm Viewer
The Alarm Viewer is only available in graphic mode, it displays the alarms that have been received, and providing
the user has authority enables them to be acknowledged. Colours are used to indicate whether the alarm is a set alarm
or a cleared alarm. A red bell indicates a set alarm, and a green bell indicates a cleared alarm. If the alarm has been
actioned a bell with appear with a tick over it. Alarms can also cause an alarm panel to be displayed on the client PC
to draw the user's attention to the alarm.
It has two tabs: Alarm History, and Incoming alarms. The Alarm History stores the all the alarms in the database
that have been processed whether or not they have been actioned by the user. The alarms can be viewed in
chronological order or a summary view. The Alarm History is colour coded to indicate whether or not the alarm is
current, red indicates that the alarm is current. The Incoming Alarms contains the last 100 alarms received.
The Device Viewer
The Device Viewer is only available in graphic mode, it displays all inputs, outputs, adjustments, and occupation
times on the system that have been learnt. This information can be restricted to parameters in a particular device, LAN,
or site. Changes can be made to any of the adjustments or occupation times if the user has the correct authority. These
changes are limited by a PIN level, which is the same as that defined for the parameter in the device itself. Single trace
graphs of selected parameters can be displayed. It also provides access to the configuration mode of IQ system devices
that support that feature.
Note that it is not possible to learn the system from a client.
Graphs
When operating in graphics mode graphs can be displayed from buttons on schematic pages or from the Device View
in the same way as on the server. When operating in text mode a table of the graphs values is displayed instead.
System Security
The 963s security system is fully implemented users when accessed from a client users are required to login in which
determines their level of access to the system.
For more detailed description of how 963 Server provides information to clients see the Server Operation section of
this manual.
3.2.1 Server Operation
963 Server operates as a web server making the information on its schematic pages available in HTML format over a
TCP/IP network. This means that the information can be accessed by any web browser from anywhere in the world
(using the Internet), providing 963 and the Ethernet network to which it is connected have been configured
accordingly.
When a client accesses the 963 Server, the server will either display the index.htm page, or prompt for the user to
login (depending on how the server has been engineered). If the page that is displayed contains values from the IQ
system, 963 will request those values. When they are available, they will be passed to the client where Java applets
downloaded from the server will replicate any dynamic objects on the page.
A managed device is a network node that contains an SNMP agent and that resides on a managed network.
Managed devices collect and store management information and make this information available to NMSs
using SNMP. Managed devices, sometimes called network elements, can be routers and access servers,
switches and bridges, hubs, computer hosts, or printers.
An agent is a network-management software module that resides in a managed device. An agent has local
knowledge of management information and translates that information into a form compatible with SNMP.
An NMS executes applications that monitor and control managed devices. NMSs provide the bulk of the
processing and memory resources required for network management. One or more NMSs must exist on any
managed network.
The 963 behaves as an agent.
There are 4 basic commands used to pass data between the agents, devices and NMSs: 'read', 'write', 'trap', and
'traversal'.
The 'read' command is used by NMSs to read specific data from a device.
The 'write' command is used by NMSs to adjust specific data in the devices.
The 'trap' command is used by agents and devices to send events to NMSs.
The 'traversal' command is used by NMS to discover details about the devices.
The 963 only supports the trap command i.e. it may not be interrogated by NMSs (it cannot respond to SNMP
commands).
Note extended character sets are not supported.
For answers to frequently asked questions about 963 SNMP see the 963 SNMP Information Sheet (TG200929).
3.5 Compatibility
IQ System: 963 can display all devices on the IQ System connected using Lans, internetworks, autodialled links, and
TCP/IP links in the Device Viewer. It provides access to all parameters in all IQ system devices that support text
communications. Parameters within other 963 supervisors engineering tools and network displays are inaccessible.
IQL controller parameters can be accessed using a 3xtend/EINC L, fieldbus device parameters can be accessed using
an FNC. It can communicate over IQ system LANs and internetworks including remote TCP/IP sites, autodialled links
(PSTN) or digital networks (PSDN). It will not operate on network running at 1k2 or 4k8 baud rates. Graphs are
available from IQ controllers, and TOPS devices, however there are some limitations on the graphs that are available
see the table below for details.
4 SECURE 963
4.1 Introduction
The purpose of the Security Manual is to provide the information necessary for those involved in the installation and
maintenance of a product or system to understand the requirements for configuring and managing the security of the
product or system
4.2 Disaster Recovery Planning
When developing the disaster recovery plan ensure that it includes ALL data required to restore system operation. A
typical 963 installation consists of both configuration data and historic data:
Configuration data is held in the 963 database and also in the form of: schematic pages; graphics,
animation, script and analogue text files, INI files. All configuration files can be found in the current 963
project directory with the exception of the 963 database which may be configured to a separate location
(remote SQL server).
Historic data, consisting of alarms and controller log values, is stored in the 963 database and potentially
local archive data files.
For more information on database backup/restore refer to the following:
963 User Guide (TC200635)- Backup the Database
963 User Guide (TC200635)- Restore a Backed up Database
4.3 Physical and Environmental Considerations
The PC running 963 should be secured against unauthorised physical access.
4.4 Security Updates and Service Packs
Ensure the PC running 963 and any client devices have the latest operating system updates installed, and the latest
version of 963 is being used.
Trend software is tested against the latest service packs and updates applicable at the time of release. For significant
operating system and Java updates / service packs, please check the Trend Partners web site:
https://partners.trendcontrols.com for any compatibility issues.
4.5 Virus Protection
Ensure the PC running 963 and any client devices are running virus protection software, and the virus definitions are
kept up-to-date.
Some virus protection software has been shown to have an adverse impact on the performance of 963. In such cases
request that the 963 directory be excluded from on-access scan.
Further details can be found on the Trend Partners web site: https://partners.trendcontrols.com
4.6 Network Planning and Security
If 963 is to be connected to an Ethernet network follow the guidelines in the 'General Security Best Practice for Trend
IP Based Products Information Sheet' (TP201331).
It is recommended that the Ethernet network used by the BMS system is separated from the normal office network
using an air gap, or virtual private network. Physical access to the Ethernet network infrastructure must be restricted.
You must also ensure that the installation complies with your companys IT policy.
For any 963 installation the use of a Firewall and Intrusion Detection System (IDS) from a reputable provider of
security products is recommended. Follow best practice for the products chosen as well as any corporate IT policy
where the installation is made. Lock down the products to the particular port youve configured for 963 HTTPS and
HTTP (see Engineering Manual 4.18 Configure Web Server Settings).
4.7 Virtual Environments
Follow best practice for the products chosen as well as any corporate IT policy where the installation is made. Refer
to the installation instructions for details of Virtual Environments tested with 963.
4.8 Securing Wireless Devices
If a wireless network is being used it must be secured according to your companys IT policy.
5 ENGINEERING 963
Although it is possible to use 963 without the need for engineering, if the user wants to make use of all its features, it
must be engineered. This section describes how to engineer 963. It is arranged in the order of the recommended
engineering path with each aspect explained in detail.
The engineering process is shown below:
Plan the System
Decide the Engineering Method
Create a New Project
Configure Security Settings
Assemble the Necessary Files
Configure Automatic Archiving
Configure the Device Viewer
Make the required points available
Configure Graph Definitions
Configure the Schematic Pages
Configure Print Templates
Configure the Web Browser Display
Configure Occupation Times
Configure the Users
Configure Scheduled Events
Configure Alarm Handling
Configure 963 Server (963 Server Only)
Configure 963 Settings
Move the Configuration to the Destination PC
Set up any Client Devices (963 Server Only)
Test the Configuration
Backup the Configuration
The 963 is a user orientated system and it should be as simple as possible for a user to find information. Although the
configuration is totally flexible, it is strongly recommended that these guidelines be followed.
5.1 Plan the System
Before you start, it is important to plan the system. This will enable the engineering work to be carried out more
effectively, ensuring that the work is completed as quickly as possible.
Obtain Information about the system
Before starting to design a 963 system you must obtain all the necessary information from the user, HVAC equipment
specifications, documentation and any other available source. This will help to provide a good understanding of how
the system is intended to work.
Plan Client Access
If 963 Server is to be accessed by clients, the way in which they are to access the server must be considered.
Plan the Schematic Pages
Planning the required schematic pages is probably the most important part of designing a 963 system. Schematics
provide the user with the information that is needed and give the first impression of the system, so they should look
good. When planning the schematics, you must decide which information is to be displayed and how it is to be
displayed, whether or not the page will provide adjustment of setpoints etc. You must also decide how the page is to
be accessed. Is it called from another schematic? Which pages if any does it provide access to?
Plan Occupation Time Handling
On a large site, many areas will work different times and, therefore, require different occupation times to be set up.
Different diary groups can be set up for each set of working times. These are then linked to time zones within the
controllers that are to operate those times.
Plan the System Security
Because of the amount of information 963 makes easily available to users, some of which may be critical, it is
necessary to prevent unauthorised people from making changes, or from accessing certain information. You must
therefore decide who is going to access the system, what type of information they will be able to access, and what
adjustments they will be able to carry out.
For details about how 963s security works see the Users and Workgroups Explained section of this manual.
The page navigation structure provides a way of organising pages, into folders so that they can be located quickly
using the Navigator. It consists of a number of folders. Each folder can contain other folders and/or pages. The pages
and folders should be named so that they describe their contents. Top-level folders are used to group pages that contain
similar types of information; folders can be used to subdivide top-level folders (and other folders). A good way of
organising pages is geographically e.g. building name, floor number, etc. You could also organise them in terms of
the type of user that is to access them e.g. 'Security', 'Engineer' etc, or use a combination of the two.
When designing the structure you must also consider any necessary security requirements. You may want to prevent
certain users from accessing particular pages e.g. a normal office worker would not normally have access to pages
containing security information, or data about system performance. Top-level folders enable access to information to
be restricted. If a user is not authorised to access a top-level folder, it will not be displayed in the navigation structure.
A user can only display pages in the top-level folders that they have access to. A top-level folder should be created
for each group of pages for which access is to be restricted. This provides the most flexible way of controlling access.
Pages that are not in a folder can be created. These are known as top-level pages and are accessible by all users; for
this reason, it is recommended that top-level pages do not contain sensitive information.
The page navigation structure example above shows three top-level folders ('Floor Plans', 'Plantrooms', and 'Security'.
The 'Floor Plans' folder contains schematic pages that represent the floor plans. It is subdivided using two other folders
('Albery House', and 'Foundry Lane'), enabling the floor plans to be grouped by the building to which they apply.
These folders contain the actual pages. The 'Plantrooms' folder contains two pages, each of which provides information
about a different HVAC equipment room. The 'Security' folder contains a single page that provides information
necessary for the security checks. There is also a top-level page 'Trend Towers' that contains general information about
the building.
Because the 'Trend Towers' page is a top-level page, it is available to all users. However, the three top-level folders
can have their access restricted. For example, the floor plans may be accessible to everyone, but the plantroom
information restricted to engineers, and the security information available to only the security guards.
The decision about how a point is to appear on the page is mainly down to what the user wants. For a basic level user
it may be more appropriate to use allot of graphics, whereas for an engineer it may be more appropriate to make more
use of text.
Which points can be adjusted?
You must decide which points on the page are to be adjustable, and if they are, which users can adjust them. For
example, you may want basic users to see the value, but only engineers to be able or make an adjustment. If a user is
able to adjust a value displayed as text it will appear as a button, providing a visual indicator that adjustment is
possible. The appearance of points displayed as graphics will not change if they are adjustable so there will be no
visual indicator therefore you should provide some other indicator, or provide another way of adjusting the value.
The Backdrop
The backdrop is displayed behind any other items on the page. Therefore, it is important to design it correctly.
Complex backdrops often make it difficult to see information placed on top of them, so keep your design simple. Try
using a plain backdrop, and then assemble other graphics on top of it. Alternatively, the backdrop could provide the
entire graphic content of the page e.g. a floor plan with values placed on the page at the appropriate places.
If the page is to be accessed from a client you should ensure that you use colours that are supported by the browser.
Large backdrops will take a long time to load in the client, so try to keep the file size as small as possible. This can be
done by reducing the number of colours, or perhaps the physical size of the backdrop, for example, a strip along the
top of the page.
Access to Other Pages
The first thing to decide is: is the page going to directly provide access to other pages, or will the user be navigating
to pages using the Navigator.
If the user is to navigate to pages using the Navigator, then it is not necessary to provide links to other pages on the
page itself. If the page is to provide access to other pages, it is necessary to decide what these pages are and which
users will be able to access them. Links to other pages can be displayed as either buttons or graphics. Whatever method
is used; it should be clear what the objects function is. To prevent access to these pages, a pin level can be defined
for the link.
In order to make the page easy to understand keep the number of links to other pages to a minimum, this is also
important if the page is to be accessed in text mode. You could create one page that is displayed when a user logs on
which provides links to all the pages that are relevant to them. Alternatively, provide buttons that enable the user to
navigate around the page navigation structure.
What Actions can be carried out from the page?
963 has a number of actions that the user can carry out by clicking a button or graphic on the page, for a complete list
see the Actions section of this manual. The table below lists the most common ones.
Description 963 action to use
Change the current users password. CHANGEPASSWORD
Enter configuration mode on a specified device. CONFIG
Drop any autodialled links. DROPALLLINES
Query a database and display the results. EXECUTESQL
Move between pages. GOTO
Allow a specified user to log in. LOGINAS
Log out LOGOUT
Print a graph. PRINTGRAPH
Print the current page. PRINTPAGE
Run a script file. SCRIPT
Send a standard write text comms message to be sent to a specific device. SEND
Display a window containing all the current alarms for a specified alarm filter. VIEWFILTER
Display a window containing specific points from a specified device. VIEWPOINTS
Graph of all the points on the current page. VIEWGRAPH
Display a window containing all the values on the current page. VIEWPOINTS
Displays the result of the specified SQL query on the 963 database. VIEWQUERY
Go to a specified URL. WEB
Run a specified Windows based application. WINEXEC
Note that not all actions are supported when accessing pages from a client see the Action Availability section of this
manual for details.
Client Access
If the page is to be accessed by a client it is necessary to consider the web browser that is to be used as this affects
how the information is displayed. When accessed by a client using Microsoft Internet Explorer version 8 or greater,
or Firefox 3.5 or greater, and the Java runtime environment J2SE 7.0 or greater the server will operate in graphic mode
displaying the schematic pages virtually the same as on the server. The browser must have JAVA script enabled. Other
browsers are only able to access the server in text mode, which displays the schematic pages as 3 tables containing
live data (dynamic objects), actions, and additional information (static objects). There are a number of different text
mode layouts to allow for different device types (PCs, PDAs and Smartphones etc). The appropriate layout for the
client device is automatically selected. Each layout provides the same functionality, but data displayed varies to
accommodate different screen sizes and aspect ratio. Therefore, pages that are to be accessed with browser or device
that is only compatible with text mode should be created in a way that is suitable for a text only display.
If the page is to be accessed by a client you should try to keep the number of points that are displayed as a graphic to
a minimum to reduce the time taken to display the page.
If the page is to be accessed by a client, not all of the actions can be performed. The table below lists the 963 actions
that are supported in a client.
Action Description
CONFIG Provides access to the configuration mode of a specified device on the network.
DROPALLLINES Causes 963 to drop any autodialled link immediately. This action is not available in text mode.
EXECUTESMS Sends an SMS text message to a specified telephone number. This action is not available in text
(963 SMS Direct mode.
only)
GOTO Displays a specified page.
GOTO Diary Displays the Diary Display with the specified diary group visible. This action is not available in
text mode.
GOTO NEXT Displays the next page in the history of visited pages. This action is not available in text mode.
GOTO PREVIOUS Displays the previous page in the history of visited pages. This action is not available in text
mode.
LOGINAS Allows a specified user to log in.
LOGOUT Logs the current user out of 963. This action is not available in text mode.
MESSAGE Displays a message box for a specified length of time, or until the user clicks on OK. This action
is not available in text mode.
PLAY Plays either WAV or MIDI files. This action is not available in text mode.
POPUP Displays the specified schematic page in a pop-up window. This action is not available in text
mode.
SEND Sends a standard write text comms message to a specific device on the IQ network. When the
message is sent, 963 will beep, and record an event in the alarm database that can be seen in the
Alarm Display, indicating that the message has been sent.
SENDAUTO Sends a standard write text comms message to a specific device on the IQ network. This action
is not available in text mode.
SETGENERIC Enables the device from which generic dynamic objects obtain their value to be specified by the
user. This action is not available in text mode.
VIEWGRAPH Displays a window containing the specified graph definition. This action is not available in text
mode.
VIEWPOINTS Displays a window containing particular values on the current page. This action is not available
in text mode.
VIEWQUERY Displays the result of the specified SQL query on the 963 database.
WEB Displays the specified WEB page (HTML file).
If graph definitions are to be loaded from a client not all of the graph features are available from a client graph. Graph
definitions loaded from a client may appear different to when they are displayed on the server. Client graphs do not
support more than one axis, if a definition that uses more than one axis is loaded from a client all the traces will use
the same axis.
There is a folder for each site (Chichester, Portsmouth, and Horsham), and a folder for each area within each site
(Customer Area, and Staff Area). Then there are groups linking time zones with similar operating times together
(Bakery, and Offices).
The 963 also allows you to link workgroups to a set of occupation times (diary group). This enables users to be
prevented from logging on at particular times. If you are going to take advantage of this feature, a diary group that
contains the times the users can log in should be set up. In a similar way alarm retransmission destinations can be
linked to a diary group allowing the alarms that are to be sent to that destination to be saved until a particular time
(e.g. at night) and then sent.
The Diary Access Rights determine which of the 963's diary groups the users can view and modify. The Diary Access
Rights enables the users to access various diary groups. Depending on the permissions defined, the user can access all
or selected diary groups.
For a user to access the diary groups, the following two conditions must be met:
The pin level defined for the user must be same or more than the pin level defined for the diary group.
The user must be given the access rights for the diary groups using the Diary tab in the Workgroup Information
dialogue box.
Note: To access the diary displays using the web client, the user must have the Full Web Access permissions along
with the same or higher pin level and the diary access rights.
Decide What Users are Required
The 963 is shipped with two users, the Default user, and 'System Administrator. The 'Default' user has the access
rights defined in the Default workgroup, and requires no password. This user is logged on when all other users have
logged off, have timed out, or 963 is run. The 'System Administrator' has the access rights defined in the 'System
Administrator' workgroup. The 963 the password is generated randomly.
It is necessary to create other users with the access rights that they need. You will already have decided what
workgroups are going to be used, and their access rights, now you must decide what users are to be added to the
system, and which workgroup they are to be associated with.
There are several ways to decide what users are required; probably the most simple is to create a different user for
each person who is going to use 963. Another is to create a user for each type of user e.g. Security, Building Manager,
Engineer etc. Whatever method you choose you should carefully consider what access rights they require, and
associate them with the correct workgroup.
Determine the Security that has been used in the Controllers
If PIN protection has been set up in the controllers on the system, 963 will need to send a PIN to controllers that have
PIN protected enabled when it makes an adjustment. This PIN must match a PIN in the controller with a PIN Level
of at least 99.
You will need to find out what controllers have had PIN protection enabled, and what the level 99 PIN is for each one.
The strategy designer should be able to provide this information. A simple tip for making the set up of the Device
Viewer easier is to make the level 99 PIN the same in all controllers that have PIN protection enabled.
5.1.6 Plan the Alarm Handling
One very important function of a Building Management System is to report when it is not working correctly.
Therefore, it is important to plan 963's alarm handling carefully, to ensure that all alarms are handled appropriately,
without overloading either the system or the user with alarms. There are several stages required in planning the alarm
handling:
Decide the Default Alarm Action
Work out what Alarms will be Received
Decide on the Alarm Actions
Decide on the Required Alarm Groups
Decide on the Required Alarm Retransmission Destinations
Decide on the Required Alarm Filters
Which Alarm Filters are linked to each Alarm Group
What alarm priorities are required?
Account Policies
Under Account Policies are two sub policies that apply to user accounts:
Password Policy
The Password Policy allows the user to set up basic password requirements such as the minimum password
length and maximum password age. It is recommended the minimum password length should be set to eight
characters
Account Lockout Policy
A user with an account that has been locked out cannot log on again. The mechanism for doing so is similar
to 963s security system. If the user enters the password incorrectly a certain number of times, the account is
then locked out until the Administrator unlocks the account and allows the user access again. The parameters
in this policy allow the user to specify duration for the lockout period. It is recommended that the user
accounts should be set to lock if the password is incorrectly entered more than a specified number of times.
Local policies
The Local Policy has three sub policies:
Audit Policy
Auditing is covered in the 'Auditing' section of this manual. However, it is important to enable all the options
located in this policy so that all the account changing auditing features are enabled.
User Rights Assignment
The User Rights Assignment policy is a very important part of setting up some the more advanced security
features within Windows . It includes several entries for choosing the user rights for different workgroups.
For example, the Shut down the system entry allows the user to specify the workgroups that are allowed to
shutdown the computer.
Security Options
The entries specified in this section are advanced security options and should not be altered unless the user
is an expert in Windows operating system security.
Note that if Domain level policy settings are defined, they will override the local policy security settings.
5.4.1.7 Auditing
Auditing is the process that tracks the activities of users by recording selected types of events in the security log of a
server or workstation. General auditing can be activated by editing the computers Local Security Policy see the
'Adjusting the Local Security Policy' section of this manual.
Auditing and logging will not prevent misuse. However, audit logs can be useful when attempting to understand what
has gone wrong on the system and help prevent these issues in the future. It is important to balance the level of logging
with the ultimate reduction in system performance.
Auditing can also be set up on individual files. For example, the 963 database. Each time the user interacts with the
file it will be recorded in the auditing logs
To set up file auditing on an individual file:
1. Right click on the file for which auditing information is to be recorded and click Properties.
2. Click the Security tab.
3. Click Advanced.
4. Click the Auditing tab.
5. Remove the Everyone workgroup from the auditing entries and add a user from a workgroup you have
specified, e.g. Administrator.
6. A list of different auditing options to monitor is displayed. Select everything in the list for both Successful
and Failed.
7. Click OK.
The auditing is now set up for when a user from that workgroup is logged on the PC and accessing that file. Each time
the user interacts with the file will be recorded in the auditing logs. To test this edit the file and use Event Viewer to
examine the events captured.
5.4.1.7.1 Event Viewer
Windows has an in-built auditing tool, the Event Viewer, which is used for reviewing audits. To run the Event
Viewer, click Start, then click Run and type eventvwr in the displayed dialogue box. There are three different types
of logs located in Event Viewer including:
Application Log
This log contains events captured from applications running on the computer. For example, error accessing
a database.
System Log
This log contains events captured from system components. For example, if a device driver for a sound card
fails to load.
Security Log
This log records such events as invalid logon attempts.
To further analyse the auditing information kept in the system logs, save the log as a comma separated file, this can
then be imported into Microsoft Excel.
5.4.1.8 Security Patches & Hot Fixes
It is important to regularly update the operating system with all recommended hot fixes, and service packs as
recommended by Microsoft. If possible enable Windows updates and regularly check for system updates.
5.4.2 Configure 963 Security
There are a number of things that can be done to maximise the 963's security.
Set up the Database User Password
Ensure 963 Does not Use Mixed Mode to Connect to SQL Server unless 963 is configured to run under non-
admin account
Enforce a Strong Password Policy
Specify File Types Allowed through the Web Server (963 Server Only)
Specify File Types not Allowed through the Web Server (963 Server Only
Specify which IP Addresses can Access the 963 Server (963 Server Only)
Prevent Users Logging in more the Once (963 Server Only)
Prevent Client Use of VIEWQUERY (963 Server Only)
Prevent Client Use of VIEWQUERYEX (963 Server Only)
Protect Against Cross Site Scripting (963 Server Only)
Remove Links to Trend Web Sites
Specify Whether Passwords Must be Entered to Action Alarms
Configure External HTTP Links to Use a 'Bounce' Page
5.4.2.1 Ensure 963 Does not Use Mixed Mode to Connect to SQL Server
When 963 is installed it is set to connect to SQL Server using Windows authentication mode as this is the most secure
method of connection. Therefore to ensure maximum security you should ensure that 963 is not connecting to SQL
Server using mixed mode.
To ensure that 963 is not connecting to SQL server in mixed mode:
1. Run 963.
2. Log in as a user in the System Administrator workgroup.
3. On the Database menu click Properties. The Database Properties dialogue box is displayed.
4. Ensure that the Using SQL Server Authentication check box in NOT selected.
5. Click OK.
3. If it is not selected select the Using SQL Server Authentication check box.
4. Click Set database user password. The Change Database User Password dialogue box is displayed.
5. In the Please enter a new database password box enter the required password.
6. In the Please re-enter your new password box enter the password.
7. Click OK.
8. A dialogue box indicating that the password has been changed is displayed; click OK to return to the
Database Properties dialogue box.
9. Click OK. The 963 dialogue box is displayed.
10. If the Using SQL Server Authentication check box was selected in step (3) clear it.
Caution failure to clear the Using SQL Server Authentication check box when SQL Server is operating
in Windows Authentication Mode will prevent 963 from running.
11. Click OK.
12. Restart 963.
Important: A record of the database user password must be kept in a safe place (e.g. a firesafe)
2. Click , or on the Mode menu click Users to select the User Display.
3. Right click System Administrator and select Properties. The Workgroup Information dialogue box is
displayed.
4. Click the System Administrator tab. The dialogue box changes.
5. Click Change Master Password. The New Master User password dialogue box is displayed.
2. Click , or on the Mode menu click Users to select the User Display.
3. Right-click the System Administrator workgroup, and click Properties. The Workgroup Information
dialogue box is displayed.
4. Click the System Administrator tab. The dialogue box changes.
5. Select the required length of time for password date expiry using the Select an interval for new password
list.
6. Click OK.
2. Click , or on the Mode menu click Users to select the User Display.
3. Right-click the System Administrator workgroup, and click Properties. The Workgroup Information
dialogue box is displayed.
4. Click the System Administrator tab. The dialogue box changes.
5. In the Minimum password length box enter the minimum length for passwords, range 1 to 30.
6. Click OK.
5.4.2.4.3 Specify the Number of Password Retries
The maximum number of attempts a user is allowed to make to correctly enter their password before that user is
blocked, default = 20.
To specify the number of password retries:
1. Log in as a user in the System Administrator workgroup.
2. Click , or on the Mode menu click Users to select the User Display.
3. Right-click the System Administrator workgroup, and click Properties. The Workgroup Information
dialogue box is displayed.
4. Click the System Administrator tab. The dialogue box changes.
5. In the Number of password retries box enter the required number of retries.
6. Click OK.
5.4.2.6 Specify File Types not Allowed through the Web Server
963 Server Only. Once a user has logged on the 963 Server allows all file types through the web server except EXE,
Dll, Ckn, Ini, Dat, Mdb, Mdf, Ndf, Ldf, and scc. To increase the level of security it is recommended that the following
file types are also prevented from passing through the web server once the user has logged on.
41s bak bat
bmp cab chm
class cnt db
dll emf ent
hlp ldf key
log manifest mib
ngn rll rst
sql sql1 tlb
tmp tpl tss
xco xls
To specify the types of file not allowed through the web server before the user logs in:
1. Edit the [FilesNotAllowedToView] section of the S2.INI file as below:
[FilesNotAllowedToView]
<File Extension>=1
<File Extension> is the file extension of files that are not to be allowed through.
E.g. To block the files extensions specified above:
[FilesNotAllowedToView]
41s=1
bak=1
bat=1
bmp=1
cab=1
chm=1
class=1
cnt=1
db=1
dll=1
emf=1
ent=1
hlp=1
ldf=1
key=1
log=1
manifest=1
mib=1
ngn=1
rll=1
rst=1
sql=1
sql1=1
tlb=1
tmp=1
tpl=1
tss=1
xco=1
xsl=1
2. Click , or on the Mode menu click Users to select the User Display.
3. Right-click the System Administrator workgroup, and click Properties. The Workgroup Information
dialogue box is displayed.
4. Click the System Administrator tab. The dialogue box changes.
5. If the user is to be prompted for their password before they can action an alarm select the Users must re-
enter password to action alarms check box.
6. Click OK.
4. Ensure that the Using SQL Server Authentication check box is cleared.
5. Click OK.
6. Close 963.
7. Configure the SQL server to run in Windows Authentication mode only - refer to the 'Run SQL Server in
Windows Authentication Mode' section of the General Security Best Practice for Trend IP Based Products
Information Sheet (TP201331).
5.4.4 Remote Access and Network Security
The web server must be configured independently of 963. For SSL operation, a certificate is required. Certificates
contain encryption keys for SSL and are also the means by which a client recognises websites as being authentic.
Certificates are tied to the domain name of the web server, time limited, and are issued by a trusted authority. When
a web browser connects to a web server, the certificate keys are checked for authenticity. Only when the certificate
confirms the domain it serves, the browser displays the SSL indicators. Any mismatch or expiration can cause the
browser to display a message advising the user that this site should not be trusted.
For a typical 963 server running on an internal network, this process may be considered complex and/or costly to
manage. In such cases, you can opt to create your own self-signed certificates using the 963 web server configuration
utility. A self-signed certificate provides the SSL encryption and basic identification. However, it is not recognised as
a trusted site by any client web browser. It is possible to overcome this by manually exporting the certificate and
importing it into every web client browser that connects to 963. 963 will generate two certificates, a current certificate
for identifying the site, and a server certificate. It is the current certificate that should be exported into the client
browsers.
However, for sites with more demanding security requirements or when wishing to access the 963 remotely over the
web it is recommended additional steps are taken to secure the system as described in the 'Using a VPN with Trend
Systems Information Sheet' (TP201333).
3. Click or on the Mode menu click Scheduler to select the Event Scheduler Display.
4. Click New. The Configure Scheduled Action dialogue box is displayed.
5. Click Choose action in the Configure the required command for scheduling area. The What action
dialogue box is displayed.
6. In the list click ARCHIVEDATA. The Archive Historic Data dialogue box is displayed.
7. Click Next>. The dialogue box changes.
8. Specify the location and name for the backup file by typing the path and filename into the File Name box. If
required 963 variables can be used to help specify the path and filename. The default is to back up the file to
the directory in which 963 is installed, the filename is trend96X and includes the date and time. The location
of the file can also be specified by clicking Choose file location and browsing to the required directory. To
return to the default settings click Generate default file name.
9. Click Next>. The dialogue box changes.
10. Select either All, Last Day, Last Week, Last Month, Last Year or Custom data range to specify the data
that is to be archived. If Custom data range is selected click Choose Date to display another dialogue box
and click the start date for the date range. Click Next and click the last date in the range and click Finish.
Note that by setting All, Last Day, Last Week, Last Month, Last Year or Custom data range will trigger to
archive the data just that period only. Rest all data will remain untouched. Eg. Last Year will archive just
that last year (ie: from today backwards one year). Data older than last year will remain untouched.
11. Click Finish.
12. A dialogue box is displayed asking if data is to be deleted from the database, click Yes to archive the data
and delete it from the original database, or click No to just archive it. The What action dialogue box is
displayed.
Note if data is not removed from the database its size will not be reduced.
13. Click OK.
14. Specify what happens if the action fails, in the OPTIONAL: Choose an action to perform if the required
command fails area of the dialogue box. To specify no action click Do Nothing. To generate an alarm click
Set to default. To specify an action click Choose action to display the What action dialogue box, click the
required action from the list, and click OK.
15. Specify what happens when action succeeds in the OPTIONAL: Choose an action to perform if the
required command is successful area of the dialogue box. To specify no action, click Do Nothing. To
generate an alarm, click Set to default. To specify an action click Choose action to display the What action
dialogue box click the required action from the list, and click OK.
16. Click Next>. A dialogue box is displayed.
17. In the First event box enter the date and time when the event is to first occur in the following format:
dd/mm/yy hh:mm:ss
To specify the event to occur now, click Now.
18. Select the Do you wish to repeat this action check box.
19. In the Choose an interval list click the interval at which it is to be repeated. This interval should be dependent
on the site. You should monitor how fast the database size increases, and set this to an appropriate time. If
unsure select 'Week' or 'Month', the interval can always be changed later. 963 recommends an option based
on the configuration settings.
20. In the..and how many times to repeat it list click how many times the event is to occur.
21. If Day or Week was specified as the interval, specify the day(s) of the week that the event is to occur. If Day
was selected, all seven days can be selected. If Week was selected, only one day can be selected.
22. Click Next>. A dialogue box is displayed.
23. Check that the event is set up correctly, and then click Finish.
24. Configure 963 to shrink the database on startup.
Note: It is strongly recommended that the DELETEHISTORIC DATA command be executed to prevent the database
from becoming too large.
If 963 is using the supplied version of SQL Server (SQL Express) 963 will check the database size on daily basis. If
it exceeds 75% usage then a SYST alarm is generated, if it exceeds the 95% usage then along with the SYST alarm a
message box will be displayed advising that it is time to archive the database or to upgrade to a full version of SQL
server. The SYST alarm can be used to make the user aware of the problem enabling the database to be archived. If
this occurs it will be necessary to archive the database.
The archive process archives historic data (graph data, recorded schematics and alarms) within the supervisor to an
external data source. The data can either be deleted from the 963s database or kept for future reference. The archived
graph data can be played back using the Load recorded data option in the Graph Window. The archived schematic
data can be played back using the View recorded data option on the Data Recording menu. It is recommended that
a scheduled event be created using the ARCHIVEDATA action to regularly archive the 963's database.
During the ARCHIVEDATA process the database size is actually increased to enable the process to occur. This size
increase can be as much as 10 or more times. Once the process is complete the database size will be reduced by SQL
Server's database maintenance process within 24 hours. However this can be done manually by setting 963 to shrink
the database on, and restarting 963. Before carrying out the ARCHIVEDATA process you should ensure that there is
enough disk space is available. External disk drives can be used for this purpose.
Archiving of a large database for the first time will take a long time.
To manually archive the 963's database:
1. Log in.
2. On the Database menu click Archive Data. The Archive Historic Data dialogue box is displayed.
3. Click Next>. The dialogue box changes.
4. Specify the location and name for the backup file by typing the path and filename into the File Name box. If
required 963 variables can be used to help specify the path and filename. The default is to back up the file to
the directory in which 963 is installed, the filename is trend96X and includes the date and time. The location
of the file can also be specified by clicking Choose file location and browsing to the required directory. To
return to the default settings click Generate default file name.
5. Click Next>. The dialogue box changes.
6. Select either All, Last Day, Last Week, Last Month, Last Year or Custom data range to specify the data
that is to be archived. If Custom data range is selected click Choose Date to display another dialogue box
and click the start date for the date range. Click Next and click the last date in the range and click Finish.
Note that by setting All, Last Day, Last Week, Last Month, Last Year or Custom data range will trigger to
archive the data just that period only. Rest all data will remain untouched. Eg. Last Year will archive just
that last year (ie: from today backwards one year). Data older than last year will remain untouched.
7. Click Finish.
8. A dialogue box is displayed asking if data is to be deleted from the database, click Yes to archive the data
and delete it from the original database, or click No to just archive it. The What action dialogue box is
displayed.
Note if data is not removed from the database its size will not be reduced.
5.5.2 Configure 963 to Shrink the Database on Startup
The 963 can be configured to shrink the database on startup. This useful if the database has been archived and SQL
has not yet reduced the database size.
Caution setting this option will increase the time taken for the 963 to start up. This time may be quite
considerable for a large database that has not been compacted.
To configure 963 to shrink the database on startup:
1. Edit the [DATABASE] section of the S2.INI file as below:
[DATABASE]
ShrinkDB=<shrink>
<shrink> specifies whether the database is compacted on startup. 1 = compacted, 0 = not compacted
E.g.
[DATABASE]
ShrinkDB=1
5.6 Assemble the Necessary Files
Having planned the system and designed the pages, alarm handling etc you should assemble the necessary backdrop,
graphic, sound, animation, and script files that are required.
Backdrop files are standard files sized so that they exactly fill the Data Display. Graphic files are used for graphics
on pages, buttons etc. Sound files are standard WAV, and MIDI files used to provide an audible aspect to 963s
operation, e.g. when a particular alarm occurs. Animation files enable animated pictures and text to be included on
schematic pages. Script files enable 963 to perform a sequence of actions. Active content files allow the content of
files types such as Excel and Word to be integrated into a schematic page.
Some of the files you require may already exist e.g. company logos or ones used on previous 963 projects. In which
case they should be copied to the appropriate sub-directory of the directory in which 963 is installed. The required
sub-directory for each type of file is described in the table below.
File Type Location
Analogue Graphics Analogue
Animation Animation
Backdrop Backdrops
Active Content Other
HTML HTML
Graphics BMP, JPEG, GIF, WMF, and EMF.
Point Templates Template
Script Scripts
Sound WAV files wav, and MIDI files midi
If the required files do not exist, then it will be necessary to create them. For details about creating the different files
required by 963 see the next few sections of this manual.
This will display the bitmap 1.bmp when the value is less than 29, when the value is between 29 and 39 it will display
2.bmp, and when it is above 39 it will display 3.bmp.
To create an analogue graphic file:
1. Create a sub-directory in the install directory called analogue.
2. Create a sub-directory in the analogue directory for the file.
3. Move the graphics files that will be referenced into that directory.
4. Run the text editor.
5. Type the references for each bitmap on a separate line in the text editor, in the format shown below:
<Value>=<Bitmap>
Where <Value> specifies the value below which the specified bitmap file will be displayed, and <Bitmap>
specifies the path and filename of the bitmap, e.g.
29=\analogue\myfirsttank\10.bmp
This specifies a bitmap file called '10.bmp' in the 'myfirsttank' sub-directory of the 'analogue' directory of the
install directory to be displayed while the value is below or equal to 29. The first bitmap is the default, and
will be displayed when the value is below the bottom of the range.
The value can also be a decimal number, e.g.
32.25=\analogue\myfirsttank\04.bmp
This specifies a bitmap file called '04.bmp' in the 'myfirsttank' sub-directory of the 'analogue' directory of the
install directory to be displayed while the value is below or equal to 32.25.
6. Save the file in the same directory as the graphics files it references with the .analogue file extension.
5.6.2 Create Animation Files
Animation files are text files that define an animation for a schematic page. The animation is made up of a number of
different frames, where the animation moves from frame to frame. Each frame is defined on a separate line in the
animation file as either a piece of text, a bitmap, or sound file (WAV file). Animation files can be created using any
text editor (e.g. notepad).
An example of an animation file that animates a piece of text is shown below:
Select Here>>>>>>>>>>>>>>>>
>>>>>>>>Select Here>>>>>>>>
>>>>>>>>>>>>>>>>Select Here
This file displays the words 'Select Here' with arrows before and after. The display changes between 'Select
Here>>>>>>>>>>>>>>>>' and '>>>>>>>>>>>>>>>>Select Here'.
An example of an animation file that animates a bitmap is shown below:
\animation\boiler\flame1.bmp
\animation\boiler\flame2.bmp
\animation\boiler\flame3.bmp
\animation\boiler\flame4.bmp
\animation\boiler\flame5.bmp
This file displays an animation of a boiler flame that is made up of 5 graphics files in the animation boiler directory.
To create animation files using a text editor:
1. Create a sub-directory in the 'animation' sub-directory of the install directory for the animation. It is
recommended that no more than 5 bitmaps be used in a single animation.
2. Move the graphics files for the animation file into that directory.
3. Run the text editor.
4. Type references for each bitmap piece of text or sound file on a separate line in the text editor. Be careful not
to leave an empty line at the end of the file because it will be interpreted as a blank frame.
When specifying graphics, the path and filename of the file, minus the install directory part of the pathname
e.g. c:\program files\trend control systems\963 should not be entered. If a graphic file that does not exist is
referred to, 963 will treat that reference as text, and display that instead of the file. Animation files can also
contain a mixture of text and graphics.
5. Save the file in the same directory as the graphics files it references with the .animation file extension.
Tip: 963 will automatically create animation files when it enters page configuration mode if it detects a folder in its
animation directory that contains files. labelled1.BMP, 2.BMP etc, or Click here to update lists is selected in the
Configuration dialogue box.
5.6.3 Create Backdrop Files
The 963 uses standard files for the backdrops of schematic pages. It is possible to use BMP, JPEG, GIF, WMF, and
EMF files (WMF and EMF Files are not supported in the client).
They can be created using any proprietary software package that is capable of producing the required format file.
Although paint type packages can be used, the best results are obtained using a vector graphics package and
exporting/saving the image in the required format. The exact appearance of the backdrop depends on the monitor, the
Windows desktop scheme, the width of the menu bar, the size of the Windows border, and even the number of colours.
It is therefore recommended that the backdrop files are created on a PC with a configuration similar to that of the PC
on which 963 is to run. The table below lists some things to remember when creating backdrop files.
Area Remember This
Design When creating a backdrop it is important to remember that it is to be a backdrop. Complex
backdrops often make it difficult to see information placed on top of them, so keep your design
simple.
If a page is to consist of a number of static graphics put them on the backdrop rather than adding
each one as an individual object.
Size in Pixels The backdrop should exactly fill the display area of the schematic page without causing scroll bars.
The 963 provides a facility for determining the current size of the schematic page.
Colours Although 963 supports 24 bit colour bitmaps, it is important to consider the colours that are used
to ensure that the result in 963 is as you would expect. If the backdrop is to be used on pages that
are to be accessed from a client you should ensure that you use colours that are supported by the
browser.
Size in Bytes Backdrop files can easily get very large especially if they utilise photographs etc. The larger the
file size, the longer the page will take to load especially if it is being accessed from a client.
Therefore, it is recommended that the file size be kept to a minimum. Try reducing the number of
colours, this will greatly reduce the file size, and may not affect the appearance.
To create a backdrop file:
1. Decide what the backdrop is to show.
2. Determine the required size in pixels of the file.
3. Using the software package of your choice create the file. Remember to set the image size to the required
number of pixels.
4. Save the file in the required format.
5. Move it to the backdrops sub-directory of the install directory.
Tip: Once you have determined the size of the backdrop file create a template file specifying the size in pixels that
can be used as a basis for other files.
Remember to keep the original file so that changes can be made in the future.
2. Click . The Information Centre dialogue box is displayed. This contains the required size for the
backdrop.
This would enable a user called '963 Client User' to log in.
2. Save them in the 'html' sub-directory of the install directory.
3. If any of the HTML pages contain references to file types other than JPG, BMP, HTM, XML, XSL, or HTML
these files types must be added to the unsecure file types list.
5.6.8 Create Point Template Files
Points Template Files allow you to create a list of points which can be displayed either by holding down the CTRL
key when clicking a dynamic object, or from a button using the VIEWPOINTS action.
The file contains a label for the window and a list of points. The template file is purely a list of points to be displayed.
The Lan and controller references are used to link the template file with the correct controller. This file can then be
applied to any number of controllers that share the same strategy - i.e. IQL controllers. An example of a points template
file is shown below:
Floor 1
D5,Floor 1 Htg Valve,,0
K1,Floor 1 Occ SetPt,DegC,10
S10,Floor 1 Supply Temp,DegC,0
S11,Floor 1 Return Temp,DegC,0
In the example above, the label for the window is 'Floor 1' it will display the value of driver 5, knob 1, and sensors 10
and 11. The line specifying the points should be in the format shown below:
<Module>,<Label>,<Units>,<PIN Level>
<Module> specifies the type of module, and module number (e.g. S1 specifies sensor 1). <Label> specifies the label
of the module (e.g. Sensor 1); <Units> specifies the units used for the module (e.g. DegC). <PIN Level> specifies the
minimum PIN level required by the user to adjust the item.
2. Click , or on the Mode menu click Device Viewer to select the Device Viewer.
3. Display the items that are to be displayed in the points window. Do not worry about selecting the controller
the file only specifies the item e.g. S1 for sensor 1.
4. Click the required items to highlight them. More than one item can be selected by holding down the CTRL
key and clicking the required items.
5. Once all the items have been selected, right-click any of the selected items, and click Add Selected Point(s)
to Template File. The Save all data to file dialogue box is displayed.
6. In the box enter the path and filename of the template file. By default, the directory for these files is the
template directory within install directory.
7. If the file is to overwrite an existing file of the same name select the Tick here to overwrite, else it will add
to the file check box. If this check box is not selected the select points will be added to the existing file.
8. Click the Label tab.
9. In the box enter the text that is to appear in the menu bar of the points window.
10. Click OK.
5.6.9 Create Script Files
Script files enable 963 to carry out specified sequence of actions when a particular event occurs, such as an alarm, or
a button is selected. These actions are described in the '963 Actions' section of this manual. A script file is a text file
that defines the actions that are performed. Each different action is on a separate line in the file, for example.
GOTO Pages\Floor Plans\Floor 1.tss
MESSAGE Albery House Alarm, <ALARMDESC>,0,!,65025,255
BEEP
SLEEP 1000
PLAY wav\Fire.wav
When selected this button would run the script file 'fire.txt'.
Script files can be created using any text editor (e.g. notepad) simply by typing in the text specifying the required
action the required action as described in the Specifying Actions section of this manual. Each action is specified on
a separate line. They can ask a question, and perform a different task depending on the user's response, or can include
a variable value.
To create a script file:
1. Run the text editor.
2. Type the code for each action that is to be performed on a separate line in the text editor, in the format shown
below:
<ACTION> <Optional Parameter>
<ACTION> is the action that is to be performed; it should be specified in capitals. A full list of the actions
and what they do is provided in the 963 Actions section of this manual. <Optional Parameter> specifies
any additional information required to carry out the command e.g. for the GOTO action the optional
parameter would specify the page 963 would go to. Details of the optional parameters required for each action
can be found in the individual section for that action.
E.g.
GOTO pages\getting started.tss
Specifies the 'GOTO' action and tells 963 to display the Getting Started page in the 'pages' sub-directory of
the install directory.
For full details of the format of the code used to specify each action, see the 963 Actions section of this
manual. 963 variables can be used as described in the Using Variables in Action Codes section of this
manual to enable information from the PC, or alarms received by 963 to be included in a 963 action. This
allows the action to be modified according to the value returned. For example, the default alarm action could
be set up to display a message box with the text customised to indicate the type of alarm. The ? variable
can be used to include a user response, and ISDIARYNOCC and ISDIARYOCC variables can be used to
prevent particular actions being carried out at particular times.
3. Save the file in the scripts sub-directory of the install directory with a .TXT file extension.
Note that the use of script files is not supported when viewing the page in a web browser.
5.6.9.1 Asking Questions in a Script File
A script file can ask a question, and perform a different task depending on the user response. To cause the script file
to ask a question the line in the file should be in the form shown below:
?<Question>
The ? at the beginning of the line indicates that the text following is a question. <Question> is the actual text of the
question. The question will always be asked in a Yes/No message box. (E.g.'? Are You Sure' will display a message
box asking 'Are You Sure', with two buttons Yes, and No. If the user clicks Yes the next line of code will be executed,
if No is selected the line after is executed e.g.
?Display boiler 1 information
Goto pages\boiler 1.tss
MESSAGE Information, You did not want to view the boiler information,0,!,65025,255
The code above will display a message box asking if the user wants to view boiler 1 information. If he clicks Yes, the
schematic page 'boiler 1.tss' is displayed; if he selects No a message box containing the text You did not want to view
the boiler information is displayed.
5.6.9.2 Using Command Line Parameters in a Script File
When running a script file parameters can be included in the action code that runs the script file. These values are used
in the script.
SCRIPT <Filename> [<argument list>]
<Filename> specifies the path and filename of the script file that is to be run. <argument list> specifies parameters
that are to be passed into the script file. If there is more than one parameter they should be separated by a comma ,.
To include these parameters in the script enter the following code in the script at the required place:
<PARAMn>
Where n specifies the variable number. The variable number is determined by the order in the argument list i.e. the
first argument in the argument list would be referenced by <PARAM1>, and the second by <PARAM2>. E.g.
MESSAGE <PARAM1>
SLEEP 1000
MESSAGE <PARAM2>
If the above script was in a file called params.txt the following command would run the script file params.txt
display a message box reading WARNING, and then 1 second later display a message reading Boiler Overheat.
SCRIPT scripts\parameters.txt [WARNING,Boiler Overheat]
The code above in a script file would cause 963 to display the Floor1Normal page when the normal occupation times
for the Floor 1 diary group where occupied, and the Floor1Security page when the normal occupation times for
the Floor 1 diary group where unoccupied.
SCRIPT2.TXT
MESSAGE SCRIPT2,Starting
SLEEP 5000
MESSAGE SCRIPT2,Finishing
SCRIPT1 displays a message box then starts SCRIPT2 using the code:
SCRIPT scripts\SCRIPT2.txt
Because SCRIPT1 is running, SCRIPT2 will wait until SCRIPT1 completes before it starts. If we look at the time-
line, this is what the user would see:
Time Message Title Message
00:00 SCRIPT1 Starting
00:10 SCRIPT1 Finishing
00:10 SCRIPT2 Starting
00:15 SCRIPT2 Finishing
Run the Second Script and Pause the First
The 963 can run the second script while pausing the first until the second finishes when the first script will continue.
This is achieved by using <INLINE> keyword in the script action. This is explained below continuing the previous
example. SCRIPT1 is modified to included <INLINE> in the command that runs SCRIPT2.
SCRIPT1.TXT
MESSAGE SCRIPT1,Starting
SCRIPT scripts\SCRIPT2.txt INLINE
SLEEP 10000
MESSAGE SCRIPT1,Finishing
2. Click , or on the Mode menu click Device Viewer to select the Device Viewer.
3. In the Navigator right-click Local Site not learnt and on the displayed menu click Learn my local site. If
the site has already been learnt 963 will relearn the site go to (6) if the site has not been learned the Label
dialogue is displayed.
2. Click , or on the Mode menu click Device Viewer to select the Device Viewer.
3. Right-click the Navigator outside the network tree, and click Add new site. The Add new site dialogue box
is displayed.
9. In the IP Address or hostname box enter the IP address or hostname of the PC running TOPS this will
normally be the same PC as the one running 963 in which case enter 127.0.0.1.
Note that a hostname should be used if a DHCP server is being used on the system to setup the IP settings of
the PC running TOPS if it is not the local PC.
10. In the Start Port box enter the port number of the TOPS virtual CNC (normally 10101).
11. In the End Port box enter the port number of the TOPS virtual CNC (normally 10101).
12. Select the Permanent Connection check box. The Idle Time box is greyed out.
13. If TOPS is running on another PC, and the connection is to be made through a firewall, select the Are you
connected via a Firewall? check box.
14. If TOPS is running on another PC, and the connection is to be made through a firewall, enter the MAC
Address of the device that the 963 is to use to make the connection to the site in the Mac Address box.
15. If TOPS is running on another PC, and the connection is to be made through a firewall, enter the IP address
of the firewall in the Firewall IP Address box.
16. If TOPS is running on another PC, and the connection is to be made through a firewall, and the connection
to the firewall is to be made using a different port to the ones specified in (10 and 11) select the Port check
box and enter the required port number in the Port box.
Note that the firewall must be configured to route the messages on the specified port to the IP address of the
PC running TOPS. If the PC running TOPS is protected by a firewall, this must also be configured to route
messages on the specified port to the device.
17. Click Finish. If the Learn Network check box was selected 963 will attempt to communicate with the site,
and learn the network structure. The Information Centre is displayed to indicate the status of the operation.
This may take some time on a large site. To cancel the operation at any time click Cancel Command in the
Information Centre. Once the 963 has learnt the site, its structure will be displayed in the Navigator.
Note that values will not be available until the labels have been collected.
If TOPS is bound into the Trend site connection to can be made via any vCNC on the site however it is strongly
recommended that the connection is made via the vCNC in TOPS as described above.
2. Click , or on the Mode menu click Device Viewer to select the Device Viewer.
3. Right-click the Navigator outside the network tree, and click Add new site. The Add new site dialogue box
is displayed.
9. Click InterNetwork, or Local LAN to specify the location of the autodialling device on the autodialled site.
If Local LAN was selected, enter the Lan number in the Number box.
10. In the Telephone box enter the number of the site. The number may be up to 20-characters in length.
Characters Description
0 to 9 Dialling characters.
ABCD#* Considered as dialling characters on some systems.
J or : Wait for secondary dial tone.
K or ; or , 2 seconds pause (Note on some autodiallers this may be a 1 second pause).
< Pulse dialling.
M or = Tone dialling.
11. If there is more than one type of autodialler specify the type that the 963 is to use to dial out. This autodialler
MUST be of a type that is compatible with the autodialler at the far end. Any Dialler enables the 963 to use
any autodialler in the specified location.
12. Click Finish. If the Learn Network check box was selected 963 will attempt to communicate with the site,
and learn the network structure. The Information Centre is displayed to indicate the status of the operation.
This may take some time on a large site. To cancel the operation at any time click Cancel Command in the
Information Centre. Once the 963 has learnt the site, its structure will be displayed in the Navigator.
Note that values will not be available until the labels have been collected.
5.7.1.5 Add a TCP/IP Remote Site
If the 963 is to access a site other than the local site over a TCP/IP connection, it must be added as a TCP/IP Remote
Site. For the link to work, it must be possible for a TCP/IP connection to be made between the PC running the 963
and the device containing the virtual CNC to which 963 is to connect. This requires the correct installation and set up
of the Ethernet networks to which both the 963 and device are connected. Details of these types of connections can be
found in the IQ System Ethernet Products Engineering Guide (TE200369).
To add a remote TCP/IP site:
1. Log in.
2. Click , or on the Mode menu click Device Viewer to select the Device Viewer.
3. Right-click the Navigator outside the network tree, and click Add new site. The Add new site dialogue box
is displayed.
9. In the IP Address or hostname box enter the IP address or hostname of the device containing the virtual
CNC 963 is to use to make the connection to the site.
Note that a hostname should be used if a DHCP server is being used on the system to setup the IP settings of
the device containing the virtual CNC. You should also remember that EINCs and IQ3 controllers earlier
than v1.3 do not support hostname addressing.
10. In the Start Port box enter the port number of the first virtual CNC in the range of virtual CNCs to which
963 can connect (e.g. 10005).
11. In the End Port box enter the port number of the last virtual CNC in the range of virtual CNCs to which 963
can connect (e.g. 10008).
12. In the Idle Time box enter the time in seconds between the last messages being sent and the connection being
dropped. If the connection is to remain permanently connected select the Permanent Connection check box.
The Idle Time box is greyed out.
13. If the TCP/IP connection is to be made through a firewall, select the Are you connected via a Firewall?
check box.
14. If the TCP/IP connection is to be made through a firewall, enter the MAC Address of the device that the 963
is to use to make the connection to the site in the Mac Address box.
15. If the TCP/IP connection is to be made through a firewall, enter the IP address of the firewall in the Firewall
IP Address box.
16. If the connection to the firewall is to be made using a different port to the ones specified in (10 and 11) select
the Port check box and enter the required port number in the Port box.
Note that the firewall must be configured to route the messages on the specified port to the IP address of the
device containing the virtual CNC if a firewall is protecting it. If the device containing the virtual CNC is
protected by a firewall, this must be configured to route messages on the specified port to the device.
17. Click Finish. If the Learn Network check box was selected 963 will attempt to communicate with the site,
and learn the network structure. The Information Centre is displayed to indicate the status of the operation.
This may take some time on a large site. To cancel the operation at any time click Cancel Command in the
Information Centre. Once the 963 has learnt the site, its structure will be displayed in the Navigator.
Note that values will not be available until the labels have been collected.
5.7.1.6 Learn a Site or Lan
If a site or Lan has been changed since the information about it was obtained, or a site or Lan has Learn Me next to
it, the information must be learned.
To learn a site or Lan:
1. Log in.
2. Click , or on the Mode menu click Device Viewer to select the Device Viewer.
3. Right-click the site or Lan that is to be learned, and click Learn, or Learn my local site for the local site.
The Information Centre is displayed to indicate the status of the operation.
Note that this operation may take some time on a large site. To cancel the operation at any time click Cancel
Command in the Information Centre.
5.7.1.7 Move the Site Information onto a Different PC
The information about the site is stored in a database file therefore all that is required to move the site information
onto a different PC is to move that file from one PC to the other.
To move the site information onto a different PC:
1. Using a suitable method of transferring files from one PC to another, copy the i96X_data.mdf and
i96X_log.ldf files located in the database directory on to the required PC.
Caution: This will overwrite any existing site information on the PC.
2. Click , or on the Mode menu click Device Viewer to select the Device Viewer.
3. If the site's labels have already been collected, and you have modified them manually and want to prevent
them being overwritten right click the site and click Overwrite existing data entries ensuring that it is
unticked.
4. Right-click the site whose labels are to be learnt and click Collect Labels, and then click From all Module
Types. The Information Centre is displayed, to indicate the status of the operation. To cancel the operation
at any time click Cancel Command in the Information Centre.
To collect a sites labels from specific module types:
1. Log in.
2. Click , or on the Mode menu click Device Viewer to select the Device Viewer.
3. If the site's labels have already been collected, and you have modified them manually and want to prevent
them being overwritten right click the site and click Overwrite existing data entries ensuring that it is
unticked.
4. Right-click the site whose labels are to be learnt and click Collect Labels, and then click From Specific
Module Types. The Select Module Types dialogue box is displayed.
5. Clear the check boxes for the module types for which labels are NOT to be collected. To select all module
types select the Select all module types check box.
6. Click OK. A warning saying that labels will not be collected from all module types is displayed. OK will be
greyed out if no module types are selected.
7. Click OK to continue. The Information Centre is displayed, to indicate the status of the operation. To cancel
the operation at any time click Cancel Command in the Information Centre.
2. Click , or on the Mode menu click Device Viewer to select the Device Viewer.
3. Right-click the site whose connection is to be changed, and on the displayed menu click Properties. The Site
Properties dialogue box is displayed.
3. Select the Detach database after Supervisor has been shutdown check box.
4. Click OK.
5. Close 963.
6. Move the file (s2.mdb) into 963s install directory.
7. Make sure all the other 5 .mdb files are in the 963s install directory.
8. Delete the i96x_data.mdf and i96x_log.ldf files from the database subdirectory in the 963s install directory.
9. Run 963. After a while the 963 dialogue box is displayed.
11. Click Yes. A dialogue box is displayed asking if the database is password protected.
12. Click Yes. The data will be imported. If is it is necessary to remove the password first click No.
13. A dialogue box is displayed when the import process is complete, click OK.
5.7.3 Add Lans and Controllers
5.7.3.1 Add a Controller
Controllers that have not yet been added to the IQ network can be added to the Device Viewer.
To add a controller to the Device Viewer:
1. Log in.
2. Click , or on the Mode menu click Device Viewer to select the Device Viewer.
3. Right-click the Lan to which the controller is to be added, and on the displayed menu click Add Single
Device. The Network Address dialogue box is displayed.
4. In the box enter the network address of the controller number into the box. Range 1, 4 to 9, 11 to 119, and
126.
5. Click OK. The controller will be added to the Device Viewer, with the words 'Learn Me' next to it to indicate
that it has not yet been learned.
If 963 is learning/collecting labels, the controller will not be displayed in the Device Viewer until 963 has finished
the task.
Note that as soon as the controller is added to the IQ network or the configuration is moved on to the final PC, the
controller should be updated.
5.7.3.2 Add a Lan
Lans that have not yet been added to the IQ network can be added to the Device Viewer.
To add a Lan to the Device Viewer:
1. Log in.
2. Click , or on the Mode menu click Device Viewer to select the Device Viewer.
3. Right-click the site to which the Lan is to be added, and click Add Single Lan. The Network Address
dialogue box is displayed.
4. In the box enter the number of the Lan. Range 0, 1, 4 to 9, and 11 to 119.
5. Click OK. The Lan will be added to the Device Viewer; with the words Learn Me next to it to indicate that
the Lan has not yet been learned.
If 963 is learning/collecting labels, the Lan will not be displayed in the Device Viewer until 963 has finished the task.
Note that as soon as the Lan is added to the IQ network or the configuration is moved on to the final PC, the Lan
should be learned.
5.7.3.3 Update a Controller
If a controller on the network has been changed since information about it was obtained, the information must be
updated. This option retrieves the PROM version etc from the controller.
To update information about a particular controller:
1. Log in.
2. Click , or on the Mode menu click Device Viewer to select the Device Viewer.
3. Right-click the controller that is to be updated, and click Update. The Information Centre is displayed to
indicate the status of the operation.
Note that this operation may take some time. To cancel the operation at any time click Cancel Command in the
Information Centre.
5.7.4 Remove Unwanted Items from the Device Viewer
It is possible to remove unwanted items from the Device Viewer. For example, if the user does not need to access a
controller from the Device Viewer. Values from deleted items can still be displayed on schematic pages.
To delete a controller from the Device Viewer:
1. Log in.
2. Click , or on the Mode menu click Device Viewer to select the Device Viewer.
3. Right-click the site, Lan, or controller that is to be deleted, and on the displayed menu click Delete. A
dialogue box is displayed asking for confirmation of the deletion.
4. Click Yes. The selected item will be deleted from the Device Viewer.
5.7.5 Edit Labels
Labels of items in the Device Viewer are normally obtained from the devices when the labels are collected. Sometimes
these labels may not be suitable and it is possible to edit the labels of Lans and controllers to something more suitable.
Lans are identified using their Lan number, and do not have label to provide a more friendly interface to the user Lans
can be given a label, and if the label of a controller is not suitable it can be changed. To change the label of a site it is
necessary to edit the site.
To edit a label:
1. Log in.
2. Click , or on the Mode menu click Device Viewer to select the Device Viewer.
3. Right-click the required Lan or controller, and click Label. The Labelling dialogue box is displayed.
2. Click , or on the Mode menu click Device Viewer to select the Device Viewer.
3. Right-click the site, Lan, or device for which the PIN is to be set and on the displayed menu click Set Pin.
The Setting pins dialogue box is displayed.
4. In the box enter the PIN (max 4 digits). This PIN MUST correspond to a level 99 user in the controllers.
5. Click OK.
5.7.7 Set Up a Value's PIN Level
Each value displayed in the Device Viewer has a PIN level associated with it, which is used to determine if a user can
adjust that value. This level is obtained from the controller when the labels are collected. It can be changed.
Note that changing the PIN level in this way changes the PIN level in the controller, which may affect security for
devices such as the NDP, which also use these levels. It is therefore recommended that changes to the PIN level are
made by the strategy designer using SET.
To change a values PIN level:
1. Log in.
2. Click , or on the Mode menu click Device Viewer to select the Device Viewer.
3. In the Pin Level column, right-click the PIN level of the value whose PIN level is to be changed and click
Change PIN Level. The New Pin Level for this point dialogue box is displayed.
2. Click , or on the Mode menu click Device Viewer to select the Device Viewer.
3. Right-click the value whose units are to be changed and click Change Units. The New unit for point
dialogue box is displayed.
4. Save the file in the 'CustomActions\DeviceViewer' sub-directory of the install directory with an .ACT file
extension. The file name must be formatted as below:
<Friendly Name>.act
<Friendly Name> must be one of the items in the table below and specifies the device type that the menu is
to be added to.
<Friendly Name> Description
921 921 Supervisor
92x 920 Series Supervisor
940 940 Supervisor
942 942 Supervisor
943-v1 943 v1 Supervisor
943-v1-1 943 v1.1 Supervisor
945 945 Supervisor
95x 950 Series Supervisor
Autodialler Autodial Nod Controller (ANC)
BACnet Generic BACnet device
BINC BACnet Internetwork Node Controller (BINC)
CNC Communication Node Controller (CNC)
FNC Fancoil Node Controller (FNC)
GDP Generic Display Panel (GDP)
LonWorks Generic LONWORKS device
OPCClient Generic OPC Client device
INC Internetwork Node Controller (INC)
IQ100 IQ100 Series Controller
IQ111 IQ111 Controller
IQ131 IQ131 Controller
IQ150-V2 Version 2 IQ150 Controller
IQ150-V3 Version 3 IQ150 Controller
IQ151 IQ151 Controller
IQ2 IQ2 Controller
IQ251 IQ251 Controller
IQ3 IQ3 Controller
IQ4 IQ4 Controller
IQ7x IQ7x Series Controller
IQ9x IQ9x Series Controller
IQeco IQeco Controller
IQEYE-Collector IQ EYE Collector
IQL IQL Series Controller
IQView IQView
LINC LonWorks Internetwork Controller (LINC)
LonWorks Generic LonWorks device
MNC Modem Node Controller (MNC)
Modbus Generic Modbus device
NDP Network Display Panel (NDP)
Non-Trend- Non Trend Supervisor
Supervisor
Novar-Logic-One Novar Logic 1 device
PNC Printer Node Controller (PNC)
Supervisor 963 or 962 Supervisor
TOPS-Generic Generic TOPS device
TOPS-Server TOPS
TrendTool Trend Tool
Unknown Unknown device
2. Click New. The Please enter the label dialogue box is displayed.
Note that if the graph definition is to be loaded from a client a maximum of 5 traces can be added.
3. In the box enter the label for the graph definition. The label can be up to 255 characters long.
4. Click OK.
5. Edit the Graph definition to specify the required traces and the graphs appearance.
6. Once the graph is configured as required click OK. The sensor references, logging intervals, scaling, which
axis for each sensor and charting mode (if selected) will be saved.
4. In the box enter the name for the graph definition. The name can be up to 255 characters long.
5. Click OK. The sensor references, logging intervals, scaling, which axis for each sensor and charting mode
(if selected) will be saved.
5.8.2 Delete a Graph Definition
Unwanted graph definitions can be deleted.
To delete a graph definition:
1. On the Graphs menu click View Graph Manager, or click View Manager in the Graph Viewer, or in the
Graph Viewer click the View Manager. The Graph Management dialogue box is displayed.
2. In the Graph Definitions box click the graph definition that is to be deleted.
3. Click Delete.
2. In the Graph Definitions box click the graph definition that is to be edited. The graph definition can now be
edited by adding a trace, deleting a trace, displaying a grid, editing a trace, fix the scaling of the Y axis,
resetting sensor labels, specifying a chart, specifying a precision graph or specifying the label of a graph
Definition. See the appropriate sections of this manual.
3. Once the definition is set up correctly click OK.
Clicking Show full will display the Graph Viewer containing the graph definition as it is currently set up.
5.8.3.1 Add a Trace
A trace can be added to a graph definition.
To add a trace to a graph definition:
1. On the Graphs menu click View Graph Manager, or click View Manager in the Graph Viewer, or in the
Graph Viewer click the View Manager. The Graph Management dialogue box is displayed.
2. In the Graph Definitions box click the graph definition that is to be edited.
3. Click Add Trace. The Edit graph trace dialogue box is displayed.
5. In the Pick a site box click the site containing the point that is to be graphed.
6. In the Pick a LAN box click the Lan containing the point that is to be graphed.
7. In the Pick an OS box click the controller containing the point that is to be graphed.
8. In the Enter a search box enter the label of the point that is to be graphed. An asterisk * can be used as a
wildcard, to specify any number of any characters.
9. Click Find matching points. All the sensors and plots that match the criteria specified above will be listed
in the Pick a point box.
10. In the Pick a point box click the required value.
11. Click OK to return to the Edit graph trace dialogue box. The details of the selected point are added into the
Label and Point reference boxes.
12. Click Choose an interval.
If only one plot module is associated with the value a dialogue box is displayed, click OK the dialogue
box closes, and that plot module is selected.
If more than one plot module is associated with the value the Plots dialogue box is displayed, click the
plot module recording the data at the required interval, and click OK.
13. Click Left or Right to specify whether the axis is to be on the left or right.
14. Click OK.
2. In the Graph Definitions box click the graph definition that is to be deleted.
3. Click the trace that is to be deleted.
4. Click Delete Trace. A prompt is displayed asking for confirmation of the deletion click Yes.
5.8.3.3 Display a Grid on a Graph
963 can display a vertical and/or horizontal grid on any graph. When a horizontal grid is selected, the grid can be
based on either the left, or right hand axis.
To display a grid:
1. On the Graphs menu click View Graph Manager, or click View Manager in the Graph Viewer, or in the
Graph Viewer click the View Manager. The Graph Management dialogue box is displayed.
2. In the Graph Definitions box click the graph definition that is to be edited.
3. Click Left Grid or Right Grid depending which axis is to be used for the grid to display a horizontal grid,
and click X-Grid to display a vertical grid.
4. Click Save.
2. In the Graph Definitions box click the graph definition that is to be edited.
3. Click the trace that is to be edited.
4. Click Edit Trace. The Edit graph trace dialogue box is displayed.
2. In the Graph Definitions box click the graph definition that is to be edited.
3. Select the Fix left or Fix right check box, depending for which axis the scaling is to be fixed.
4. In the Max box enter the maximum value for the axis.
5. In the Min box enter the minimum value for the axis.
6. Click Save.
Note that this facility is not supported when a graph definition is loaded from a client.
5.8.3.6 Reset Sensor Labels
The labels of the traces on a graph definition can become different to the label of the sensor in the Device Viewer if
for example, the labels have been changed, or the site relearned. Therefore, it may be necessary to reset the label for
each trace on the graph to the label of the sensor stored in the Device Viewer.
To reset the sensor labels:
1. On the Graphs menu click View Graph Manager, or click View Manager in the Graph Viewer, or in the
Graph Viewer click the View Manager. The Graph Management dialogue box is displayed.
2. In the Graph Definitions box click the graph definition that is to be edited.
3. Select the Chart check box.
4. In the Refresh interval box enter the refresh interval in seconds between points on the chart.
5. Click Save.
5.8.3.8 Specify a Precision Graph
The graph definition can be set to display a precision chart instead of logged data.
To specify a precision graph:
1. On the Graphs menu click View Graph Manager, or click View Manager in the Graph Viewer, or in the
Graph Viewer click the View Manager. The Graph Management dialogue box is displayed.
2. In the Graph Definitions box click the graph definition that is to be edited.
3. Select the Use Precision check box.
4. Click Save.
2. In the Graph Definitions box click the graph definition that is to be edited.
3. In the Label box enter the label.
4. Click Save.
5.9 Configure the Schematic Pages
Configuring the schematic pages is a very important part of engineering the 963 because it is what the user will see
on a day to day basis. During the planning stage of the project you should have decided on what schematic pages are
required, and what they are to display. The necessary files should have been assembled during the Assemble the
Necessary Files stage and the values made available in the Make the Required Points Available stage.
The first stage in configuring the schematic pages is to configure the template page. All new pages are based on the
template page. Any object on this page is automatically placed onto a new page when it is created, enabling standard
objects to be easily included on all pages.
The second stage is to create the page navigation structure, including folders, and the pages. This structure should
enable each page to be easily located, and allow the necessary security to be provided.
The final stage is to configure the pages themselves by adding the different objects to the page and positioning them
accordingly.
To configure the schematic pages:
1. Set up the schematic template page.
2. Create the page navigation structure.
3. Specify the Object Defaults.
4. Configure the pages.
5. Specify any sound played when a page is displayed.
6. Specify how the pages are refreshed.
7. Check the Display.
2. Click or on the Mode menu click Schematics to select the Schematic Page Display.
3. On the File menu point to Open template and click Schematic Template. The schematic template page is
displayed.
4. Configure the template page in the same way as any schematic page.
5.9.2 Create the Page Navigation Structure
The page navigation structure provides a way of organising pages so that they can be located quickly. Folders are used
to group pages that contain similar types of information. There is no limit to the number of folders. Each folder can
be sub-divided by other folders.
To create the page navigation structure:
1. Create the required folders
2. Create the required pages.
Note that pages can be added by copying . tss files, or directories containing .tss files in to the 'pages' directory (e.g.
from another 963 system). Important if pages are copied from another 963 system, any supporting files (e.g. graphics
etc) must also be copied.
5.9.2.1 Create a Folder
It is possible to create two different types of folder: top-level folders, or a folder within another folder.
To create a top-level folder:
1. Log in.
2. Click or on the Mode menu click Schematics to select the Schematic Page Display.
3. Click Global and on the File menu click Add Folder, or right-click Global, and on the displayed menu click
Add Folder. The Label dialogue box is displayed.
4. In the box enter the name of the folder (max 50-characters). The whole path (including filename) must be
less than 256-characters.
5. Click OK.
To create a folder within another folder:
1. Log in.
2. Click or on the Mode menu click Schematics to select the Schematic Page Display.
3. Click the folder that is to contain the new folder and on the File menu click Add Folder, or right-click the
folder that is to contain the new folder and on the displayed menu click Add Folder. The Label dialogue
box is displayed.
4. In the box enter the name of the folder (max 50-characters). The whole path (including filename) must be
less than 256-characters.
5. Click OK.
5.9.2.2 Delete a Folder
To delete a folder:
1. Log in.
2. Click or on the Mode menu click Schematics to select the Schematic Page Display.
3. Click the on the folder that is to be deleted and on the File menu click Delete, or right-click the folder that is
to be deleted, and click Delete. This displays a dialogue box asking for confirmation of the deletion.
4. Click Yes.
Caution deleting a folder will delete all the pages and folders within it.
5.9.2.3 Move a Folder
To move a folder:
1. Log in.
2. Click or on the Mode menu click Schematics to select the Schematic Page Display.
3. Navigate down the tree structure in the Navigator to display the required folder.
4. Click the folder that is to be moved, and drag it to the required location.
5. Release the mouse button.
5.9.2.4 Rename a Folder
To rename a folder:
1. Log in.
2. Click or on the Mode menu click Schematics to select the Schematic Page Display.
3. Click the folder that is to be renamed and on the File menu click Rename, or right-click the folder that is to
be renamed, and click Rename. The Label dialogue box is displayed.
4. In the box enter the name of the folder (max 50-characters). The whole path (including filename) must be
less than 256-characters.
5. Click OK.
2. Click or on the Mode menu click Schematics to select the Schematic Page Display.
3. Click Global and on the File menu click Add Schematic, or right-click Global, and on the displayed menu
click Add Schematic. The Label dialogue box is displayed.
4. In the box enter the name of the page (max 50-characters). The whole path (including filename) must be less
than 256-characters.
5. Click OK.
To create a page within a folder:
1. Log on.
2. Click or on the Mode menu click Schematics to select the Schematic Page Display.
3. Click the folder that is to contain the new page and on the File menu click Add Schematic, or right-click the
folder, and click Add Schematic. The Label dialogue box is displayed.
4. In the box enter the name of the page (max 50-characters). The whole path (including filename) must be less
than 256-characters.
5. Click OK.
5.9.2.6 Delete a Page
To delete a page:
1. Log in.
2. Click or on the Mode menu click Schematics to select the Schematic Page Display.
3. Click the on the page that is to be deleted and on the File menu click Delete, or right-click the page that is to
be deleted, and click Delete. This displays a dialogue box asking for confirmation of the deletion.
4. Click Yes.
5.9.2.7 Move a Page
To move a folder:
1. Log in.
2. Click or on the Mode menu click Schematics to select the Schematic Page Display.
3. Navigate down the tree structure in the Navigator to display the required page.
4. Click the page that is to be moved, and choose drag it to the required location.
5. Release the mouse button.
2. Click or on the Mode menu click Schematics to select the Schematic Page Display.
3. Click the page that is to be renamed and on the File menu click Rename, or right-click the page that is to be
renamed, and click Rename. The Label dialogue box is displayed.
4. In the box enter the name of the page (max 50-characters). The whole path (including filename) must be less
than 256-characters.
5. Click OK.
It is also possible to rename a page while in page configuration mode by changing the page properties.
To rename a page by changing the page properties:
1. Enter page configuration mode on the page that is to be renamed.
2. On the File menu click Properties or right-click and click Schematic Properties. The Schematic Properties
dialogue is displayed.
3. In the Name box enter the name of the page (max 50-characters). The whole path (including filename) must
be less than 256-characters, and should not include the following characters: , #, and %.
4. Click OK.
5.9.2.9 Specify a Page Description
It is possible specify a description for a schematic page one it has been created.
To specify a page description:
1. Enter page configuration mode on the page that is to be renamed.
2. On the File menu click Properties or right-click and click Schematic Properties. The Schematic Properties
dialogue is displayed.
5. Click the required item and drag it on to the object that is to be edited. The cursor will change to a as the
attribute is being dragged, and then to a when it is over an object onto which it can be dropped.
6. Once the attribute is over the required object release the mouse button.
7. If prompted, specify the attribute that is being specified.
Note that dragging a value onto the object will specify the Label, Units, Connection, Lan, Outstation, and
Item attributes of the value.
If the page to which the object is being added is to be accessed from a client not all actions should be specified
as the Command, When On, When Off, When In Alarm, On Error, While Waiting, When Overridden Off,
and When Overridden On attributes. For details of which actions can be used see the Action Availability
section of this manual. Static objects that use an action that is not supported in the client will not be displayed
in the web browser. It is also recommended that the Autosize option is turned off, and the size specified by
manually. For dynamic objects If the value is to appear as text only and not as a button set the objects PIN
Level attribute to >99.
The 963 Object Attributes section of this manual contains a full description of each of the different object attributes.
3. In the Choose an attribute to replace area select the required option to specify the attribute that is to be
replaced.
If Text attributes is selected specify the particular attributes that are to be changed, and what they are
to be change to. To change the font, click Set new font, and then click the required one from the drop
down list. To change the size, click Set new size, and then enter required size in the box. To change the
colour, click Set new colour, and the click the required colour from the box. To make the text bold,
italic, shadow, or underline, click Set new style, and then click Bold, Italic, Shadow, or Underline as
required.
If Item was selected it is possible to replace the label and units by selecting the Replace Label, Units
check box.
4. In the look for this box enter what text is to be found. The search can be restricted to all the static and
dynamic objects that match the specified criteria. E.g. To restrict the search of dynamic objects to dynamic
objects with a specific telephone number enter the required number in the Connection box. To restrict the
search of dynamic objects to dynamic objects with a specific Lan number enter the required number in the
LAN box. To restrict the search of dynamic objects to dynamic objects with a specific outstation number
enter the required number in the Outstation box.
5. Click either Exact match or Partial match to specify whether the match is to be an exact or partial match.
6. In the And replace it with this box enter the new text. Leaving this blank leaves the text unchanged. This is
useful if only the text attributes are being changed. An action can be specified by clicking Choose a new
display or action, and then specifying the required file or action from the dialogue box that is displayed.
7. Click OK.
5.9.4.4.1.4 Enter Text on More Than One Line
To enter text on more than one line:
1. Click . This will display the keyboard.
To reset to the default size attributes (height, width and autosize) on the Default menu click Reset
selection to default sizes or right-click and on the displayed menu point to Reset Objects and click
Reset selected objects to default sizes.
5.9.4.4.2 Position Objects
5.9.4.4.2.1 Align Objects to the Grid
Objects can be aligned to the grid (the size of the object is adjusted so that all the borders fit on the grid).
To align existing objects to the grid:
1. Display the grid as described in the Display the Grid section of this manual.
2. Select the required objects as described in the Select Objects section of this manual.
3. On the Layout menu point to Grid and click Size all objects to grid or right-click anywhere on the page
and on the displayed menu point to Grid and click Fit all objects to grid.
5.9.4.4.2.2 Display the Grid
A grid can be displayed on a schematic page while it is being configured to help with the alignment of objects on the
page.
To display the grid:
1. Enter page configuration mode for the page.
2. On the Layout point to Grid and click Use Grid, or right-click anywhere on the page and on the displayed
menu point to Grid and click Use Grid. The grid will now be displayed on the page.
5.9.4.4.2.3 Enable/Disable Snap to Grid
When a grid is displayed it is possible to snap objects to the grid (top left is aligned to the nearest grid point) when
they are added to the page, or moved.
To enable/disable snap to grid:
1. Display the grid.
2. On the Layout menu point to Grid and click Snap all objects to grid, or right-click anywhere on the page
and on the displayed menu point to Grid and click Snap all objects to grid.
5.9.4.4.2.4 Specify the Grid
The spacing, colour etc of the grid can be specified to suit your requirements.
To specify the grid:
1. Display the grid.
2. On the Layout menu point to Grid and click Grid Properties, or right-click anywhere on the page and on
the displayed menu point to Grid and click Grid Properties. The Grid dialogue box is displayed.
4. In the Rows box enter the number of rows. The 963 automatically adjusts the number of columns to so that
the table can accommodate the number of objects selected.
5. Click OK.
5.9.4.4.2.6 Move Objects
Once objects have been placed on a page they can be moved into the required position.
To move objects into position:
1. Enter page configuration mode for the page that contains the object(s) that are to be moved.
2. Select the required objects.
3. Click the object(s) and drag it into position.
Or
1. Enter page configuration mode for the page that contains the object(s) that are to be moved, as described in
the Enter Page Configuration Mode section of this manual.
2. Select the required objects.
3. Use the keys to move the objects as required.
Key Function
Move the selected objects 1 pixel in the direction of the arrow.
Shift+ Move the selected objects 5 pixels in the direction of the arrow.
Ctrl+ Align the selected objects in the direction of the arrow.
5.9.4.4.2.7 Move Objects Between Layers
Objects on a page are arranged in layers, one on top of another. It is possible to move objects between layers.
To move objects between layers:
1. Enter page configuration mode for the page that contains the object(s) that are to be moved.
2. Select the required objects.
3. Right-click one of the selected objects, and select the required option from the displayed menu.
Menu Command Function
Move To Front Moves the object(s) to be on top of all the others.
Move To Back Moves the object(s) to be underneath all the others.
Move Forward Moves the object(s) up one layer.
Move Backward Moves the object(s) down one layer.
Note that, active content (e.g. pdf, xls files etc) will always appear on top of other objects.
2. Add a dynamic object to the page linked to the required analogue value.
3. In the Display Object Editor pane click Yes in the Use Outstation Template box to make the object use a
points template file.
4. In the Outstation Template box underneath Use Outstation Template in the Display Object Editor pane
click . The Select Item dialogue box is displayed.
5. Click the required file.
6. Set up the objects other attributes as required.
5.9.4.5.4 Add a Button to a Page
A button ( ) is displayed on a page when a static object is added with the Command attribute defined. When the
page is viewed, the button will be displayed.
To add a button to a page:
1. Add a static object to the page.
2. In the To Display box enter the text that is to appear on the button.
3. Specify the Command attribute to use the required action by clicking in the Command box of the Display
Object Editor pane and clicking the required action from the list, or enter the required code for the action.
Some actions require additional information to be provided. If this is the case, a dialogue box is displayed
enabling the information to be entered.
If the page which the button is being added is to be accessed from a client not all actions should be specified
as the Command attribute. For details of which actions can be used see the Action Availability section of
this manual. Buttons that use an action that is not supported in the client will not be displayed in the web
browser.
4. Set up the objects other attributes as required.
5.9.4.5.5 Add a Button to a Popup Schematic
A button can be placed on a page that will display a schematic page in a pop-up window.
To add a pop-up schematic to a page:
1. Add a static object to the page.
2. Specify the Command attribute to use the POPUP action to display the required schematic page.
3. Set up the objects other attributes as required.
5.9.4.5.6 Add a Button to Calculate the Mean Kinetic Temperature to a Page
A button can be added to the page to calculate the Mean Kinetic Temperature (MKT) for a specified sensor and display
it on the screen, providing the sensor is being recorded by 963.
To add a button to calculate the Mean Kinetic Temperature to a page:
1. Ensure that the sensor for which the Mean Kinetic Temperature is required is being recorded by 963.
2. Add a static object to the page.
3. In the To Display box enter the text that is to appear on the button.
4. In the Command box click . The What action dialogue box is displayed.
5. In the What action do you want to run? box click CALCULATEMKTDATE from the list to specify the
Command attribute to use the CALCULATEMKTDATE action. The Mean Kinetic Temperature dialogue
box is displayed.
6. If the site containing the information is a remote site, in the Connection box enter the telephone number, or
IP address required to access the site
7. In the Lan box enter the Lan containing the required information. Range 0, 1, and 4 to 119 excluding 10.
8. In the Outstation Number box enter the controller containing the required information, range 0, 1, 4 to 119
excluding 10.
9. In the Item box enter the number of the sensor for which the MKT is required.
10. Click Next>. The dialogue box changes to allow the start date of the calculation to be specified.
11. Specify the start date of the calculation by selecting the required month and year from the boxes, and then
clicking the required date.
12. Click Next>. The dialogue box changes to allow the end date of the calculation to be specified.
13. Specify the end date of the calculation by selecting the required month and year from the boxes, and then
clicking the required date.
14. Click Finish to return to the What action dialogue box.
15. Click OK to return to the Display Object Editor pane.
16. Set up the object's other attributes as required.
Note that the result of this calculation is not stored.
5.9.4.5.7 Add a Button to Go to a Generic Page
A button can be added to a page that will display a generic page, and specify the device from which the values are
retrieved.
To go to a generic page and specify the device:
1. Create the required page using generic objects.
2. Specify the Command attribute to link to the required page and define the device by entering the code
described below in the Command box of the Display Object Editor pane.
GOTO <Filename> GENERIC=<Connection>L<Lan Number>O<Controller Address>
<Filename> specifies the page that is to be displayed. <Connection> is an optional parameter that specifies
the IP address or host name if the site is accessed over TCP/IP or the telephone number required to access
the site if it is autodialled. When entering an IP address it must be prefixed by 'IP' e.g. IP192.186.23.87. If
specifying a hostname it must be prefixed by 'IP' and enclosed in double quotes e.g. IP"Albery House". When
entering a telephone number it can contain the following characters.
Characters Description
0 to 9 Dialling characters.
ABCD#* Considered as dialling characters on some systems.
J or : Wait for secondary dial tone.
K or ; or , 2 second pause (Note on some autodiallers this may be a 1 second pause).
< Pulse dialling.
M or = Tone dialling.
<Lan Number> specifies the Lan containing the device (range 0, 1, 4 to 119 excluding 10), 0 specifies the
local Lan. <Controller Address> specifies the address of the controller (range 0, 1, 4 to 119 excluding 10).
E.g.
GOTO pages\AHU Unit.tss GENERIC=01234567890L99O24
This would display the generic page pages\AHU Unit.tss and tell it to obtain values from controller 24 on
Lan 99 accessed using the phone number 01234567890.
4. Set up the objects other attributes as required.
Code Description
<USER> Displays the name of the user currently logged on.
<VER> Displays the version of 963.
To add system variables to a page:
1. Add a static object to the page.
2. Specify the To Display attribute as the required variable, by clicking in the To display box of the Display
Object Editor pane, clicking the required variable from the list, and clicking OK.
3. Set up the objects other attributes as required.
5.9.4.5.16 Add Text to a Page
Text is displayed on a page when a static object is added with some text specified as the To Display attribute. When
the page is viewed, the text will be displayed.
To add a text to a page:
1. Add a static object to the page.
2. In the To Display box of the Display Object Editor pane enter the text.
3. Set up the objects other attributes as required.
Text can also be added to the page by dragging the required text onto the page from the Schematic Config dialogue
box. This will add a static object with the text as the To Display attribute.
5.9.4.5.17 Add the Mean Kinetic Temperature to a Page
The Mean Kinetic Temperature (MKT) for a sensor can be added to the page, providing the sensor is being recorded
by 963. This can be done by adding a static object to the page that calculates the MKT when the page is displayed.
To add the MKT to a page:
1. Ensure that the sensor for which the MKT is required is being recorded by 963.
2. Add a static object to the page as described in the Add Objects to the Page section of this manual.
3. In the To Display box of the Display Object Editor pane specify the To Display attribute to use the
CALCULATEMKTDATE action by entering the command in the format shown below.
<CALCULATEMKTDATE <Connection> L<Lan Number> O<Controller Address>S<Sensor
Number>,<Start Date>,<End Date>>
<Connection> is an optional parameter that specifies the IP address or host name if the site is accessed over
TCP/IP or the telephone number required to access the site if it is autodialled. When entering an IP address
it must be prefixed by 'IP' e.g. IP192.186.23.87. If specifying a hostname it must be prefixed by 'IP' and
enclosed in double quotes e.g. IP"Albery House". When entering a telephone number it can contain the
following characters.
Characters Description
0 to 9 Dialling characters.
ABCD#* Considered as dialling characters on some systems.
J or : Wait for secondary dial tone.
K or ; or , 2 second pause (Note on some autodiallers this may be a 1 second pause).
< Pulse dialling.
M or = Tone dialling.
<Lan Number> specifies the Lan containing the device (range 0, 1, 4 to 119 excluding 10), 0 specifies the
local Lan. <Controller Address> specifies the address of the controller (range 0, 1, 4 to 119 excluding 10).
<Sensor Number> specifies the number of the sensor for which the MKT is required. <Start Date> specifies
the first date in the range for which the MKT is to be calculated. <End Date> specifies the last date in the
range for which the MKT is to be calculated. The code must be enclosed by <>. E.g. <Code>.
E.g.
CALCULATEMKTDATE L24O20S2,26/12/2001,2/1/2002
This would calculate the MKT for sensor 2 in controller 20, on Lan 24 between 26/12/2001, and 2/1/2002.
Note that the result of this calculation is not stored.
4. Set up the objects other attributes as required.
Tip If the MKT for the sensor has already been calculated using a scheduled event, the virtual sensor can be added to
the page.
The 963 is supplied with a number of different print templates which provide some useful options for printing. They
are located in the Navigator for schematics in the Print Templates folder in the 963 Folder.
To create a print template:
1. Add a schematic page.
2. Enter page configuration mode for the page.
3. On the File menu click Properties, or right-click on the page and click Schematic Properties. The
Schematic Properties dialogue box is displayed.
2. Click or on the Mode menu click Internet to select the Web Browser Display.
3. In the Navigator right-click anywhere in the list of available sites, and click Add URL. The URL Setup
dialogue box is displayed.
Tip: To help get the URL right, use Internet Explorer to locate the required page, highlight the URL with a mouse,
press CTRL+C to copy it, follow the procedure for creating a link to an HTML page (described above). When entering
the URL, click in the box and press CTRL+V to paste the URL into 963.
Note that 963s WEB action may be used from a schematic page to jump directly to a particular HTML page.
5.11.2 Delete Links to HTML Pages
Unwanted links to HTML pages can be deleted.
To delete a link to an HTML page:
1. Log in.
2. Click or on the Mode menu click Internet to select the Web Browser Display.
3. Right-click the link that is to be deleted and click Delete.
5.11.3 Edit Links to HTML Pages
Links to HTML pages can be edited.
To edit a link to an HTML page:
1. Log in.
2. Click or on the Mode menu click Internet to select the Web Browser Display.
3. Right-click the link that is to be edited, and click Edit.
4. Change the parameters as required.
5. Click OK.
Tip: To help get the URL right, use Internet Explorer to locate the required page, highlight the URL with a mouse,
press CTRL+C to copy it, follow the procedure for creating a link to an HTML page (described above). When entering
the URL, click in the box and press CTRL+V to paste the URL into 963.
5.12 Configure Occupation Times
The occupation times for the controllers on the system are configured in the Diary Display. This enables the
occupation times in the controllers on the IQ system to be set up and managed. The normal occupation times can be
defined, along with exceptions to the normal times. 963 will automatically download any exceptions to the normal
occupation times to the controller.
The configuration of the occupation times requires a group for each different set of occupation times to be set up, and
connected to the time zones in the controllers that are to work those times. The normal occupation times (standard
week) for each group must be set up along with any exceptions to those times e.g. bank holidays. It is also necessary
to specify when the times will be downloaded. If the normal occupation times are to be left to the local user to set up
and only exceptions are to be centrally managed 963 can be set on only download exceptions.
To configure the occupation times:
1. Create the diary navigation structure.
2. Set up normal occupation times for each diary group.
3. Exception templates which enable sets of exception times to be predefined e.g. for bank holidays etc which
can be used when adding an exception, or to provide the normal occupation times can be setup as described
in the Setup Exception Templates section of the 963 User Guide (TC200635).
4. Link the time zones to the diary groups.
5. Set up any exceptions to the normal occupation times as described in the Add an Exception section of the
963 User Guide (TC200635).
Note that if configuring the occupation times for a BACnet site it is possible to view the occupation times of the BACnet
devices, see the 'View Occupation Times in BACnet Devices' section of this manual for more details.
5.12.1 Create the Diary Navigation Structure
The diary navigation structure provides a way of logically grouping time zones that are to use the same occupation
times together so that they can be located quickly.
To create the diary navigation structure:
1. Add the required diary folders.
2. Add the required diary groups.
2. Click or on the Mode menu click Diary to select the Diary Display.
3. Right-click Global and on the displayed menu click Add Folder. The Label dialogue box is displayed.
2. Click or on the Mode menu click Diary to select the Diary Display.
3. Navigate down the tree structure in the Navigator to display the required folder.
4. Right-click the folder that is to contain the new folder, and on the displayed menu click Add Folder. The
Label dialogue box is displayed.
5. In the box enter the folder name (max 50-characters).
6. Click OK.
5.12.1.2 Delete a Diary Folder
If a diary folder is no longer required it can be deleted.
To delete a diary folder:
1. Log in.
2. Click or on the Mode menu click Diary to select the Diary Display.
3. Navigate down the tree structure in the Navigator to display the required folder.
4. Right-click the diary folder that is to be deleted, and on the displayed menu Delete. This displays a dialogue
box asking for confirmation of the deletion.
Note you will be asked if you want to delete each item within the folder to be deleted. If you choose not to
delete a particular diary group within the folder it will be moved to the root level.
5. Click Yes. For each item in the folder that is to be deleted.
5.12.1.3 Move a Diary Folder
The position of a diary folder can be changed. Moving a folder will also move any diary folders, and diary groups it
contains.
To move a diary folder:
1. Log in.
2. Click or on the Mode menu click Diary to select the Diary Display.
3. Navigate down the tree structure in the Navigator to display the required diary folder.
4. Click the diary folder that is to be moved, and drag it to the required location.
5. Release the mouse button.
2. Click or on the Mode menu click Diary to select the Diary Display.
3. Right-click the diary folder whose name is to be changed, and on the displayed menu click Rename. The
Label dialogue box is displayed.
2. Click or on the Mode menu click Diary to select the Diary Display.
3. Right click here to create a new group. The Group Settings dialogue box is displayed.
4. Click Global to create a group at the root level, or to create a group inside a folder navigate down the tree
structure to display the required folder and click it.
5. Click Next>.
6. In the Label box enter the group name.
7. In the PIN box enter the PIN Level required to see the group (range 0 to 99).
8. Click Next>.
9. In the Download time boxes enter the time when the normal occupation times should be downloaded to the
controllers. The hour should be specified in the first box and the minutes in the second.
10. In the Retry interval box click the interval between retries.
11. If only the exceptions are to be downloaded select the Only download exceptions check box. A warning
message appears. Click Yes to download only the exceptions. If No is selected, 963 will download both
exceptions, and normal occupation times.
Use this option if you wish to globally control the configuration of holidays etc. but want to leave the normal
times under the control of local users.
12. Click Finish. A dialogue box is displayed asking if you want to link the time zones to the group.
13. To assign them now click Yes, to leave it for later click No. If Yes is selected a dialogue box is displayed
enabling the time zones to be linked to the diary group.
14. Set up the occupation times for the group.
15. Click OK.
If there are common time schemes in the Global diary group, go to step 16 or else go to step 17.
Note that the Import Time Scheme option is displayed only if there are common time schemes in the Global
diary group.
16. Import Time Schemes.
Select a time scheme to Import Time Scheme Common to Folder. This action will help you import
the common time schemes of the Global group to the new group. Check the Time Scheme check
box to select all the time schemes. To select one time scheme, clear the Time Scheme check box
and select one time scheme.
Note that if there are more than one time schemes with the same name but different time settings, the Select
a Time Scheme dialogue box is displayed. Select the required time scheme.
2. Click or on the Mode menu click Diary to select the Diary Display.
3. Right-click the diary group that is to be deleted, and click Delete. This displays a dialogue box asking for
confirmation of the deletion.
4. Click Yes.
2. Click or on the Mode menu click Diary to select the Diary Display.
3. Click the diary group for that is to be edited.
4. Click the Group setup and status tab.
5. Click Edit Group Settings. The Group Settings dialogue box is displayed.
2. Click or on the Mode menu click Diary to select the Diary Display.
3. Navigate down the tree structure in the Navigator to display the required diary group.
4. Click the diary group that is to be moved, and drag it to the required location.
5. Release the mouse button.
2. Click or on the Mode menu click Diary to select the Diary Display.
3. Click the diary group for which operating time are to be set up.
4. Click the Time Schemes tab.
5. In the Configured schemes box click Normal Times. The normal times will be displayed in the right of the
screen.
6. Click Edit. A dialogue box asking if you are sure you want to edit the default times is displayed, click Yes.
The Diary Week Day Scheme Editor dialogue box is displayed.
7. The colour used to represent days that use these times can be specified by clicking Choose and selecting the
required colour from the dialogue box that is displayed, and clicking OK.
8. Set up the operating times for each day as required by dragging each end of the bar to specify the times. To
add another period click and drag to the right, and then drag each end of the bar to specify the times. To
set occupation for the whole day, right click the day and on the displayed menu click On all day. To set non-
occupation for the whole day, right click the day and on the displayed menu click Off all day. The times can
be specified by clicking the required period and entering the start and stop times in the Start Hours, Start
Minutes, Stop Hours, and Stop Minutes boxes. Two periods can be merged by right clicking a period and
on the displayed menu Merge Left, or Merge right. Occupation times from one day can be copied and then
pasted to another day, or the entire week, by right clicking the day whose times are to be copied, on the
displayed menu clicking Copy Day, then right clicking the day to which the times are to be pasted, and on
the displayed menu clicking Paste Day. To paste the times to the entire week right click and on the displayed
menu click Paste for week, and to paste them just to the working week (Monday to Friday) week right click
and click Paste for working week. A single period can be copied by right clicking it, and on the displayed
menu clicking Copy, it can then be pasted where required in a similar way to pasting the entire day. To set
occupation for the entire week, right click and on the displayed menu click On all week. To set non-
occupation for the entire week, right click and click Off all week. Existing times can be loaded from another
diary group as described in the Load Existing Times section of the 963 User Guide, or loaded from a
controller as described in the Load Times From a Controller section of the 963 User Guide.
Note that for diary groups that are to define the times for pre IQ3 controllers there is a maximum of 3 periods.
9. Once the occupation times are correctly set up, click OK. A dialogue box asking if you want to download
the changes now or configure the scheduler to do it later is displayed, click the required option and then click
OK.
2. Click or on the Mode menu click Diary to select the Diary Display.
3. Click the diary group for which time zones are to be set up.
4. Click the Group setup and status tab.
5. Click Add/Remove IQ zone(s). The Select Zones dialogue box is displayed.
6. Specify the time zones that are to use the times specified by the group by clicking them in the Zones Left
box to, and then clicking . This will move them into the Zones Chosen box. To remove a time zone
from the list, click it in the Zones Chosen box, and then click . To select a range hold down the
SHIFT key and then click the first and last time zones in the range. Clicking Select All will select all the
displays in the list, and clicking Unselect All will deselect all the time zones currently selected in either the
in Zones Chosen, or Zones Left box.
Note that the 963 only supports binary schedules from BACnet devices
7. Once the required time zones have been added, click OK.
Note that the occupation times in the controllers will now be updated with the times specified in the diary
group.
8. Click Send changes to controllers.
5.12.4 View Schedules in a BACnet Device
If using 963 to configure occupation times for BACnet devices it maybe useful to see what the current occupation
times are in the devices, this is done by viewing the device's schedules.
To view schedules in a BACnet device:
1. Connect to TOPS.
2. In the Networks pane click next to Drivers.
3. Click next to BacnetNetwork.
4. Double click the device from which alarms are to be received.
5. Click the Bacnet Schedule Manager tab. The Schedule Manager screen for the device is displayed.
6. In the BACnet schedules pane click the schedule that is to be viewed. The schedule times are displayed in
the lower part of the screen.
Note that it is not possible to change the times from here.
2. Click , or on the Mode menu click Users to select the User Display.
3. Right-click anywhere in the Navigator, and click Add Workgroup. The Workgroup Information dialogue
box is displayed.
10. Specify the web session time limit (in minutes). Should a user exceed this limit they will be required to re-
enter their log in details in order to continue.
11. Click the View tab.
12. Specify which of the 963s displays users in the workgroup will have access to by clicking the 963s displays
in the View Access Rights box to highlight them, and then clicking >>. This will move them into the Current
View Access Rights box, enabling users in the workgroup to access those displays. To remove a display
from the list that the users can access, click it in the Current View Access Rights box and then click <<. To
select more than one display hold down the CTRL key, and click the required displays. To select a range
hold down the SHIFT key and then click the first and last display in the range. Clicking Select All will select
all the displays in the list.
13. Click the Configuration tab.
14. In the Config Access Rights box click the required access rights and click >> to specify the access rights of
users in the workgroups. This will move them into the Current Config Access Rights box, assigning those
rights to users in the workgroup. To remove a particular access right from the users, click it in the Current
Config Access Rights box, and click <<. To select more than one access right hold down the CTRL key, and
click the required access rights. To select a range hold down the SHIFT key, and then click the first and last
access right in the range. Clicking Select All will select all the access rights in the list.
Access Right Description Default System
Administrator
Access Help Files Specifies whether the users can access the 963s help files.
Add/Remove Specifies whether the users can add or remove folders and
Schematic Pages pages.
Note that users with this access right are able to see all pages
and folders.
Can action alarms Specifies whether the users can action alarms
Can clear alarms Specifies whether the users can clear alarms.
Can move and size Specifies whether the users can move or resize the 963
window Window.
Close Program Specifies whether the users can close 963.
Configure Alarm Specifies whether the users can configure alarm handling.
Handling
Configure Client Specifies whether the users can configure client auto execute
Auto Execute Alarm alarm.
Configure Specifies whether the users can edit the labels, units and PIN
Controller Points levels of items in the Device Viewer.
Configure Data Specifies whether the users can set up automatic data
Recording recording.
Configure Device Specifies whether the users can configure the Device Viewer.
Viewer They are able to learn sites, add sites, collect labels, label
sites, Lans, and controllers and delete sites, Lans, and
controllers.
Configure Diary Specifies whether the users can configure the Diary Display.
Groups
Configure Diary Specifies whether the users can configure occupation times.
Occupation Times
Configure Graphs Specifies whether the users can set up graph definitions.
Configure Scheduler Specifies whether the users can configure the Event
Events Scheduler Display.
Configure Specifies whether the users can configure the schematic
Schematic Pages pages that they are able to see.
Configure SMS Specifies whether the users can configure SMS settings (963
SMS Direct only).
Configure Web Specifies whether the users can configure the Web Browser
Browser Display.
Display Comms Specifies whether the users can display communications
Window information.
Full Web Access Specifies whether the users have full access (i.e. can make
adjustments) from a client.
2. Click , or on the Mode menu click Users to select the User Display.
3. Right-click the workgroup that is to be deleted, and click Delete. This displays a dialogue box asking for
confirmation.
4. Click Yes.
All users within the workgroup will also be deleted.
Ensure that at least one workgroup provides full access rights.
5.13.2 Set Up the User Template Page
It is important to set up the user template page before creating any users to reduce the amount of engineering required.
The user template page defines the objects that are placed on the page that is created for every user. It is set up in
exactly the same way as any other page. The table below lists the objects that should be included in the page.
What should go on the page How to add it
Ability to log in Static object with the Command attribute set to LOGINAS <PNAME>.
Ability to log off Static object with the Command attribute set to LOGOUT.
Ability to change the password Static object with the Command attribute set to CHANGEPASSWORD.
Details about the user e.g. name, Static object set to display the required text.
position, department, extension, and
email address.
Note that once a user has been created, changes made to the user template page WILL NOT be made to existing pages.
Because of this, it is important that it is set up as required before users are added to the system.
2. Click or on the Mode menu click Schematics to select the Schematic Page Display.
3. On the File menu point to Open Template and click User Template. The user template page is displayed.
4. Configure the user template page in the same way as any schematic page.
5.13.3 Add a User
A different user needs to be set up for each person (or group) that is going to use 963. It is important that the Default
user is assigned to the workgroup Default that provides minimal access, and to display a page that allows all the
other users to log in. It is recommended that a minimum of two users with full administrative right are configured for
a system as a backup incase someone forgets their password, or when running 963 is locked.
To add a user:
1. Log in as a user in the System Administrator workgroup.
2. Click , or on the Mode menu click Users to select the User Display.
3. Right-click the workgroup to which the user is to be added and on the displayed menu click Add User. The
Operator name dialogue box is displayed.
6. In the Password box enter the users password. When deciding on the password, it is recommended that
passwords have the following attributes:
Be at least seven characters long.
Use a mixture of upper and lower case characters, e.g. A and a. Do not user '&' in the user name as it causes
problems using client features of 963 Server.
Use some numeric characters, e.g. IlikeFruit7.
Be significantly different from previously used passwords.
Should not use common or guessable names associated with yourself, e.g. love or your partners name.
When running 963 it will check to see that the password confirms to the minimum length, and will not allow
a password to be reused, or use one that has been used by another user.
7. In the Confirmation box enter the users password again.
8. Click OK. The user will be added to the selected workgroup.
5.13.3.1 Change a User's Access Rights
Because a users access rights are determined by the workgroup the users access rights can be changed by editing the
workgroup to change the access rights. This will assign the new access rights to all users in the workgroup, and should
only be done if the access rights of all the users in the workgroup are to be changed. If this is not possible the only
way to change the access rights for a particular person is to move the user into a different workgroup.
To move a user into a different workgroup:
1. Log in as a user in the System Administrator workgroup.
2. Click , or on the Mode menu click Users to select the User Display.
3. Navigate down the tree structure in the Navigator to display the required user.
4. Click the user that is to be moved, and choose drag it to the required workgroup.
5. Release the mouse button.
Note that sometimes when the tree is redrawn the user may be missing it is necessary to right click the tree and click
Refresh View.
2. Click , or on the Mode menu click Users to select the User Display.
3. Click the workgroup containing the user that is to be expired.
4. Right-click the user that is to be expired, and click Expire User. The Are you sure? dialogue box is
displayed.
5. Click Yes.
5.14 Configure Scheduled Events
Scheduled events enable any of 963s actions to be run automatically at specified times. E.g. the automatic recording
of graphs, synchronising the controller times with the PC clock, and pages to be printed at a set time. 963 will also
add scheduled events for the download of occupation times from the Diary, and add events to automatically calculate
the mean kinetic temperature for specified sensors.
To configure scheduled events:
1. Add the required scheduled events to the scheduler.
5.14.1 Add a Scheduled Event
Scheduled events enable any of 963s actions to be run automatically at specified times.
Some actions require additional information to be provided. In this case, a dialogue box is displayed that enables the
information to be entered. For more details about specifying actions see the Specifying Actions section of this
manual. The length of the action code should not exceed 256 characters.
All the variable commands, can be used as described in the 963 Variable Availability section of this manual. The
ISDIARYOCC and ISDIARYNOCC variables can be used to prevent particular actions being carried out at particular
times.
To add a scheduled event:
1. Log in.
2. Click or on the Mode menu click Scheduler to select the Event Scheduler Display.
3. Click New. The Configure Scheduled Action dialogue box is displayed.
4. Click Choose action in the Configure the required command for scheduling area. The What action
dialogue box is displayed.
10. In the First event box enter the date and time when the event is to first occur in the following format:
dd/mm/yy hh:mm:ss
To specify the event to occur now, click Now.
11. If the event is to occur more than once, select the Do you wish to repeat this action check box, and go to
step (12). If the event is to only occur once, clear the Do you wish to repeat this action? check box, and go
to step (15).
12. In the Choose an interval list click the interval at which it is to be repeated. 963 recommends an option
based on the configuration settings.
13. In the ..and how many times to repeat it list click how many times the event is to occur.
14. If Day or Week was specified as the interval, specify the day(s) of the week that the event is to occur. If Day
was selected, all seven days can be selected. If Week was selected, only one day can be selected.
15. Click Next>. A dialogue box is displayed.
16. Check that the event is set up correctly, and then click Finish.
2. Click or on the Mode menu click Scheduler to select the Event Scheduler Display.
3. Right-click the scheduled event that is to be deleted, and click Delete. A dialogue box prompting for
confirmation of the deletion is displayed.
4. Click Yes.
To delete all scheduled events:
1. Log in.
2. Click or on the Mode menu click Scheduler to select the Event Scheduler Display.
3. Click Delete All items from current list. A dialogue box promoting for confirmation of the deletion is
displayed.
4. Click Yes.
5.14.3 Edit a Scheduled Event
To edit a scheduled event:
1. Log in.
2. Click or on the Mode menu click Scheduler to select the Event Scheduler Display.
3. Right-click the event that is to be edited in the scheduler, and on the displayed menu click Edit.
4. Set up the scheduled events action attributes as required.
5. Click Next.
6. Set up the scheduled events time attributes as required.
7. Click Next.
8. Check that the event is set up correctly, and then click Finish.
5.15 Scheduled Event Examples
5.15.1 Automatically Calculate a Sensor's Mean Kinetic Temperature
963 can automatically calculate the Mean Kinetic Temperature (MKT) for a sensor at regular intervals. This is done
by adding an event to the scheduler that runs the CALCULATEMKT action.
To automatically calculate a sensor's MKT:
1. Ensure that the sensor for which the MKT is required is being recorded by 963.
2. Add a scheduled event, using the CALCULATEMKT action by clicking Choose Action and then in the
What action do you want to run? box clicking CALCULATEMKT. The MKT : Mean Kinetic
Temperature dialogue box is displayed.
3. If the site containing the information is remote enter the telephone number, IP address or host name required
to access it in the Connection box.
4. In the Lan Number box enter number of the Lan containing the required information, range 0, 1, 4 to 119
excluding 10.
5. In the Outstation Number box enter the address of the controller containing the required information, range
0, 1, 4 to 119 excluding 10.
6. In the Item box enter the number of the sensor for which the MKT is required.
7. In the Label box enter the label of the sensor for which the MKT is required.
8. Click Next. The dialogue box changes to allow the virtual sensor that is to be used to store the MKT to be
displayed.
9. Click Automatically pick virtual sensor number to make 963 choose the number of the virtual sensor.
Click Manually input virtual sensor number, and enter the number in the box to specify the number
yourself.
10. Click Next. The dialogue box changes to allow the high and low alarm limits for the sensor to be specified.
11. In the Low Alarm Limit (Deg C) box enter the low alarm limit for the sensor.
12. In the High Alarm Limit (Deg C) box enter the high alarm limit for the sensor.
13. Click Next. The dialogue box changes to allow the number of days over which the MKT is to be calculated
to be specified.
14. In the Number of days box enter the required number of days.
15. Click Finish to return to the What action dialogue box.
16. Click OK to return to the Configure Scheduled Action dialogue box.
17. Set up the rest of the scheduled events as required. It is recommended that the optional fail action is set up to
ensure that the user is aware if the calculation fails.
It is also possible to configure the automatic calculation of a sensors MKT by right-clicking it in the Device Viewer,
and on the displayed menu clicking Configure Scheduled MKT.
5.15.2 Automatically Print a Graph
963 can be engineered to print graphs at regular intervals. This is done by adding an event to the scheduler that runs
the PRINTGRAPH, or PRINTGRAPH96 action.
Note that it is recommended not to configure too many graphs that print at the same time, and that the default printer
be set up as required, e.g. landscape/portrait, resolution etc.
To automatically print graphs:
1. Configure the required graph definition showing the required combination of sensors, scaling etc.
2. Add a scheduled event using the PRINTGRAPH, or PRINTGRAPH96 action, scheduled to run as required.
PRINTGRAPH should be used for 1000 point graphs, and PRINTGRAPH96 for 96 point graphs.
PRINTGRAPH <Graph Definition>
<Graph Definition> is the name of the graph definition that is to be printed.
E.g.
PRINTGRAPH Outside Air Temperature
This example prints a graph defined by the graph definition Outside Air Temperature.
5.15.3 Automatically Print a Page
963 can be engineered to print a page automatically at regular intervals by using a script file similar to the one below,
and running it from the scheduler.
GOTO Pages\My Page 1.tss
SLEEP 30000
PRINTPAGEAUTO
The script works by first loading the page into 963, then there is a pause while the values are loaded. The
PRINTPAGEAUTO action is then used to print the page straight to the default printer. The SLEEP time should be
adjusted to suite the local site conditions and you should ensure the default printer is set and configured as required -
landscape/portrait, resolution etc. Because this command loads the schematic into the main window of 963, it is best
to run it at a quiet time of day.
Do not attempt to print a large number of pages in one go, create a number of script files, and schedule each
one at a different time.
To automatically print a page:
1. Create a script file that will print out the required page similar to the one above.
2. Add a scheduled event, using the SCRIPT action as shown below, scheduled to run as required.
SCRIPT <Filename>
<Filename> specifies the path and filename of the script file that is to be played.
E.g.
SCRIPT scripts\samples\page 1.txt
Would run the script file page 1.txt located in the scripts\samples sub-directory of the install directory.
The first line adds a request for S1(V) to the live values cache of 963 - this returns a `Wait` the first time 963 gets the
request. The next line waits a suitable period (in mS) for the value to be refreshed. The third line prints out a message
including the same LIVE request, which by now should have a value in it.
To automatically print a value:
1. Create a script file that will print out the required value similar to the one above.
2. Add a scheduled event, using the SCRIPT action as shown below, scheduled to run as required.
SCRIPT <Filename>
<Filename> specifies the path and filename of the script file that is to be played.
E.g.
SCRIPT scripts\samples\outside.txt
This would run the script file outside.txt located in the scripts\samples sub-directory of the install
directory.
5.15.5 Automatically Record a Graph
963 can automatically record data logged in controllers on the IQ system at specified intervals (e.g. at night when the
system is quiet).
To record logged data automatically:
1. Ensure that the data 963 is to record is being logged in the controller. This should be checked with the strategy
designer if there is any uncertainty.
2. Display a graph from a schematic page or from the Device Viewer and on the Data recording menu click
Configure automatic recording for these sensors.
Or
View the value for which logged data is to be recorded in the Device Viewer, right click the value and click
Configure Data Recording from the displayed menu. If the value is being logged by more than one plotting
channel point to Configure Data Recording and click the required plotting channel.
Note that you can select more than one value for configuring data recording. Press the Ctrl key and select
the required values. Right click and click Configure Data Recording.
A dialogue box is displayed.
3. If precision logs are required click Yes and go to (4) otherwise click No and go to (6). If Yes was selected
the Number of values to collect dialogue box.
4. In the box enter the number of values that are to be collected each time the action is carried out.
6. In the First event box enter the date and time when the data is to be first recorded in the following format:
dd/mm/yy hh:mm:ss
To specify the event to occur now, click Now.
7. If the recording is to be performed more than once, select the Do you wish to repeat this action? check box,
and go to step (9). If the recording is to only be performed once, clear the Do you wish to repeat this action?
check box, and go to step (11).
8. In the Choose an interval box click the interval at which the recording is to occur. 963 recommends an
option based on the configuration settings.
9. In the ..and how many times to repeat it box click how many times recording is to occur.
10. If Day or Week was specified as the interval, select the check box for the day(s) of the week recording is to
occur. If Day was selected, all seven days can be selected. If Week was selected, only one day can be selected.
11. Click Next>. A dialogue box providing a summary of what is to be recorded is displayed.
12. Check that the recording is set up correctly, and then click Finish. A dialogue box is displayed.
13. Click Yes. Either the same settings are applied to all the selected values or an error message is displayed. An
error message is displayed as some of the values may not support the specified interval. You are then
prompted to configure data recording for individual values. Go to step (3) and continue.
Or
Click No to let the settings of the individual values be as is and to manually configure the values. Go to step
(3) and continue.
This is done by adding an event to the scheduler that runs the RECORDTOTEXT action.
To automatically record data to a text file:
1. Ensure that the data 963 is to record, is being logged in the controller.
2. Add a scheduled event, as described in the Add a Scheduled Event section of this manual, using the
RECORDTOTEXT action as shown below, scheduled to run as required.
E.g.
RECORDTOTEXT 0123 456789L99O24P1[10|1|100],C:\Program Files\Trend Control
Systems\963\L99O24P1 Recorded Data.txt,[TAB],[CR]
Specifies the recording of the last 100 values of a precision log or plot module 1 labelled Outside Air in
device 24 on Lan 99 accessed using the phone number 0123 456789, to a file L99O24P1 Recorded Data.txt
with the fields separate by tabs, and records separated by a carriage return.
5.15.7 Automatically Send an SMS Message
If a pay as you go SIM is being used to send the alarms it is recommended that a scheduled event be set up to send a
regular SMS message to keep the SIM active. Some pay as you go SIM cards will be deactivated by the provider if
they are not used for a period of time.
To automatically send an SMS message:
1. Add a scheduled event, using the EXECUTESMS action as shown below, scheduled to run at the required
interval. If this event is being set up to ensure that a pay as you go SIM remains active the interval should be
less than the period inactivity before the SIM is deactivated.
EXECUTESMS <Connection>,<Message>
<Connection> The phone number to which the message is to be sent including the international code.
<Message> specifies the message that is to be sent. The message can be built up by combining the text, and
963 variables. For details of the 963 variables that can be used see the 963 Variable Availability section of
this manual.
E.g.
EXECUTESMS 4401234567890, Scheduled SMS test message
This example sends the SMS message Scheduled SMS test message to a GSM phone whose number is
+44012345678901 using the GSM modem connected to the PC.
5.15.8 Synchronise Controller Times to the PC Clock
It is possible for 963 to send out a message every day that synchronises the times in all controllers to that of the time
clock in the computer, using the scheduler. This is done by adding an action to the scheduler that updates the time of
the controller acting as the timemaster.
To synchronise controller times to the PC clock:
1. Add a scheduled event using the SEND action similar as shown below, scheduled to run once a day for an
unlimited period.
SEND L<Lan Number> O<Device Address>
T(N=<PCMIN>,H=<PCHOUR>,D=<PCDAY>,M=<PCMONTH>,Y=<PCYEAR>)
<Lan Number> specifies the Lan containing the device to which the message is to be sent (range 0, 1, 4 to
119 excluding 10). <Device Address> specifies the address of the device containing the device to which the
message is to be sent (range 0, 1, 4 to 119 excluding 10).
E.g.
SEND L95O44 T(N=<PCMIN>,H=<PCHOUR>,D=<PCDAY>,M=<PCMONTH>,Y=<PCYEAR>)
This example above updates the time in controller 44 on Lan 95.
Note that if the controller is PIN protected the PIN must be correctly set up in Device Viewer.
2. Click or on the Mode menu click Alarms to select the Alarm Viewer.
3. Click the Setup tab.
4. Select or clear the Check this box to perform alarm actions and display alarm panels check box. Selected
means enabled.
5.16.2 Enable/Disable Alarm Logging
When enabled, alarm logging stores alarms in the database.
To enable/disable alarm logging:
1. Log in.
2. Click or on the Mode menu click Alarms to select the Alarm Viewer.
3. Click the Setup tab.
4. Select or clear the Check this box to log alarms to the database check box. Selected means enabled.
5.16.3 Enable/Disable Alarm Printing
When alarm printing is enabled, alarms are printed onto the alarm printer providing printing has been specified in the
group.
Note that disabling printing here will prevent printing of alarms from all groups.
To enable/disable alarm printing:
1. Log in.
2. Click or on the Mode menu click Alarms to select the Alarm Viewer.
3. Click the Setup tab.
4. Select or clear the Check this box to print incoming alarms check box. Selected means enabled.
2. Click or on the Mode menu click Alarms to select the Alarm Viewer.
3. Click the Setup tab.
4. Click Alarm Groups / Filters. A dialogue box is displayed asking if you are sure.
5. Click Yes.
5.16.5 Add a Retransmission Destination
There are seven different types of retransmission destination. The type used depends on where the alarm is to be
retransmitted. This is explained in the table below.
Note that the below retransmission types are available based on your 963 license.
Destination Type Used For
E-mail via SMTP To send an email message to, up to 3 different email address.
E-mail via SMTP with SSL To send an email message to, up to 3 different email address with SSL.
Free format (945 & 963) To retransmit alarms to 963 or 945.
Pager via Trend Modem To send messages, and alarm information to a pager when an alarm occurs.
SMS (963 SMS Direct only) To retransmit alarms using SMS text messaging to a GSM phone. Available only
with 963 SMS Direct.
SNMP (963 SNMP only) To retransmit alarms via SNMP. Available only with 963 SNMP.
Trend text message (PNCs etc) To send standard Trend text message to a specific device on the IQ network.
5.16.5.1 Add a Free format (945 & 963) Retransmission Destination
A Free format (945 & 963) retransmission destination enables 963 to retransmit alarms to another 963, or 945.
To add a Free format (945 & 963) retransmission destination:
1. Log in.
2. Click or on the Mode menu click Alarms to select the Alarm Viewer.
3. Right-click , and click Create a new retransmission destination. The Configure retransmission
destination dialogue box is displayed.
4. In the Type box click Free format (945 & 963). The dialogue box will change to allow the appropriate
parameters to be specified.
8. In the Alternate destination if this one fails box click an alternate destination for the message to be used if
963 cannot deliver the message after the specified number of retries.
9. In the Maximum batch size box enter how many messages are transmitted at one time to the destination
before 963 will retransmit to another destination. It should be set to a low number for low priority destinations
and a higher number for higher priority destinations.
10. If 963 is to store messages for the destination and send them during the occupancy of a specific diary group,
click the required diary group from the Wait until hours defined in this diary group before sending any
pending alarms box.
Tip: You can configure 2 destinations for the same place if you want one for use when sending high priority
alarms all the time (no link to diary) and another for sending low-priority alarms overnight (linked to a diary
group).
11. In the destination LAN address box enter the number of the Lan containing the device to which the message
is to be sent (1 to 119 excluding 2, 3, and 10).
12. In the destination OS address box enter the network address of the device to which the message is to be
sent (1 to 119 excluding 2, 3, and 10).
13. If the <963CODED > or <962CODED> variable is to be used with the destination ensure that the Extra text
for this message box is empty.
14. In the Timeout in ms(!) box enter the length of time in milli-seconds after the message is sent that 963 will
wait before it logs a message failure.
15. If the device to which the message is to be sent is on a remote site, enter the telephone number or IP address
required to access the device in the Site telephone number box. The IP address must be preceded by IP.
The number may be up to 20-characters in length.
Characters Description
0 to 9 Dialling characters.
ABCD#* Considered as dialling characters on some systems.
J or : Wait for secondary dial tone.
K or ; or , 2 second pause (Note on some autodiallers this may be a 1 second pause).
< Pulse dialling.
M or = Tone dialling.
16. Click Click here to send a text message, use the alarm viewer to monitor the results to test that the
destination is set up correctly by. The results of the transmission will be displayed in the bottom of the Alarm
Viewer.
17. Once the destination is correctly set up click OK.
2. Click or on the Mode menu click Alarms to select the Alarm Viewer.
3. Right-click , and click Create a new retransmission destination. The Configure retransmission
destination dialogue box is displayed.
4. In the Type box click Pager via Trend modem. The dialogue box will change to allow the appropriate
parameters to be specified.
2. Click or on the Mode menu click Alarms to select the Alarm Viewer.
3. Right-click , and click Create a new retransmission destination. The Configure retransmission
destination dialogue box is displayed.
4. In the Type box click Trend text message (PNCs etc). The dialogue box will change to allow the appropriate
parameters to be specified.
2. Click or on the Mode menu click Alarms to select the Alarm Viewer.
3. Right-click , and click Create a new retransmission destination. The Configure retransmission
destination dialogue box is displayed.
4. In the Type box click E-mail via SMTP. The dialogue box will change to allow the appropriate parameters
to be specified.
15. In the SMTP server name box enter the IP address or name of the SMTP server that is to be used. This
information should be obtained from the IT department responsible for the Ethernet network to which 963 is
connected.
Note that if a name is used the PC must be able to resolve the name.
16. In the Server port number box enter the port number used by the SMTP server. This is normally 25 but the
information should be obtained from the IT department responsible for the Ethernet network to which 963 is
connected.
17. In the Copy to (1), and Copy to (2) boxes enter the email addresses of additional people who are to receive
the message they should be in the standard format.
E.g.
aperson@company.com.
18. In the Senders' username box enter the username for the email account that is being used to send the
message.
19. In the Senders' password box enter the password for the email account that is being used to send the
message.
20. Click Click here to send a text message, use the alarm viewer to monitor the results to test that the
destination is set up correctly by. The results of the transmission will be displayed in the bottom of the Alarm
Viewer.
18. Once the destination is correctly set up, click OK.
5.16.5.5 Add an E-mail via SMTP with SSL Retransmission Destination
Ensure that your IT provider has enabled SMTP for 963.
An E-mail via SMTP with SSL retransmission destination enables 963 to send an email message to up to 3 different
email address in a secured protocol.
To E-mail via SMTP with SSL Retransmission destination:
1. Log in.
2. Click or on the Mode menu click Alarms to select the Alarm Viewer.
3. Right-click , and click Create a new retransmission destination. The Configure retransmission
destination dialogue box is displayed.
4. In the Type box click E-mail via SMTP with SSL. The dialogue box will change to allow the appropriate
parameters to be specified.
9. In the Maximum batch size box enter how many messages are transmitted at one time to the destination
before 963 will retransmit to another destination. It should be set to a low number for low priority destinations
and a higher number for higher priority destinations.
10. If the 963 is to store messages for the destination and send them during the occupancy of a specific diary
group, click the required diary group from the Wait until hours defined in this diary group before sending
any pending alarms box.
Tip: You can configure 2 destinations for the same place if you want one for use when sending high priority
alarms all the time (no link to diary) and another for sending low-priority alarms overnight (linked to a diary
group).
11. In the Recipients e-mail address box enter the email address to which the message is to be sent. It should
be in the standard format.
E.g.
aperson@company.com.
12. In the Senders e-mail address box enter the email address of the sender. It should be in the standard format.
E.g.
aperson@company.com.
This address is the address to which people can reply to the original message. As 963 cannot receive replies
this address should be set to a person who can deal with the replies e.g. the Building Manager.
13. In the Text for 'subject' field box enter the subject of the message.
Note that variables cannot be used in the subject field.
14. In the Extra text for this message box enter any text that is to always be included in the message.
15. In the SMTP server name box enter the IP address or name of the SMTP server that is to be used. This
information should be obtained from the IT department responsible for the Ethernet network to which 963 is
connected.
Note that if a name is used the PC must be able to resolve the name.
16. In the Server port number box enter the port number used by the SMTP server. This is normally 465 but
the information should be obtained from the IT department responsible for the Ethernet network to which
963 is connected.
17. In the Copy to (1), and Copy to (2) boxes enter the email addresses of additional people who are to receive
the message they should be in the standard format.
E.g.
aperson@company.com.
18. In the Senders' username box enter the username for the email account that is being used to send the
message.
19. In the Senders' password box enter the password for the email account that is being used to send the
message.
20. Click Click here to send a text message, use the alarm viewer to monitor the results to test that the
destination is set up correctly by. The results of the transmission will be displayed in the bottom of the Alarm
Viewer.
21. Once the destination is correctly set up, click OK
5.16.5.6 Delete a Retransmission Destination
To delete a retransmission destination:
1. Log in.
2. Click or on the Mode menu click Alarms to select the Alarm Viewer.
3. Double-click to expand the All retransmission destinations section.
4. Right-click the destination that is to be deleted, and click Delete. A dialogue box is displayed asking for
confirmation of the deletion, click Yes.
2. Click or on the Mode menu click Alarms to select the Alarm Viewer.
3. Double-click to expand the All retransmission destinations section.
4. Right-click the destination that is to be edited, and click Edit. The Configure retransmission destination
dialogue box is displayed.
2. Click or on the Mode menu click Alarms to select the Alarm Viewer.
3. Right-click , and click Create a new filter here. The Alarm filter dialogue box is displayed.
4. In the Filter name box enter the name for the filter.
5. If the filter is to catch all alarms except the one specified (an exclusion filter) select the Use as exclusion
(NOT) filter check box.
6. If the filter is to catch set alarms, select the Filter occurred alarms check box.
7. If the filter is to catch cleared alarms, select the Filter clear alarms check box.
8. In the Tele box enter the connection string of the site(s) for which alarms are to be matched by the filter. If
required it can be dragged from the Suggested items box.
If the site is autodialled, enter the required telephone number of the site in the box.
E.g. 01234567891
If the site is accessed over Ethernet specify the IP address of the required to access it prefixed by IP.
E.g. IP123.456.7.8
To enter more than one site separate them with a comma ,.
E.g. IP123.456.7.8, O1234567891, Albery House
If the site to be referenced by its label the label should be enter in double quotes.
E.g. Albery House"
Wildcards may be used in the label as indicated in the table below.
Wildcard Description
* Any number of any characters.
? Any single character.
E.g. North* would specify any site with a label starting with the word North.
Or
Floor??? would specify any site with a label starting in the word Floor followed by three characters.
9. In the Lan box enter the Lan number, or label of the device(s) for which alarms are to be matched. If required
it can be dragged from the Suggested items box. The valid Lan addresses are 1 to 119 excluding 2, 3, and
10.
If the Lan to be referenced by its label the label should be enter in double quotes.
E.g.First Floor
Wildcards may be used in the label as indicated in the table below.
Wildcard Description
* Any number of any characters.
? Any single character.
E.g. *Floor* would specify any Lan with the word Floor in its label.
Or
Floor??? would specify any Lan with a label starting in the word Floor followed by three characters.
To enter more than one Lan separate them with a comma ,.
E.g. 20, 24, First Floor
To specify a range of Lans separate the top and bottom of the range with a hyphen -.
E.g. 20-24
10. In the OS box enter the network address of the devices whose alarms are to be matched by the filter. If
required it can be dragged from the Suggested items box. The valid addresses are 1 to 119 excluding 2, 3,
and 10.
If the device is to be referenced by its label the label should be enter in double quotes.
E.g. Boiler Room
To enter more than one address separate them with a comma ,
E.g. 20, 24, Boiler Room
To specify a range of addresses separate the top and bottom of the range with a hyphen -.
E.g. 20-24
11. In the Alarm Code box enter the alarm code for the alarms to be matched by the filter. If required it can be
dragged from the Suggested items box.
E.g. AONL
Note that the alarm code must always be entered as 4 characters even if the alarm code is less than 4
characters. E.g. if 'LOW' should be prefixed with a space ' LOW'.
To enter more than one code separate them with a comma,
E.g. AANR,BTNR
Wildcards may be used in the label as indicated in the table below.
Wildcard Description
* Any number of any characters.
? Any single character.
E.g. ??NR would specify any 4-character alarm code ending with the letters NR.
12. In the Text of alarm description box enter the text within the alarm to be matched by the filter. If required
it can be dragged from the Suggested items box.
E.g. Sensor High
Wildcards may be used in the label as indicated in the table below.
Wildcard Description
* Any number of any characters.
? Any single character.
E.g. *Sensor* would specify any alarm containing the word Sensor.
To enter more than one piece of text separate them with a comma ,
E.g. Albery House, Foundry Lane
This text is a piece of text within the incoming alarm message. The position of the text in the alarm
message is dependent on the alarm type.
13. In the Module code or label box enter the module code or label of the modules whose alarms are to be
matched by the filter. If required it can be dragged from the Suggested items box.
If the module(s) are to be referenced by a module code it should be entered in the form below:
<Module><Module Number>
<Module> specifies the type of module using its module identifier (e.g., S specifies sensor modules).
For details of module identifiers see the see the IQ Configuration Reference Manual (90-1533), or the
IQ3/4 Configuration Reference Manual (TE200768). <Module Number> specifies the number of the
module.
E.g. S1
If the module to be referenced by its label the label should be enter in double quotes.
E.g. Outside air Temp
Wildcards may be used in the label as indicated in the table below.
Wildcard Description
* Any number of any characters.
? Any single character.
E.g. *Temp* would specify any module with the word Temp in its label.
To enter more than one module separate them with a comma ,.
E.g. S1,D7,L3, Outside air Temp
To specify a range of modules separate the top and bottom of the range with a hyphen -.
E.g. S1-6
To specify all modules of a particular type use the * wildcard in conjunction with the module identifier
as shown below:
<Module Identifier>*
E.g. K*
14. In the Alarm priority box enter the alarm priority of the alarms that are to be matched by the filter to be
specified. If required it can be dragged it from the Suggested items box.
To enter more than one priority separate them with a comma ,.
E.g. 1,7,3
To specify a range of priorities separate the top and bottom of the range with a hyphen -.
E.g. 20-29
15. Once the filter is correctly set up, click OK.
To check the filter click Test for matching alarms. This will display a box containing the alarms currently in the
alarms database that would have been caught by the filter, or clicking Test for matching results alarms which will
display a box containing a list of points whose alarms would be caught by the filter.
5.16.6.1 Delete an Alarm Filter
To delete a filter:
1. Log in.
2. Click or on the Mode menu click Alarms to select the Alarm Viewer.
2. Click or on the Mode menu click Alarms to select the Alarm Viewer.
3. Right-click the filter that is to be edited, and click Edit. The Alarm filter editor dialogue box is displayed.
2. Click or on the Mode menu click Alarms to select the Alarm Viewer.
3. Right-click All alarm groups, and on the displayed menu click Add group. The Alarm Group dialogue
box shown below is displayed.
4. In the Enter the name of the alarm group box enter the name for the group
5. Click Choose next to the Action when occupied (Default) box, and select the required action from the list
in the dialogue box that is displayed, or enter the required code into the Action when occupied (Default)
box to specify the action that is to occur on the 963 when the group is activated. The code used to specify the
action can be a maximum of 250 characters.
Note that if a diary group is to be specified in the Diary group box the action specified in the Action when
not occupied box will be carried out instead during that diary groups non-occupancy period.
For details about specifying a particular action see the 963 Actions section of this manual.
If alarms are to be retransmitted you should ensure that the retransmission does not produce excessive
network traffic.
6. In the Diary group box click the required diary group to specify whether a different action is to occur when
a particular diary group is in non-occupancy. To turn this off, click None. If a different action is to occur
when a particular diary group is in non-occupancy. Specify that action by clicking Choose next to the Action
when not occupied box, and selecting the required action from the list in the dialogue box that is displayed,
or by entering the required code in the Action when not occupied box. The code used to specify the action
can be a maximum of 250 characters.
For details about specifying a particular action see the 963 Actions section of this manual.
7. If the alarm panel is to be displayed when the group is activated, select the Display an alarm panel for
alarms in this group check box.
8. Click Choose, click the required colour in the dialogue box that is displayed, and then click OK to specify
the colour of the alarm panel.
9. If the alarm panel is to beep when the group is activated, select the Beep when alarm panel is active check
box.
10. If a manual alarm action is to be available specify that action by clicking Choose next to the Command
button setting box, and selecting the required action from the list in the dialogue box that is displayed, or by
entering the required code into the Command button setting box.
For details about specifying a particular action see the 963 Actions section of this manual.
11. Click the Alarm to workgroup setup tab.
12. In the Do not notify these workgroups box click the required workgroup and then click >> to specify the
workgroups whose users will be notified of the alarm if they are logged in. The workgroup name will be
moved to the Notify these workgroups if logged in box. To prevent users from a particular workgroup being
notified of an alarm, click the workgroup in Notify these workgroups if logged in box, and click <<. To
add all workgroups, click Add All; to remove all workgroups click Remove All.
13. If an action is to be carried out when a user in one of the specified workgroups is logged on click Choose
next to the Action box, and select the required action from the list in the dialogue box that is displayed, or
enter the required code in the Action box. The code used to specify the action can be a maximum of 250
characters.
For details about specifying a particular action see the 963 Actions section of this manual.
If the action is required to be carried out if the user logs from a client not all actions can be used. For details
of which actions can be used see the Action Availability section of this manual. Objects that use any of the
other actions will not be displayed.
14. If the user is to be notified of the alarm with a message box when they are logged in on the 963, select the
Popup message on server check box.
15. Click Choose, next to the Present alarms for remote clients in this colour box, click the required colour
in the dialogue box that is displayed, and then click OK to specify the colour of the message box displayed
when the user is logged on using a from a client.
16. Click the Print Options tab.
17. If the alarms are to be printed out select the Print alarms for this group check box.
18. In the Print using this format box enter the message that is to be printed out. This message can include
variable values, and escape characters to define how the message appears on the printout. See the Defining
the Alarm Printout section of this manual for more details. To set this message to be the default message
click Set as Default. To use the default message click Load Default. To reset the message to the factory
default click Restore factory default.
19. If a printer other than the default alarm printer is to be used click Choose printer. The Choose Printer
dialogue box is displayed.
20. In the Select a printer from the list box click the required printer.
21. Click OK.
22. Click the Filters tab.
23. Specify which filters are to be used by the group by adding or removing, filters to the Selected Filters box.
To add a filter, click it in the Available Filters box, and then click >>. To add all the filters click Add All.
To remove a filter from the list, click it in the Selected Filters box, and then click <<. To remove all the
filters, click Remove All.
24. Click OK.
5.16.7.1 Defining the Alarm Printout
The message printed out for each alarm group can be specified by typing the required message in Print using this
format box on Print Options tab of the Alarm Group Editor dialogue box. This message can include text variable
values, and escape characters to define how the message appears on the printout.
The default message is defined below:
<LABEL><TAB><ALARMDESC><TAB><TIME>
Site-><SITE><TAB>LAN-><LANLABEL><TAB>OS-><OSLABEL>
<TELE>L<LAN>O<OS> <MODULE> <ALARMCODE>
It consists of variable values, and some text, and will produce a printout similar to the one shown below:
Outside Air Temp Automatic data recording OK 10/12/2001 14:27:21
Albery House Lan->Forth Floor OS->Boilers
L59O20 S32 DLOK
To define the alarm printout:
1. In the Print using this format box enter the message. The alarm printout is built up by combining the
required text, and 963 variables. For details of the 963 variables that can be used see the 963 Variable
Availability section of this manual.
If required the ESC variable can be used to insert escape characters into the printout to format it, e.g. turning
bold printing ON, or inserting a carriage return. The escape characters will vary depending on the printer that
is being used. Check the documentation supplied with the printer for the correct code.
If a laser printer or inkjet printer is being used for the printing of alarms, and you do not want to wait for a
page of alarms to be generated before anything is printed, it is necessary to include the control code for a
new page at the end of the alarm printout using the ESC variable.
To set this message to be the default message click Set as Default. To use the default message click Load
Default. To reset the message to the factory default click Restore factory default.
5.16.7.2 Delete an Alarm Group
To delete an alarm group:
1. Log in.
2. Click or on the Mode menu click Alarms to select the Alarm Viewer.
3. Double-click All alarm groups.
4. Right-click the group that is to be deleted, and click Delete. A dialogue box is displayed asking for
confirmation of the deletion, click Yes.
5.16.7.3 Edit an Alarm Group
An alarm group can be edited.
To edit an alarm group:
1. Log in.
2. Click or on the Mode menu click Alarms to select the Alarm Viewer.
3. Right-click the group that is to be edited, and click Edit. The Alarm Group Editor dialogue box is displayed.
4. Set up the parameters as required.
5. Click OK.
5.16.7.4 Alarm Group Examples
5.16.7.4.1 Display a Message When an Alarm Occurs
963 can be engineered to display a message when an alarm occurs by using the MESSAGE action.
To print a graph when an alarm occurs:
1. Add an alarm group that uses the MESSAGE action as shown below for the Action when occupied (default)
attribute as described in the Add an Alarm Group section of this manual.
E.g.
MESSAGE System Fault, Ring the Engineer,0,!,65025,255
This example displays a message box titled System Fault containing the text Ring the Engineer until the
user presses OK.
For more information about the MESSAGE action see the Specifying the MESSAGE Action section of this manual.
5.16.7.4.2 Print a Graph when an Alarm Occurs
963 can be engineered to a print graph when an alarm occurs by using the PRINTGRAPH action. If this facility is to
be used and you should ensure the default printer is set and configured as required - landscape/portrait, resolution etc.
To print a graph when an alarm occurs:
1. Configure the required graph definition showing the required combination of sensors, scaling etc.
2. Add an alarm group, using the PRINTGRAPH action as shown below for the Action when occupied (default)
attribute.
PRINTGRAPH <Graph Definition>
<Graph Definition> is the name of the graph definition that is to be printed.
E.g.
PRINTGRAPH Outside Air Temperature
This prints a graph defined by the graph definition Outside Air Temperature.
2. Click or on the Mode menu click Alarms to select the Alarm Viewer.
3. Right-click , and click Add group. The Alarm Group Editor dialogue box is displayed.
4. In the Group Name box enter the name for the group.
5. Click Choose next to the Action when occupied (default) box.
6. Click RETRANSMIT from the list in the dialogue box that is displayed. A dialogue box listing all the
retransmission destinations is displayed.
7. Click the required destination from the list.
8. Click OK. The Message dialogue box is displayed.
9. In the box enter the required message into the box. The message can be built up by combining the text, and
963 variables.
E.g.
A <ALARMCODE> occurred at <TIME> from <LABEL> in <OSLABEL>
The code above would send a message similar to the one below:
A HIGH occurred at 14:50 from Outside Air Sensor in Office Block
The default is <ALLLABELS> variable that will include all the labels from the alarm in the message.
For details of the 963 variables that can be used see the 963 Variable Availability section of this manual.
10. Click OK. The What action dialogue box is displayed.
11. Click OK. The Alarm Group Editor dialogue box is displayed.
12. Set up the alarm groups other parameters as required.
13. Once the group is set up as required, click OK
2. Click or on the Mode menu click Alarms to select the Alarm Viewer.
3. Right-click and click Add group. The Alarm Group Editor dialogue box is displayed.
4. In the Group Name box enter the name for the group.
5. Click Choose next to the Action when occupied (default) box.
6. Click RETRANSMIT from the list in the dialogue box that is displayed. A dialogue box listing all the
retransmission destinations is displayed.
7. Click the required destination from the list.
8. Click OK. The Message dialogue box is displayed.
9. In the box enter the required message. The message can be built up by combining the text, and 963 variables.
E.g.
A <ALARMCODE> occurred at <TIME> from <LABEL> in <OSLABEL>
The code above would send a message similar to the one below:
A HIGH occurred at 14:50 from Outside Air Sensor in Office Block
The default is <ALLLABELS> variable that will include all the labels from the alarm in the message.
For details of the 963 variables that can be used see the 963 Variable Availability section of this manual.
10. Click OK. The What action dialogue box is displayed.
11. Click OK. The Alarm Group Editor dialogue box is displayed.
12. Set up the alarm groups other parameters as required.
13. Once the group is set up as required, click OK.
2. Click or on the Mode menu click Alarms to select the Alarm Viewer.
3. Right-click and click Add group. The Alarm Group Editor dialogue box is displayed.
4. In the Group Name box enter the name for the group.
5. Click Choose next to the Action when occupied (default) box.
6. Click RETRANSMIT from the list in the dialogue box that is displayed. A dialogue box listing all the
retransmission destinations is displayed.
7. Click the required destination from the list.
8. Click OK. The Message dialogue box is displayed.
9. In the box enter the required message into the box. The message can be built up by combining the text, and
963 variables.
E.g.
A <ALARMCODE> occurred at <TIME> from <LABEL> in <OSLABEL>
The code above would send a message similar to the one below:
A HIGH occurred at 14:50 from Outside Air Sensor in Office Block
The default is <ALLLABELS> variable that will include all the labels from the alarm in the message.
For details of the 963 variables that can be used see the 963 Variable Availability section of this manual.
10. Click OK. The What action dialogue box is displayed.
11. Click OK. The Alarm Group Editor dialogue box is displayed.
12. Set up the alarm groups other parameters as required.
13. Once the group is set up as required, click OK.
14. Add a record to the number table of the MNC/TMN that is to communicate with the pager. See the
Autodialling Reference Manual (90-1353), or the /TMN Installation Instructions Configuration
(TG200088).
2. Click or on the Mode menu click Alarms to select the Alarm Viewer.
3. Right-click and click Add group. The Alarm Group Editor dialogue box is displayed.
4. In the Group Name box enter the name for the group.
5. Click Choose next to the Action when occupied (default) box.
6. Click RETRANSMIT from the list in the dialogue box that is displayed. A dialogue box listing all the
retransmission destinations is displayed.
7. Click the required destination from the list.
8. Click OK. The Message dialogue box is displayed.
9. In the Message box enter <FORPNC>. This will automatically configure your alarms to be printed in the
following format:
Site name Lan name Os name
Item label Alarm label Time and date
Coded form of above
10. Click OK. The What action dialogue box is displayed.
11. Click OK. The Alarm Group Editor dialogue box is displayed.
12. Set up the alarm groups other parameters as required.
13. Once the group is set up as required, click OK.
5.16.7.4.10 Retransmit Alarms to an Email Address
An alarm group can be set up to retransmit alarms to an Email address. This is done by configuring the alarm group
to use the RETRANSMIT action specifying the required destination.
If alarms are to be retransmitted, you should ensure that the retransmission does not produce excessive
network traffic.
To retransmit an alarm to an Email Address:
1. Add an E-mail via SMTP retransmission destination or Add an E-mail via SMTP with SSL retransmission
destination that specifies the address of the Email address to which the alarm is to be sent.
2. Click or on the Mode menu click Alarms to select the Alarm Viewer.
3. Right-click and click Add group. The Alarm Group Editor dialogue box is displayed.
4. In the Group Name box enter the name for the group.
5. Click Choose next to the Action when occupied (default) box.
6. Click RETRANSMIT from the list in the dialogue box that is displayed. A dialogue box listing all the
retransmission destinations is displayed.
7. Click the required destination from the list.
8. Click OK. The Message dialogue box is displayed.
9. In the box enter the required message. The message can be built up by combining the text, and 963 variables.
E.g.
A <ALARMCODE> occurred at <TIME> from <LABEL> in <OSLABEL>
The code above would send a message similar to the one below:
A HIGH occurred at 14:50 from Outside Air Sensor in Office Block
The default is <ALLLABELS> variable that will include all the labels from the alarm in the message.
For details of the 963 variables that can be used see the 963 Variable Availability section of this manual.
10. Click OK. The What action dialogue box is displayed.
11. Click OK. The Alarm Group Editor dialogue box is displayed.
12. Set up the alarm groups other parameters as required.
13. Once the group is set up as required, click OK.
2. Click or on the Mode menu click Alarms to select the Alarm Viewer.
3. Right-click and click Add group. The Alarm Group Editor dialogue box is displayed.
4. In the Group Name box enter the name for the group.
5. Click Choose next to the Action when occupied (default) box.
6. Click RETRANSMIT from the list in the dialogue box that is displayed. A dialogue box listing all the
retransmission destinations is displayed.
7. Click the required destination from the list.
8. Click OK. The Message dialogue box is displayed.
9. In the Message box enter <962CODED>.
10. Click OK. The What action dialogue box is displayed.
11. Click OK. The Alarm Group Editor dialogue box is displayed.
12. Set up the alarm groups other parameters as required.
13. Once the group is set up as required, click OK.
5.16.7.4.12 Retransmit Alarms to Multiple Destinations
There are two methods that can be used to retransmit alarms to more than one destination. Method 1 uses a combination
of alarm filters, alarm groups and alarm retransmission destinations. Method 2 is similar but uses a script file that
contains each retransmission command.
Method 1
1. Create an alarm filter to catch the required alarms.
2. Create the required retransmission destinations.
3. Create an alarm group for each alarm destination, and ensure that the same alarm filter is used for each group.
4. Edit first alarm group, and click Choose next to the Action when occupied (default) box.
5. Click RETRANSMIT from the list in the dialogue box that is displayed. A dialogue box listing all the
retransmission destinations is displayed.
6. Click the required destination from the list, and click OK.
7. Repeat steps (5) and (7) until all alarm groups have been linked to the required alarm destination.
8. Click OK.
This method is useful as you can link the group to a diary group and restrict when the retransmission occur.
Method 2
1. Create an alarm filter to catch the required alarms.
2. Create the required retransmission destinations.
3. Create an alarm group linked to the alarm filter created in step (1).
4. Create a script file with a RETRANSMIT action for each destination. E.g.
RETRANSMIT 1,(BoilerHouse),<ALLLABELS>
RETRANSMIT 2,(Security),<ALLLABELS>
RETRANSMIT 3,(BMSManager),<ALLLABELS>
The script above would retransmit the alarm to three destinations, BoilerHouse, Security, and
BMSManager.
For details of the RETRANSMIT action see the Specifying the RETRANSMIT Action section of this
manual. You can use the command line editor within 963 to help formulate these actions.
5. Edit the alarm group, and click Choose next to the Action when occupied (default) box.
6. Click SCRIPT from the list in the dialogue box that is displayed. A dialogue box listing all the script files is
displayed.
7. Click the required file from the list, and click OK.
8. Click OK.
6. Click or on the Mode menu click Alarms to select the Alarm Viewer.
7. Right-click and click Add group. The Alarm Group Editor dialogue box is displayed.
8. In the Group Name box enter the name for the group.
9. Click Choose next to the Action when occupied (default) box.
10. Click RETRANSMIT from the list in the dialogue box that is displayed. The Select a retransmission
destination dialogue box listing all the retransmission destinations is displayed.
11. Click the required destination that from the list.
12. Click OK. The Message dialogue box is displayed.
13. In the Message box enter <ALARMASXML>. This will automatically configure the alarms as required.
14. Click OK. The What action dialogue box is displayed.
15. Click OK. The Alarm Group Editor dialogue box is displayed.
16. Click the Filters tab.
17. Specify the filters that have been set up to catch the required alarms by adding or removing, filters to the
Selected Filters box. To add a filter, click it in the Available Filters box, and then click >>. To add all the
filters click Add all >>. To remove a filter from the list, click it in the Selected Filters box, and then click
<<. To remove all the filters, click << Remove all.
18. Set up the alarm groups other parameters as required.
19. Once the group is set up as required, click OK.
20. The information in each alarms EXTRAINFO1 and EXTRAINFO2 fields is included in the message (trap)
to the NMS these fields can be used for your own specific requirements. E.g. the EXTRAINFO1 field could
be used to group the alarms by type e.g. heating, cooling, ventilation etc, and the text in the EXTRAINFO2
field could be used to specify the severity e.g. 0 clear, 1 Information, 2 Low, 3 Medium, and 4 Critical. To
do this extra text must be added to each alarm being sent using SNMP in either the EXTRAINFO1 or
EXTRAINFO2 field.
21. Use the SNMP program manager to configure the destination to process the incoming alarm as required. This
must be done by the person responsible for that network (usually the IT department). 963 sends the alarms
(traps) in the format defined in the '963SNMP.mib' file. The MIB file can be found in the SNMP sub-directory
of the install directory. The alarms contain the following information.
Item Description
Alarm Index The unique reference given to the alarm by 963
Alarm Device The device generating the alarm specified in the format:
<Connection>/L<Lan Number>/O<Controller Address>
<Connection> is an optional parameter that specifies the IP address or host name if the site
is accessed over TCP/IP or the telephone number required to access the site if it is
autodialled. When entering an IP address it must be prefixed by 'IP' e.g. IP192.186.23.87. If
specifying a hostname it must be prefixed by 'IP' and enclosed in double quotes e.g.
IP"Albery House". <Lan Number> specifies the Lan containing the device, and <Controller
Address> specifies the address of the device.
Date and Time The date and time the alarm occurred in the format:
<YYYY>-<MM>-<DD>T<hh>:<mm>:<ss>
<YYYY> specifies the year, <MM> specifies the month number, <DD>, specifies
the date of the month, <hh> specifies the hour, <mm> specifies the minutes, and
<ss> specifies the seconds.
Module The module code of the module that is in alarm e.g. S1 for sensor 1.
Item Description
Alarm A text description of the alarm.
Description
Alarm Code A 4-character code that specifies the alarm, see the Alarm Codes section of this manual
for more details.
Module Label The label of the module in alarm.
EXTRAINFO1 The text defined in the EXTRAINFO1 field.
EXTRAINFO2 The text defined in the EXTRAINFO2 field.
SNMP does not support secure delivery therefore it is not possible to tell if the alarms (traps) reach the NMS.
For this reason, some customers request a data field that holds a sequential number. Their NMS can then
determine if it has lost an alarm (trap) by looking for gaps in the numbering sequence.
The 963 creates a unique alarm ID which is sequential for all alarms logged. In a typical system, not all
alarms are retransmitted hence those sent via SNMP will have gaps in the sequence. However, if ALL 963
alarms were transmitted then this could be used to satisfy the requirement.
If it is necessary to send a heat beat trap to the NMS so that it knows the 963 is still working configure a
LOGMSG command in the 963 scheduler to create an internal alarm at the required interval. The LOGMSG
details should be set to match the filters created in the alarm viewer so that a new 963 trap is triggered.
Various free tools are available for testing 963 SNMP transmissions.
2. Click or on the Mode menu click Alarms to select the Alarm Viewer.
3. Right-click and click Add group. The Alarm Group Editor dialogue box is displayed.
4. In the Group Name box enter the name for the group.
5. Click Choose next to the Action when occupied (default) box.
6. Click RETRANSMIT from the list in the dialogue box that is displayed. A dialogue box listing all the
retransmission destinations is displayed.
7. Click the required destination from the list.
8. Click OK. The Message dialogue box is displayed.
9. In the box enter the required message. The message can be built up by combining the text, and 963 variables.
E.g.
A <ALARMCODE> occurred at <TIME> from <LABEL> in <OSLABEL>
The code above would send a message similar to the one below:
A HIGH occurred at 14:50 from Outside Air Sensor in Office Block
The default is <ALLLABELS> variable that will include all the labels from the alarm in the message.
For details of the 963 variables that can be used see the 963 Variable Availability section of this manual.
10. Click OK. The What action dialogue box is displayed.
11. Click OK. The Alarm Group Editor dialogue box is displayed.
12. In the Diary group box click the diary group that is to be linked to the alarm group.
13. Click Choose next to the Action when not occupied box.
14. Click RETRANSMIT from the list in the dialogue box that is displayed. A dialogue box listing all the
retransmission destinations is displayed.
15. Click the required destination from the list.
16. Click OK. The Message dialogue box is displayed.
17. In the box enter the required message. The message can be built up by combining the text, and 963 variables.
E.g.
A <ALARMCODE> occurred at <TIME> from <LABEL> in <OSLABEL>
The code above would send a message similar to the one below:
A HIGH occurred at 14:50 from Outside Air Sensor in Office Block
The default is <ALLLABELS> variable that will include all the labels from the alarm in the message.
For details of the 963 variables that can be used see the 963 Variable Availability section of this manual.
18. Click OK. The What action dialogue box is displayed.
19. Click OK. The Alarm Group Editor dialogue box is displayed.
20. Once the group is set up as required, click OK.
5.16.7.4.15 Retransmit to a WAP Phone
963 can retransmit alarms to a WAP phone. This is done by retransmitting to an email address that can be accessed
by the phone, therefore the set up is exactly the same as for Retransmitting Alarms to an Email Address.
2. Click or on the Mode menu click Alarms to select the Alarm Viewer.
3. Double-click All alarm groups.
4. Right-click Default Alarm Group and on the displayed menu click Edit. The Alarm Group dialogue box
is displayed.
2. Click or on the Mode menu click Alarms to select the Alarm Viewer.
3. Right-click Alarm Priorities, and on the displayed menu click Add alarm priority. The Add alarm
priority dialogue box is displayed.
4. In the Select the priority level box click the alarm priority that is to be added. Range = 0 to 255. 0 is the
lowest priority.
5. If alarms of this priority are to be displayed in the incoming alarms list select the Display these alarms in
the incoming alarms list check box.
6. Click Choose Colour, and in the displayed dialogue box click the required colour, and click OK. To use a
custom colour click Define Custom Colors>>.
7. Click OK.
5.16.9.2 Delete an Alarm Priority
If a particular alarm priority is no longer required it can be deleted.
To delete an alarm priority:
1. Log in.
2. Click or on the Mode menu click Alarms to select the Alarm Viewer.
3. Double-click Alarm Priorities to expand the Alarm Priorities section.
4. Right-click the priority that is to be deleted, and choose Delete from the displayed menu. A dialogue box is
displayed asking for confirmation of the deletion, click Yes.
5.16.9.3 Edit an Alarm Priority
A particular alarm priority can be edited.
To edit an alarm priority:
1. Log in.
2. Click or on the Mode menu click Alarms to select the Alarm Viewer.
3. Double-click Alarm Priorities to expand the Alarm Priorities section.
4. Right-click the priority that is to be edited, and click Edit.
5. Set up the parameters as required.
6. Once the filter is correctly set up click OK.
5.16.9.4 Specify Alarm Priorities for Early IQ Alarms
If alarms received from IQ controllers less than version 3.0 are to have priorities assigned to them it is necessary to
define the priority level associated with each alarm because it is not included in the alarm itself.
To specify alarms for early IQ alarms:
1. Log in.
2. Click or on the Mode menu click Alarms to select the Alarm Viewer.
3. Click the Setup tab.
4. Click Edit Alarm Priority Table. The Edit alarm priority lookup table dialogue box is displayed.
2. Click , or on the Mode menu click Device Viewer to select the Device Viewer.
3. Ensure that the 945, from which alarms are to be retransmitted appears in the Device Viewer.
4. Right-click the 945, from which alarms are to be retransmitted, and on the displayed menu Update from the
displayed menu. A dummy critical alarm is added. This dummy critical alarm will go into an alarm condition
when a retransmitted alarm is received from that 945.
Note that the 945 must be set up correctly to retransmit the alarm to the 963. This requires the 963 to appear in one
of the 945 Groups in the Outstation Organiser, and be identified as a 945 Issue 2. For details of setting up 945 Groups
see the 945 Supervisor Engineering Manual (TD101379).
2. Click or on the Mode menu click Alarms to select the Alarm Viewer.
3. Click the Setup tab.
4. Click Alarm Codes. The Edit alarm code lookup table dialogue box shown below is displayed.
5. Scroll down to the code of the alarm that is to be set to be auto actioned.
6. Scroll across to the alarmRequiresAction column.
7. In the alarmRequiresAction column click the cell corresponding to the required alarm.
8. In the Field value box enter 1 to cause the alarm to be auto actioned, or 0 for it to be require user
acknowledgement
9. Click OK.
Do not change items in any of the other columns.
Note that setting an alarm to be auto actioned will prevent it being displayed in an alarm panel. However, filters will
catch it, and therefore any actions carried out.
Unwanted alarm codes can be removed by clicking them in the table, and then clicking Delete, and new ones added
by clicking New and then specifying the parameters for the new code.
If required the user can be prevented from seeing automatically actioned alarms by hiding them from all alarm views
except Historic as described in the Hide Auto Actioned Alarms section of this manual.
2. Click or on the Mode menu click Alarms to select the Alarm Viewer.
3. Click the Setup tab.
4. Click Alarm Codes. A dialogue box is displayed.
5. Scroll down to the code of the alarm that is to be set to cause a red bell to be displayed.
6. Scroll across to the displaysInRed column.
7. In the displaysInRed column click the cell that corresponds to the required alarm.
8. In the Field value box enter 1 to cause the alarm to display a red bell, or 0 not to display the red bell.
9. Click OK.
Do not change items in any of the other columns.
Unwanted alarm codes can be removed by clicking them in the table, and then clicking Delete, and new ones added
by clicking New and then specifying the parameters for the new code.
5.16.14 Specify Extra Text for Alarms
Two additional text descriptions can be added to in-coming alarms. They can be used to supply additional information
about the alarm to the user. The additional text can be made part of your alarm action using 2 variables:
<EXTRAINFO1>
<EXTRAINFO2>
The 963 matches the parameters of incoming alarms with the details in the table to pick out the required extra
information text. The priority is used to determine the order in which 963 looks for a match. The alarm to which the
extra text is added is determined by matching the following parameters of the incoming alarm.
Priority
ConnectionString
Lan
Os
Label
Alarmed
The text that has the highest priority is used, unless the Matches are cumulative check box is selected. This will
cause all the pieces of extra text that match the parameters of the incoming alarm to be used. If this is the case each
piece of text will be separated by a specified character e.g. new line.
Tip It is recommended if you are retransmitting alarms using SNMP the text in the EXTRAINFO1 field should be
used to group the alarms by type e.g. heating, cooling, ventilation etc, and the text in the EXTRAINFO2 field should
be used to specify the serenity e.g. 0 clear, 1 Information, 2 Low, 3 Medium, and 4 Critical.
To specify extra text:
1. Log in.
2. Click or on the Mode menu click Alarms to select the Alarm Viewer.
3. Click the Setup tab.
4. Click Extra Alarm Text 1 if the extra text is to be added to the <EXTRAINFO1> field, or Extra Alarm
Text 2 if the extra text is to be added to the <EXTRAINFO2>. A dialogue box is displayed.
Note that the module cannot be specified using codes such as S for sensors, K for knobs etc.
Wildcards may be used as indicated in the table below.
Wildcard Description
* Any number of any digit
? Any single number.
E.g.
* would mean any label
Or
*Room would specify any module with a label ending in the word Room.
Or
Boiler?? would specify any module with a label ending starting with the word Boiler followed by any
2 characters.
11. Click the cell in the alarmCode column for the new record, and specify the alarm code for which for which
alarms are to have extra text added.
E.g. AONL
Wildcards may be used as indicated in the table below.
Wildcard Description
* Any number of any digit
? Any single number.
E.g.
??NR would specify any 4-character alarm code ending with the letters NR.
12. Click the cell in the Extra Info column for the new record, and specify the text that is to be added.
13. Click OK.
14. If all the matching pieces of extra text are to be used is select the Matches are cumulative check box, and
specify the character that is to separate each individual piece of text in the Separator between matching
text box.
Unwanted extra text can be removed by clicking them in the table, and then clicking Delete, and new ones added by
clicking New and then specifying the parameters.
2. Click or on the Mode menu click Alarms to select the Alarm Viewer.
3. Click the Setup tab.
4. Click Module Labels. A dialogue box is displayed.
2. Click or on the Mode menu click Alarms to select the Alarm Viewer.
3. Click the Setup tab.
4. Click Alarm Codes. A dialogue box is displayed.
2. Click or on the Mode menu click Alarms to select the Alarm Viewer.
3. Click the Setup tab.
4. Click Restore Default. A dialogue box asking for confirmation is displayed
5. Click Yes. The default alarm codes will be restored. This may take some time.
5.17 Configure 963 Server
If 963 is to function as a server providing information to clients, the way in which the server operates needs to be
defined.
To configure 963 Server:
1. Create any HTML Pages.
2. Convert bitmaps to JPG format.
3. Specify whether the last login date and time are displayed in the login page.
4. Specify whether PC names are displayed.
5. Specify what is displayed when the client first accesses the server.
6. Specify the size of the schematic window.
7. Specify the size of the schematic applet.
8. Specify the number of points sent to clients.
9. Specify the servers TCP/IP port.
5.17.1 Convert Bitmaps to JPEG Format
For the graphics on a schematic page to be displayed, they must be converted to JPEG format. This is done dynamically
by 963 Server when a client requests a page. However, this process takes time, slowing down the display of the page.
The load time of pages viewed in a client can be improved if the conversion has already been done.
To convert graphics to JPG format:
1. Using the graphics package of your choice, open each bitmap that is to be accessed by a client, and save it in
JPEG format.
Note that where possible if pages are to be accessed from a client you should use JPEG.
5.17.2 Display Last Login Date and Time
It is possible to display the date and time the user last logged in on the login page.
To display the last login date and time:
1. Edit the [WEBSERVER] section of the S2.INI file as below:
[WEBSERVER]
DISPLAYLASTLOGINTIME=<Display>
<Display> specifies whether the login date and time is displayed. 1 will display the information, and 0 will
not display the information.
E.g.
[WEBSERVER]
DISPLAYLASTLOGINTIME=1
2. On the Tools menu, click Configure Web Server. The 963 Web Server Configuration dialogue box is
displayed.
3. Click Manage Server Certificates. The Server Certificate Manager window is displayed.
4. Click Create self signed Certificate button. The Confirm Site Information dialogue box is displayed
4. Click OK. The Save As dialogue box is displayed. Browse to the location the certificate is to be exported to.
4. Specify the location and name of the backed up file by typing the path and filename into the File Name box.
If required 963 variables can be used to help specify the path and filename. The default is to back up the file
to the directory in which 963 is installed, the filename is trend96X and includes the date and time. The
location of the file can also be specified by clicking Choose file location and browsing to the required
directory. To return to the default settings click Generate default file name.
Note that the database can only be backed up to a local drive unless 963 has been correctly configured to
backup to a network location, and the PC running 963 must be logged on to the network using the network
user name specified during that configuration process. An alternative to this is to backup the files locally,
and then copy the files created to the required remote location using a script file.
5. Click Finish. The dialogue box changes.
6. In the First event at box enter the date and time when the backup is to first occur by in the following format:
dd/mm/yy hh:mm:ss
To specify the event to occur now, click Now.
7. If the backup is to occur more than once, select the Do you wish to repeat this action? check box, and go
to step (10). If the event is to only occur once, clear the Do you wish to repeat this action? check box, and
go to step (13).
8. In the Choose an interval list click the interval at which it is to be repeated. 963 recommends an option
based on the configuration settings.
9. In the ..and how many times to repeat it list click how many times the event is to occur.
10. If Day or Week was specified as the interval, specify the day(s) of the week that the event is to occur. If Day
was selected, all seven days can be selected. If Week was selected, only one day can be selected.
11. Click Next>. A dialogue box describing what has been set up is displayed.
12. Check that everything is set up correctly, and then click Finish.
3. If the database name is to be changed in the Current database name box enter the new database name.
It is NOT recommended that the database name be changed.
4. In the Current database server box specify the location of the SQL Server. A full stop '.' species a local
server. To specify a remote server enter the name of the PC running SQL server, and the instance used in the
form shown below.
<SQL server PC name>\<instance name>
<SQL server PC name> specifies name of the PC on the network on which the SQL Server is installed.
<instance name> specifies instance name used to install the SQL Server.
5. Click Choose directory. A dialogue box that provides you with advice about selecting a new location for
the database is displayed.
6. Click OK. The Browse For Folder dialogue box is displayed.
7. Click the new location of the database, or in the Current database directory box enter the required
directory. If required 963 variables can be used.
8. Click OK. A dialogue box is displayed reminding you that you need to restart 963.
9. Click OK.
10. Run 963. If the database exists 963 will connect to it, if not a dialogue box is displayed informing you that it
can't connect to the database, click Yes to enable 963 to create a new database.
3. Select the Detach database after supervisor has been shutdown check box.
4. Click OK.
5.19.9 Configure 963 to Operate with IQ1 Series Controllers
If communication with IQ1 series controllers is required it may be necessary to make some changes to the
TCOMSRV.INI file. IQ1 series controllers are unable to handle the same volume of data as the more recent IQ2, IQ3,
and IQ4 series controllers. To prevent communications errors appearing on the screen there are some recommended
settings needed in TCOMSRV.INI.
2. Click , or on the Mode menu click Device Viewer to select the Device Viewer.
3. Right-click the required controller, and click Set this device to use batch refresh. A dialogue box is
displayed.
4. Click Yes.
Note that LONWORKS devices will always use the settings specified in the [LonBatchComms] section of the S2.INI file.
To stop a device using batch refreshing:
1. Log in.
2. Click , or on the Mode menu click Device Viewer to select the Device Viewer.
3. Right-click the required controller, and click Set this device to use batch refresh. A dialogue box is
displayed.
4. Click Yes.
5.19.15.2 Specify Batch Refresh Settings
To specify the batch refresh settings:
1. Edit the [NormalBatchComms] section of the S2.INI file as below:
[NormalBatchComms]
BatchInterval=<batch interval>
MaxRequestsBefporePause=<request pause>
PauseInterval=<interval>
BatchSize=<size>
<batch interval> specifies the delay in seconds between each batch request (default 1 second). <request
pause> specifies the length of time in seconds before the batch process repeats itself, this is a delay in seconds
before the whole process starts again (default 5 seconds). <interval> specifies the delay in seconds between
each batch request (default 1 second). <size> specifies the number of requests/items per batch (default 10).
Note that LONWORKS devices will always use the settings specified in the [LonBatchComms] section of the S2.INI file.
2. Click , or on the Mode menu click Device Viewer to select the Device Viewer.
3. Right-click the device for which the communications timeout is to be specified and click Properties. The
Device Properties dialogue box is displayed.
Specify the number of points to collect on the Server in the Number of points to collect on the
Server box.
Specify the number of points to display on web client graph in the Number of points to display on
web client graph box.
Specify the maximum number of points to playback the recorded data in the Max number of points
when recorded data is played back box.
4.Click Apply to apply the changes, or click OK to save the changes and close the dialogue box, or you may
click Cancel to abort the action.
5.19.28 Specify How Long 963 Keeps Alarms For
The 963 deletes all alarms in its database after a specified period of time. This length of time can be adjusted.
To specify how long 963 stores alarms:
1. Log in.
2. Click or on the Mode menu click Alarms to select the Alarm Viewer.
3. Click the Setup tab.
4. In the How many days to keep alarms in the database box enter the required number of days.
5. If 963 is to remove alarms other than clear alarms, and actioned alarms clear the appropriate check box.
Check box Description
Only purge clear alarms When selected the 963 will only purge clear alarms from the database.
Only purge actioned alarms When selected the 963 will only purge actioned alarms from the database.
6. Click Update.
5.19.29 Enable the Compact Graph Option
The option to compact a graph can be selected. The compact protocol can be either single or double precision. With
single precision the values are sent as a percentage of maximum value minus the minimum value (i.e. maximum error
of 1%); these integer percentage values are each coded and communicated as one ASCII character. The values are
sent back with the start time and period so that the time points are calculated in the supervisor.
Double precision plots use the same algorithm as for the single precision plots, but use two ASCII characters to code
the percentage value and thus have a maximum error of 0.01% (i.e. 0 to 9999). They take approximately twice the
time to communicate.
To enable the compact graph option from device viewer:
1. Log in as a System Administrator user.
2. On the Tools menu click Supervisor Settings. The Supervisor Settings dialogue box is displayed.
3. Go to the Graphs tab and check the Enable compact graph option from device viewer check box.
4. Click Apply to apply the changes, or click OK to save the changes and close the dialogue box, or you may
click Cancel to abort the action.
5.19.30 Specify Global or Local Comments when Actioning Alarms
When a user acknowledges an alarm 963 saves the comments and makes them available for use another time. The list
can be set to contain either the comments entered by all users (global), or comments entered by the current user (local).
By default only the comments entered by the current user are displayed.
To specify global or local comments when actioning alarms:
1. Edit the [Alarms] section of the S2.INI file as below:
[Alarms]
UserLevelAlarmActionComments=<comments>
<comments> specifies whether the list contains previous comments entered by all users, or just the current
user. 1 = current user, 0 = all users.
E.g.
[Alarms]
UserLevelAlarmActionComments=1
Displays the comments entered by the current user.
5.19.35 Specify How the Tree View Appears in the Diary Display
It is possible to specify whether the tree view in the Navigator when the Diary Display is displayed is initially expanded,
or collapsed.
To specify how the tree view appears in the Diary Display:
1. Edit the [EXTRA] section of the S2.INI file as below:
[EXTRA]
ExpandTrees=<expand trees>
<expand trees> specifies whether the tree view is displayed expanded or collapsed. 1 causes the tree to
initially be expanded, 0 causes it to initially be collapsed; the default is 1.
E.g.
[EXTRA]
ExpandTrees=1
5.19.36 Specifying Precision Resolution for Logging
To specify the Precision resolution for extended logging:
1. Log in as a System Administrator user.
2. On the Tools menu click Supervisor Settings. The Supervisor Settings dialogue box is displayed.
3. Go to the Graphs tab and specify the resolution to be used for extended logging, in the Precision resolution
for extended logging box.
4. Click Apply to apply the changes, or click OK to save the changes and close the dialogue box, or you may
click Cancel to abort the action.
5.19.37 Specifying the Number of Decimals for Server Graph
963 allows you to specify the number of decimal places that must appear in the list data on a server graph.
To specify the number of decimals for list data on server graph:
1. Log in as a System Administrator user.
2. On the Tools menu click Supervisor Settings. The Supervisor Settings dialogue box is displayed.
3. Go to the Graphs tab and specify the number of decimal places for list data on server graph in the Number
of decimal places for list data on server graph box.
4. Click Apply to apply the changes, or click OK to save the changes and close the dialogue box, or you may
click Cancel to abort the action.
5.19.38 Specify Logging of all Remote Alarm Acknowledgements
The action of remotely acknowledging alarms can be set to cause an event on the server indicating that a particular
user has acknowledged an alarm.
Note that the alarm acknowledgement is always logged in the alarm event list.
To specify logging of all remote acknowledgements:
1. Edit the [WebAlarms] section of the S2.INI file as below:
[WebAlarms]
LogRemoteAcks=<log>
<log> specifies whether remote alarm acknowledgements are logged. 1 = logged, 0 = not logged.
E.g.
[WebAlarms]
LogRemoteAcks=1
5.19.39 Specifying How to Reset Audit Lan
The Reset Audit Lan option enables 963 to reset the audit LAN.
When comparing against a list of devices the user is only notified of devices that are missing from the list. For example,
if the nodes in the list were 15-18 and 963 detected devices 13, 14, 15, 17 and 18 on the respective lan, the only
notification will for the missing device (device 16).
Note that the Reset Audit Lan option is enabled only on the Audit Lans. To audit lans, refer to Specifying the Audit
Lan Action section of this manual.
To reset the audit lan:
1. Log in.
2. Click and right click the LAN for which the audit information is to be reset in the
Navigator list.
3. Select the Reset Audit Lan option. A confirmation message is displayed.
4. Click Yes to reset the Audit LAN information or No to cancel the action
5.19.40 Specify Intelligent Plot Labelling
Intelligent plot labelling enables 963 to add the logging interval to the label of plot modules in the Device Viewer. It
is turned on by default but can be enabled/disabled as required.
To specify intelligent plot labelling:
1. Edit the [DeviceDiscovery] section of the S2.INI file as below:
[DeviceDiscovery]
IntelligentPlotLabelling=<enable>
<enable> specifies whether intelligent plot labelling is enabled/disabled. 1 = enabled, 0 =disabled.
E.g.
[DeviceDiscovery]
IntelligentPlotLabelling=1
5.19.41 Specify Paper Width
The paper width for the alarm printer can be set to the required width.
To specify the paper width for the alarm printer:
1. Edit the [ALARMS] section of the TCOMMSRV.INI file as below:
[ALARMS]
ColumnsAcross=<width>
<width> specifies the width in columns of the alarm printout.
E.g.
[ALARMS]
ColumnsAcross=80
5.19.42 Specify Printer Baud Rate
If the alarm printer is a serial printer it is necessary to specify the baud rate that is to be used for communication with
the printer.
To specify the Printer Baud Rate:
1. Log in as a System Administrator user.
2. On the Tools menu click Supervisor Settings. The Supervisor Settings dialogue box is displayed.
3. Go to the Alarms tab and specify the baud rate for communications with the alarm printer in the Baud rate
for communications with alarm box.
4. Click Apply to apply the changes, or click OK to save the changes and close the dialogue box, or you may
click Cancel to abort the action
5.19.43 Specify the Adjustment Confirmation
It is possible to specify whether or not 963 asks for confirmation of adjustments to parameters in a controller, the
default is to ask for confirmation.
To specify confirmation of an adjustment:
1. Edit the [DYNAMICOBJECTS] section of the S2.INI file as below:
[DYNAMICOBJECTS]
AdjustConfirm=<adjust>
<adjust> specifies whether 963 prompts for confirmation. 1 causes 963 to ask for confirmation, 0 stops 963
asking for confirmation.
E.g.
[DYNAMICOBJECTS]
AdjustConfirm=1
These files will be used by all controllers, however if required it is possible to set up different files for each different
controller type by creating a sub-directory for each controller type to contain the module templates for that controller
type which will be used instead.
To specify which configuration parameters can be adjusted:
1. Ensure that 963 is not running.
2. Run notepad, and open the appropriate template file from Template directory or one of its sub-directories.
See the table below for details about which file applies to which module type, and which directory applies to
which controller.
3. Edit the file as required. Each line of the file specifies a single configuration parameter. The format of each
line must be as shown below:
<XXXX>(<configuration letter>),<label>,<units>,<PIN level>
Where <configuration letter> is the letter that identifies the parameter in configuration mode, <label> is text
that describes parameter, <units> specifies the units of the parameter, and <PIN level> specifies the PIN level
required to make the adjustment. The PIN level can be in the range -1 to 100, where -1 means that anyone
can adjust the parameter, and 100 means that nobody can adjust it, although it will be visible to users with a
PIN level of 99.
3. In the Size box click the size of the paper that is to be used.
4. In the Source box click the location of the paper in the printer.
5. In the Header and Footer boxes enter the required header and footer. Codes can be used to include the
special characters as part of the text.
Code Description
&w Window title.
&u Page address (URL).
&d Date in short format (as specified by Regional Settings in Control Panel).
&D Date in long format (as specified by Regional Settings in Control Panel).
&t Time in the format specified by Regional Settings in Control Panel.
&T Time in 24-hour format.
&p Current page number.
&P Total number of pages.
&& A single ampersand (&).
&b The text immediately following these characters as centered.
& The text immediately following the first "&b" as centered, and the text following the second "&b" as
b&b right justified.
6. Click Portrait, or Landscape to specify the orientation of the page.
7. In the Left, Right, Top, and Bottom boxes enter the required values to specify the margins.
8. Click OK.
Note that this setting applies to all lists printed form 963, and because the process uses Internet Explorer the changes
made will also be reflected when you print from Internet Explorer.
3. In the Name box click the required printer from the list.
4. Click OK.
Note that if a user changes the printer when they print out a page, graph, or the alarm priority statistics that printer
will become the page printer.
5.19.51 Specify the Precision Logging Protocol
The precision of the compact protocol can be selected. The compact protocol can be either single or double precision.
With single precision the values are sent as a percentage of maximum value minus the minimum value (i.e. maximum
error of 1%); these integer percentage values are each coded and communicated as one ASCII character. The values
are sent back with the start time and period so that the time points are calculated in the supervisor.
Double precision plots use the same algorithm as for the single precision plots, but use two ASCII characters to code
the percentage value and thus have a maximum error of 0.01% (i.e. 0 to 9999). They take approximately twice the
time to communicate.
Not all controllers support the TIN protocol, therefore it may not always be appropriate to set mode
ExtendedCompactTIN=1.
To specify the precision logging protocol:
1. Edit the [Logging] section of the S2.INI file as below:
[Logging]
ExtendedCompactTIN=<protocol>
<<protocol> specifies the protocol 0=single precision logging, 1 = double precision logging.
5.19.52 Specify the Print Template for Alarm Priority Statistics
The print template used for the print out of the alarm priority statistics can be specified.
To specify the print template used for alarm priority statistics:
1. Display the alarm priority statistics.
2. Click Print Setup. The Print Setup dialogue box is displayed.
E.g.
http://963 server
Note that if the 963 Server has been configured to provide information on a port other than the default of 80,
the port number must be added to the end of the address the browser is using. If the server is protected by a
firewall, the browser should be configured to access the external IP Address of the firewall instead of the IP
address of the PC running 963 Server.
3. Click Next>.
4. In the Select a name for the shortcut box enter a name for the shortcut.
5. Click Finish.
Note that this may not be possible on some operating systems, or the procedure may differ from that described above.
Tip: An alternative to this is to set the browsers default address to that of the 963 Server.
5.20.4 Install the JAVA Runtime Environment
To access 963 Server in graphic mode it is necessary to install the Java runtime environment J2SE 6.0 or greater if
one is not already installed on the PC. This can be downloaded from www.java.com. If a client without the Java
runtime environment J2SE 6.0 or greater installed attempts to connect to the 963 Server the client will automatically
attempt to connect to the internet to download it. During the installation procedure the Oracle JAVA runtime
environment must be registered for use with the correct browser.
Note that this is applicable only for machines that use 963 client.
To enable copy graph:
If your Java version is greater than Java 6 Update 24, perform the following steps to enable copy graph functionality
in 963 client:
1. Open file <java installed path>\lib\security\java.policy.
To open the <java installed path>:
Click Start > Control Panel > Java to view the Java Control panel.
Under the Java tab, click View. The Java Runtime Environment Settings dialog box appears.
2. Click or on the Mode menu click Alarms to select the Alarm Viewer.
3. Right-click the alarm whose alarm action is to be emulated, and on the displayed menu click Replay Alarm
Action. The specified action will now be carried out.
APPENDICIES
A1 APPENDIX 1 - ACTIONS
This section describes the actions that can be performed when a static object is selected, when a user logs on, when
an alarm occurs etc. It also describes how to specify each action and where they can be used.
Action Description
? Asks a Yes/No question during a script file. If users answer Yes then the following
script command is executed, else it skips onto the NEXT command.
ARCHIVEDATA Archives the historic data within the supervisor to an external data source.
AUDIT_LAN Enables 963 to periodically check for existence of controllers on a specified Lan and
raise an alarm if devices are missing (DVMS alarm), or new ones added (DVNW
alarm).
BACKUPDB Enables any of the 963s database files to be backed up to a specified directory.
BACKUPFILE Enables a specified file to be backed up to a specified directory.
BALLOON Pops up a small bubble containing some pre-defined text on the Windows task bar.
BEEP Causes 963 to beep.
BROWSER POPUP Launches a web browser in a new window with a specified URL. The size and
position of the window can be specified and the window can be given a name.
CALCULATEMKT Calculates the Mean Kinetic Temperature (MKT) for the specified sensor over a
specified period and stores it in a virtual sensor.
CALCULATEMKTDATE Calculates the mean kinetic temperature for the specified sensor for a specified date
range. The result of the calculation is for display only it is not stored.
CHANGEPASSWORD Enables the current user to change their password. It displays a sequence of dialogue
boxes asking for the existing password, the new one, and confirmation of the new
one.
CHANGEPIN Enables the PIN level of the current user to be temporarily changed. This enables the
user to see what the pages look like for users with different PIN levels. It displays a
dialogue box that enables the required PIN level to be specified. When the user logs
on the next time his normal PIN level will be used.
COMMAND Displays a dialogue box that enables any 963 action to be launched.
CONFIG Provides access to the configuration mode of a specified device on the network.
COPYFILE Copies a specified file to another directory.
CREATEDIRECTORY Creates a specified directory.
DELETE Deletes a specified file.
DELETEHISTORICDATA Deletes the alarms from the 963s database that are older than a specified number of
days.
DOCUMENT Creates a text file containing a definition of each object on a page.
DROPALLLINES Causes 963 to drop any autodialled link immediately.
DROPTHISLINE The DROPTHISLINE action will force 963 to drop the specified autodialled link.
EXECUTESMS Sends an SMS text message to a specified telephone number.
(963 SMS Direct only)
EXECUTESQL Executes a specified SQL command.
EXIT Closes 963 with an Are you sure message, leaving Windows running.
FIT2PAGE Enables a schematic page to be made to fit completely in the display area, or to be
normal size
FORCECLOSE Closes 963 without any messages, leaving Windows running.
GOTO Displays a specified page.
GOTO Alarms Displays the Alarm Viewer.
GOTO Config Displays the Configuration Mode Display.
GOTO Devices Displays the Device Viewer.
GOTO Diary Displays the Diary Display with the specified diary group visible.
GOTO NEXT Displays the next page in the history of visited pages.
GOTO PREVIOUS Displays the previous page in the history of visited pages.
GOTO Scheduler Displays the Event Scheduler Display.
Action Description
GOTO Users Displays the User Display.
GOTO Web Displays the Web Browser Display.
HIDENAVIGATOR Hides the Navigator if it is displayed.
HOTSPOTS Briefly displays all the areas on the current page that do something when selected.
INPUTSTRING Displays a dialogue box that enables the user to specify a value that is then written to
a particular place in a specified INI file.
KILLMSG Closes the specified message box.
LEARNSITE Allows a specified site to be learnt in the background.
LICENSE Displays the License dialogue box.
LOGINAS Allows a specified user to log in.
LOGMSG Inserts a message into the alarm database that will be visible in the Alarm Viewer.
LOGOUT Logs the current user out of 963.
MESSAGE Displays a message box for a specified length of time, or until the user clicks on OK.
PLAY Plays either WAV or MIDI files.
POPUP Displays the specified schematic page in a pop-up window.
PRINTAFILE Prints a specified file.
PRINTGRAPH Prints the specified graph.
PRINTGRAPH96 Prints the last 96 values of the specified graph.
PRINTLINE Prints a specified line of text.
PRINTPAGE Prints the current schematic page.
PRINTPAGEAUTO Prints the current schematic page automatically.
PRINTPAGEPREVIEW Displays a preview of how a specified schematic page will look when it is printed.
PRINTQUERY Runs a specified SQL query, and prints the results.
PRINTSETUP Displays a dialogue box that enables the printer used by 963 to print pages, graphs,
and lists to be specified.
QUERYTOTEXTFILE Runs a specified SQL query, and saves the results to a specified text file.
RECORD Records the data stored in a controller for a specified plot or sensor module.
RECORDAUTO_COMPACT Records data from the value of a module specified in an alarm using compact data.
RECORDAUTO_PRECISION Records data from the value of a module specified in an alarm using precision data.
RECORDSCHEMATIC Records data from a schematic page.
RECORDTOTEXT Records the data stored in a controller for a specified plot or sensor module into a text
file
REMOTE Enables any action to be triggered on a different 963 (remote 963).
RESOLUTION Displays a dialogue box that specifies the size of 963s display area in pixels.
RETRANSMIT Sends a specified message to a particular destination.
RUN Runs a Windows recognised file, e.g. . htm, .doc, .bmp, . xls etc, or if a URL is
specified a web browser is loaded displaying the specified URL.
RUN_ADJUSTMENT_SET Enables a previously saved set of multiple adjustments (adjustment set) to be made
on a regular basis.
SCRIPT Runs the specified script file.
SEND Enables a standard write text comms message to be sent to a specific device on the
IQ network. When the message is sent, 963 will beep, and record an event in the alarm
database that can be seen in the Alarm Viewer, indicating that the message has been
sent.
SENDAUTO Enables a standard write text comms message to be sent to a specific device on the
IQ network.
SETGENERIC Enables the device from which generic dynamic objects obtain their value to be
specified by the user.
SETIOPORT Displays the Port Select dialogue box that enables the communications port (that 963
uses to communicate with other IQ system devices) to be set up.
SHOWNAVIGATOR Displays the Navigator if it is hidden.
SLEEP Causes the script file to pause at the current position for the specified number of Ms.
This command should only be used in scripts.
Action Description
USERS_LOGOUT Logs out all users accessing 963 from a client. It is only available to System
Administrator users, or users in the System Administrator workgroup
VIEWFILTER Displays a window containing of all the current alarms for the specified filter.
VIEWGRAPH Displays a window containing graphs of all the IQ system points on the current page.
If logged information is available in the controller, this will be displayed; otherwise,
live values will be used. If a graph definition is specified the specified graph definition
is displayed.
VIEWPOINTS Displays a window containing all the values on the current page, or the values in the
specified Points Template file.
VIEWQUERY Displays the result of the specified SQL query on the 963 database.
VIEWQUERYEX Displays the result of the specified SQL query on an external database.
WEB Displays the specified web page (HTML file).
WINEXEC Runs the specified Windows based program. A command line entry enables the
specified program to be started with a particular file open.
WINEXECU Runs the specified Windows based program. A command line entry enables the
specified program to be started with a particular file open. The command line can use
unicode characters to specify the file.
WRITESTRING Writes the specified value to the specified INI file.
WRITETOTEXTFILE Writes text to a specified text file.
3. Specify the location and name of the backed up file by typing the path and filename into the File Name box.
If required 963 variables can be used to help specify the path and filename. The default is to back up the file
to the directory in which 963 is installed, the filename is trend96X and includes the date and time. The
location of the file can also be specified by clicking Choose file location and browsing to the required
directory. To return to the default settings click Generate default file name.
Note that the action will fail if an exclamation mark '!' is used ! in filename.
4. Click Next>. The dialogue box changes.
5. Select either All, Last Day, Last Week, Last Month, Last Year or Custom data range to specify the data
that is to be archived. If Custom data range is selected click Choose Date to display another dialogue box,
and click the start date for the date range. Click Next and click the last date in the range and click Finish.
Note: By setting All, Last Day, Last Week, Last Month, Last Year or Custom data range will trigger to archive
the data just that period only. Rest all data will remain untouched. Eg. Last Year will archive just that last year
(ie: from today backwards one year). Data older than last year will remain untouched.
6. Click Finish.
7. A dialogue box is displayed asking if data is to be deleted from the database, click Yes to archived the data
and delete it from the original database, or click No to just archive it.
Or
1. Type the code to specify the action in the following format:
ARCHIVEDATA <Path and filename>,<Backup Days>,<Start Date>,<Stop Date>,<Delete Data>
<Path and filename> specifies location and name of the backed up file. If required 963 variables can be used.
<Backup Days> specifies the number of days for which data is to be backed up e.g. 7 would specify the
backup of last weeks data. If a range of dates is to be specified <Backup Days> should be set to -1,<Start
Date>, specifies the date and time of the start of the backup range. <Stop Date> specifies the date and time
of the end of the backup range. <Delete Data> Specifies whether the data is deleted from the database 1 will
delete the data 0 keeps the data.
Note: It is strongly recommended that the DELETEHISTORICDATA command be executed to prevent the database
from becoming too large.
A1.2.3 Specifying the AUDIT_LAN Action
Schematic Action Login Action Alarm Action Event Scheduler Script Files Dynamic Menus Client Access
The AUDIT_LAN action enables 963 to periodically check for existence of devices on a specified Lan and raise an
alarm if devices are missing (DVMS alarm), or new ones added (DVNW alarm). The action can compare the current
contents of the specified Lan with either the content of the Lan the last time it was audited, the contents of the Lan the
first time it was audited, or against a specified list of devices.
When comparing against a list of devices the user is only notified of devices that are missing from the list. For example,
if the nodes in the list were 15-18 and 963 detected devices 13, 14, 15, 17 and 18 on the respective lan, the only
notification will for the missing device (device 16).
TIP: To change the list used for the comparison for COMPARE_ORIGINAL run the action using the
COMPARE_LAST option this will update list of required devices to the result of the compare last, then return to using
the action with COMPARE_ORIGINAL.
To specify the AUDIT_LAN action:
1. Log in.
2. Click or on the Mode menu click Scheduler to select the Event Scheduler Display.
3. Click New. The Configure Scheduled Action dialogue box is displayed.
4. Click Choose action in the Configure the required command for scheduling area. The What action
dialogue box is displayed.
5. In the list click AUDIT_LAN. The Audit Lan dialogue box is displayed.
7. Expand the tree to display the Lan that is to be audited, and click on it.
8. Click Next>. The AUDIT_LAN Configuration dialogue box is displayed.
9. Select the required option. If 'Compare to Specified' is selected enter the network addresses of the devices
that should be on the Lan separating each with a comma, and ranges of with a hyphen e.g. 15,19,33-40 for
devices 15, 19, 33, 34, 35, 36,37, 38, 39, 40.
Setting Description
Compare to Original Compares the current contents of the specified Lan with the contents of the
Audit Lan the first time it was audited
Compare to Last Audit Compares the current contents of the specified Lan with the content of the
Lan the last time it was audited.
Compare to Specified Compares the current contents of the specified Lan against a specified list
of devices
10. Click Finish to return to the What action dialogue box.
11. Click OK to return to the Configure Scheduled Action dialogue box.
12. Specify what happens if the action fails, in the OPTIONAL : Choose an action to perform if the required
command fails area of the dialogue box. To specify no action click Do Nothing. To generate an alarm click
Set to default. To specify an action click Choose action to display the What action dialogue box, click the
required action from the list, and click OK.
13. Specify what happens when action succeeds in the OPTIONAL : Choose an action to perform if the
required command is successful area of the dialogue box. To specify no action, click Do Nothing. To
generate an alarm, click Set to default. To specify an action click Choose action to display the What action
dialogue box click the required action from the list, and click OK.
14. Click Next>. A dialogue box is displayed.
15. In the First event box enter the date and time when the event is to first occur in the following format:
dd/mm/yy hh:mm:ss
To specify the event to occur now, click Now.
16. If the event is to occur more than once, select the Do you wish to repeat this action check box, and go to
step (17). If the event is to only occur once, clear the Do you wish to repeat this action? check box, and go
to step (20).
17. In the Choose an interval list click the interval at which it is to be repeated. 963 recommends an option
based on the configuration settings.
18. In the ..and how many times to repeat it list click how many times the event is to occur.
19. If Day or Week was specified as the interval, specify the day(s) of the week that the event is to occur. If Day
was selected, all seven days can be selected. If Week was selected, only one day can be selected.
20. Click Next>. A dialogue box is displayed.
21. Check that the event is set up correctly, and then click Finish.
Audit Lan can be reset. See the Reset Audit Lan' section to reset the audit lan.
Or
1. Type the code to specify the action in the following format:
AUDIT_LAN <Connection>L<Lan Number>,<Mode>,"<Node List>"
<Connection> is an optional parameter that specifies the IP address or host name if the site is accessed over
TCP/IP or the telephone number required to access the site if it is autodialled. When entering an IP address
it must be prefixed by 'IP' e.g. IP192.186.23.87. If specifying a hostname it must be prefixed by 'IP' and
enclosed in double quotes e.g. IP "Albery". When entering a telephone number it can contain the following
characters.
Characters Description
0 to 9 Dialling characters.
ABCD#* Considered as dialling characters on some systems.
J or : Wait for secondary dial tone.
K or ; or , 2 second pause (Note on some autodiallers this may be a 1 second pause).
< Pulse dialling.
M or = Tone dialling.
<Lan Number> specifies the Lan that is to be audited (range 0, 1, 4 to 119 excluding 10), 0 specifies the
local Lan.
<Mode> specifies what the current content of the Lan is to be compared against. It can be set the following:
Setting Description
COMPARE_LAST Compares the current contents of the specified Lan with the content of
the Lan the last time it was audited.
COMPARE_ORIGINAL Compares the current contents of the specified Lan with the contents of
the Lan the first time it was audited
COMPARE_SPECIFIED Compares the current contents of the specified Lan against a specified
list of devices
<Node List> is an optional parameter that is required if <Mode> is set to 'COMPARE_SPECIFIED', it
specifies the list of devices that the current content of the Lan is to be compared against. The list specifies
the addresses of the devices. Multiple addresses should be separated by a comma ','. Hyphens can also be
used to signify a range of nodes. E.g. To specify comms nodes 13, 15, 48 to 56 and 99 you would enter the
node list as "13,15,48-56,99".
E.g.
Examples:
AUDIT_LAN IP"Albery-House"L24,COMPARE_LAST
The code above would compare all the devices on Lan 24 of a remote DHCP site called "Albery-House" with
the results of the last comparison.
AUDIT_LAN IP"Albery-House"L24,COMPARE_SPECIFIED,"26,27,34-56"
The code above would compare all the devices on Lan 24 of a remote DHCP site called "Albery-House"
against the specified list to ensure that devices 26,27, 34 to 56 are present.
3. Specify the location and name of the backed up file by typing the path and filename into the File Name box.
If required 963 variables can be used to help specify the path and filename. The default is to back up the file
to the directory in which 963 is installed, the filename is trend96X and includes the date and time. The
location of the file can also be specified by clicking Choose file location and browsing to the required
directory. To return to the default settings click Generate default file name.
4. Click Finish.
Or
1. Type the code to specify the action in the following format:
BACKUPDB <Path and filename>
<Path and filename> specifies location and name of the backed up file. If required 963 variables can be used.
For example:
c:\BackupFileName.dat
If the backup is to be made to a network location it is necessary to specify the full network drive location for
the backup; this must not be a mapped network drive. For example:
\\ BackupServerNameUNCFormat\SharedFolderName\BackupFileName.dat
3. In the Message box enter the message that is to appear in the balloon.
4. In the Title box enter the title of the balloon.
5. In the Style box click the required style for the balloon.
Style Description
None Only displays the title text in the title.
Error Displays an in the title.
Warning Displays an in the title.
Info Displays an in the title.
6. In the Timeout box enter the length of time in seconds that the balloon is to be displayed.
7. Click Finish.
Or
1. Type the code to specify the action in the following format:
BALLOON <Message>,<Title>,<Icon>,<Time out>
<Message> Specifies the text that is to appear in the balloon. <Title> the text that appears in the balloons
title. <Icon> Specifies the icon that appears in the balloons title.
<Icon> Description
0 Displays an in the title.
1 Displays an in the title.
2 Only displays the title text in the title.
3 Displays an in the title.
<Time out> The time in seconds that the balloon is to be displayed.
A1.2.7 Specifying the BEEP Action
Schematic Action Login Action Alarm Action Event Scheduler Script Files Dynamic Menus Client Access
The BEEP action causes the PC running 963 to BEEP. The pitch and length of the BEEP can be altered from within
S2.INI in the install directory, [SOUND] section.
To specify the BEEP action:
1. Click BEEP from the list of actions.
Or
1. Type BEEP.
Note that the default beep must be enabled.
A1.2.8 Specifying the BROWSER_POPUP Action
Schematic Action Login Action Alarm Action Event Scheduler Script Files Dynamic Menus Client Access
The BROWSER_POPUP action launches a web browser in a new window with a specified URL. The size and position
of the window can be specified and the window can be given a name. If a window of the same name is already open
it is used.
The ability to specify the size and location of the window, and name it is not supported on a client.
To specify the BROWSER_POPUP action:
1. Click BROWSER_POPUP from the list of actions. The Pop up dialogue box is displayed.
Or
1. Type the code to specify the action in the following format:
BROWSER_POPUP <URL>,< WIN_X>,<WIN_Y>,<SIZE_X>,<SIZE_Y>,<WINDOW_NAME>
<URL> specifies the URL of the HTML file that is to be displayed. <WIN_X> is an optional parameter that
specifies the x coordinate in pixels of the top left of the browser window. <WIN_Y> is an optional parameter
that specifies the y coordinate in pixels of the top left of the browser window. <SIZE_X> is an optional
parameter that specifies the width of the browser window in pixels of the top left of the browser window.
<SIZE_Y> is an optional parameter that specifies the height of the browser window in pixels of the top left
of the browser window. <WINDOW_NAME> is an optional parameter that specifies the name of the window
e.g. Graph Window. Window names are case sensitive, and can contain the following characters A-Z, a-z, 0-
9.
E.g.
BROWSER_POPUP www.trendcontrols.com,100,100,800,800,Browser Window
Launches a browser window 800 x 800 pixels, 100 pixels form the top and left called 'BrowserWindow'.
A1.2.9 Specifying the CALCULATEMKT Action
Schematic Action Login Action Alarm Action Event Scheduler Script Files Dynamic Menus Client Access
The CALCULATEMKT action available in 963, calculates the Mean Kinetic Temperature (MKT) for a sensor over
a specified period, and stores it in a virtual sensor. This action can only be used from a scheduled event.
In order to perform the calculation the sensor must be logged in the IQ controller and the data must be recorded by
963. If the data recorded by 963 is not complete e.g. only the last 4 days of readings are available, or there is a gap in
the data, the MKT will not be calculated and an alarm (MKFL) will be raised. 963 cannot detect if data has been lost
due to the controller being turned off and the MKT will be calculated using the available data and an alarm is not
generated. If the calculation is performed correctly an MKOK alarm is generated.
Note that the action is only compatible with data logged in the IQ controller using synchronised logs.
To specify the CALCULATEMKT action:
1. Click CALCULATEMKT from the list of actions. The MKT : Mean Kinetic Temperature dialogue box
is displayed.
2. If the site containing the information is remote in the Connection box enter the IP address or host name if
the site is accessed over TCP/IP or the telephone number required to access the site if it is autodialled. When
entering an IP address it must be prefixed by 'IP' e.g. IP192.186.23.87. If specifying a hostname it must be
prefixed by 'IP' and enclosed in double quotes e.g. IP"Albery House". When entering a telephone number it
can contain the following characters.
Characters Description
0 to 9 Dialling characters.
ABCD#* Considered as dialling characters on some systems.
J or : Wait for secondary dial tone.
K or ; or , 2 second pause (Note on some autodiallers this may be a 1 second pause).
< Pulse dialling.
M or = Tone dialling.
3. In the Lan box enter the Lan containing the required information, range 0, 1, 4 to 119 excluding 10.
4. In the Outstation Number box enter the network address of the controller containing the required
information, range 0, 1, 4 to 119 excluding 10.
5. In the Item box enter the sensor for which the MKT is required.
6. In the Label box enter the label of the sensor used to store the MKT.
7. Click Next. The dialogue box changes to allow the virtual sensor that is to be used to store the MKT to be
displayed.
8. Click Automatically pick virtual sensor number to make 963 choose the number select, or click Manually
input virtual sensor number, and enter the number into the box to specify the number yourself.
9. Click Next. The dialogue box changes to allow the high and low alarm limits for the sensor to be specified.
10. In the Low Alarm Limit (Deg C) box enter the low alarm limit for the sensor
11. In the High Alarm Limit (Deg C) box enter the high alarm limit for the sensor.
12. Click Next. The dialogue box changes to allow the number of days over which the MKT is to be calculated
to be specified.
13. In the Number of days box enter the required number of days.
14. Click Finish.
Or
1. Enter the code to specify the action in the following format:
CALCULATEMKT <Connection> L<Lan Number> O<Controller Address>S<Sensor
Number>,<Sensor Label>,<Low Alarm>,<High Alarm>,<No of Days>,<Phone Number1> L<Lan
Number1> O<Controller Address1>C<virtual sensor Number>
<Connection> is an optional parameter that specifies the IP address or host name if the site is accessed over
TCP/IP or the telephone number required to access the site if it is autodialled. When entering an IP address
it must be prefixed by 'IP' e.g. IP192.186.23.87. If specifying a hostname it must be prefixed by 'IP' and
enclosed in double quotes e.g. IP"Albery". When entering a telephone number it can contain the following
characters.
Characters Description
0 to 9 Dialling characters.
ABCD#* Considered as dialling characters on some systems.
J or : Wait for secondary dial tone.
K or ; or , 2 second pause (Note on some autodiallers this may be a 1 second pause).
< Pulse dialling.
M or = Tone dialling.
<Lan Number> specifies the Lan containing the device (range 0, 1, 4 to 119 excluding 10), 0 specifies the
local Lan. <Controller Address> specifies the address of the controller (range 0, 1, 4 to 119 excluding 10).
<Sensor Number> specifies the number of the sensor for which the MKT is required. <Sensor
Label>specifies the label of the virtual sensor used to store the MKT. <Low Alarm> specifies the low alarm
limit for the virtual sensor that is to store the calculated value. <High Alarm> specifies the high alarm limit
for the virtual sensor that is to store the calculated value. <No of Days> specifies the number of days over
which the calculation is to be made. <Phone Number1> is an optional parameter that specifies the telephone
number used to access the site of the device containing the virtual sensor if it is autodialled, or the IP address
of the site is accessed over TCP/IP. <Lan Number1> specifies the Lan containing the device containing the
virtual sensor (range 0, 1, 4 to 119 excluding 10), 0 specifies the local Lan. <Controller Address1> specifies
the address of the controller containing the virtual sensor (range 0, 1, 4 to 119 excluding 10). <virtual sensor
Number> specifies the number of the virtual sensor used to store the MKT.
E.g.
CALCULATEMKT L24O20S2,Sensor 2,20.00,30.00,7,1234L24O20X12
This would calculate the MKT for sensor 2 in controller 20, on Lan 24 over a seven day period, and store it
in virtual sensor number 12 for the same device with a low alarm of 20, a high alarm of 30.
2. If the site containing the information is remote in the Connection box enter the IP address or host name if
the site is accessed over TCP/IP or the telephone number required to access the site if it is autodialled. When
entering an IP address it must be prefixed by 'IP' e.g. IP192.186.23.87. If specifying a hostname it must be
prefixed by 'IP' and enclosed in double quotes e.g. IP"Albery House". When entering a telephone number it
can contain the following characters.
Characters Description
0 to 9 Dialling characters.
ABCD#* Considered as dialling characters on some systems.
J or : Wait for secondary dial tone.
K or ; or , 2 second pause (Note on some autodiallers this may be a 1 second pause).
< Pulse dialling.
M or = Tone dialling.
3. In the Lan box enter the Lan containing the required information, range 0, 1, 4 to 119 excluding 10.
4. In the Outstation Number box enter the network address of the controller containing the required
information, range 0, 1, 4 to 119 excluding 10.
5. In the Item box enter the sensor for which the MKT is required.
6. Click Next. The dialogue box changes to allow the start date of the calculation to be specified.
7. Specify the start date of the calculation by selecting the required month and year from the boxes, and then
clicking the required date.
8. Click Next. The dialogue box changes to allow the end date of the calculation to be specified.
9. Specify the end date of the calculation by selecting the required month and year from the boxes, and then
clicking the required date.
10. Click Finish.
Or
1. Type the code to specify the action in the following format:
CALCULATEMKTDATE <Connection> L<Lan Number> O<Controller Address>S<Sensor
Number>,<Start Date>,<End Date>
<Connection> is an optional parameter that specifies the IP address or host name if the site is accessed over
TCP/IP or the telephone number required to access the site if it is autodialled. When entering an IP address
it must be prefixed by 'IP' e.g. IP192.186.23.87. If specifying a hostname it must be prefixed by 'IP' and
enclosed in double quotes e.g. IP"Albery". When entering a telephone number it can contain the following
characters.
Characters Description
0 to 9 Dialling characters.
ABCD#* Considered as dialling characters on some systems.
J or : Wait for secondary dial tone.
K or ; or , 2 second pause (Note on some autodiallers this may be a 1 second pause).
< Pulse dialling.
M or = Tone dialling.
<Lan Number> specifies the Lan containing the device (range 0, 1, 4 to 119 excluding 10), 0 specifies the
local Lan. <Controller Address> specifies the address of the controller (range 0, 1, 4 to 119 excluding 10).
<Sensor Number> specifies the number of the sensor for which the mean kinetic temperature is required.
<Start Date> specifies the first date in the range for which the MKT is to be calculated. <End Date> specifies
the last date in the range for which the mean kinetic temperature is to be calculated.
E.g.
CALCULATEMKTDATE L24O20S2,26/12/2001,2/1/2002
This would calculate the MKT for sensor 2 in controller 20, on Lan 24 between 26/12/2001, and 2/1/2002.
963 can be set up to prompt the user to enter any of these parameters to enable the user to define what happens
each time by leaving any of the parameters above blank.
E.g.
CALCULATEMKTDATE ,,26/12/2001,2/1/2002
This would cause 963 to prompt for the site, Lan, and controller address before it calculates the MKT for
sensor 2 between 26/12/2001, and 2/1/2002.
A1.2.11 Specifying the CHANGEPASSWORD Action
Schematic Action Login Action Alarm Action Event Scheduler Script Files Dynamic Menus Client Access
The CHANGEPASSWORD action enables the current user to change their password. It displays a sequence of
dialogue boxes asking for the existing password, the new one, and confirmation of the new one. For users in the
System Administrator workgroup 963 does not prompt for the existing password. This is to allow administrator users
to change the password of normal users who have forgotten their password.
To specify the CHANGEPASSWORD action:
1. Click CHANGEPASSWORD from the list of actions.
Or
1. Enter CHANGEPASSWORD.
2. If the device is on a remote site enter the IP address or host name if the site is accessed over TCP/IP or the
telephone number required to access the site if it is autodialled. When entering an IP address it must be
prefixed by 'IP' e.g. IP192.186.23.87. If specifying a hostname it must be prefixed by 'IP' and enclosed in
double quotes e.g. IP"Albery House". When entering a telephone number it can contain the following
characters.
Characters Description
0 to 9 Dialling characters.
ABCD#* Considered as dialling characters on some systems.
J or : Wait for secondary dial tone.
K or ; or , 2 second pause (Note on some autodiallers this may be a 1 second pause).
< Pulse dialling.
M or = Tone dialling.
3. Click the LAN tab.
4. Specify the Lan containing the device in the box (range 0, 1, 4 to 119 excluding 10). 0 specifies the local
Lan.
5. Click the OS tab.
6. Specify the address of the device in the box (range 0, 1, 4 to 119 excluding 10).
7. Click OK.
Or
1. Type the code to specify the action in the following format:
CONFIG <Connection> L<Lan Number> O<Controller Address>
<Connection> is an optional parameter that specifies the IP address or host name if the site is accessed over
TCP/IP or the telephone number required to access the site if it is autodialled. When entering an IP address
it must be prefixed by 'IP' e.g. IP192.186.23.87. If specifying a hostname it must be prefixed by 'IP' and
enclosed in double quotes e.g. IP"Albery House". When entering a telephone number it can contain the
following characters.
Characters Description
0 to 9 Dialling characters.
ABCD#* Considered as dialling characters on some systems.
J or : Wait for secondary dial tone.
K or ; or , 2 second pause (Note on some autodiallers this may be a 1 second pause).
< Pulse dialling.
M or = Tone dialling.
<Lan Number> specifies the Lan containing the device for which configuration mode is required (range 0,
1, 4 to 119 excluding 10), 0 specifies the local Lan. <Controller Address> specifies the address of the
controller (range 0, 1, 4 to 119 excluding 10).
E.g.
CONFIG 0123 456789L99O24
Specifies the configuration mode for device 24 on Lan 99 on an autodialled site accessed using the telephone
number 0123 456789.
E.g.
CONFIG L0O24
Specifies the configuration mode for device 24 on the local Lan.
A1.2.15 Specifying the COPYFILE Action
Schematic Action Login Action Alarm Action Event Scheduler Script Files Dynamic Menu Client Access
The COPYFILE action copies a specified file to another directory.
To specify the COPYFILE action:
1. Enter the code to specify the action in the following format:
COPYFILE <Source filename>,<Destination Directory>
<Source Filename> specifies the path and filename of the file that is to be copied, and <Destination
Directory> specifies the directory to which it is to be copied to.
E.g.
COPYFILE <DATA>\S2.ini,<DATA>\Test Results
Would copy a file called S2.INI in the install directory to the directory called Test Results in the install
directory.
If required 963 variables can be used to help specify the path and filename. It is not possible to use wild card
characters (* and ?).
Note that the directory to which the file is to be copied to must already exist, if it doesnt, it can be created using the
CREATEDIRECTORY action.
2. In the box enter the phone number to which the message is to be sent including the international code.
E.g.
+4401234567890
3. Click the Message tab.
4. In the box enter the message that is to be sent in the box. The message can be built up by combining the text,
and 963 variables. For details of the 963 variables that can be used see the 963 Variable Availability section
of this manual.
5. Click OK.
Or
1. Enter the code to specify the action in the following format:
EXECUTESMS <Phone Number>,<Message>
<Phone Number> The phone number to which the message is to be sent including the international code.
<Message> specifies the message that is to be sent. The message can be built up by combining the text, and
963 variables. For details of the 963 variables that can be used see the 963 Variable Availability section of
this manual.
E.g.
EXECUTESMS 4401234567890,There is a problem please attend
This example sends the SMS message There is a problem please attend to a GSM phone whose number is
+44012345678901 using the GSM modem connected to the PC.
A1.2.23 Specifying the EXECUTESQL Action
Schematic Action Login Action Alarm Action Event Scheduler Script Files Dynamic Menus Client Access
The EXECUTESQL action carries out a specified SQL command.
To specify the EXECUTESQL action:
1. Enter the code to specify the action in the following format:
EXECUTESQL <SQL Command>
<SQL Command> is the SQL command that is to be carried out.
Caution can be dangerous especially if using the SQL command DELETE or UPDATE.
Or
1. Enter the code to specify the action in the following format:
GOTO <Filename> GENERIC=<Connection>L<Lan Number>O<Controller Address>
<Filename> specifies the path and filename of the schematic page that is to be displayed. If required 963
variables can be used to help specify the path and filename. The GENERIC= parameter is an optional
parameter used when linking to a generic page that enables the device from which data is retrieved to be
specified. <Connection> is an optional parameter that specifies the IP address or host name if the site is
accessed over TCP/IP or the telephone number required to access the site if it is autodialled. When entering
an IP address it must be prefixed by 'IP' e.g. IP192.186.23.87. If specifying a hostname it must be prefixed
by 'IP' and enclosed in double quotes e.g. IP"Albery House". When entering a telephone number it can contain
the following characters.
Characters Description
0 to 9 Dialling characters.
ABCD#* Considered as dialling characters on some systems.
J or : Wait for secondary dial tone.
K or ; or , 2 second pause (Note on some autodiallers this may be a 1 second pause).
< Pulse dialling.
M or = Tone dialling.
<Lan Number> specifies the Lan containing the device (range 0, 1, 4 to 119 excluding 10), 0 specifies the
local Lan.<Controller Address> specifies the address of the controller (range 0, 1, 4 to 119 excluding 10).
Note that =<Connection> L<Lan Number> O<Controller Address> are only required when linking to a
generic page, and the device is to be specified.
E.g.
GOTO pages\getting started.tss
Specifies the GOTO action, and tells it to display the getting started page in the pages sub-directory of
the install directory.
Note that if a page is engineered with a GOTO action and the linked page has user restrictions, a user who
does not have the access rights to the linked page gets an error message if they try to access the linked page
Tip: Generic pages that can be reused in other projects can be created by specifying relative paths in the GOTO
statement. Including <GOUPTREE n> will substitute the path of the directory n levels up into the GOTO statement.
Using <PAGEDIR> will insert the current directory.
A1.2.28 Specifying the GOTO Alarms Action
Schematic Action Login Action Alarm Action Event Scheduler Script Files Dynamic Menus Client Access
The GOTO Alarms action displays the Alarm Viewer.
To specify the GOTO Alarms action:
1. Enter GOTO Alarms.
Note that the word Alarms is case sensitive.
2. In the box enter the section within the file to which the value is to be written. It should be entered with square
brackets around it (e.g. [ Offline]).
3. Click the Key tab.
4. In the box enter the value that is to be changed.
5. Click the Filename tab.
6. Specify the path and filename of the INI file containing the value that is to be changed in the box. If required
963 variables can be used to help specify the path and filename. If a path is not specified, the Windows
directory will be used.
7. Click OK.
Or
1. Enter the code to specify the action in the following format:
INPUTSTRING <Section>,<Key>,<Filename>
<Section> specifies the section in the INI file to which the value is to be written. <Key> specifies the line in
the specified section whose value is to be modified. <Filename> specifies the path and filename of the INI
file that is to be modified. If required 963 variables can be used to help specify the path and filename. If a
path is not specified, the Windows directory will be used.
E.g.
INPUTSTRING width, outstationID, c:\program files\trend control systems\963\S2.INI.
This specifies the outstationID line in the width section of the S2.INI file.
2. If the device is on a remote site, enter the IP address or host name if the site is accessed over TCP/IP or the
telephone number required to access the site if it is autodialled. When entering an IP address it must be
prefixed by 'IP' e.g. IP192.186.23.87. If specifying a hostname it must be prefixed by 'IP' and enclosed in
double quotes e.g. IP"Albery House". When entering a telephone number it can contain the following
characters.
Characters Description
0 to 9 Dialling characters.
ABCD#* Considered as dialling characters on some systems.
J or : Wait for secondary dial tone.
K or ; or , 2 second pause (Note on some autodiallers this may be a 1 second pause).
< Pulse dialling.
M or = Tone dialling.
3. Click the LAN tab.
4. In the box enter the Lan containing the device to which the message relates (range 0, 1, 4 to 119 excluding
10).
5. Note that the device must exist in the tree. If it does no 963 will create one that will be indicated as unknown.
6. Click the OS tab.
7. In the box enter the address of the device to which the message relates (range 0, 1, 4 to 119 excluding 10).
8. Click the Text for item code tab.
9. Enter the code for the module to which the message relates. This is in the form:
<Module Type><Module Number>
<Module Type> specifies the type of module using its module identifier. For details of module identifiers
see the IQ Configuration Reference Manual (90-1533), or the IQ3 Configuration Reference Manual
(TE200768). <Module Number> specifies the number of the module.
10. Click the Text to go in the alarm description tab.
11. In the box enter the alarm description.
12. Click the Text to go in the item label field tab.
13. In the box enter the text that describes the item.
14. Click OK.
Or
1. Enter the code to specify the action in the following format:
LOGMSG <Connection> L<Lan Number> O<Controller Address>, <Module Type><Module
Number>, <Alarm Description>, <Item Label>, <Alarm Code>
<Connection> is an optional parameter that specifies the IP address or host name if the site is accessed over
TCP/IP or the telephone number required to access the site if it is autodialled. When entering an IP address
it must be prefixed by 'IP' e.g. IP192.186.23.87. If specifying a hostname it must be prefixed by 'IP' and
enclosed in double quotes e.g. IP"Albery House".
2. In the box enter the subject of the message. If required 963 variables can be used in addition to text to help
specify the subject.
3. Click the Message tab.
4. In the box enter the required message (max 80-characters). If required 963 variables can be used in addition
to text to help specify the message.
5. Click the Timeout tab.
6. In the box enter the length of time (in second) the message remains on the screen. 0 specifies no time out (i.e.
box will stay on screen until OK is selected).
7. Click the Exclamation tab.
8. If you want the message box to have an exclamation mark enter ! in the box.
E.g.
POPUP pages\welcome\welcome.tss,200,200,0,0,0
This display the welcome.tss page in the pages\welcome sub-directory of the install directory in a pop-up
window 200 pixels square in the top left corner.
A1.2.49 Specifying the PRINTAFILE Action
Schematic Action Login Action Alarm Action Event Scheduler Script Files Dynamic Menus Client Access
The PRINTAFILE action enables a specified file to be printed.
Caution you must have the necessary application to print the file.
To specify the PRINTAFILE action:
1. Enter the code to specify the action in the following format:
PRINTAFILE <Filename>
<Filename> specifies the path and filename of the schematic page that is to be displayed. If required 963
variables can be used in addition to text to help specify the page.
A1.2.50 Specifying the PRINTGRAPH Action
Schematic Action Login Action Alarm Action Event Scheduler Script Files Dynamic Menus Client Access
The PRINTGRAPH action will load and print a specified 1000 point graph automatically to the PCs default printer
e.g. when an alarm occurs, or at a specified time.
To specify the PRINTGRAPH action:
1. Click PRINTGRAPH from the list of actions. The Please choose a graph definition dialogue box is
displayed.
8. In the box specify whether the page is to be landscape by clicking Yes or No.
9. Click OK.
Or
1. Enter the code to specify the action in the following format:
PRINTGRAPH <Graph Definition>,<Template Name>,<Printer Name>,<orientation>
<Graph Definition> is the name of the graph definition that is to be printed. <Template Name> is an optional
parameter that specifies the print template that is to be used. If it is not specified the current page will be
printed as it is without using a print template. <Printer Name> is an optional parameter that specifies the
name of the printer that can be used. If it is not specified the printer specified as the page printer will be used.
<orientation> is an optional parameter that specifies whether the page is printed out in portrait or landscape
0 = portrait, 1 = landscape.
E.g.
PRINTGRAPH Outside Air Temp,\\Rnd0\techp_laser1
This would print the graph called Outside Air Temp on the printer called \\Rnd0\techp_laser1.
A1.2.51 Specifying the PRINTGRAPH96 Action
Schematic Action Login Action Alarm Action Event Scheduler Script Files Dynamic Menus Client Access
The PRINTGRAPH96 action will load and print a specified 96 point graph automatically to the PCs default printer
e.g. when an alarm occurs, or at a specified time.
To specify the PRINTGRAPH96 action:
1. Click PRINTGRAPH96 from the list of actions. The Please choose a graph definition dialogue box is
displayed.
8. In the box specify whether the page is to be landscape by clicking Yes or No.
9. Click OK.
Or
1. Enter the code to specify the action in the following format:
PRINTGRAPH96 <Graph Definition>,<Template Name>,<Printer Name>,<orientation>
<Graph Definition> is the name of the graph definition that is to be printed. <Template Name> is an optional
parameter that specifies the print template that is to be used. If it is not specified the current page will be
printed as it is without using a print template. <Printer Name> is an optional parameter that specifies the
name of the printer that can be used. If it is not specified the printer specified as the page printer will be used.
<orientation> is an optional parameter that specifies whether the page is printed out in portrait or landscape
0 = portrait, 1 = landscape.
E.g.
PRINTGRAPH96 Outside Air Temp,\\Rnd0\techp_laser1
This would print the graph called Outside Air Temp on the printer called \\Rnd0\techp_laser1.
A1.2.52 Specifying the PRINTLINE Action
Schematic Action Login Action Alarm Action Event Scheduler Script Files Dynamic Menus Client Access
The PRINTLINE action prints a specified line of text to the printer as specified in OutputDevice= under [ALARMS]
in TCOMMSRV.INI, not the default one. This could be used to printout live dynamic values at specified intervals.
To specify the PRINTLINE action:
1. Enter the code to specify the action in the following format:
PRINTLINE <Text to Print>
<Text to print> specifies the text that is sent to the printer. If required 963 variables can be used in addition
to text to help specify the text.
E.g.
PRINTLINE Emergency Call the Engineer.
This code sends the text Emergency Call the Engineer to the printer.
To print dynamic values the PRINTLINE action would need to be incorporated into a script file to allow the
dynamic data to be collected.
E.g.
<LIVE L0O24S1(V)>
Sleep 10000
PRINTLINE Sensor 1 in o/s 24 lan 0 is . <LIVE L0O24S1(V)> at <PCHOURS>:<PCMINS>
The first line adds a request for S1(V) to the live values cache; this returns a wait the first time 963 gets the
request. The next line waits a suitable period (in mS) for the value to be refreshed. The third line prints out a
message including the same LIVE request, which by now should have a value in it.
A1.2.53 Specifying the PRINTPAGE Action
Schematic Action Login Action Alarm Action Event Scheduler Script Files Dynamic Menus Client Access
The PRINTPAGE action prints out a schematic page enabling the user to select a printer.
To specify the PRINTPAGE action:
1. Click PRINTPAGE from the list of actions.
Or
1. Enter the code to specify the action in the following format:
PRINTPAGE <Page Name>,<Template Name>
<Page Name> is an optional parameter that specifies the name of the path and filename of the page that is to
be printed. If it is not specified the current page will be printed. <Template Name> is an optional parameter
that specifies the print template that is to be used. If it is not specified the current page will be printed as it is
without using a print template.
E.g.
PRINTPAGE
This would prompt the user to specify the required printer, and then print the current page.
Or
PRINTPAGE pages\albery house.tss,user name template.tss
This would prompt the user to specify the required printer, and then print the page called albery house.tss
using the print template called user name template.tss.
A1.2.54 Specifying the PRINTPAGEAUTO Action
Schematic Action Login Action Alarm Action Event Scheduler Script Files Dynamic Menus Client Access
The PRINTPAGEAUTO action prints out a schematic page to the specified printer, without the need for user
intervention.
To specify the PRINTPAGEAUTO action:
1. Click PRINTPAGEAUTO from the list of actions. A dialogue box is displayed listing all the available
pages.
2. Click the required page. The Choose a print template dialogue box is displayed.
7. In the box specify whether the page is to be landscape by clicking Yes or No.
8. Click OK.
Or
1. Enter the code to specify the action in the following format:
PRINTPAGEAUTO <Page Name>,<Template Name>,<Printer Name>,<Orientation>
<Page Name> is an optional parameter that specifies the name of the path and filename of the page that is to
be printed. If it is not specified the current page will be printed. <Template Name> is an optional parameter
that specifies the print template that is to be used. If it is not specified the current page will be printed as it is
without using a print template. <Printer Name> is an optional parameter that specifies the name of the printer
that can be used. If it is not specified the printer specified as the page printer will be used. <Orientation> is
an optional parameter that specifies whether the page is printed out in portrait or landscape 0 = portrait, 1 =
landscape.
E.g.
PRINTPAGEAUTO
This would print the current page to the default printer.
Or
PRINTPAGEAUTO pages\albery house.tss,user name template.tss,\\Rnd0\techp_laser1,1
This would print the page called albery house.tss using the print template called user name template.tss on
the printer called \\Rnd0\techp_laser1 in landscape.
2. Click the required page. The Choose a print template dialogue box is displayed.
2. If the device is on a remote site, enter the IP address or host name if the site is accessed over TCP/IP or the
telephone number required to access the site if it is autodialled. When entering an IP address it must be
prefixed by 'IP' e.g. IP192.186.23.87. If specifying a hostname it must be prefixed by 'IP' and enclosed in
double quotes e.g. IP"Albery House". When entering a telephone number it can contain the following
characters.
Characters Description
0 to 9 Dialling characters.
ABCD#* Considered as dialling characters on some systems.
J or : Wait for secondary dial tone.
K or ; or , 2 second pause (Note on some autodiallers this may be a 1 second pause).
< Pulse dialling.
M or = Tone dialling.
3. Click the LAN tab.
4. In the box enter Lan containing the device (range 0, 1, 4 to 119 excluding 10). 0 specifies the local Lan.
5. Click the OS tab.
6. In the box enter the address of the device (range 1, 4 to 119 excluding 10).
7. Click the Item tab.
8. Specify the sensor that is to be recorded. This is in the form:
<Module>
<Module> specifies the type of module, sensor (S) or plot (P) using its module identifier and module number
(e.g. S1 specifies sensor 1).
9. Click the Label tab.
10. In the box enter the label of the module that is to be recorded.
11. Click OK.
12. If more than one plot module is associated with the value being recorded the Plots dialogue box is displayed,
click the required plot module, and click OK.
13. If a synchronised plot module is selected a dialogue box is displayed asking if a precision log is to be used.
If precision logs are required click Yes otherwise click No. If precision logs were not specified the set up is
complete, if they were a dialogue box is displayed. In the box enter the number of values that are to be
collected each time the action is carried out (maximum value is 1000), and click OK.
Or
1. Enter the code to specify the action in the following format:
RECORD <Connection> L<Lan Number> O<Controller Address>, <Module>[<Logging
Interval>|<Precision Logging>|<Number of Values>],<Label>
<Connection> is an optional parameter that specifies the IP address or host name if the site is accessed over
TCP/IP or the telephone number required to access the site if it is autodialled. When entering an IP address
it must be prefixed by 'IP' e.g. IP192.186.23.87. If specifying a hostname it must be prefixed by 'IP' and
enclosed in double quotes e.g. IP"Albery House". When entering a telephone number it can contain the
following characters.
Characters Description
0 to 9 Dialling characters.
ABCD#* Considered as dialling characters on some systems.
J or : Wait for secondary dial tone.
K or ; or , 2 second pause (Note on some autodiallers this may be a 1 second pause).
< Pulse dialling.
M or = Tone dialling.
<Lan Number> specifies the Lan containing the sensor (range 0, 1, 4 to 119 excluding 10). 0 specifies the
local Lan. <Controller Address> specifies the address of the device containing the sensor (range 1, 4 to 119
excluding 10). <Module> specifies the type of module, sensor (S) or plot (P) using its module identifier and
module number (e.g. S1 specifies sensor 1). <Logging Interval> specifies the logging interval that is to be
used. It can be set to the following values:
Value Logging Interval Value Logging Interval
-1 Any Interval 6 5 minutes
1 15 minutes 7 10 minutes
2 24 hours 8 20 minutes
3 1 minute 9 6 hours
4 1 hour 10 1 second
5 30 minutes
For triggered or change of value, logging interval is -1. And for periodic plots, logging interval is the number
of second between each sample.
If the logging interval is not specified, 963 will use the first log for that sensor that it finds. You should only
specify the logging interval if the sensor is being logged at more one interval.
<Precision Logging> specifies whether precision logging is required. It can be set to 1, or 0. 1 specifies
precision logging, and 0 specifies compact logging. <Precision Logging> must be set to 1 if the action is to
record data from a triggered plot module. <Number of Values> this parameter is only required if precision
logging is being used. It can be set to -1 for triggered plots or any integer between 1 and 1000 for synchronised
plots. When set to -1 963 values logged since the last total record count for are collected. <Label> specifies
the label of the module.
E.g.
RECORD 0123 456789L99O24S1[7|1|100],,Outside Air
Specifies the recording of a precision log of the last 100 values of sensor 1 labelled Outside Air in device 24
on Lan 99 accessed using the telephone number 0123 456789 that is logged at 10 minute intervals.
A1.2.60 Specifying the RECORDAUTO_COMPACT Action
Schematic Action Login Action Alarm Action Event Scheduler Script Files Dynamic Menus Client Access
The RECORDAUTO_COMPACT action records the data stored in the plotting channel for the module from which
an alarm has been received using compact data.
It is intended for use when a buffer ready event (BBUF) is received indicating that a particular plotting channel is
nearly full allowing the 963 to record the data from the plotting channel in the controller before it is overwritten see
the 'Record Logged Data when a BBUF Alarm is Received' section of this manual for more details.
To specify the RECORDAUTO_COMPACT action:
1. Click RECORDAUTO_COMPACT from the list of actions.
Or
Enter RECORDAUTO_COMPACT.
2. If the device is on a remote site, enter the IP address or host name if the site is accessed over TCP/IP or the telephone
number required to access the site if it is autodialled. When entering an IP address it must be prefixed by 'IP' e.g.
IP192.186.23.87. If specifying a hostname it must be prefixed by 'IP' and enclosed in double quotes e.g. IP"Albery
House". When entering a telephone number it can contain the following characters.
Characters Description
0 to 9 Dialling characters.
ABCD#* Considered as dialling characters on some systems.
J or : Wait for secondary dial tone.
K or ; or , 2 second pause (Note on some autodiallers this may be a 1 second pause).
< Pulse dialling.
M or = Tone dialling.
3. Click the LAN tab.
4. Specify the Lan containing the device to which the message is being sent in the box (range 0, 1, 4 to 119
excluding 10). 0 specifies the local Lan.
5. Click the OS tab.
6. In the box enter the address of the device to which the message is being sent (range 0, 1, 4 to 119 excluding
10).
7. Click the Item tab.
8. In the box enter the number of the sensor that is to be recorded. This is in the form:
<Module>
<Module> specifies the type of module, sensor (S) or plot (P) using its module identifier and module number
(e.g. S1 specifies sensor 1).
9. Click the Label tab.
10. In the box enter the label of the sensor that is to be recorded.
11. Click the Filename tab.
12. In the box enter the filename to which the data is to be recorded. If required 963 variables can be used in
addition to text to help specify the filename.
13. Click the Field separator tab.
14. In the box enter the character that is to separate the fields in each record. This can be any printable character
plus a tab, or carriage return. A tab is specified by typing [TAB], a carriage return by typing [CR], and a
comma by typing [COMMA].
15. Click the Record separator tab.
16. In the box enter the character that is to separate each record. This can be any printable character plus a tab,
or carriage return. A tab is specified by typing [TAB], a carriage return by typing [CR], and a comma by
typing [COMMA].
17. Click OK.
18. If more than one plot module is associated with the value being recorded the Plots dialogue box is displayed,
click the required plot module, and click OK.
19. If a synchronised plot module is selected a dialogue box is displayed asking if a precision log is to be used.
If precision logs are required click Yes otherwise click No. If precision logs were not specified the set up is
complete, if they were a dialogue box is displayed. In the box enter the number of values that are to be
collected each time the action is carried out, and click OK.
Or
1. Enter the code to specify the action in the following format:
RECORDTOTEXT <Connection> L<Lan Number> O<Controller Address> S<Sensor
Number>[<Logging Interval>|<Precision Logging>|<Number of Values>,<Sensor Label>
<Filename><Field Separator><Record Separator>
<Connection> is an optional parameter that specifies the IP address or host name if the site is accessed over
TCP/IP or the telephone number required to access the site if it is autodialled. When entering an IP address
it must be prefixed by 'IP' e.g. IP192.186.23.87. If specifying a hostname it must be prefixed by 'IP' and
enclosed in double quotes e.g. IP"Albery House". When entering a telephone number it can contain the
following characters.
Characters Description
0 to 9 Dialling characters.
ABCD#* Considered as dialling characters on some systems.
J or : Wait for secondary dial tone.
K or ; or , 2 second pause (Note on some autodiallers this may be a 1 second pause).
< Pulse dialling.
M or = Tone dialling.
<Lan Number> specifies the Lan containing the sensor (range 0, 1, 4 to 119 excluding 10). <Controller
Address> specifies the address of the device containing the sensor (range 0, 1, 4 to 119 excluding 10).
<Sensor Number> specifies the number of the sensor. <Logging Interval> specifies the logging interval that
is to be used. It can be set to the following values:
Value Logging Interval Value Logging Interval
-1 Any Interval 6 5 minutes
1 15 minutes 7 10 minutes
2 24 hours 8 20 minutes
3 1 minute 9 6 hours
4 1 hour 10 1 second
5 30 minutes
If the logging interval is not specified, 963 will use the first log for that sensor that it finds.
<Precision Logging> specifies whether precision logging is required. It can be set to 1, or 0. 1 specifies
precision logging, and 0 specifies compact logging. <Precision Logging> must be set to 1 if the action is to
record data from a triggered plot module. <Number of Values> this parameter is only required if precision
logging is being used. It can be set to -1 for triggered plots or any integer between 1 and 1000 for synchronised
plots. When set to -1 963 values logged since the last total record count for are collected. <Label> specifies
the label of the module. <Filename> specifies the name of the file to which the data is to be recorded in the
box. If required 963 variables can be used in addition to text to help specify the filename. <Field separator>
is the character that is to separate the fields in each record. <Record separator> is the character that is to
separate each record in the box.
E.g.
RECORDTOTEXT 0123 456789L99O24S1[10|1|100],Outside Air,C:\Program Files\Trend Control
Systems\963\L99O24S1 Recorded Data.txt,[TAB],[CR]
Specifies the recording to a file called L99O24S1 Recorded Data.txt of a precision log of the last 100 values of
sensor 1 labelled Outside Air in device 24 on Lan 99 accessed using the telephone number 0123 456789 that is
logged at 10 minute intervals. The fields are separated by tabs, and records separated by a carriage return.
2. If the remote 963 is on a remote site, enter the IP address or host name if the site is accessed over TCP/IP or
the telephone number required to access the site if it is autodialled. When entering an IP address it must be
prefixed by 'IP' e.g. IP192.186.23.87. If specifying a hostname it must be prefixed by 'IP' and enclosed in
double quotes e.g. IP"Albery House". When entering a telephone number it can contain the following
characters.
Characters Description
0 to 9 Dialling characters.
ABCD#* Considered as dialling characters on some systems.
J or : Wait for secondary dial tone.
K or ; or , 2 second pause (Note on some autodiallers this may be a 1 second pause).
< Pulse dialling.
M or = Tone dialling.
3. Click the LAN tab.
4. Specify the Lan containing the remote 963 in the box (range 0, 1, 4 to 119 excluding 10). 0 specifies the local
Lan.
5. Click the OS tab.
6. In the box enter the address of the remote 963 (range 1, 4 to 119 excluding 10).
7. Click the Enter remote command tab.
8. In the box enter the action that is to be carried out by typing the action and its associated parameters box.
This action can be any of the actions defined in this section of the manual.
9. Click OK.
Or
1. Enter the code to specify the action in the following format:
REMOTE <Connection> L<Lan number> O<Device Address><Action>
<Connection> is an optional parameter that specifies the IP address or host name if the site is accessed over
TCP/IP or the telephone number required to access the site if it is autodialled. When entering an IP address
it must be prefixed by 'IP' e.g. IP192.186.23.87. If specifying a hostname it must be prefixed by 'IP' and
enclosed in double quotes e.g. IP"Albery House". When entering a telephone number it can contain the
following characters.
Characters Description
0 to 9 Dialling characters.
ABCD#* Considered as dialling characters on some systems.
J or : Wait for secondary dial tone.
K or ; or , 2 second pause (Note on some autodiallers this may be a 1 second pause).
< Pulse dialling.
M or = Tone dialling.
<Lan Number> specifies the Lan containing the remote 963 (range 0, 1, 4 to 119 excluding 10). 0 specifies
the local Lan. <Device Address> specifies the address of the remote 963 (range 1, 4 to 119 excluding 10).
<Action> specifies the action that is to be carried out on the remote 963. This action can be any of the actions
defined in this section of the manual.
E.g.
5. In the box enter the required message. This can be a simple text message such as An alarm has occurred, or
can use 963 variables and text to generate a meaningful customised message e.g.
A <ALARMCODE> occurred at <TIME> from <LABEL> in <OSLABEL>
The code above would send a message similar to the one below:
A HIGH occurred at 14:50 from Outside Air Sensor in Office Block
The default is the <ALLLABELS> variable that will include all the labels from the alarm in the message.
For details of the 963 variables, see the 963 Variables section of this manual which explains each variable
and where they can be used. Only variables specified for use in alarm action codes can be used.
If the alarm is to be sent to another 963or a 962, and it is required that the alarm appears to the other 963 or
962 as though it has come from the original device, the message should be set to <963CODED>, or
<962CODED>.
When sending long messages the 963 will automatically split them up into smaller messages for transmission
over the IQ network. The NEWMSG variable can be used to split the message at a specified point. See the
Using the NEWMSG Variable section of this manual for more details.
6. Click OK.
Or
1. Ensure that the required destination has been set up.
2. Enter the code to specify the action in the following format:
RETRANSMIT <Destination Index>,<(Destination Name)>,<Message>
<Destination Index> specifies the destination index for the required destination, <Destination Name>
specifies the name of the required destination, and <Message> specifies the actual text to be sent to the
specified destination see (5) above for more details.
E.g.
RETRANSMIT 1,(Building Manager),The Boiler is off-line
Sends the message The Boiler is off-line to the destination called Building Manager, with a destination
index of 1.
2. Click the file that is to be run. To specify a file in another directory, click the drive, or folder in the Look in
box that contains the file, and double-click the folders in the folder list until the file is displayed.
3. Click Open.
Or
1. Enter the code to specify the action in the following format:
RUN <Destination>
<Destination> specifies the path and filename of the file that is to be run, or the URL that is to be accessed.
If required 963 variables can be used in addition to text to help specify the file.
E.g.
RUN report.xls
This will run Excel and load the file 'report.xls'.
2. In the folder list click the adjustment set. To specify a file in another directory, click the drive, or folder in
the Look in box that contains the file, and double-click the folders in the folder list until the file is displayed.
3. Click Open.
Or
1. Enter the code to specify the action in the following format:
RUN_ADJUSTMENT_SET <Filename>
<Filename> specifies the path and filename of the schematic page that is to be displayed.
E.g.
RUN_ADJUSTMENT_SET C:\Program Files\Trend Control
Systems\963\AdjustmentSet_11_01_11_11_42_22.xml
2. If the device is on a remote site, enter the IP address or host name if the site is accessed over TCP/IP or the
telephone number required to access the site if it is autodialled. When entering an IP address it must be
prefixed by 'IP' e.g. IP192.186.23.87. If specifying a hostname it must be prefixed by 'IP' and enclosed in
double quotes e.g. IP"Albery House". When entering a telephone number it can contain the following
characters.
Characters Description
0 to 9 Dialling characters.
ABCD#* Considered as dialling characters on some systems.
J or : Wait for secondary dial tone.
K or ; or , 2 second pause (Note on some autodiallers this may be a 1 second pause).
< Pulse dialling.
M or = Tone dialling.
3. Click the Lan tab.
4. In the box enter the Lan containing the device to which the message is being sent (range 0, 1, 4 to 119
excluding 10). 0 specifies the local Lan.
5. Click the OS tab.
6. In the box enter the address of the device to which the message is being sent (range 1, 4 to 119 excluding
10).
7. Click the Message tab.
8. In the box enter the text comms message. The message can be up to 80-characters long. Only standard write
text comms messages can be used.
9. Click OK.
Or
1. Enter the code to specify the action in the following format:
SEND <Connection> L<Lan Number> O<Device Address><Message>
<Connection> is an optional parameter that specifies the IP address or host name if the site is accessed over
TCP/IP or the telephone number required to access the site if it is autodialled. When entering an IP address
it must be prefixed by 'IP' e.g. IP192.186.23.87. If specifying a hostname it must be prefixed by 'IP' and
enclosed in double quotes e.g. IP"Albery House". When entering a telephone number it can contain the
following characters.
Characters Description
0 to 9 Dialling characters.
ABCD#* Considered as dialling characters on some systems.
J or : Wait for secondary dial tone.
K or ; or , 2 second pause (Note on some autodiallers this may be a 1 second pause).
< Pulse dialling.
M or = Tone dialling.
<Lan Number> specifies the Lan containing the device to which the message is to be sent (range 0, 1, 4 to
119 excluding 10). 0 specifies the local Lan. <Device Address> specifies the address of the device
containing the device to which the message is to be sent (range 1, 4 to 119 excluding 10). <Message>
specifies the text comms message. The message can be up to 80-characters long. Only standard write text
comms messages can be used.
E.g.
SEND 0123 456789L99O24K1(V=21)
Specifies the text comms message K1(V=21) to be sent to device 24 on Lan 99 accessed using the telephone
number 0123 456789.
A1.2.71 Specifying the SENDAUTO Action
Schematic Action Login Action Alarm Action Event Scheduler Script Files Dynamic Menus Client Access
Not text
mode
The SENDAUTO action enables a standard write text comms message to be sent to a specific device on the IQ
network.
Note that if the action is to be used to make an adjustment to a controller that is PIN protected the PIN must be
correctly set up in Device Viewer as described in the Set up the PIN Sent to Controllers section of this manual.
To specify the SENDAUTO action:
1. Click SENDAUTO from the list of actions. The Send Message to an Outstation dialogue box is displayed.
2. If the device is on a remote site, enter the IP address or host name if the site is accessed over TCP/IP or the
telephone number required to access the site if it is autodialled. When entering an IP address it must be
prefixed by 'IP' e.g. IP192.186.23.87. If specifying a hostname it must be prefixed by 'IP' and enclosed in
double quotes e.g. IP"Albery House". When entering a telephone number it can contain the following
characters.
Characters Description
0 to 9 Dialling characters.
ABCD#* Considered as dialling characters on some systems.
J or : Wait for secondary dial tone.
K or ; or , 2 second pause (Note on some autodiallers this may be a 1 second pause).
< Pulse dialling.
M or = Tone dialling.
3. Click the Lan tab.
4. In the box enter the Lan containing the device to which the message is being sent (range 0, 1, 4 to 119
excluding 10). 0 specifies the local Lan.
5. Click the OS tab.
6. In the box enter the address of the device to which the message is being sent (range 0, 1, 4 to 119 excluding
10).
7. Click the Message tab.
8. In the box enter the text comms message. The message can be up to 80-characters long. Only standard write
text comms messages can be used
9. Click OK.
Or
1. Enter the code to specify the action in the following format:
SENDAUTO <Connection> L<Lan Number> O<Device Address><Message>
<Connection> is an optional parameter that specifies the IP address or host name if the site is accessed over
TCP/IP or the telephone number required to access the site if it is autodialled. When entering an IP address
it must be prefixed by 'IP' e.g. IP192.186.23.87. If specifying a hostname it must be prefixed by 'IP' and
enclosed in double quotes e.g. IP"Albery House". When entering a telephone number it can contain the
following characters.
Characters Description
0 to 9 Dialling characters.
ABCD#* Considered as dialling characters on some systems.
J or : Wait for secondary dial tone.
K or ; or , 2 second pause (Note on some autodiallers this may be a 1 second pause).
< Pulse dialling.
M or = Tone dialling.
<Lan Number> specifies the Lan containing the device to which the message is to be sent (range 0, 1, 4 to
119 excluding 10). 0 specifies the local Lan. <Device Address> specifies the address of the device to which
the message is to be sent (range 1, 4 to 119 excluding 10). <Message> specifies the text comms message.
The message can be up to 80-characters long. Only standard write text comms messages can be used.
E.g.
SENDAUTO 0123 456789L99O24K1(V=21).
Specifies the text comms message K1(V=21) to be sent to device 24 on Lan 99 accessed using the telephone
number 0123 456789.
A1.2.72 Specifying the SETGENERIC Action
Schematic Action Login Action Alarm Action Event Scheduler Script Files Dynamic Menus Client Access
Not text
mode
The SETGENERIC action displays a dialogue box that enables the device from which generic dynamic objects obtain
their value to be specified.
To specify the SETGENERIC action:
1. Click SETGENERIC from the list of actions.
Or
1. Enter SETGENERIC.
A1.2.73 Specifying the SETIOPORT Action
Schematic Action Login Action Alarm Action Event Scheduler Script Files Dynamic Menus Client Access
The SETIOPORT action displays the Port Selection dialogue box that enables the communications port that 963 uses
to communicate with other IQ system devices to be set up.
To specify the SETIOPORT action:
1. Click SETIOPORT from the list of list of actions.
Or
1. Enter SETIOPORT.
The list can be filtered by clicking Enable, clicking the field that is to be searched in the Search this field
box, and entering the text that is to be searched for in the for this text box. The list is filtered to display
only items that match the search criteria.
3. Click OK.
Or
1. Enter the code to specify the action in the following format:
VIEWFILTER <Filter Name>
<Filter Name> specifies the name of the filter for which the results are to be accessed.
E.g.
VIEWFILTER Critical Alarms
This would display a list of all the alarms that match the parameters defined in an alarm filter called Critical
Alarms.
A1.2.78 Specifying the VIEWGRAPH Action
Schematic Action Login Action Alarm Action Event Scheduler Script Files Dynamic Menus Client Access
Not text
mode
The VIEWGRAPH action displays a window containing graphs of all the IQ system points on the current page. If
logged information is available in the controller, this will be displayed; otherwise, live values will be used. If a graph
definition is specified in the action, the specified definition will be loaded instead. If the VIEWGRAPH action is used
on a client, it is necessary to specify a specific graph definition.
To specify the VIEWGRAPH action:
1. Click VIEWGRAPH from the list of actions. A dialogue box shown below is displayed.
2. If the action is to load a specific graph definition, click Yes, and go to (3), otherwise click No to complete
the definition.
3. Click the required graph definition from the list in the Please choose a graph definition dialogue box that
is displayed.
4. Click OK.
Or
1. Enter the code to specify the action in the following format:
VIEWGRAPH <Graph Definition>
<Graph Definition> is the name of the graph definition that is to be loaded.
E.g.
VIEWGRAPH Outside Air Sensor
This would display the graph definition Outside Air Sensor.
2. In the box enter the database fields that are to be extracted, separate each field with a comma ,.
3. Click the FROM tab.
4. In the box enter the database table from which the data is to be extracted.
5. Click the WHERE tab.
6. In the box enter the SQL command that is to be used to extract the data.
Or
1. Enter the code to specify the action in the following format:
VIEWQUERY [<Window Title>],<SQL Command>
<Window Title> specifies the title of the window. <SQL Command> is the SQL query that is to be
performed. The SQL command must be in the following order:
SELECT <selected data> FROM <database table> WHERE <query criteria>
E.g.
SELECT * FROM LastAlarmDetailsByTime WHERE AlarmCode = N'ADJU
This selects all the alarms in the alarms in the LastAlarmDetailsByTime table where the alarm code is
N'ADJU
For details about the fields in the alarms database see the Database section of this manual.
2. Click the database on which the query is to be run. To specify a file in another directory, click the drive, or
folder in the Look in box that contains the file, and double-click the folders in the folder list until the file is
displayed.
3. Click Open. The VIEWQUERY dialogue box is displayed.
4. In the box enter the database fields that are to be extracted, separate each field with a comma ,.
5. Click the FROM tab.
6. In the box enter the database table from which the data is to be extracted.
7. Click the WHERE tab.
8. In the box enter the SQL command that is to be used to extract the data.
9. Click OK.
Or
1. Enter the code to specify the action in the following format:
VIEWQUERYEX <Database>, <SQL Command>
<Database> specifies the path and filename of the database that is to be queried. <SQL Command> is the
SQL query that is to be performed. The SQL command must be in the following order:
SELECT <selected data> FROM <database table> WHERE <query criteria>
E.g.
VIEWQUERYEX C:\Program Files\Trend Control Systems\963\i96x_sys.mdf,SELECT * FROM
Alarms WHERE setUser=Default
This selects all the alarms in the alarms database that the Default user acknowledged and displays the,
AlarmCode, theModule, and userText fields from the i96x_sys.mdf database.
2. Click the file that is to be run. To specify a file in another directory, click the drive, or folder in the Look in
box that contains the file, and double-click the folders in the folder list until the file is displayed.
3. Click Open.
Or
1. Enter the code to specify the action in the following format:
WINEXECU <Application Path>,<Data File Path>
<Application Path> specifies the path and filename of the program that is to be run. <Data File Path> specifies
the filename of the file that is to be opened. If required 963 variables can be used in addition to text to help
specify the path and filename. Unicode characters can be used. <Data File Path> is optional.
E.g.
WINEXECU C:\ Programfiles\ . exe
To execute a program called . exe.
Or
WINEXECU C:\Programfiles\office\excel.exe, D:\\ .xls
To open a specific file within a program when executed.
2. In the box enter the section within the file to which the value is to be written. It should be entered with square
brackets around it (e.g. [Offline]).
3. Click the Key tab.
4. In the box enter the value that is to be changed.
5. Click the Value tab.
6. In the box enter the actual value.
7. Click the Filename tab.
8. In the box enter the path and filename of the INI file containing the value that is to be changed. If required
963 variables can be used in addition to text to help specify the path and filename.
Note that if a path is not specified, the Windows directory will be used.
9. Click OK.
Or
1. Enter the code to specify the action in the following format:
WRITESTRING <Section>,<Key>,<Value>,<Filename>
<Section> specifies the section in the INI file to which the value is to be written. <Key> specifies the line in
the specified section whose value is to be modified. <Value> specifies the value to which the setting is to be
set. <Filename> specifies the path and filename of the INI file that is to be modified. If required 963 variables
can be used in addition to text to help specify the path and filename.
E.g.
WRITESTRING [ALARMS], DaysToKeep,50, c:\program files\trend control systems\963\s2.ini
This example enables a user to click the button and change the number of days to keep old acknowledged
alarms for the alarm database to 50. This entry is stored in the [ALARMS] section of S2.ini file located in
the install directory under the DaysToKeep keyword.
Or
WRITESTRING [ANC], NumRefreshes,10, c:\program files\trend control systems\963\Tcommsrv.ini
This would enable a user to click the button and change the number of refreshes 963 will take of an
autodialled site before dropping the line to 10. This entry is stored in the [ANC] section of the tcommsrv.ini
file located in the install directory, under the NumRefreshes keyword.
Note that after ini file changes 963 will need to be restarted for the changes to take effect.
Field Description
Sat This a bit field having the value 0 or 1. A value of 1 indicates that the respective action is valid for
Saturdays.
Sun This a bit field having the value 0 or 1. A value of 1 indicates that the respective action is valid for
Sundays.
NumberOfEvents This is an integer value indicating how many times the action is to run. A value of 0 indicates that
the action is to run indefinitely. 963 will decrement this value each time the action is executed and
will remove the action when it is no longer required.
NextEventAt This is the local time of when the action will next trigger.
OnFailure This is the 963 action that will be executed if the action defined in "Command" fails.
OnSuccess This is the 963 action that will be executed if the action defined in "Command" succeeds.
CreatedBy This is a string of 255 characters or less of the username that created the action.
theExpiryDate This field is reserved for future use and must be set NULL.
A3.2 AllDetailsForLans View
The AllDetailsForLans view holds information for every Lan that has been learnt and stored in the 963 database. The
view is defined as follows:
Field Description
siteID Unique ID assigned for respective entry in database.
siteLabel This is the label for the respective Lan, e.g. "My Supervisor".
siteConnectionString This is the connection string for the given Lan. This is only applicable for remote sites, e.g.
"IP100.200.300.400".
siteRemoteLan This is the device address of the remote connection on the Lan. This is normally 126.
lanID This is an index back to the table of Lans use this to retrieve additional detailed information
about a particular Lan.
lanNo This is the Trend address of the Lan.
DeviceType For internal use only.
theLabel This is the label from INC.
A3.3 AllDetailsForOutstation View
The AllDetailsForOutstation view contains all information about every device learnt and stored in the 963 database.
The view is defined as follows.
Field Description
siteID Unique ID assigned for respective entry in database.
siteLabel This is the label for the respective Lan, e.g. "My Supervisor".
siteConnectionString This is the connection string for the given Lan. This is only applicable for remote
sites, e.g. "IP100.200.300.400".
siteRemoteLAN This is the device address of the remote connection on the Lan. This is normally 126.
lanID This is an index back to the table of Lans use this to retrieve additional detailed
information about a particular Lan.
lanNo This is the Trend address of the Lan.
lanLabel This is the label of the Lan that the respective outstation belongs to.
outstationID This is a unique database ID for the respective outstation.
NodeAddress This is the address of the node on the respective Lan, e.g. 0, 1, 4-9, 11-119 or 126
(INC).
OSLabel This is the label for the respective outstation.
FWVersionMajor When applicable, this will be the major firmware version number of the device for
the respective outstation.
FMVersionMinor When applicable, this will be the minor firmware version number of the device for
the respective outstation.
DeviceType This field contains the appropriate character code for the respective Trend device for
the outstation. This parameter is case sensitive.
deviceSubType The network type of the device e.g. BACnet. For Trend devices this will be blank.
This parameter is case sensitive.
Field Description
theLabel The field is identical to OSLabel.
outPin This is the PIN for the respective device.
deviCeResponse This is the Trend text communication response R(C) this normally contains a
description of the device including software version etc.
nodeIpAddrr This contains the IP address of the respective node, e.g. "112.113.114.115" or
"#N/A#" if not applicable.
PlotsDiscoveryAttempted This parameter is set to 1 if the associated outstations plot discovery has been
performed (initiated).
overviewDevCommsResponse Contains an overview of the communications settings used for the device. This
response is used to identify the device type, device major version, device minor
version etc.
TimeMasterStatus Status of the time master. Whether the device is acting as Time master.
A3.4 CountAllAlarms View
The CountAllAlarms view is designed to give generalised information of the total frequency, number actioned and
number of cleared alarms for each point/alarm code. The table generated by this view is as follows:
Field Description
AlarmCode This the alarm code for the particular alarm e.g. "ADJU" for adjustment.
alarmCodeID This is the internal alarm code ID for the respective alarm code.
stringResID This is an internal number that identifies the human readable translation for the respective alarm
code.
theDescription This is the description for the respective AlarmCode.
Priority This is the priority number associated with the respective alarm. A value of -1 identifies no
alarm priority.
siteLabel The name of the site for which the alarm is associated to.
connectionString The connection string used to connect to the site for which the alarm code is associated with.
lan The Lan number where the alarm originated from.
os The Outstation number where the alarm originated from.
numActioned This is a count of times that the alarm has been actioned.
theModule The entry here describes the module that is associated with the respective alarm. If the alarm
were an adjustment of a switch 10, W10 may be entered here.
ModuleLabel This is the label associated with the module. For example, if W10 had a label of "Lighting",
"Lighting" would be entered here.
controllerLabel If the alarm/event originated from a controller, the label for that controller (Outstation) will be
entered here.
lanLabel If the alarm/event originated from an outstation, this will be set to the label of the Lan where
the outstation is located.
theCount The total number of alarms.
pointID The ID of the point in alarm as specified by the database.
clearToID The ID for the specific clear alarm.
ModuleType The type of module.
numCleared The number of cleared alarms
ModuleNumber The module number.
alarmRequiresAction Indicates whether the alarm must be acknowledged by the user. When set to 1 the alarm must
be acknowledged by the user.
OriginallyCurrent indicates if the alarm is current. When set to 1 the alarm is current.
2. Click , or on the Mode menu click Device Viewer to select the Device Viewer.
3. Right-click the device for which the properties are to be displayed and click Properties. The Device
Properties dialogue box is displayed. Clicking Set Timeout enables the communications timeout to be set.
Set Timeout is only available to users with who are able to configure the Device Viewer.
Note that the information is that stored in the 963's database, and may differ from that actually in the device.
For information directly from the device right click the device and click View Device Details.
A4.10 Problems with Defragmentation Programs
The 963 uses CrypKey to perform the licensing functions. Sometimes after disk defragmentation using Speed Disk
included in Norton utilities the 963 licence is lost, and it is not possible to run 963. This is because if the CrypKey
files are moved during the defragmentation process the licence is invalidated. To prevent this Speed Disk must be
configured not to move the CrypKey files.
Configuring Speed Disk not to move the CrypKey files:
1. Run Speed Disk.
2. On the File menu point to Options, then point to Customize, and then click Unmovable files.
3. Specify *.ENT, *.KEY, and *.RST as unmovable files.
4. Save the changes.
It is probable that other defragmentation programs will cause the same problem. If this occurs you should follow the
instructions provided with the program to specify *.ENT, *.KEY, and *.RST as unmovable files.
A4.11 Problems with Virus Scanning and Anti Spyware Programs
The 963 uses CrypKey to perform the licensing functions. Some anti spyware and virus scanning programs see one
of the crypkey files (crypserv.exe) as a potentially harmful file and delete it. This results in the 963 displaying the
following message No network directory - check crypkey has been configured for this directory and 963 will not
run up.
To prevent this problem from happening again, set up the virus scanner and anti spyware software to exclude the 963
directory and the crypkey files. If it is not possible to configure the software it may be necessary to remove the anti
spyware.
If this problem has occurred follow the procedure below.
To add the link to the CrypKey service:
1. In the 'c:\program files\trend control systems\963' directory double click 103.bat.
A5.1 TCOMMSRV.INI
This file contains all settings for controlling the communications with the IQ network, most users will not see, or want
to modify this file. Some of the settings are controlled and written to by the software and others can be directly
modified by an engineer.
Caution: only make changes to this file if you understand what you are doing, and make a backup first.
The file is divided into the following sections.
[ALARMS] Section
[ANC] Section
[GROUPING] Section
[IO] Section
[NETWORK] Section
[RETRIES] Section
[TIMEOUTS] Section
A5.1.1 [ALARMS] Section
963 will generate a SYST alarm in case an alarm module is invalid. A module is validated by a regular expression.
By default regular expression is as follows:
[!-/:-~]{1,9}[0-9]{1,9}
This regular expression can be changed in future by changing following parameters in tcommsrv.ini file.
[Alarms]
ModuleValidation=[!-/:-~]{1,15}[0-9]{1,6}
It is possible to force 963 to use a particular type of dialler when dialling a specific number by inserting an entry in
the format shown below:
<Phone Number>=<Device Type>
Where <Phone Number> is the telephone number that is being dialled. <Device Type> specifies the type of device
that can be used.
E.g.
6447=MNC
The example above specifies an MNC must be used when dialling the telephone number 6447.
A5.1.4 [IO] Section
Keyword Default Description
AUTOSCAN 0
BAUD 9600 Specifies the baud rate used to communicate with the node connecting 963 to the
network it can be set to any valid baud rate. However because 963 automatically
scans the baud rates it will not have any effect unless the automatic scanning of the
baud rate has been turned off; (POLLING=0).
COMM 0 Specifies the COM port number used to connect to the IQ network. It can be set to
any valid COM port number. The 963 sets this parameter (range 1, 2, 3,4).
CommsRequestPoolSize 50 Determines the responsiveness of the comms. Increasing this value can improve
comms responsiveness at the expense of using more PC resources.
MaxRequestsPerFrame 0 Sets the maximum number of item requests per message. Removing this entry or
setting it to 0 switches off the safety feature.
MODE 1 Should always be set to 1 unless the 963 is directly connected to an IQ1s local
supervisor port when it should be set to 2.
POLLING 1 Enables the auto-scan baud rate feature to be enabled/disabled. It can be set to 1, or
0. 1 enables the auto-scan baud rate feature, and 0 disables it. This should normally
be set to 1.
SameIQFrameDelay 2000 Specifies the delay in Ms between frames sent to the same device. This can be used
to prevent overloading the device.
SERIALPORTSERVER - Specifies the IP address of the device which 963 is to use to connect to the IQ
network when it is communicating using TCP/IP.
SOCKETFROM 10005 Specifies the first socket in the range of port numbers on the Device to which 963
can connect.
SOCKETTO 10007 Specifies the last socket in the range of port numbers on the device to which 963
can connect.
USETCP 0 Specifies whether the 963 is to connect to the IQ network using TCP/IP. This
parameter is set by 963, when set to 1 963 will communicate using TCP/IP, and
the comport setting (COMM=x) is ignored. When a comport is specified, 963 will
set it to 0.
A5.1.5 [NETWORK] Section
Keyword Default Description
IgnoreNWOK 0 This can be used if 963s main connection is using an EINC with address> 100. If 963 thinks
the network is broken it will stop all comms. Sometimes an EINC at an address >100 can cause
this to occur. Setting this to 1 prevents 963 from stopping comms. In most cases, this should
be left at the default of 0.
A5.1.6 [RETRIES] Section
Keyword Default Description
ConditionalTextComms 1 Number of retries for text comms.
IgnoreDelFail 0 Enables/disables 963 low level retries. 0 enables it, 1 disables it.
LocalSite 1 Number of retries for local sites.
RemoteSites 1 Number of retries for remote sites.
RemoteATDNetworkMap 30000 Specifies the time out in Ms for mapping a remote ATD site. Should be increased
if the site continually times out during mapping.
RemoteTCPSites 30000 Specifies the time out in mS for TCP/IP remote sites.
RemoteTCPNetworkMap 30000 Specifies the time out in Ms for mapping a remote TCP site. Should be increased
if the site continually times out during mapping.
TeleLanOs Specifies the time out in mS for the specified device.
For the local site, there are 3 settings- a starting value (LocalSite), then two limits (MinLocalSite) and (MaxLocalSite).
963 will initially use the starting value, and then adjust the time out within the range defined by the MaxLocalSite,
and MinLocalSite settings. If time outs are occurring on schematic pages, it may be necessary to adjust these
parameters. The table below lists the keywords, and their purpose.
It is possible to specify a different time out for a specific device by adding an entry for that device into this section in
the format shown below:
<Phone Number> L<Lan Number> O<Controller Address>=<Time out>
<Phone Number> is an optional parameter that specifies the telephone number used to access the site if it is
autodialled. <Lan Number> specifies the Lan containing the device (range 0, 1, 4 to 119 excluding 10). 0 specifies
the local Lan. <Controller Address> specifies the address of the device (range 0, 1, 4 to 119 excluding 10). <Time
out> specifies the time out in mS for that device.
E.g.
6381L99O21=60000
The example above specifies a time out of 60000 mS for device 21 on Lan 99 accessed with the telephone number
6381.
A5.2 S2.INI
This file contains all settings specific to 963. Some of the settings are controlled and written to by the software and
others can be directly modified by an engineer.
Caution: only make changes to this file if you understand what you are doing, and make a backup first.
The file is divided into the following sections:
[AlarmPrinting] Section
[ALARMQUICKFILTER] Section
[ALARMS] Section
[BACNETDRIVER] Section
[ClientAlarmViewer] Section
[COLOURS] Section
[COMMS] Section
[CONFIGMODE] Section
[Database] Section
[DeviceDiscovery] Section
[DeviceViewer] Section
[DIARY] Section
[DYNAMICOBJECTS] Section
[EMAIL] Section
[EXTRA] Section
[FilesNotAllowedToView]
[GenericAddresses] Section
[GRAPHS] Section
[ICONS] Section
[IPADDRESS] Section
[LANGUAGE] Section
[LOGGING] Section
[LonBatchComms]
[PrintTemplate] Section
[NormalBatchComms] Section
[retransmission] Section
[Scheduler] Section
[SchedulerFilterSearch] Section
[Schematics] Section
[SMS] Section
[SOUND] Section
[StaticObjects] Section
[TCPIP] Section
[TEXTFILEMANAGE] Section
[TSS] Section
[UNSECUREFILETYPES] Section
[WebAlarms] Section
[WebServer] Section
A5.2.1 [AlarmPrinting] Section
Keyword Default Description
PrintText <LABEL><TAB><ALARMDESC><TAB><TIME> The default print layout for alarm groups.
Site -><SITE><TAB>" lan -><LANLABEL><TAB> os -
><OSLABEL
<TELE>L<LAN>O<OS>
<MODULE><ALARMCODE>
A5.2.2 [ALARMQUICKFILTER] Section
The [ALARMQUICKFILTER] stores the last 100 manual entries that have been used in the Quick Filter area of the
Alarm History display and can be recalled by the user from selecting the list.
Keyword Default Description
0-99 - The filter information. E.g. 0=OUTL
There is a separate keyword for each
of the 100 filters.
To specify an address that cannot access the 963 server enter the IP address followed by 0 in
the format below:
xxx.xxx.xxx.xxx=0
For example the following will prevent access to all IP addresses except 192.254.3.5 and 192.254.45.7
[IPADDRESS]
DENYONLY=0
192.254.3.5=1
192.254.45.7=1
Keyword Description
BatchInterval The delay in seconds between each batch request (default 1 second)
MaxRequestsBeforePause The length of time in seconds before the batch process repeats itself, this is a delay in
seconds before the whole process starts again (default 5 seconds)
PauseInterval The delay in seconds between each batch request (default 1 second).
BatchSize Specifies the number of requests/items per batch (default 10).
Keyword Description
BatchInterval The delay in seconds between each batch request (default 1 second)
MaxRequestsBeforePause The length of time in seconds before the batch process repeats itself, this is a delay in
seconds before the whole process starts again (default 5 seconds)
PauseInterval The delay in seconds between each batch request (default 1 second).
BatchSize Specifies the number of requests/items per batch (default 10).
SchematicSizeForAutoBatch Specifies the number of values on a schematic page before the requests for data are
batched according to the settings above.
2. In the What action do you want to run? box click the required action from the list, or enter the required
code for the action as described in the appropriate section of this manual. Some actions require additional
information to be provided. If this is the case, a dialogue box is displayed enabling the information to be
entered.
For more details about specifying actions, see the Specifying Actions section of this manual.
A6.6 Specifying the Connection Attribute
For dynamic objects only, the Connection attribute specifies the telephone number, or IP address required to access
the controller containing the value to which the dynamic object is linked. It is only necessary to specify this if the
controller containing the value is on a remote site.
Note that this attribute cannot be specified if the Use Generic attribute is set to 'Yes'.
To specify the Connection attribute:
1. In the Tele box in the Display Object Editor pane enter the required telephone number, IP address or
hostname. When entering an IP address it must be prefixed by 'IP' e.g. IP192.186.23.87. If specifying a
hostname it must be prefixed by 'IP' and enclosed in double quotes e.g. IP"Albery House". When entering a
telephone number it can contain the following characters. The number may be up to 20-characters in length,
and include the following characters. If the device is on the local site leave this field blank.
Characters Description
0 to 9 Dialling characters.
ABCD#* Considered as dialling characters on some systems.
J or : Wait for secondary dial tone.
K or ; or , 2 second pause (Note on some autodiallers this may be a 1 second pause).
< Pulse dialling.
M or = Tone dialling.
A6.7 Specifying the Decimal Places Attribute
For dynamic objects only, the Decimal Places attribute specifies the number of decimal places after the decimal point
that are displayed on the page.
To specify the Decimal Places attribute:
1. In the Decimal Places box in the Display Object Editor pane enter required number of decimal places. If
set to -1 963 will display the information exactly as it is received.
If the object is viewed from a web browser, the browser will not display a different graphic when the mouse is moved
over the object, or when the mouse button is pressed.
If the object is viewed from a web browser, the browser will not display a different graphic when the mouse is moved
over the object, or when the mouse button is pressed.
A6.21 Specifying the PIN Attribute
For both dynamic and static objects, the PIN attribute defines the minimum PIN level of users who can see/use the
object. For dynamic objects if the users PIN level is less than the value of this attribute, clicking the object will have
no effect. For static objects if the users PIN level is less than the value of this attribute, the object does not appear on
the page.
To specify the PIN attribute:
1. In the PIN box in the Display Object Editor pane enter the required PIN level. Range -1 to 100. -1 means
that anyone can see/use the object, and 100 means that nobody can adjust the value, although it will be visible
to users.
A6.22 Specifying the Refresh View Attribute
For dynamic objects only, the Refresh View attribute specifies how often the value from the system is updated.
To specify the Refresh View attribute:
1. In the Refresh View box in the Display Object Editor pane enter the required refresh rate in seconds (any
valid integer).
Setting the refresh rate of an object to 999 forces the refreshing of the page to be controlled by entries in the INI file.
This enables the comms request to be controlled when the page contains allot of dynamic objects.
Note that if the object is to be on a page that will be viewed in a web browser, the value specified here will be ignored
by the web browser, which has its refresh rate fixed at 30 seconds. Values on text mode schematic pages are not
automatically refreshed, and must be manually refreshed using the button on the screen.
A6.23 Specifying the Shadow Attribute
For both dynamic and static objects, the Shadow attribute defines if the text is displayed in shadow text.
To specify the Shadow attribute:
1. In the Display Object Editor pane click Yes in the shadow box to make text display in shadow text, or No
to make it display in normal text.
Note that if the object is to be viewed from a web browser, this attribute is ignored.
System variable In the To display box click , and then select the required code from the list, or type
the required variable into the box, and click OK. These codes are described in the 963
Variables section of this manual.
If required the display can be built up by combining the 963 variables and text.
URL Enter the URL in the To display box.
Text Enter the required text in the To display box.
If required the display can be built up by combining the 963 variables and text.
Nothing In the To display box click , and then click Nothing.
If the object is viewed from a web browser, the browser will not display a different graphic when the mouse is moved
over the object, or the mouse button is pressed.
If an HTML file is added which contains references to file types other than JPG, BMP, HTM, XML, XSL, or HTML
they must be added to the unsecure file types list.
A6.25 Specifying the Tooltip Attribute
For both dynamic and static objects, the Tooltip attribute defines the text that is displayed when the mouse is held
over the object.
To specify the Tooltip attribute:
1. In the Tooltip box in the Display Object Editor pane enter the text.
If the object viewed from a web browser the text specified here will appear in the status bar.
A6.26 Specifying the Transparency Attribute
For both dynamic and static objects, the Transparency attribute enables a colour used in a bitmap file to be made
transparent, or for the button effect to be turned off if the object is displayed as text.
To specify the Transparency attribute:
1. In the Display Object Editor pane click Yes in the Transparency box to make the object the transparency
colour, or No to make it use the normal colour.
2. In the Transparency Colour box in the Display Object Editor pane click . The Color dialogue box is
displayed.
If the object is viewed from a web browser, the browser will not display a different graphic when the mouse is moved
over the object, or when the mouse button is pressed.
A6.31 Specifying the When OFF Attribute
For dynamic objects only, the When Off attribute specifies what is displayed when the value linked to the object is
OFF (0). It only applies when the object is linked to a digital value. It is possible to display a specific piece of text, a
bitmap, or animation.
To specify the When Off attribute:
1. In the When Off box in the Display Object Editor pane specify the attribute.
What 963 can do How to set it up
Carry out an action In the When Off box enter the code for the required action in the box. For
details about setting up actions, see the Specifying Actions section of this
manual.
Note that the use of actions in this way is not supported on the client.
Display a border around the In the When Off box click and click <BORDER> from the displayed
object list.
Display a flashing border around In the When Off box click and click <FLASHBORDER> from the
the object displayed list.
Display a graphic file In the When Off box click , then click Choose BMP in the dialogue box
that is displayed click the required file. This method only enables BMP
files in the BMP directory to be used, to use other graphic files click
Choose from directory, select the required file from the list, and then click
OK. To specify a file in another directory, click the drive, or folder in the
Look in box that contains the file, and double-click the folders in the folder
list until the file is displayed.
To display different graphics when the mouse moves over the object, is
held over the object for more than 10s, or when the mouse button is pressed
by create the graphic and save it as using the filenames below.
Mouse Over Object <filename>_o
Mouse held over object for more than 10s <filename>_h
Mouse button pressed over the object <filename>_d
Note that mouse over images must be the same size as the normal image
Display an animation file In the When Off box click , then click Choose Animation in the
dialogue box that is displayed click the required file. This method only
enables animation files in the animation directory to be used, to use other
files click Choose from directory, select the required file from the list,
and then click OK. To specify a file in another directory, click the drive,
or folder in the Look in box that contains the file, and double-click the
folders in the folder list until the file is displayed.
To display different graphics when the mouse moves over the object, is
held over the object for more than 10s, or when the mouse button is pressed
by create the graphic and save it as using the filenames below.
Mouse Over Object <filename>_o
Mouse held over object for more than 10s <filename>_h
Mouse button pressed over the object <filename>_d
Note that mouse over images must be the same size as the normal image
Display a system variable In the When Off box click and then select the required code from the
list, or type the required variable into the box. These codes are described
in the 963 Variables section of this manual.
If required the display can be built up by combining the 963 variables and
text.
Display text In the When Off box enter the required text.
If required the display can be built up by combining the 963 variables and
text.
Display text in the transparency In the When Off box click and click <INVERT> from the displayed
colour list and then enter the required text
If the object is viewed from a web browser, the browser will not display a different graphic when the mouse is moved
over the object, or when the mouse button is pressed.
A6.32 Specifying the When On Attribute
Only for dynamic objects linked to digital values, the When On attribute specifies what is displayed or the action that
is carried out when the value linked to the object is ON (1). It only applies when the object is linked to a digital value.
It is possible to display a specific piece of text, a bitmap, or animation.
To specify the When On attribute:
1. In the When On box in the Display Object Editor pane specify the attribute.
What 963 can do How to set it up
Carry out an action In the When On box enter the code for the required action in the box. For
details about setting up actions, see the Specifying Actions section of this
manual.
Note that the use of actions in this way is not supported on the client.
Display a border around the In the When On box click and click <BORDER> from the displayed
object list.
Display a flashing border around In the When On box click and click <FLASHBORDER> from the
the object displayed list.
Display a graphic file In the When On box click , then click Choose BMP in the dialogue box
that is displayed click the required file. This method only enables BMP
files in the BMP directory to be used, to use other graphic files click
Choose from directory, select the required file from the list, and then click
OK. To specify a file in another directory, click the drive, or folder in the
Look in box that contains the file, and double-click the folders in the folder
list until the file is displayed.
To display different graphics when the mouse moves over the object, is
held over the object for more than 10s, or when the mouse button is pressed
by create the graphic and save it as using the filenames below.
Mouse Over Object <filename>_o
Mouse held over object for more than 10s <filename>_h
Mouse button pressed over the object <filename>_d
Note that mouse over images must be the same size as the normal image
Display an animation file In the When On box click , then click Choose Animation in the
dialogue box that is displayed click the required file. This method only
enables animation files in the animation directory to be used, to use other
files click Choose from directory, select the required file from the list,
and then click OK. To specify a file in another directory, click the drive,
or folder in the Look in box that contains the file, and double-click the
folders in the folder list until the file is displayed.
To display different graphics when the mouse moves over the object, is
held over the object for more than 10s, or when the mouse button is pressed
by create the graphic and save it as using the filenames below.
Mouse Over Object <filename>_o
Mouse held over object for more than 10s <filename>_h
Mouse button pressed over the object <filename>_d
Note that mouse over images must be the same size as the normal image
Display a system variable In the When On box click and then select the required code from the
list, or type the required variable into the box. These codes are described
in the 963 Variables section of this manual.
If required the display can be built up by combining the 963 variables and
text.
If the object is viewed from a web browser, the browser will not display a different graphic when the mouse is moved
over the object, or when the mouse button is pressed.
A6.33 Specifying the While Waiting Attribute
For dynamic objects only, the While Waiting attribute specifies what is displayed while 963 is waiting for the value
to come back from the controller. It is possible to display a specific piece of text, a bitmap, or animation.
To specify the While Waiting attribute:
1. In the While Waiting box in the Display Object Editor pane specify the attribute.
What 963 can do How to set it up
Carry out an action In the While Waiting box enter the code for the required action in the box.
For details about setting up actions, see the Specifying Actions section of
this manual.
Note that the use of actions in this way is not supported on the client.
Display a border around the In the While Waiting box click and click <BORDER> from the
object displayed list.
Display a flashing border around In the While Waiting box click and click <FLASHBORDER> from
the object the displayed list.
Display a graphic file In the While Waiting box click , then click Choose BMP in the dialogue
box that is displayed click the required file. This method only enables BMP
files in the BMP directory to be used, to use other graphic files click
Choose from directory, select the required file from the list, and then click
OK. To specify a file in another directory, click the drive, or folder in the
Look in box that contains the file, and double-click the folders in the folder
list until the file is displayed.
To display different graphics when the mouse moves over the object, is
held over the object for more than 10s, or when the mouse button is pressed
by create the graphic and save it as using the filenames below.
Mouse Over Object <filename>_o
Mouse held over object for more than 10s <filename>_h
Mouse button pressed over the object <filename>_d
Note that mouse over images must be the same size as the normal image
Display an animation file In the While Waiting box click , then click Choose Animation in the
dialogue box that is displayed click the required file. This method only
enables animation files in the animation directory to be used, to use other
files click Choose from directory, select the required file from the list,
and then click OK. To specify a file in another directory, click the drive,
or folder in the Look in box that contains the file, and double-click the
folders in the folder list until the file is displayed.
To display different graphics when the mouse moves over the object, is
held over the object for more than 10s, or when the mouse button is pressed
by create the graphic and save it as using the filenames below.
Mouse Over Object <filename>_o
Mouse held over object for more than 10s <filename>_h
Mouse button pressed over the object <filename>_d
Note that mouse over images must be the same size as the normal image
Variable Description
INVERT Causes the text of a dynamic object to be displayed in the transparency/text flash
colour.
IP Returns the IP address of the 963.
IQVALUE Returns the specified value from the IQ system.
IQ.V2LOG.TLR Returns the time of the last record for a specified plot module.
IQ.V2LOG.TRC Returns the total record count for a specified plot module.
ISDIARYIDNOCC Prevents the action running when the specified diary group is unoccupied. Diary
identified by ID number.
ISDIARYIDOCC Prevents the action running when the specified diary group is occupied. Diary
identified by ID number.
ISDIARYNOCC Prevents the action running when the specified diary group is unoccupied. Diary
identified by name.
ISDIARYOCC Prevents the action running when the specified diary group is occupied. Diary
identified by name.
LABEL Returns the label of the item in the alarm.
LAN Returns the Lan number to which 963 is connected.
LANLABEL Returns the Lan label of the controller sending the alarm.
LFNAME Returns the filename of the file currently being viewed.
LIVE Returns the live value of the specified value from the IQ system from the web servers
cache.
MEMREPORT Returns a general memory report, including a virtual memory report in hexadecimal.
ML Returns the memory load.
MODBY Returns the name of the user who last modified the page.
MODTIME Returns when the page was last modified.
MODULE Returns the module code of the item in alarm
NEWLINE Inserts a new line in the message e.g. to force a new line on a printer.
NEWMSG Forces a new IQ system message when used with the RETRANSMIT command.
OPTION Returns the status of a specific licence option.
OS Returns the address of the controller/device that sent the alarm.
OSLABEL Returns the label of the controller/device that sent the alarm.
OSVERSION Returns the operating system name and version that 963 is running on.
PAGEDIR Returns the path of the current page.
PCDATE Returns the current date.
PCDAY Returns the day of the month.
PCHOUR Returns the hour.
PCMIN Returns minutes.
PCMONTH Returns the month.
PCSEC Returns the current seconds value.
PCTIME Returns the time.
PCWKDAY Returns the current day of the week.
PCYEAR Returns the current year.
PNAME Returns the page name.
PRINTAREA Only used when the page is a print template, it determines the area on the template
that is to include the data.
RESOLUTION Returns the resolution of the screen.
SERIALNO Returns the serial number of the controller that generated the alarm.
SERVERSTATUS Returns the server status.
SHORTADJUDESC Converts the adjust message to a machine readable format required for IQ EYE.
SHORTTIME Returns the date and time of the alarm in short format.
SITE Returns the name of the site containing the alarm.
SQLVALUE Returns the result of the specified SQL query.
SYSTEM Returns the path of the operating systems system directory.
Variable Description
TAB Inserts a tab character in the message for formatting prints outs.
TELE Returns either the IP address or telephone number of the site from which the alarm
originated.
TESTVALUE Enables a test to be included in an action code.
TIME Returns date and time.
TIMEON Returns the length of time since 963 was started.
TIMEONFULL Returns the length of time since 963 was started in an extended format.
TIMESPECx Returns an individual time and date field from an alarm in a number of different
formats.
USER Returns the name of the user currently logged on.
VALUE Returns a specified value from an INI file.
VER Returns the version of 963.
The ? variable makes it possible include a user response in an action code. This means that the 963 can prompt the
user for information and then include it in the code for a specified action.
Do not specify an action that requires a user response if it is likely to occur when the user is not available to
provide the required response e.g. actions carried out when an alarm occurs, or scheduled actions.
To use the ? variable:
1. Specify the action in the normal way.
2. Edit the code for the action to replace the information that the user is to supply with the code for the question.
The code for the question should be in the format:
<?<Question>>
<Question> is the text that is displayed in the dialogue box. When 963 sees the code it will ask the question,
and use the answer in the action code.
E.g.
SEND L<?Enter LAN>O<?Enter OS>S<?Enter Sensor number>(H=<?Enter new high alarm value>)
This would ask the user 4 questions, the Lan number, the outstation number, the sensor number, and the new
high alarm value for that sensor. The replies would then be included in the SEND action to determine which
outstation is to be accessed, and which sensors high alarm value is to be changed and then set it to the
specified value.
The == variable enables the length of the result returned by a variable in an action code to be fixed. This allows text
messages of a fixed length to be created when using the variable in a command feature. If the returned result is greater
than the required value, it will be truncated to the required length, and if it is shorter, it will be padded out with spaces
at the end to make it the required length.
To use the == variable:
1. Add the == variable at the end of the variable before the > as shown below:
<<Variable Code>==<xx>>
<Variable code> is the variable code for which the length is to be fixed. <xx> specifies the number of
characters that are required.
E.g.
<DATA==30>
This would return the first 30 characters of the current 963-directory name.
A10.7 Using the 962CODED Variable
Schematic Display Action Codes (Not Alarm Action) Dynamic Menus Alarm Action Codes
Server
Client
The 962CODED variable returns the alarm in the format shown below which enables it to be retransmitted to 962s or
963s.
||*962*||<Connection>||<Lan Number>||<Controller Address>||<Module Type><Module
Number>||<Alarm Code>||<Alarm Time>||
<Connection> is the telephone number used to access the site containing the alarm if it is autodialled or the IP address
of the site is accessed over TCP/IP. <Lan Number> specifies the Lan containing the device in alarm. <Controller
Address> specifies the address of the controller containing the alarm. <Module Type> specifies the type of module
generating the alarm using its module identifier (e.g., S specifies sensor). <Module Number> specifies the number of
the module generating the alarm in zero based hexadecimal. <Alarm Code> is the 4-character code that specifies the
type of alarms for details of these codes see the Alarm Codes section of this manual. <Alarm Time> specifies the
time of the alarm in the format HH:MM.
To use the 962CODED variable:
1. Click 962CODED.
Or
1. Enter <962CODED>.
For details about the 963 variables used, see the appropriate sections of this manual.
To use the FORPNC variable:
1. Click FORPNC.
Or
1. Enter <FORPNC>.
A10.42 Using the FREE Variable
Schematic Display Action Codes (Not Alarm Action) Dynamic Manus Alarm Action Codes
Server
Client
The FREE variable returns the amount of free disk space (in Mbytes) on the specified drive.
To use the FREE variable:
1. Enter the code to specify the variable in the following format:
<FREE <Drive Letter>:>
<xx> is the number of levels up the tree that is to be returned.
E.g.
<FREE C:>
This makes it possible to create pages that can be reused in other projects or locations by specifying relative paths in
the GOTO statement. Including GOUPTREE will substitute the path a specified number of levels above the current
page into the GOTO action.
To use the GOUPTREE variable:
1. Enter the code to specify the variable in the following format:
<GOUPTREE <xx>>
<xx> is the number of levels up the tree that is to be returned.
E.g.
<GOUPTREE 2>
This would return the path 2 levels above the current page.
A10.44 Using the GRAPHLEGEND Variable
Schematic Display Action Codes (Not Alarm Action) Dynamic Menus Alarm Action Codes
Server
Client
The GRAPHLEGEND variable is only used when the page is a print template for graphs, it displays the legends of
the graph. It can only be used in the To Display attribute of a static object.
To use the GRAPHLEGEND variable:
1. Enter <GRAPHLEGEND> in the What to display box in the Display Object Editor pane.
E.g.
<IQ.V2LOG.TLR L99O35P9>
This would display the time of the last record for plot module 9 from controller 35 on Lan 99 on the local
site.
E.g.
<IQ.V2LOG.TRC IP"Albery House"L99O35P9>
This would display the time of the last record for plot module 9 from controller 35 on Lan 99 on a site
accessed via a device with a host name of 'Albery House'.
A10.48 Using the IQ.V2LOG.TRC Variable
Schematic Display Action Codes (Not Alarm Action) Dynamic Menus Alarm Action Codes
Server
Client
The IQ.V2LOG.TRC variable returns the total record count for a specified plot module.
To use the IQ.V2LOG.TRC variable:
1. Type the code to specify the variable in the following format:
<IQ.V2LOG.TRC <Connection> L<Lan Number>O<Controller Address>P<Plot Module Number>>
<Connection> is an optional parameter that specifies the IP address or host name if the site is accessed over
TCP/IP or the telephone number required to access the site if it is autodialled. When entering an IP address
it must be prefixed by 'IP' e.g. IP192.186.23.87. If specifying a hostname it must be prefixed by 'IP' and
enclosed in double quotes e.g. IP"Albery House". When entering a telephone number it can contain the
following characters.
Characters Description
0 to 9 Dialling characters.
ABCD#* Considered as dialling characters on some systems.
J or : Wait for secondary dial tone.
K or ; or , 2 second pause (Note on some autodiallers this may be a 1 second pause).
< Pulse dialling.
M or = Tone dialling.
<Lan Number> specifies the Lan of the controller containing the plot module. <Controller Address> specifies
the address of the controller. <Plot Module Number> specifies the module number of the plot module for
which the total record count is required.
E.g.
<IQ.V2LOG.TRC L99O35P9>
This would display the total record count for plot module 9 from controller 35 on Lan 99 on the local site.
E.g.
<IQ.V2LOG.TRC IP"Albery House"L99O35P9>
This would display the total record count for plot module 9 from controller 35 on Lan 99 on a site accessed
via a device with a host name of 'Albery House'.
4. Open the required INI file (S2.INI or TCOMMSRV.INI) normally in the c:\program files\trend control
systems\963 folder.
5. Edit the INI file to edit a key`s value, edit a key`s name, add a new key, delete a key, edit a section`s name,
add a new section, or delete a section.
To delete a section:
In the section pane click the section that is to be deleted.
Click Delete. 963 prompts for confirmation of the deletion.
Click Yes.
To add a new section:
Click New Section. The INI file settings dialogue box is displayed.
Click the Key tab. The INI file settings dialogue box changes.
Click the Key tab. The INI file settings dialogue box changes.
Click the Value tab. The INI file settings dialogue box changes.
INDEX