WEB-911 XTools
WEB-911 XTools
Table of Contents
Introduction.................................................................................................................................................... 1
WEB-911 XTools ....................................................................................................................................... 1
XTools Demo ............................................................................................................................................. 2
Setup ......................................................................................................................................................... 4
The ActiveX Controls .................................................................................................................................... 5
XContacts .................................................................................................................................................. 5
XContacts .............................................................................................................................................. 5
Name Definition ..................................................................................................................................... 6
Connection Definition ............................................................................................................................. 8
XGroup .................................................................................................................................................... 10
XGroup ................................................................................................................................................. 10
Group Edit ............................................................................................................................................ 12
XSchedule ............................................................................................................................................... 14
XActivate.................................................................................................................................................. 16
XStandby ................................................................................................................................................. 17
XApply ..................................................................................................................................................... 18
XTools Options ............................................................................................................................................ 19
iii
Introduction
WEB-911 XTools
The WEB-911 XTools allow users to modify and apply configuration changes to WIN-911 across the
network environment. As they are a set of ActiveX controls, they can be easily placed inside HMI
screens.
These tools can be used to:
•
•
•
•
•
•
•
Modify contacts
Modify connections
Display alarm group settings
Modify alarm group contact lists
Modify duty schedules
Apply configuration changes to Scan & Alarm
Switch Scan & Alarm to Active or Standby mode
1
WEB-911 XTools
XTools Demo
The WEB-911 XTools demonstrations provide a basic understanding and working example of the
WIN-911 system and its suite of ActiveX controls. These examples are self-contained and do not
require additional software not included in the WIN-911 install or on the install CD (Top Server for
OPC). If voice telephony is desired for the demo, then you will need a TAPI modem or Dialogic card
and a phone line. If you wish to demonstrate paging you will need a standard Hayes® compatible
modem and phone line with a pager service provider and if you wish to demonstrate email you will
need a LAN connection and email servers. If SMS is desired you will need a GSM modem with an
activated cellular account. This demo will run with WIN-911 in DEMO mode (for 30 days).
Creating a WEB-911 XTools Demo
The WEB-911 XTools will run in demo mode for 30 days from the time of installation. The WEB-911
XTools demo period will work with both a licensed or nonlicensed copy of WIN-911. After the XTools
30-day trial period expires the WIN-911 software must be licensed.
The WEB-911 XTools demo uses the OPC Demo configuration and assumes the user has followed
the OPC Demo setup explained in Chapter 3 of the WIN-911 Quick Start manual or in the OPC Data
Server.CHM under "Creating a Demo OPC Server". This demo also assumes the user has already
installed the WEB-911 Service and XTools Client as outlined in the previous section, "Setup".
Setting up WEB-911 XTools
Install the WEB-911 service with IIS on your host computer then install the XTools client on your
client machine. These can be the same machine. Start the WIN-911 Configurator from the "Start
Program" button. If you have not already done so, from the File menu select Open. Select "OPC
DEMO.MDB". Next find the WEB-911 XTools Client located at C:\Program Files\Specter
Instruments\XTools\IE Client\WEB-911 XTools.html.
Note: Internet Explorer version 5 or later must be used to view the webpage. ActiveX controls are not
supported in the Mozilla Firefox browser.
When the IE browser appears you will probably see an information bar popup at the top of the
window.
This bar is warning you that IE has restricted this webpage from running ActiveX controls.
Right-click the information bar and select 'Allow Blocked Content…'. Then click 'Yes'. The six ActiveX
controls should appear. You will also see a brief description of each control in the center of the
webpage.
2
Introduction
Each control needs to be activated by clicking it once. After each control is activated you should be
able to access all six controls with a single click.
Exploring WEB-911 XTools
You can now explore the XContacts, XGroup, XSchedule, XApply, XStandby and XActivate controls.
Note: There will be a few seconds delay when an XTool is accessed for the first time. If at anytime you
need help, you can access the WEB-911 XTools help file through the Help buttons on each control.
The WEB-911 XTools Options window can be accessed by right-clicking on any of the three Active X
control's (XContacts, XSchedule, and XGroup) Help button. For a more in-depth discussion on the
WEB-911 XTools Option window see the "XTools Options" section.
3
WEB-911 XTools
Setup
Refer to the WIN-911 Configurator Manual for instructions on installing the WEB-911 XTools and
Web Service.
4
The ActiveX Controls
XContacts
XContacts
This dialog displays a global view of the phone book entries. From this page you can create new
entries, as well as copy, delete, and edit existing entries.
In this dialog box, you can quickly review the following:
•
•
•
•
Contact name
Name sound
Access code
Acknowledge code
5
WEB-911 XTools
Name Definition
This dialog allows the user to define a contact in the Phone Book, assign Access and
Acknowledgement Codes, develop a Name Sound file, review and/or assign connections, and select
the sequence of each connection.
In this dialog box, you can quickly review the following:
•
•
•
•
•
•
•
Connections defined for the contact
Telephone or Pager number
Pager PIN/E-Mail Address/Country Code
The assigned Duty Schedule
Number of retries
Delay between retries
Delay before calling the next number or sending the next email
Name
The "Name" is a unique identifier for the person that will have "Group" access. This name is later
found in a menu within the XGroup for selection purposes.
6
The ActiveX Controls
Name Sound
The user "Name Sound" is essentially a verbalization of the user name to be used in the "Voice"
dial-out operation. Here the text to be converted must be typed in. The sound file is then created by
the main configurator, using Text-to-Speech or Runtime Voice Synthesis. The user name sound is not
required.
Access Code
The "Access Code" is a required numeric code (maximum of 15 digits) used to control and
document access to alarm events. This number should be unique unless otherwise specified. See
WIN-911 Configurator documentation for details concerning exceptions.
Acknowledge Code
The "Acknowledge Code" is a required numeric code (maximum of 15 digits) used to acknowledge
an alarm condition, and can be used for local password entry. The combination of the user name and
Ack code can be used to ensure that alarms are recognized by the appropriate persons if configured
to be unique.
Move Up
The "Move Up" button moves the selected connection up in the contact's connection list. The order
of the contact's connection list determines the order of the call outs for each user.
Move Down
The "Move Down" button moves the selected connection down in the contact's connection list. The
order of the contact's connection list determines the order of the call outs for each user.
Help
The "Help" button displays the Name Definition help.
7
WEB-911 XTools
Connection Definition
Connection
The Connection drop-down box allows you to select a notification method.
Phone Number
If a Voice, Voice Pager, Numeric Pager, SMS, or Dial-out Announcer connection is defined, this field
contains the contact's telephone number. If an Alphanumeric connection is defined, this field contains
the pager service number designed to accept incoming calls from modems. This is the dispatch
number that the Pager Service will assign for automatic computer message dial-outs.
Pager PIN
If an Alphanumeric or a Local Alpha Pager connection is defined, this field contains the contacts
pager PIN number. The maximum size of this number is 255 digits. This field will be inactive for all
other connections.
E-Mail Address
If an E-Mail connection is defined, this field contains the contact's e-mail address. The maximum size
of any e-mail address is 255 characters.
Country Code
If an SMS Message connection is defined, this field contains the contact's country code prefix. The
country code for the US and Canada is 1.
Duty Schedule
Each connection requires a Duty Schedule be assigned to it. This schedule determines the
connections availability for contact when an alarm occurs. Only connections which are currently
scheduled will be contacted.
Number of Retries
The Number of Retries is honored by all connection types except, Numeric Pager, Local Numeric
Pager and Dial-out Announcer. Below describes what will cause a retry for each connection type:
1.
2.
3.
4.
Voice: busy signal, no dial-tone, invalid access code, no answer.
Voice Pager: busy, no dial-tone, no answer
E-Mail: no connection, time-out, invalid information, unsuccessful transmission of message
Alphanumeric: busy signal, no dial-tone, no connection, invalid information, unsuccessful
transmission of message
5. Local Alpha Pager: busy signal, no dial-tone, no connection, invalid information, unsuccessful
transmission of message
6. SMS Message: unsuccessful transmission of message, interference in the cellular signal
8
The ActiveX Controls
A value of "0" in this box will not retry the connection in any of the scenarios above. Instead the
notification will escalate to the next connection. A value greater than "0" will retry the connection that
number of times after the initial call. For example, if Number of Retries = "2" WIN-911 will call the
connection a total of 3 times; once initially, then retry it twice.
Delay Between Retries
Delay Between Retries is the number of minutes or seconds to wait between retrying the connection.
Toggling between minutes and seconds is accomplished using the pull-down menu to the right of the
value. This is only enabled if a retry is configured.
Delay Between Same Connection Type
This is the amount of time WIN-911 will wait before it attempts to contact the next connection of the
same type.
9
WEB-911 XTools
XGroup
XGroup
This dialog displays all groups defined in WIN-911. Within these groups the user can create specific
contact lists, set delays, enable/disable logging, and enable/disable audio. Here, the "Group
Definition" displays a list of groups and displays their settings. The "Edit" button allows the user to edit
the Contact List for the selected group.
Group Name
The "Group Name" is a unique name used to identify the group. This name may be used in alarm
messages if desired. The "Group Name" can only be edited in the main WIN-911 Configurator.
Display
The "Display" check box tells the user whether alarms for this group will be seen in the alarm monitor.
If the box is checked, all alarms associated with this group will be passed to and seen in the WIN-911
Alarm Monitor window. If the box is not checked, all alarms associated with this group will NOT be
seen in the WIN-911 Alarm Monitor window. This setting can only be toggled in the main WIN-911
Configurator.
Disk
10
The ActiveX Controls
The "Disk" check box tells the user whether alarms for this group will be sent to the alarm loggers
(Daily .TXT & Monthly .MDB). All activity which would normally show up in the "History Display" will
also be recorded to a log file. By default, all log files are stored in the "\Log Files" directory. Error
messages, event logging, call progression, and acknowledgment information are also logged. A new
file is created daily or monthly, depending on user preference. If the box is checked, all alarms
associated with this group will be passed to the appropriate log file. This setting can only be toggled
in the main WIN-911 Configurator.
Printer
The "Printer" check box tells the user whether alarms for this group will be sent to a printer. The
printer option must be configured in WIN-911 for the print module to work. See, WIN911
Configurator.CHM -> Global Options -> Printer Definitions for instructions on how to configure the
printer. This setting can only be toggled in the main WIN-911 Configurator.
Pop Up
The "Pop Up" column describes whether a pop-up is configured for this group. Four options can be
configured: None, Summary List on New Unacked, Summary List on Any Change, and Box. This
setting can only be selected in the main WIN-911 Configurator.
None
If "None" is selected, the pop up feature will be disabled for this group of alarms. This setting can only
be selected in the main WIN-911 Configurator.
Summary List on New Unacked
If "Summary List on New Unacked" is selected, any new unacknowledged alarms will cause the
Monitor (Summary) view to appear over any other window. If the Monitor program is minimized, the
view will be restored to the last location and size. The display option must also be selected. This
setting can only be selected in the main WIN-911 Configurator.
Summary List on Any Change
If "Summary List on Any Change" is selected, any alarm (including a return to normal) will cause the
Monitor (Summary) view to appear over any other window. If the Monitor program is minimized, the
program will be restored to the last size. The display option must also be selected. This setting can
only be selected in the main WIN-911 Configurator.
Box
If "Box" is selected, any new unacknowledged alarms will appear in a pop-up dialog box. The dialog
box will appear over any other window and will disappear when the alarm is acknowledged. If this
option is used, it is recommended that the WIN-911 Monitor run as a minimized program. The display
option must also be selected. This setting can only be selected in the main WIN-911 Configurator.
Sound
The "Sound" check box tells the user whether alarms for this group have the local audio announcer
enabled. If the box is checked, all alarms associated with this group will be announced locally over
the speakers (via soundcard.) If the box is not checked, all alarms associated with this group will NOT
be announced locally over the speakers (via soundcard). This setting can only be toggled in the main
WIN-911 Configurator.
Help
The "Help" button displays the XGroup help. If you right-click the "Help" button you can access the
WEB-911 XTools Options display.
11
WEB-911 XTools
Group Edit
The Group Edit window allows the user to manipulate the contact list. The user is able to Add and
Remove users from the contact list. The user also has the ability to change the order in which the call
outs will be made by using the Move Up and Move Down buttons.
Available Name List
The Available Name List shows all contacts previously defined in either the WIN-911 Configurator or
with XContacts .
Selected Name List
The Select Name List lists contacts, in order, which will be notified when an alarm occurs within this
group.
Add
To "Add" a contact to the Selected Name List, highlight the desired name and click on the "Add"
button. You may add the same contact in the Selected Name List more than once.
Remove
12
The ActiveX Controls
To "Remove" a contact from the Selected Name List, highlight the desired name and click on the
"Remove" button.
Move Up
The location of the name in the list determines how the alarm notifications will escalate. Use the
"Move Up" button to move a contact up in the Selected Name List.
Move Down
The location of the name in the list determines how the alarm notifications will escalate. Use the
"Move Down" button to move a contact down in the Selected Name List.
Exit
The "Exit" button saves your changes and brings you back to the XGroup display.
Cancel
The "Cancel" button discards your changes and brings you back to the XGroup display.
Help
The "Help" button displays the Group Edit help.
13
WEB-911 XTools
XSchedule
The XSchedule window allows the user to view and modify schedules for all existing connections.
Connections must be created through the WIN-911 Configurator or XContacts before you can modify
a schedule.
In this dialog box, you can quickly review the following:
•
•
•
•
Contact name
Connection type
Phone number/Pager PIN/E-mail address/SMS
Duty Schedule
Assign Selected User(s) Schedule
The "Assign Selected User(s) Schedule" list box allows the user to assign pre-configured duty
schedules. If you do not find a schedule which fits your needs for a particular connection, you may
edit or add additional duty schedules using the WIN-911 Configurator. The selected duty schedule will
14
The ActiveX Controls
be applied to all selected users upon clicking the "Assign" button. Multiple users may be selected by
holding the control key (CTRL) or holding the (SHIFT) key while clicking the mouse.
Note: In the E-Mail, Pager, SMS and Voice applications, a pre-existing, unacknowledged alarm will not be
dialed out to a single user if he/she comes on-duty after that Item has gone into an alarm condition.
Exit
The "Exit" button saves your changes and closes the XGroup display. The changes will also be
applied if "Apply Changes" is enabled in the WEB-911 XTools Options
Assign
The "Assign" button assigns the selected schedule to the selected connection(s).
Help
The "Help" button displays the XSchedule help. If you right-click the "Help" button you can access the
WEB-911 XTools Options display.
15
WEB-911 XTools
XActivate
The XActivate button changes Scan & Alarm from Standby to Active mode. While Active, WIN-911
will perform normal functionality. This XTool could accommodate someone who is running with a
redundant pair of WIN-911 systems. The XStandby or the Standby.exe applet will would also need to
be used to place WIN-911 in Standby mode when that particular WIN-911 system is not the primary.
16
The ActiveX Controls
XStandby
The XStandby button changes Scan & Alarm from Active to Standby mode. While in Standby, WIN911 will function normally but all remote notifications will be disabled. This XTool could accommodate
someone who is running with a redundant pair of WIN-911 systems. The XActivate or the
Activate.exe applet will put Scan & Alarm back in Active mode.
17
WEB-911 XTools
XApply
The XApply button applies all modifications made with the XContacts, XSchedule, and XGroup. If
"Apply Changes" is disabled in the WEB-911 XTools Options the XApply button must be hit to apply
the changes. This option could accommodate someone who is interested in applying all their changes
at once, instead of every time the user exits one of the XTools windows.
18
XTools Options
This dialog can be accessed by right-clicking the "Help" button on any of the main XTools' dialogs.
This window will also appear in the event of a connection problem. The "WEB-911 XTools Options"
dialog is used to configure the server machine and IP port, as well as configure how the controls will
apply changes.
Note: The "WEB-911 XTools Options" controls can be disabled by setting the "WEB-911.config" file as
Read-Only for the current windows user. The WEB-911.config will be located on the client machine in the
XTools folder.
IP Address / URL / Computer Name
The location of the WEB-911 Service is designated in the "IP Address / URL / Computer Name" text
box. This text box will accept the IP address, URL, or computer name. The default computer name is
'localhost'. Note: that only alphanumerics, dashes, and dots are allowed.
IP Port
The server port is designated here through the spinner input. The default port is 80 and the supported
range is 1 to 65535.
Enable Apply
The "Enable Apply" check box enables/disables applying changes upon exiting each XTool control. If
this check box is selected, the user will be prompted if they would like to Apply their changes. If this
checkbox is not selected, then changes may only be applied to Scan & Alarm by using XApply or
restarting WIN-911.
19
WEB-911 XTools
Save Changes
The "Save Changes" button saves the changes made to the WEB-911 XTools Options. If "Save
Changes" is not selected the user will lose all changes made upon exiting. Also, the "Save Changes"
button is disabled if no changes have been made.
Exit
The "Exit" button exits the WEB-911 XTools Option and brings you back to the same XTools window
you access the options from. If the WEB-911 XTools Option dialog was displayed as a result of a
connection problem, XTools will attempt a reconnect to whichever XTools applet encountered the
problem.
Help
The "Help" button displays the WEB-911 XTools Options help.
20
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertisement