Truesite Workstation: Fire Fire
Truesite Workstation: Fire Fire
FIRE
FIRE
TrueSite Workstation
TSW Configurator
574-xxx
Rev. 4User Guide
579-844
Rev. U
*0579844U*
Copyrights, Trademarks and Cautions
© 2018 Johnson Controls. All rights reserved. All specifications and other information shown were current as of docu-
ment revision and are subject to change without notice. Additional listings may be applicable, contact your local
Simplex® product supplier for the latest status. Listings and approvals under Simplex Time Recorder Co.
Simplex, and the product names listed in this material are marks and/or registered marks. Unauthorized use is strictly
prohibited. NFPA 72 and National Fire Alarm Code are registered trademarks of the National Fire Protection Associa-
tion (NFPA).
SYSTEM REACCEPTANCE TEST AFTER SOFTWARE CHANGES - To ensure proper system operation, this
product must be tested in accordance with NFPA-72, after any programming operation or change in site-specific soft-
ware. Reacceptance testing is required after any change, addition or deletion of system components, or after any modi-
fication, repair or adjustment to system hardware or wiring.
All components, circuits, system operations, or software functions known to be affected by a change must be 100%
tested. In addition, to ensure that other operations are not inadvertently affected, at least 10% of initiating devices that
are not directly affected by the change, up to a maximum of 50 devices, must also be tested and proper system operation
verified.
Follow the instructions in the installation, operating and programming manuals. These instructions must be followed to
avoid damage to the control panel and associated equipment. The Fire Alarm Control Panel (FACP) operation and reli-
ability depend upon proper installation.
ii
Table of Contents
Help menu..........................................................................................................................................1-7
Overview.......................................................................................................................................1-7
Help topics ....................................................................................................................................1-7
About TSW Confgurator ...............................................................................................................1-7
Hardware............................................................................................................................................2-3
Workspace details ........................................................................................................................2-3
Adding hardware ..........................................................................................................................2-4
Editing hardware...........................................................................................................................2-9
Removing Hardware ...................................................................................................................2-10
Configuring the 4120 NIC ...........................................................................................................2-10
....................................................................................................................................................2-10
....................................................................................................................................................2-11
Configuring the ES Net Card ......................................................................................................2-11
Configuring the 4120 or ES Net NIC ..........................................................................................2-17
iii
Table of Contents
Points ...............................................................................................................................................2-22
Workspace details ......................................................................................................................2-22
Adding points..............................................................................................................................2-23
Editing DACR accounts ..............................................................................................................2-25
Setting view ................................................................................................................................2-25
Removing points.........................................................................................................................2-25
Making public / Making local.......................................................................................................2-25
Editing lists .................................................................................................................................2-26
Assigning action messages ........................................................................................................2-26
More Info ....................................................................................................................................2-26
Apply/Revert ...............................................................................................................................2-26
Action Messages.............................................................................................................................2-27
Workspace details ......................................................................................................................2-27
Adding action messages ............................................................................................................2-28
Exporting the messages .............................................................................................................2-28
Importing the messages .............................................................................................................2-28
Removing action messages .......................................................................................................2-28
Copy ...........................................................................................................................................2-28
Assigning points to a selected message ....................................................................................2-28
System Options...............................................................................................................................2-29
Workspace details ......................................................................................................................2-29
Operators .........................................................................................................................................2-36
Workspace details ......................................................................................................................2-36
Adding operators ........................................................................................................................2-36
Removing operators ...................................................................................................................2-36
Operator options.........................................................................................................................2-37
Sound ...............................................................................................................................................2-41
Workspace details ......................................................................................................................2-41
iv
Table of Contents
Concepts............................................................................................................................................3-2
Overview.......................................................................................................................................3-2
Command editor..............................................................................................................................3-17
Main page...................................................................................................................................3-17
v
Table of Contents
Coverage zones...............................................................................................................................3-21
Defining coverage zones ............................................................................................................3-21
Linking points..............................................................................................................................3-21
Chapter 4. Configuring TSW Remote Client and TSW Workstation for cli-
ent operation ........................................................................................... 4-1
Procedure .....................................................................................................................................4-1
Navigation..........................................................................................................................................5-2
Starting the TFXnet editor ............................................................................................................5-2
Navigating the TFXnet Editor .......................................................................................................5-2
Menus.................................................................................................................................................5-3
Points view ...................................................................................................................................5-3
vi
Table of Contents
vii
Logging in
Overview The TSW Configurator consists of a set of editors and utilities that can be used to create and
modify TSW jobs. It should be used by technicians or other trained personnel. The menus that
appear on the toolbar at the top of the Configurator and on the workspace pane on the left are
used to add and modify features of TSW jobs.
The TSW Configurator requires a security dongle key (USB device) to be plugged in to the
computer in order to run. Contact your sales representative to obtain the dongle.
Refer to document 579-825: Installing the Software Security System (shipped with TSW) for
instructions on installing the Key Security Service. This service is necessary to access the TSW
Configurator.
The table below lists the minimum requirements for the TSW Configurator to run.
2 USB Ports
i5 Processor
4 GB RAM
ix
Logging in
Logging in to the Follow the steps below to launch and login to the TSW Configurator:
TSW Configurator
1. Attach the dongle key and double click on the TSW Configurator desktop icon to launch it.
.
2. A TrueSite Workstation Configurator screen appears,
3. Create a new job to log in to the TSW Configurator or log in to the TSW Configurator using
an existing job.
4. Follow the steps shown in Table 1-1 to complete the login:
1. Click File and then click New. 1. Click File and then click Open.
Note: You can also use the Ctrl + N keyboard key Note: The Ctrl + O keyboard key combination
combination. can also be used.
2. In the New Job dialog box, enter the job Name. A 2. In the Open Job File dialog box, browse to
valid job name must start with a number and and select the appropriate TSW job. Click
contain between 1 and 8 characters. It cannot Open to load it.
contain a space or the any of the following
characters: \ / : * ? “ < > |. Note: TSW jobs are files with either .dbf or
.sdf file extensions.
Note: If the job name is too short, the Name field is
bounded by a red rectangle. 3. In the Log In dialog box that appears, log in
to the Configurator using an appropriate
3. If the required site is not in the dropdown list, click user name and passcode.
Create Site. The Create Site dialog box appears.
Once the login is complete, all functions of the TSW Configurator are available.
x
User interface
User interface
Overview The TSW Configurator user interface provides access to the various options available to
configure a TSW job. At start-up, the Configurator appears as a blank window with a menu at
the top and a status bar at the bottom. The menu provides access to the various functions and
utilities, and the status bar displays information about the current network, job, and edit status.
See Figure 1-1 to see the user interface after login, and refer to Table 1-1 and Table 1-2 for a
brief description of each option in Figure 1-1.
xi
User interface
Overview
Save Use Save to save the job that is currently being edited.
Log In Use Log In to log in to the chosen job. See “File menu” in
File
Chapter 1 for more details
Log Off Use Log Off to log out of the current job.
Error Check Use Error Check to test the TSW job for mistakes.
Use the Hardware workspace to add, modify and remove hardware from the See “Hardware” in
Hardware
system. Chapter 2 for more details
The Action Messages workspace is used to create, modify, and delete system See “Action Messages” in
Action Messages
and user action messages. Chapter 2 for more details
The System Options workspace is used to customize system operations and See “System Options” in
System Options
preferences. Chapter 2 for more details
xii
User interface
Overview
Use the Control Windows workspace to define the audio control screens that
See “Control windows” in
Control Windows appear during runtime using the Utility, Speaker Audio and Auxiliary Audio
Chapter 2 for more details
tabs.
Use the Operators workspace to add or remove an operator, as well as change See “Operators” in
Operators
the operator name and access level. Chapter 2 for more details
Use the Runtime Access workspace to edit the access levels within TSW
Runtime for the displayed categories.
Use the Configurator Access workspace to edit the access levels within the
See “Access controls” in
Access Control TSW Configurator for the displayed categories.
Chapter 2 for more details
Use the System Access workspace to select which system features are
accessible through the TSW application on a TSW PC or a Remote Client
application on a Remote Client PC, or both.
Use the Color Definition workspace to edit the color associated with each type
Color Definition Use
of event (Fire, Priority 2, Trouble, Supervisory, General Information).
Use the Sound workspace to select the sounds for the Fire, Priority 2, See “Sound” in Chapter 2
Sound
Supervisory and Trouble events. for more details
Use the Port Vectoring workspace to enable the logging of various events to See “Port Vectoring” in
Port Vectoring
selected ports. Chapter 2 for more details
xiii
Chapter 1. TSW Configurator menus
Introduction The TSW Configurator allows you to configure the TSW. The main menu contains these
items:
• File
• Tools
• Help
1-1
Chapter 1 . TSW Configurator menus
File menu
Overview Use the File menu functions to generate new TSW jobs, open existing TSW jobs, save jobs that
are being edited, and log in and out of TSW.
Creating a new If a job is already open in the TSW Configurator when a new one is created, the Configurator
job provides two different options when you click New:
The New Job dialog box opens, where the job name, node
number and job site are entered.
1. TSW Configurator does not
have a Job Open
Note: See section “Launching the TSW Configurator “ for more details
on the New Job dialog box.
1. The dialog box prompts you to save changes to the existing job.
Click either Save or Don’t Save to proceed.
2. In the New Job dialog box that appears, enter the job name,
node number and job site.
Note: See section “Launching the TSW Configurator ” for more details
on the New Job dialog box.
2. Browse to and select the appropriate TSW job. Click Open to load it.
When the job is loaded, the Log In dialog box appears. A user name and passcode are required
to login to the TSW Configurator. See secton “Launching the TSW Configurator” for more
login details.
Notes: 1. IMS or GCC jobs must be at Revision 3.01 (or higher) in order to perform an upgrade into TSW.
GCC jobs containing graphics must be upgraded/built in the IMS Programmer software before
upgrading to TSW.
2. A TSW-type dongle is required to run the TSW 2.01 runtime application. (Older versions of the
TSW runtime application allow operation with IMS-type dongles.) Select Help from the TSW run-
time application to view the current dongle type and contact your sales representative to obtain a
TSW-type dongle, if required.
Saving a job Click Save to save the job that is currently being edited.
2. When you save a job in TSW Configurator, the job does not change in TSW Runtime. To make a
job the new runtime job, build it using the Build option in the Tools menu.
1-2
Chapter 1 . TSW Configurator menus
Click Save As to open the Save As dialog box. Save the current job under a new name
(Rename option) or create a copy of the job under a new name and node number (Copy
option). The following options are available in the dialog box:
• Name: Enter the job name
• Node Number: Enter the node number for the job
Logging in Click Log In to login to the TSW Configurator using a access-level-specific username and
passcode.
Logging off Click Log Off to log out of the TSW Configurator.
Account settings Use the Account Settings option to view information on the current user of the TSW
Configurator user. Click Account Settings to open the Account Settings dialog box, where the
following settings are available:
• Operator Number: Shows the ID number of the user currently logged in to TSW
Configurator.
• Operator Name: Shows the username of the user currently logged in to TSW
Configurator.
• Access Level: Shows the access level of the user currently logged in to TSW Configurator.
Change Passcode: Click the Change Passcode dropdown arrow to change the passcode the
current user uses to login to TSW Configurator.
1-3
Chapter 1 . TSW Configurator menus
Tools menu
Overview The Tools menu allows you to build a job, run error checks on a job, open the Graphics Editor
and the Registry Configuration tools, and generate reports for various TSW Configurator
functions.
Building a job Click Tools, then click Build to build a TSW Runtime job. If you use revision 2.01 of the TSW,
the Configurator creates User Interface (UI) support files while the job is building. When a
TSW Remote Client connects to the TSW PC, those files are transferred to and loaded by the
Remote Client.
Note: The Ctrl + B keyboard key combination can be used instead of clicking Build.
If errors or warning conditions exist after the build, a message is displayed that informs you
that errors or warnings were detected.
Note: In the case of TSW Firegraph nodes, if the TSW’s shadow node is missing, the TSW Configurator’s
job builder prevents build completion and displays the error message.
Error checking Click Error Check to test the job for any errors or warning conditions. You may be able to
work with a job if warnings exist, however the job will not build if errors remain.
Revision history Click Revision History to open the editor which can be used to view and log changes from one
job revision to the next.
Graphics Editor Use the Graphics Editor to create runtime screens for use with the TSW. These screens can be
tied to real time events. The screens can be used to provide a graphical representation of the
points contained within the current job. See for details on using the Graphics Editor.
Registry Use the Registry Configuration utility to apply registry settings which are necessary for correct
Configuration operation of specific hardware components defined in the Hardware Configuration screen.
This applies to the 4120 network card and the ISA UL card. You must use the Registry
Configuration utility when major changes to the defined hardware are made, such as:
• Adding a network interface card
• Deleting a network interface card
• Modifying the settings for the network interface card
• Adding or deleting a ISA UL card
Click Registry Configuration from the Configure menu. A registry configuration dialog box
appears. Click Apply to configure the hardware drivers. A PC reboot prior to operating the
hardware in the TSW runtime is required. Click Cancel to discard the new driver settings.
If this is the first time a registry configuration is done on the system, and a ISA ULCard is
present in the job, the UL card driver will be installed. When the installation is complete, exit
the Configurator, and reboot the computer. After the computer restart, re-open the TSW
Configurator and re-open the registry configuration dialog box. Click Apply to accept the
changes and reboot the computer again.
1-4
Chapter 1 . TSW Configurator menus
Creating reports Hover over Reports to show the list of reports that can be generated for various TSW
Configurator functions. Click any item from the list to open the Report dialog box which
contains the report details. See Table 1-1 for a description of each report in the list.
2. The Reports menu in the Report dialog box contains the full list of reports. Click a different
report name to open a different report.
3. Use the filter located in each report dialog box to filter the contents of each report.
The Point List report contains all system lists (from L0 to L511)
Point List and user lists (L512 and up), both local and external, along with
their contents.
1-5
Chapter 1 . TSW Configurator menus
Reports option
The Utility and Audio Control report contains the utility switch and
Utility and Audio Control the audio control switch programming from the Control Windows
workspace pane.
The 2120 Port Usage report contains the 2120 file number and the
2120 Port Usage
timestamp for each 2120 SLI port configured on the job.
The DACR Point Mapping report contains a list of all Digital Alarm
DACR Point Mapping
Communication Receiver (DACR) points programmed into the job.
1-6
Chapter 1 . TSW Configurator menus
Help menu
Overview Use the Help menu to open the TSW Configurator Online Help, which is a web-based version
of this manual.
Help topics Click Help Topics to launch the TSW Configurator Online Help.
About TSW Click About TSW Configurator to open a standard Windows About dialog box, which
Confgurator displays the Configurator revision, database revision, job name, node number, node description
and license information.
1-7
Chapter 2. Workspace pane
Introduction Use the TSW Configurator workspace pane to configure both the system hardware and the
system operations. The workspace pane contains the following items:
Hardware ..................................................................................................................................2-3
Points ......................................................................................................................................2-22
Operators ...............................................................................................................................2-36
Sound .....................................................................................................................................2-41
2-1
Chapter 2 . Workspace pane
General information
Workspace Click the General Information workspace to open the editor and enter job details. The
details information entered is used mainly for documentation purposes. Table 2-1 lists the various
fields and where they are used. Any field that is not in the table appears only in the General
Information report.
The number written in the Logical Node # box will be displayed in:
• Configurator: status bar
• Configurator: job directory
Logical Node # • Configurator: report header
• Network Programmer: jobs directory
• TSW: About box
• TSW: report header
The node name appears in the General Information screen, and appears in
Node Name
the TSW About box.
Comments The comments in the Comments box are displayed in the TSW About box.
Background images for the TSW main window and banner are provided by
default. These are.BMP format files that are displayed at runtime. Use the
Browse buttons to select specific images to customize the main window
background and banner.
Notes: 1. Do not use Microsoft Office Picture Manager to edit size. Use Paint
3. When the Bitmap file is imported into the Editor, it is renamed to Back-
ground.bmp or Banner.bmp and is placed into the Images folder.
Repeated across
Less Wide Bitmap Centered in width
the banner area
2-2
Chapter 2 . Workspace pane
Hardware
Workspace Click the Hardware workspace to open the hardware editor which is used to add, modify and
details delete hardware from the system. Table 2-2 provides an explanation of the fields that appear in
the editor. The description for each button is located after the table.
Configuration Info: This column displays the current hardware configuration settings.
Click filter to open a filtering row below the column headers. Keep the following in mind:
• Wait a few seconds after a filter entry is typed. The points list refreshes automatically.
• Multiple columns can be filtered simultaneously.
• Wildcards as filter entries are allowed.
• Click cancel to cancel the filter results.
2-3
Chapter 2 . Workspace pane
Hardware, continued
Adding hardware Click Add Hardware to open the Hardware Configuration dialog box. Choose the type
of hardware from the Select Hardware dropdown list and configure the hardware settings that
appear. See Table 2-3 for settings associated with each hardware type.
See section “Configuring the 4120 NIC” later in “Hardware Options” for configuration details.
Loop Style: Allows you to pick between a Style 7 or a Style 4 network loop type.
Left Port: The port choice depends on the NIC; choose None, RS-485, or Fiber.
Right Port: Allows you to choose the port type for the right port of the NIC. The appropriate
selection depends on the NIC; choose between None, RS-485 and Fiber.
Physical Node Address: This number represents the order in which the current job node is
Network Interface Card generated on the network loop.
(4120 NIC)
Logical Node Address: This number represents an identification number assigned by the user
for the current job node.
Notes: 1. The Network Interface Card is an optional component and a maximum of seven is allowed
per system.
2. Create the network in the Network Programmer so the network is available in the TSW
Configurator.
3. When you configure the TSW for multi-network annunciation, the network card must be
assigned to a specific network. If there is only one network, this setting is made by default.
4. Select the Loop Style and the Network settings only. It is recommended to keep the other
settings at default. See section “Configuring the Network Interface Card” later in “Hardware
Option”.
See Configuring the ES Net Card in for configuration details. You must manually add the ES Net
Card for any ES Net type job.
Card Address Represents the physical address of the Card, configured via the dip switches.
Should be set to the same value as the loop number.
Network ID Globally Unique Identifier value given by the Network Programmer. Non modifiable.
ES Net Card Network Use this combo box to select the loop to which this card is connected.
Network Port Configuration This section allows configuration of the fire ports. Refer to
Configuring the ES Net Card section
2-4
Chapter 2 . Workspace pane
Left Port: Allows you to choose the port type for the left port of the Network Repeater Card. The
appropriate selection depends on the card; choose between None, RS-485 and Fiber.
Right Port: Allows you to choose the port type for the right port of the Network Repeater Card.
The appropriate selection depends on the card; choose between None, RS-485 and Fiber.
Physical Node Address: This number represents the order in which the current job node has
Network Repeater Card been generated on the network loop.
Logical Node Address: This number represents an identification number assigned by the user
for the current job node.
Notes: 1. Configure at least one Network Interface Card prior to adding a network repeater card.
2. The Network Repeater Card is an optional component and there is a maximum of three for
any given system.
3. Select the Loop Style setting only. It is recommended to keep the other settings at default.
Hardware, continued
Adding hardware
Allow Remote Client Access: This checkbox is checked by default when the
TCP/IP Interface dialog box opens. If unchecked, remote clients will not connect
to TSW.
Note: The options in the Supervised Remote Client(s) tab become available only
after the Supervised Remote Client(s) checkbox is checked.
General Supervised 3rd Party Client(s): When this checkbox is checked, up to five
Supervised 3rd Party Clients can be configured by clicking on the Supervised
3rd Party Client(s) tab and entering the name of each client under the Remote
Client Description column.
3rd party clients are user-designed custom applications that can connect to the
TSW and request data (similar to existing TSW Remote Clients).
Note: The options in the Supervised 3rd Party Client(s) tab become available only
after the Supervised 3rd Party Client(s) checkbox is checked.
Added Time Delay: Enter the time delay before a “Broken TCP/IP Connection”
message is dispatched.
TCP/IP Interface
Note: An exclamation point next to the area where the duration is entered
indicates an invalid value.
Remote Client Description: In this column, enter the name of each Remote or
3rd Party Client under the Remote Client Description column.
Notes: 1. Click or double-click a cell under the Remote Client Description column to
enter the client name.
2. A warning sign appears next to the client entry if the text entered under
the Remote Client Description exceeds 20 characters.
Supervised Remote *Vector by Provider: Check the box to choose the location from where points/
Client(s) alarm categories to be vectored are coming from.
and
*By List: Select this radio button to pick a list containing points/alarm categories
Supervised 3rd
that will be vectored.
Party Client(s)
*By Node/Account (4120 nodes and DACR Accounts): Select this radio
button to pick nodes containing points/alarm categories that will be vectored.
*Vector by Device Class: Put a check mark in this checkbox to filter points
using the device classes located underneath.
*Vector by Alarm Category: Check this box to filter alarm categories using the
categories located underneath.
*Show Selected Only: Check this box to display only the selected nodes.
2-6
Chapter 2 . Workspace pane
Hardware, continued
Adding hardware
* If these options do not appear after clicking on either the Supervised Remote
Client(s) or Supervised 3rd Party Client(s) tab, click . These options are
disabled if the Remote Client Description column is empty.
Supervised Remote
Client(s) Notes: 1. For the TSW server and all Unsupervised Remote Clients, there is no
and vectoring option. All points and alarm categories are always visible.
Supervised 3rd Vectoring only applies to Supervised Remote Clients.
Party Client(s)
2. For a Proprietary Supervising Station, only the 4190-8403 is UL-Listed for
acknowledging points. The TSW Server GUI is still the only point for
TCP/IP Interface acknowledging signals system wide. As a result, Vectored clients can
never be used for 4190-8403 installations.
Notes: 1. The TCP/IP Interface is an optional component. It is required for jobs with remote clients or email.
2. In the case of Supervised, Unsupervised or Third Party Remote Clients, a TSW Feature Code is
required to allow the Remote Client application to connect to the TSW PC. Refer to document
579-835 for more details on the TSW Feature Code.
3. For UL-Listed systems, access to Ack/Silence/Reset or any Control Operations must be disallowed
for 3rd Party Clients. Use the System Access Editor in the TSW Configurator to ensure all control
operations are not permitted.
This is an optional component and a maximum of one UL Card per system is allowed. To add a USB UL
Card to TSW, see document 579-835
Port A
Port A Interrupt
Number
ISA UL Card
(Obsolete. Replaced Port B
by USB UL Card) It is recommended to keep the default settings.
Port B Interrupt
Number
UL Card Interrupt
Number
Serial Port: Select the serial port that will be used by this component
Alert Central
Note: Alert Central is an optional component and a maximum of two Alert Centrals per system are permitted.
See section “Configuring a Quad Serial Port Card” later in “Hardwares Option” for configuration details
Base COM Port Address: Select the computer COM port that will be used by the Quad Serial Port
Quad Serial Port
Card.
Card
Note: The Quad Serial Port Card is an optional component and there is a maximum of one Quad Serial Port
Card per system. However, two cards can be physically installed (COM10 not functional).
This is an optional component and it is used to communicate with third party systems.
Generic Port
Serial Port: Select the serial port that will be used by the Generic Port component.
Use Computer Port Protocol: Put a checkmark in this checkbox to use this option.
2-7
Chapter 2 . Workspace pane
Hardware, continued
Adding hardware
This is an optional component and a maximum of one Time Synch Port for each system is allowed.
Serial Port: Select the serial port that will be used by the Generic Port component.
Time Synch Port
# of Consecutive Failures: This field refers to the allowed number of consecutive failures of the time
sync port messages, before the TSW reports time sync communication loss trouble.
This is an optional component and a maximum of one DACR port for each system is allowed.
DACR Model Type Select the DACR model that is currently on the computer.
DACR Port
Baud Rate
Parity
It is recommended to keep the default settings
Data Bits
Stop Bits
This component is used to set-up automatic email notifications as TSW events occur. The message is
automatically sent to a pre-defined email event port, simultaneously with the event.
Note: By default, there are no email event ports within a job and at most 50 can be added to a job.
Email Address: Enter one e-mail address to associate with the port. The length
of the string cannot exceed 45 characters. For example:
username@domainname.com.
Email Event Port
Email Event Port Name: Enter a description of the e-mail event port. For
example: “All Staff” or “Service Department”. It is recommended to use e-mail
Details alias addresses (or distribution lists) as opposed to specific e-mail named
addresses. This allows the e-mail administrator to change the e-mail recipient(s)
without having to reconfigure the job. When using an alias or distribution list, it
must be specified in the form of an e-mail address: e.g. "All
Staff@domainname.com”.
2-8
Chapter 2 . Workspace pane
Hardware, continued
Adding hardware
* If these options do no appear after clicking on the Message Content tab, click
.
Notes: 1. The printer is an optional system component and there is a maximum of the three printers per
system.
2. To configure a serial printer as an event printer, it must not be configured as a Windows printer.
3. The 4190-9013 (USB) printer can be used as an event printer for the TSW application, using a
USB port (Epson Compatible). Before using any other model USB printer for event printing, the
TSW operation must be verified by the installer. This is because not all printers will work with the
Printer TSW event printing. However, any printer can be used to print reports or print screens.
4. HP printer connected to TSW and job configured as:
• HP: Doesn’t print until page is full.
• Epson: Form feed after each event (1 event per page).
5. Epson printer connected to TSW (dot matrix) and job is configured as:
• HP: No print.
• Epson: One line at a time.
This is a default system component and it cannot be removed from the list of installed hardware. The
Number of Volumes and Volume Size options explained below are accessible by clicking on the Edit
Hardware button :
Number of Volumes: Specify between two and ten volumes. A larger site provides support for more
Historical Log
entries.
Note: When the historical log has used up all volumes sequentially, it starts again at volume 1, overwriting the
previous data. A message warns you when the last volume is reached.
Volume Size: Select how large each historical log volume is going to be.
Editing hardware Click Edit Hardware to open the Hardware Configuraton dialog box, where the
properties for the selected hardware type can be changed.
2-9
Chapter 2 . Workspace pane
Hardware, continued
Removing Click Remove Hardware to remove the selected hardware type from the list.
Hardware
Note: The Ctrl + Delete keyboard key combination can also be used.
This section describes how to include the 4120 NIC as part of your TSW Configurator
hardware configuration.
Complete the following steps to configure each card:
1. Use the UP ARROW and DOWN ARROW to select the network interface card, then
select OK.
2. Use the defaults for the Network Loop Styles for each card if you are using the standard
platform.
3. Attach the network card to a network as follows:
a. Select the network, then select the .DBN file, network name and network number from
a dropdown list.
b. Set the Left Port and Right Port media types, options are: None, RS-485 and Fiber.
c. If there is only one .DBN file in the site directory, the system automatically assigns the
network card to that network.
4. To install an extra network card, complete steps 1 to 3 for each extra card..
2-10
Chapter 2 . Workspace pane
Hardware, continued
Configuring the This section describes setting the network information for the ES Net NIC. See Editing basic
ES Net Card card properties for information about setting the card properties. See Setting the service port
communication settings for information about programming the service port on the cards.The
ES Net NIC has two networks, Panel Net that is internal to the panel, and a Fire Net that
connects the panels on a network, and is totally separate from the Panel Net, see Figure 6-8.
Panel Net is a network of the CPU card and its Ethernet based slave cards.
The Fire Net is a redundant single ring network connecting the ES Net NICs. The Fire Net can
have up to 99 nodes of different types, ES Panels or TSWs.
IMPORTANT: You must configure two Fire Net ports on an ES Net NIC, and pair
the connecting ports correctly.
In installations where using an ES Net External NIC is not practical, you can install a TSW ES
Net NIC in the bay of an ES Panel. Because the ES Net NIC is located in, and powered by the
panel, you must add the TSW ES Net NIC to the correct location using the ES Panel
Programmer.
Complete the following steps to configure the physical card settings of the bay mounted TSW
ES Net NIC:
2-11
Chapter 2 . Workspace pane
Hardware, continued
1. Add the card to the correct location in the Hardware window of the the ES Panel
Programmer: the unit, bay and box. See The ES Panel Programmer’s Manual (579-849) for
more information about configuring card properties.
2. You can type useful information about the TSW node in the Notes field, for example:
TSWNode X Central Office (40 characters maximum), where x is the node number on the
network.
See ES Net Slot Type Network Interface Card Installation Instructions (579-1256), ES Net Flat
Type Network Interface Card Installation Instructions (579- 1257) and TrueSite Workstation
Installation & Checkout Instructions (579-834) for more information about installing the cards.
To access the network information for the ES Net NIC, complete the following steps:
1. Double-click the card icon, and click the Card Configuration tab.
2. Select the wiring topology in the Comm Style list. Click Style 4 (Class B) or Style 7 (Class
X). Style 7 is the default selection.
The example in Figure 2-5 shows a 4 nodes Class X (Style 7) network with a mix of Ethernet
and single mode fiber.
2-12
Chapter 2 . Workspace pane
Hardware, continued
To configure this network, configure the following options in the ES Net Card configuration
dialog for each node in Table 2-1.
Table 2-1 4 Nodes Class X (Style 7) mixed media network configuration options
The example in Figure 2-6 shows 4 nodes network similar to the previous example, only this
time configured in Class B (Style 4)
2-13
Chapter 2 . Workspace pane
Hardware, continued
To configure this network, configure the following options in the ES Net Card configuration
dialog for each node in Table 2-4.
Table 2-4 4 Nodes Class B (Style 4) mixed media network configuration options
Use the Panel Net port type to connect Ethernet slave cards to the CPU card. This port type
provides supervision of the link and declares a port trouble if the link goes down.
2-14
Chapter 2 . Workspace pane
Hardware, continued
When you are pairing DSL media card ports, ensure Port E or G on one end of a link is
connected to ports F or H on the other end. If you pair them incorrectly, as with fiber media, a
Link Down trouble appears on both ports.
Ethernet ports A, E and G on the ES Net NIC or on the ES Net Ethernet media card can detect
ground fault conditions. If code requires that a Ground Fault condition be detected and
annunciated for a link, correct port pairing must be respected.
To pair the ports correctly, ensure that a port with ground fault detection capabilities (Port A, E
or G) is connected to a port without Ground Fault detection capabilities (Port B, F or H). If you
do not respect this port pairing, a miswired trouble results.
Correctly paired DSL and Ethernet links detect ground fault conditions. This option is the
default selection for both media.
Depending on local code, ground fault detection may not be required or desirable. To disable
this feature, uncheck the Link requires Ground Fault Protection check box in the port
Advanced Settings.
Note that you must deselect this option for the ports on each end of the link, that is at each
node. Failing to do this results in a miswired trouble.
2-15
Chapter 2 . Workspace pane
Hardware, continued
Table 2-1. Ground Fault Detection
• PanelNet
Port D Not applicable Port D is reserved for future use.
• UNUSED
• DSL
• Ethernet
Media card 1 • Multi-mode Fiber Not applicable
• Single-mode Fiber
• UNUSED
Port E (labeled If media card 1 is Ethernet, For Ethernet, pair with Port B, F
Port A on the Port E and Port F have the or H. For fiber media or DSL, pair
media card) following options: Port E with Port F or H.
• Fire Network The Link requires Ground
• PanelNet Fault Protection. This option is
• UNUSED selected by default on Fire
Port F (labeled If media card 1 is fiber or Network ports. This does not For Ethernet, pair with Port A, E
Port B on the DSL, Port E and Port F have apply to the fiber media cards. or G. For fiber media or DSL, pair
media card) the following options: Port H with Port E or G.
• Fire Network
• UNUSED
• DSL
• Ethernet
Media card 2 • Multi-mode Fiber Not applicable
• Single-mode Fiber
• UNUSED
Port G (labeled If media card 2 is Ethernet, For Ethernet, pair with Port B, F
Port A on the Port G and Port H have the or H. For fiber media or DSL, pair
media card) following options: Port E with Port F or H.
• Fire Network The Link requires Ground
• PanelNet Fault Protection. This option is
• UNUSED selected by default on Fire
Port H (labeled If media card 2 is fiber or Network ports. This does not For Ethernet, pair with Port A, E
Port B on the DSL, Port G and Port H have apply to the fiber media cards. or G. For fiber media or DSL, pair
media card) the following options: Port H with Port E or G.
• Fire Network
• UNUSED
Note: When you are pairing Ethernet ports that are configured as Fire Network, you must pair a port with ground fault
detection to a port that does not have ground fault detection. If you pair two ports with ground fault detection, this
results in a Wiring Mismatch trouble.
2-16
Chapter 2 . Workspace pane
Hardware, continued
Once the NICs are assigned, a new local 4100 point or local TSW point can be added without affecting
other nodes on the local network (or the connected networks). Only one ES Net Network is supported.
Local TSW points can be made public to all nodes on up to 7 directly connected 4120 Networks.
When adding a new public 4100 point or a public TSW point only nodes externalizing the public point
require a rebuild and download. Public points on all nodes with up to 7 directly connected 4120 Networks
can be made visible (externalized) to the TSW.
For example, if a new public point is added to “TSW 1” and make it external to “4100 1” on network 1,
only “TSW 1” and “4100 1” need to be rebuilt and downloaded. There is no impact to other nodes on
Network 1 or to the other networks. This means there is no downtime and there are no “Version
Mismatch” troubles on Networks 2, 3, and 4. However, if the same point is marked as external in the 4100
on Network 3, then both Network 1 and 3 require rebuilding.
Refer to the “Adding points” section in “Points” earlier in this chapter to add points to a network. The
Point Configuration Editor splits the point information it displays into separate columns.
Making a local TSW point public from the point configuration editor The logical node number is displayed in the Job
makes the point available to all nodes on all currently assigned Directory dialog box when a .DBF is opened for
networks. The appropriate .DBNs are updated to contain this public editing, and in the NIC configuration dialog box (Figure
point when the TSW .DBF file is saved. Restoring a public point to its 2-3) in the hardware configuration editor. To change a
original local state is accomplished just as it was in the past. logical node number, open the General Information
Accordingly, the .DBN files are updated when the .DBF is saved. workspace pane option.
Note: When creating new 4100 nodes, it is important to fill out the Network Information screen in the
Configurator correctly on all nodes, so that it is part of the correct network loop.
The 4100 nodes on the separate network loops have to be custom programmed to provide
automatic response, since the TSW product:
• Does not pass along the 4100 point’s alarm state to the other network loop for a secondary
4100 to respond to.
• Does not provide automatic control, since there is no default (or user-programmed) custom
control running.
Continued on next page
2-17
Chapter 2 . Workspace pane
Hardware, continued
Configuring the To support automatic response to an alarm on a separate network loop, set up sharing between
4100 or ES Net two loops. Complete the following point configurations in the 4100s on each of the network
NIC loops before sharing can be set up:
• Public TSW digital pseudo points and/or list pseudo points containing only local points.
• User custom control referencing the shared points.
For example, when an alarm condition exists on Network 1, the “4100 1” on Network 1 can
turn on a digital pseudo owned by “TSW 1.” The change in the TSW digital pseudo state can
be sent to “4100 2” on Network 2. The “4100 2” on Network 2 can then respond to the “TSW
1” digital pseudo by turning its signals on.
Note: Points can be manually controlled on multiple networks from one TSW node by mapping the points to
the TSW. To prevent network initialization issues, avoid making a list that contains referenced
external points public.
When the common TSW node is not the master time keeper, time stamps displayed with events
could be a source of confusion because the current time displayed in the active lists and logged
with events varies depending upon which 4100 last sent a time update.
It is strongly advised to configure the shared TSW node as the master time keeper. To set the
Master Time Keeper option, follow the steps below:
1. In the TSW Configurator, click System Options and then click the Operations tab.
2. Check the Master Time Keeper checkbox.
In the TSW Remote Client, use the Network window to view the physical node connections on
multiple networks.
To display a network view for a specific network, complete the following steps:
1. In the TSW Remote Client, select Network from the Utilities menu.
2. Ensure the Network Information sub-tab is selected.
3. Click Select Loop from the Network menu.
4. In the Select Network Loop dialog box that appears, select a network loop and click OK.
When you select a different network, the system closes the dialog box and refreshes the
graphical drawing to accurately display the network. The graphical window’s title bar indicates
the network that is displayed.
When TSW is detached from a network loop, all external points from all nodes on the selected
network are deleted from the database. To detach a loop, select the network card in the
hardware editor (Table 2-2) and click Remove to remove the network card and the
network.
2-18
Chapter 2 . Workspace pane
Hardware, continued
Follow the steps below to display channel status information in the TSW Remote Client:
1. Launch the TSW Remote Client.
2. Click the Utilities menu and select Network.
3. Click the Network Information sub-tab and click Channel Status. The channel status
information window appears listing the status for all channels in the current network loop.
Click OK to close the dialog box.
Configuring a Install all required hardware and software (such as controllers, drivers, etc.) before you can
Quad Serial Port successfully complete configuration. To complete configuration, follow these steps:
Card
1. From the Quad Serial Port Card configuration window (Figure 2-8), select an available
COM port as the base COM port address (COM1 through COM5 with COM3 as the
recommended port). Click OK when complete, save the job and exit the TSW Configurator.
Note: Do not attempt to assign port directories or dump files until the new hardware configuration is saved.
2-19
Chapter 2 . Workspace pane
Hardware, continued
Configuring a The Quad Serial Port Card has been configured, and a maximum of two Quad Serial Port Cards
Quad Serial Port per job can be used. Follow the steps below to add 2120 points to the network and to the point
Card database
1. Using Windows Explorer, browse to the following directory:
\netjobs\tst2120\n7
2. Create a new folder: 2120_1 for Port 1, or 2120_2 for Port 2, etc.
3. Copy the 2120 dump file to the new directory. The file extension must be .SLI in order for
the 4120 Programmer Software to accept it.
Notes: 1. The TSW Configurator scans the new directory for a .SLI file and learns its name only once.
Do not change the name after the directory is scanned.
2. If a DACR port is added to a job that also has a 2120, the DACR has to use the COM1 port,
with the DACR_1 as the folder name. As a result, the 2120 folder name needs to be
changed to include the next available port. Examples of the new folder names are 2120_2,
2120_3 or 2120_4. The 2120 dump file (.SLI extension) must be copied to that renamed
2120 folder. When the COM port changes for the 2120, the dump file must be copied to the
folder with the name that reflects the port used.
Note: The system is now aware of the new port configurations and has automatically added certain system,
channel, and transponder information in the hardware configuration.
5. Click Points from the workspace pane and scroll past the last user point to display the
information added in step 4.
6. To add 2120 user points, scroll to the user point range which starts at 2816 and ends where
the last 2120 BMUX AutoGen point begins, and click Add . The Add Points dialog box
appears.
7. From Select Point Category dropdown list, select BMUX (2120).
8. Check the box next to each point that is added. Click OK when all the necessary points have
been selected.
9. Repeat steps 5 through 9 for each 2120 BMUX in the system. The new 2120 points are
displayed with a LC2 as the class. To toggle a class between Public and Local, highlight the
Class field that you want to change and click Make Public ( ) or Make Local ( ).
10. Save the database and build the job when all the steps are complete.
2-20
Chapter 2 . Workspace pane
Hardware, continued
Note: If both DACR and 2120 are in use, DACR must use a COM port. DACR should always be on COM1.
Follow the steps that apply depending on the type of communication format being used by the
DACR for the panel, and the type of information that needs to be annunciated at the TSW.
Notes: 1. The reporting protocol formats supported by the TSW are: Ademco CID, 3/1, 4-2, BFSK, SIA
level 1 and the Bosch D6600's 3/1 and 4/2.
Manual Point Entry 4. In the new screen that appears, click Add DACR Point button to add a new point.
Notes: To add a new DACR point, you need a DACR account. To create a DACR account:
1. Follow the steps in section “Add Event Account” in this table.
2. Import DACR points, which creates DACR accounts automatically. To import DACR points, see
section “Import CID Points” in this table.
1. Click the Points workspace pane option.
4. In the new screen that appears, click Import DACR Points to import a DACR points file.
2-21
Chapter 2 . Workspace pane
Points
Workspace Click the Points workspace to open the points editor where you can add, delete and modify
details system points. Table 2-5 provides the explanation for each column in the points editor. Table 2-
6 lists the functions available across the points editor. The description for each button in the
editor can be found later in this section.
Index: Indicates the point index (internal). Device Type: See Table 2-7 for possible device types.
Loop: Indicates which loop the point is associated with. Point Type: See Table 2-8 for possible point types.
Note: Each TSW job can contain a maximum of 100,000 user points.The maximum Point index is 102,815.
Note: When adding points, for best results, do not select more than 10,000 points at a time.If a job is
modified to add over 15,000 new points, Save the job before adding more points
2-22
Chapter 2 . Workspace pane
Points, continued
Workspace
details
Function Description
Click on the column header to sort the points list according to the entries in that column.
• Index, Loop and Node columns are sorted in ascending or descending numerical order.
Sorting
• Name column is sorted in a logical way. For example, entries sorted in ascending order appear as:
1.2:P85, A0, A34, P87, ZN6
Click filter to open a filtering row below the column headers. Keep the following in mind:
• Wait a few seconds after a filter entry is typed. The points list refreshes automatically.
• Multiple columns can be filtered simultaneously.
Filtering
• Wildcards as filter entries are allowed.
• When filtering the Node column, only results with exact matches to the filter entry are displayed.
• Click the cancel icon to cancel the filter results.
Notes: 1. When editing column entries in a point window, click on another row to confirm your edits, or press Enter on the keyboard.
To cancel your edits press Esc on the keyboard.
2. The pencil icon next to a column entry indicates that it the information in the column can be edited. Double-click the
entry to modify it.
3. If checkboxes are located next to the entries in a point window, you can add and remove check marks by clicking on the
checkboxes, or using the keyboard key combination Alt+Space.
4. Click anywhere on an entry (except the checkbox) to select it. Use the key combinations Shift+Left Mouse Click and
Ctrl+Left Mouse Click to select multiple entries. Use the keyboard key combination Ctrl+A to select all entries.
5. If you need to remove some checkboxes, follow the steps below:
i. Select the entries you want to remove the checkmarks from.
ii. Click the checkbox of one of the selected entries, or use the keyboard key combination Alt+Space to remove the check
marks.
Adding points Click Add Points to open the Add Points dialog box which can be used to add custom
points to the points list. The following points are available in the Select Point Category field.
External
Selecting the External point category brings up a list of all public points from all nodes that can
be added. Select the necessary point(s) as follows:
1. Put a check mark in the checkbox next to each point that you want to add.
2. Click OK to confirm.
Note: When TSW is configured for TFXNet, the list includes points from the shadow node.
2-23
Chapter 2 . Workspace pane
Points, continued
Select the Digital Pseudo or Analog Pseudo points category to display the following fields:
1. Quantity
This field allows you to specify the number of points you want to add.
2. Type
This field allows you to select a preliminary point type that can be modified later. The
point types below are available.
3. Label
This field allows you to create a preliminary point label. This label can be edited later if
required.
List Pseudo
Selecting the List Pseudo point category displays the following fields:
1. Quantity
This field allows you to specify the number of list points you want to add.
2. Label
This field allows you to supply a preliminary point label, that can be modified later.
BMUX (2120)
Selecting the BMUX (2120) point category brings up a list of all BMUX points from all
BMUX ports that can be added. Select the necessary point(s) as follows:
1. Put a checkmark in the checkbox next to each point you want to add.
2. Click OK to confirm.
2-24
Chapter 2 . Workspace pane
Points, continued
Selecting the DACR point category brings up a window that allows you to:
Editing DACR Click Edit DACR Accounts... to open the Edit DACR Accounts dialog box which can
accounts be used to:
1. Add a new DACR account by clicking Add . A new entry appears in the DACR
accounts list below the Add button.
2. To change the DACR port number, Account number, and Description, double click the entry
in each of these three columns.
3. Click Remove .
Notes: 1. The Edit DACR Accounts button is enabled only if DACR is configured in the job.
2. To add multiple entries from one instance of the Add DACR Points dialog box, click to highlight
the last row and the Enter key on the keyboard. This re-enables the Add button in the dialog box.
Setting view Click Set View... to open the Set Point Database View dialog box, which can be used to
change the filtering of point classes and point ranges displayed.
A check mark next to an entry in the Set Point Database View dialog box indicates that this
entry will be displayed.
Note: A highlighted Set View icon indicates that the points list displayed is filtered. A standard Set View
Removing points Click Remove Point(s) to delete the selected point from the points window.
Note: The keyboard key combination Ctrl + Delete can also be used.
Note: Use the keyboard key combination Ctrl + T instead of clicking on the icon.
2-25
Chapter 2 . Workspace pane
Points, continued
Editing lists Click Edit List... button to open the Edit List dialog box, which can be used to choose the
points that will be part of a points list by placing a check mark in a checkbox next to the point.
Notes: 1. The Edit List button is available only for points with the LIST Device Type.
2. Double-clicking the Point Type cell of a point with the Device Type of LIST is the same as clicking
the Edit List button.
Assigning action Click Assign Action Messages to open the Assign Action Messages dialog box, which
messages displays the point's valid states and the message label mapped to those states for that particular
point. The message text for the selected label is displayed by clicking on the button.
To change the Message Label, double-click the current entry and select a new one from the
drop-down list.
Click OK when all the necessary changes have been made.
More Info Click More Info to open the More Information dialog box which provides detailed
information on a point selected in the points window on the main page.
Apply/Revert Click Apply to apply the changes made. Click Revert to cancel the changes made.
2-26
Chapter 2 . Workspace pane
Action Messages
Workspace Click the Action Messages workspace to open the action message editor where messages are
details created, deleted and modified. An action message is used to provide details about a particular
point event or to suggest actions to be taken in response to an event.
Table 2-9 provides the explanation for each column in the action message editor. Table 2-10
lists the functions available across the points editor. The description for each button in the
editor can be found later in this section.
Class: Indicates whether the action message is a Local, a References: Indicates the number of times a message is
System, or an Unused message. used.
Function Description
Click the column header to sort the points list according to the entries in that column.
Sorting • The Message ID and References columns are sorted in ascending or descending numerical order.
• The Class and Message Label columns are sorted in ascending or descending alphabetical order.
Click filter to open a filtering row below the column headers. Keep the following in mind:
• Wait a few seconds after a filter entry is typed. The points list refreshes automatically.
Filtering • Multiple columns can be filtered simultaneously.
• Wildcards as filter entries are allowed.
• Click cancel to cancel the filter results.
Notes: 1. Double-click anywhere on an entry to open the Edit the Content of the Action Message dialog box where the action mes-
sage text can be entered. The message can be 25,000 characters long, with a maximum of 50 characters per line.
2. Click anywhere on an entry to select it. Use the combinations of Shift+Left Mouse Click and Ctrl+Left Mouse Click to select
multiple entries. Use the keyboard key combination Ctrl+A to select all entries.
2-27
Chapter 2 . Workspace pane
Adding action Click Add Action Messages to open the Add Action Messages dialog box. Complete the
messages following fields:
Note: The action messages editor can also be used to configure point groups. See information regarding
the acknowledge options in the section “System Options”.
Exporting the Click Export the Messages to export the action message to a .FAM file, which is a text
messages editable file that is stored on the network directory at NETJOBS > site name > filename.FAM
Importing the Click Import the Messages to import action messages from a .FAM file to the job.
messages
Removing action Click Remove Action Messages to remove the highlighted action message.
messages
Copy Click Copy the Selected Action Messages to copy the contents of the highlighted
messages.
Assigning points Click Assign Points to a Selected Message to open the Assign Points to an Action
to a selected Message dialog box, which contains the following fields:
message
Choose which points category to display in the points list. The
options are:
• Alarm
Select Point Category • Priority 2
• Supervisory
• Trouble
• General Info
The points list displays the available points for the point category
selected. The list contains the following fields:
• Included: Click to add checkmarks in the checkboxes next
to points that will be associated with the action
Points List message.
• Point Name: Displays the name associated with the point
• Device Type: See Table 2-7 for possible device types.
• Point Type: See Table 2-8 for possible point types.
• Label: Displays the custom point label.
Click OK to link selected points with the action message. Click Cancel to return to the action
message editor without linking points to the action message.
2-28
Chapter 2 . Workspace pane
System Options
Workspace Click the System Options workspace to open the system options editor which is used to
details configure TSW runtime settings. Table 2-11 provides an explanation of the fields that appear in
the editor.
Preferences Operations
2-29
Chapter 2 . Workspace pane
Workspace
details
When checked, the runtime system Checking this box causes network troubles to
will display points in the active list in be annunciated. Clearing this box prevents
Reverse active list Annunciate network
reverse order, from newest to oldest. network troubles from being annunciated.
display troubles
Normally, the active list shows the Network Troubles are troubles such as:
oldest ones at the top. Network Ground and Style 7 Fault.
2-30
Chapter 2 . Workspace pane
Workspace
details
2-31
Chapter 2 . Workspace pane
Workspace
details
2-32
Chapter 2 . Workspace pane
Control windows
Workspace Click the Control Windows workspace to open the screens editor which is used to configure
details audio screens that appear during runtime. Table 2-11 provides an explanation of the fields that
appear in the editor. The description for each button is located after the table.
Use this tab to define the utility control screens that are displayed at runtime.
Utility Use the Utility control screens to control functions such as fan control,
lighting control, etc.
Tabs
Use this tab to configure speaker points that the operator may want to control
Speaker Audio
and buttons for turning the speakers on for the appropriate channels.
Auxiliary Audio Use this tab when any audio option other than speaker is configured.
This field indicates the number of rows to add to the Control Windows
Quantity
screen.
This column displays the audio point mode, such as AEVAC for
Mode “Audio: Play Evacuation Message” or AALERT for “Audio: Play
Alert Message”.
This column displays the label associated with each audio point.
Label
Note: Edit a label in the column by double-clicking on it.
This column displays the buttons for turning the audio devices on
Buttons
for the appropriate channels.
Click filter to open a filtering row below the column headers. Keep the following in mind:
• Wait a few seconds after a filter entry is typed. The points list refreshes automatically.
• Filter multiple columns simultaneously.
• Wildcards as filter entries are allowed.
• Click cancel to cancel the filter results.
2-33
Chapter 2 . Workspace pane
Add utility screen Click Add Utility Screen in the screen field to open the Edit Screen Label dialog box. In
the Name field, enter the label for the new audio screen. This new screen appears in the
existing screens list (Figure 2-9).
Delete utility Click Delete Utility Screen to remove the selected audio screen.
screen
Note: The default entries AUDIO CONTROL and AUXILIARY AUDIO CONTROL cannot be removed. The
Delete Utility Screen button is disabled.
Rename utility Click Rename Utility Screen to open the Edit Screen Label dialog box where the name
screen of a selected audio screen can be changed.
Note: The names for the default entries AUDIO CONTROL and AUXILIARY AUDIO CONTROL cannot be
changed. The Rename Utility Screen button is disabled.
Quantity / adding In the Quantity field, enter the number of audio points to add to the list. Click Add Row
row to add these rows to the list.
Removing row Click Remove Row to remove the selected audio point from the list.
Editing mode Click Edit Mode to open the Edit Mode dialog box where the audio point mode is
selected.
Using point name Click Use Point Name as Label to open the Bind a Point Name to a Screen Row dialog
as label box. Click on a point from the list to highlight it and then click OK to assign that point’s label
to the screen row Figure 2-10.
2-34
Chapter 2 . Workspace pane
Adding button Click Add to open the Edit Mode dialog box, where Control Mode and Status Mode
settings for the audio point button are configured. Complete the following fields:
Mode: From the dropdown list, choose the appropriate control mode type.
Point: Double-click on the point field to open the Bind a Point Name to a
Screen Row dialog box, where a point associated with the chosen
Control Mode
control mode can be selected.
Note: If the chosen point cannot be used with Control Mode, the message “The
selected point is invalid” appears.
Mode: From the dropdown list, choose the appropriate status mode type.
Note: The possible mode states for each mode type are reflected in the multi-colored
palette at the bottom of the Status Mode area.
Status Mode Point: Double-click on the Point field to open the Bind a Point Name to a
Screen Row dialog box, where a point associated with the chosen
status mode can be selected.
Note: If the chosen point cannot be used with Status Mode, the message “The
selected point is invalid” appears.
Once all the fields are complete, click OK to generate the audio point button. The button
appears in the Buttons column (Table 2-11).
Note: The button settings can be changed by clicking on it and making updates in the Edit Mode dialog box
that appears.
Filling across Click Fill Across to open the Fill Across dialog box which can be used to choose which field
to start filling across (on the current row).
Filling down Click Fill Down to open the Fill Down dialog box which can be used to choose which field to
start filling down on the selected row.
Audio options Click Audio Options to open the Audio Options dialog box, where the audio options for
button (Speaker the job can be changed. The following options are available:
Audio and
Auxiliary Audio
Tabs Only) Choose the way that audio works with the job. The
Audio Operation
options are None, Canadian and Standard.
Number of Channels Choose the number of audio channels for the job.
2-35
Chapter 2 . Workspace pane
Operators
Workspace Click the Operators workspace to open the operators editor which is used to add, delete and
details edit TSW operator information. Table 2-12 provides an explanation of the fields that appear in
the editor. The description for each button is located after the table.
Note: If the checkbox for Limit Invalid Login Attempts (accessible via Operator Options button) is
checked, it may be possible for users to become “locked-out” of TSW Runtime for a period of time. To
enable users to login to TSW while their accounts are reinstated, it is recommended for the local
administrator to create “Guest” accounts (before the job is built) that can be provided to locked-out
users. It is recommended to create 5 separate Guest accounts – one for each access level (1-5).
Number: This field shows the operator ID number used to log in to TSW Configurator.
Name: This field shows the operator name used to log in to TSW Configurator.
Access Level: This field indicates the access level associated with the operator. Access levels range from 1 to 7, where
1 is the lowest access level and 7 is the highest.
Passcode: This field shows the passcode used by each operator to login to TSW Configurator.
Note: The pencil icon next to a column entry indicates that it can be modified. Double-click on an entry to modify it.
Adding operators Click Add Operator to open the Add New Operator dialog box. Enter the name, login
passcode, and access level of a new operator.
Notes: 1. The entry in the Operator Name field must not exceed 16 characters.
2. The operator passcode must not exceed 10 characters. The Confirm Passcode field gets a red
bounding box if the entry inside it does not match that of the Operator Passcode field.
2-36
Chapter 2 . Workspace pane
Operators, continued
Operator options Click Operator Options to open the Operator Options dialog box where the following
settings are available:
Require Complex Passcode for All Operators: Put a check mark in this checkbox if a
complex passcode to login in to TSW is required for all operators.
Note: A complex passcode must be between 8 and 10 characters long and contain at least one upper-
case letter, one lower-case letter, and a least one digit.
Limit Invalid Login Attempts: Put a check mark in this checkbox to choose the number of
failed login attempts the operators are allowed, as well as the amount of time they are locked
after exceeding that number.
Raise a Trouble ON any/All Invalid Login Attempts: Put a check mark in this checkbox to
generate a trouble in the system every time there is an invalid login attempt.
2-37
Chapter 2 . Workspace pane
Access controls
Workspace Click the Access Controls workspace to open the access control editor which is used to
details configure user access to various functions within TSW Runtime and TSW Configurator. The
editor contains three tabs:
• System Access (Runtime)
• Operator Access (Configurator)
• Operator Access (Runtime)
This tab is used to select which system features are accessible through the TSW application, a Remote Client application, a
Third Party application or all three. The Remote Client PC connects to the TSW workstation through the TCP/IP from a remote
location and has access to its own set of features.
Select a category from the dropdown list to view different TSW runtime functions. Select the way a
Categories
system feature is accessed by putting a checkmark in the checkbox under the appropriate column.
Sub-column
Column name Description
name
Workstation Local Make the feature available to the TSW on the TSW PC by entering an X under
UI this column.
Supervised By entering an X under this column, you make a feature available to a user at a
Remote Client PC. To access the TSW application, this user connects to the
main computer through TCP/IP.
Remote Client The Supervised option is for supervised remote stations, which are
Unsupervised acknowledged by the main machine should they disconnect or connect to it.
The Non-Supervised option is for unsupervised remote stations, which are not
acknowledged by the main machine if they disconnect or connect to it.
Make a feature available to the 3rd Party Client connected to the TSW by
3rd Party UI
entering an X under this column
Notes: 1. For UL-Listed systems, access to Ack/Silence/Reset or any control operations must be disallowed for 3rd Party Clients.
2. Use the default System Access (Runtime) settings for UL-listed Remote Clients.
3. Disable the control operations (Ack/Silence/reset) for UL-listed Non-supervised Remote Clients.
4. System Access (Runtime) determines which system features are accessible through TSW or Remote Client
applications. Operator Access (Runtime) determines which features the user can access.
5. For all TrueSite Workstation Proprietary Supervising Station Installations (4190-8403), control operations are not
allowed at any remote clients. The System Access levels for system-wide functions (Ack/Silence/Reset) must be
turned-off for both Supervised and Non-supervised clients.
2-38
Chapter 2 . Workspace pane
Workspace
details
Each user has an assigned access level, which determines what the user can and cannot edit. The TSW Configurator
prevents unauthorized use of certain functions by graying out unauthorized menu options and by not displaying unauthorized
buttons and icons. If a user enters the Configurator through the run-time system, the run-time access level is carried over to
the Configurator.
There are seven operator access levels, from 0 to 6, and one Simplex access level, 7. Access level 0 corresponds to a system
where no operator is logged in. All of the user access levels are editable, which means that Simplex can prohibit even level 6
users from various services. logging in at level 7 requires knowing the passcode for user SIMPLEX and having the Simplex
branch software key.
All jobs are sent to the customer with at least one level 6 user already set up.
Users can only add, delete, or edit users that have an access level lower than their own access level. For example, a level 5
user can only add, delete, or edit users at level 4 or lower. In addition, if a user is editing user authorization information, he can
only raise that user's access level to 1 less than his own. For example, a level 4 user can only raise a user at a lower access
level up to access level 3.
A user who is editing the access levels can only edit lower access levels. For example, a user at level 4 can only edit access
levels 1, 2, and 3. In addition the user can only grant access that he has himself. So the level 4 user can modify access level 3,
but if he doesn't have authority to edit point configuration, for example, he cannot give the level 3 user access to edit point
configuration.
Select a category from the dropdown list to view different TSW runtime and TSW Configurator
functions. Select the access level required to use each function by putting a checkmark in the
checkbox under the appropriate column.
Categories Notes: 1. See Appendix D for the list of all the functions available under Operator Access (Runtime) and
Operator Access (Configurator).
2. The “Site Information” access level in the Main Menu Item Visibility category includes symbol
legend (_legend) visibility.
When there is a checkmark in this checkbox, all higher access levels are automatically granted
access when a particular access level is set. When access is denied at a particular level, all lower
Auto-Fill
levels are automatically denied access. If you did not select the function, you can specify individual
access levels.
2-39
Chapter 2 . Workspace pane
Color definition Click the Color Definition workspace to open the color editor which is used to edit colors
workspace details associated with various events during runtime. Table 2-14 provides an explanation of each field
within the editor.
Items This column lists all the events that occur during runtime.
Use this column to choose the color of the text string associated with the
Foreground Color
event.
Use this column to choose the background color that appears behind the text
Background Color
string.
Note: Click filter to open a filtering row below the Items column header. Keep the following in mind:
• Wait a few seconds after a filter entry is typed. The points list refreshes automatically.
• Wildcards as filter entries are allowed.
• Click cancel to cancel the filter results.
Node Name Click the Node Name workspace to open the node name editor which is used to customize the
workspace details format of a node name when it appears in TSW.
The editor consists of three areas (4120 Panel Node Label Definition, Command Center
Node Label Definition and DACR Node Label Definition), each representing a configurable
node type. Each area contains a list of supported node attributes that can be displayed in the
TSW. Select the different attributes by clicking on the checkbox next to a specific item.
2-40
Chapter 2 . Workspace pane
Sound
Workspace Click the Sound workspace to open the sound editor which can be used to select the sounds for
details four alarm categories (Fire, PRi2, Supervisory and Trouble) and four alarm restore categories
(Fire Restore, Pri2 Restore, Supervisory Restore and Trouble Restore). Table 2-15 provides an
explanation of the fields that appear in the editor.
Note: Restore category sounds do not apply for the “Global” acknowledge systems.
Alarm
This column lists the four alarm and four alarm restore categories.
Category
Double-click on an entry in this column to enable a dropdown list where either a “Piezo” or a “WAV File” sound
type can be selected:
Sound Type • Piezo: When this option is selected, the standard piezo sound plays when that alarm type is on.
• WAV File: When this option is selected, the Browse button is enabled, allowing a .WAV file to be selected
and played when that alarm type is on.
This button is enabled when the WAV File radio button is selected. It enables you to select the necessary .WAV
file.
Browse
Note: When you import a WAV file into a TSW job, the file is encrypted within the TSW job folder so that other
Windows applications cannot play it.
This button enables you to export the .WAV file anywhere on your computer.
Export Note: When a WAV file is exported from TSW, it is no longer encrypted. It can be played by other Windows applica-
tions.
Note: Click filter to open a filtering row below the Items column header. Keep the following in mind:
• Wait a few seconds after a filter entry is typed. The points list refreshes automatically.
• Wildcards as filter entries are allowed.
• Click cancel to cancel the filter results.
2-41
Chapter 2 . Workspace pane
Port Vectoring
Workspace Click the Port Vectoring workspace to open the editor which can be used to enable the logging
details of various events to selected ports. A port is an output or storage device (historical log,
monitor, printer, email etc.). Table 2-16 provides an explanation of the fields that appear in the
editor.
Configuration Info: This column displays the current port configuration settings.
MONITOR: This area lists the event types that can be logged to the selected port. Click a port to select it and then select the
events you want to log by putting a checkmark in the checkbox next to the event. Click Apply to confirm or click Revert to
cancel.
Click filter to open a filtering row below the column headers. Keep the following in mind:
• Wait a few seconds after a filter entry is typed. The points list refreshes automatically.
• Multiple columns can be filtered simultaneously.
• Wildcards as filter entries are allowed.
• Click cancel to cancel the filter results.
2-42
Chapter 3 Graphics Editor
Introduction The graphics editor operates in a manner similar to other available graphics packages and is
used to create runtime screens for use with TSW. These screens can be tied to real time events
and are used to provide a graphical representation of the points contained within the current
job.
Runtime screens are created by importing AutoCAD or previously created graphics files, as
well as by creating new screens using the graphics editor. Links between points in the database
and objects on the screen can be created. Points and objects can also be linked by color, where
different colors are displayed depending upon the state of the point.
Shape Properties editor ............................ 3-6 Link to Color dialog box .......................... 3-19
Document Attributes dialog box ............... 3-9 Graphics Key functions ........................... 3-22
Class Name dialog box ...........................3-11 Runtime and editor limitations ................. 3-23
Import / Export dialog boxes ................... 3-12 Color default for dynamic link objects ..... 3-26
Layer Control dialog box ........................ 3-13 Supported DWG/DXF entity types .......... 3-29
3-1
Chapter 3 Graphics Editor
Concepts
Overview Table 3-1 provides an overview of the various graphics editor concepts and conventions.
Graphics screens can be programmed on any available resolution (minimum 1024x768, default is
1280x1024), and used on any available resolution at runtime. To match the runtime graphics screen
with the editor, the runtime Graphics window can be resized to be close to the editor.
The graphics editor creates and uses a basic data file, a document, which contains three basic
objects:
1. Background objects:
Background objects are graphical objects that stand alone and do not generally change during
runtime. The graphics system allows background objects to be created from AutoCAD drawing
files, bitmaps, and other graphics formats. The objects can also be drawn using the graphics
editor. They can be changed at edit time, but they are static at runtime.
2. Dynamic links:
Dynamic links are created in the graphics editor, they are always tied to specific database points,
and generally change during runtime. When a dynamic link is created, it can be placed into a
control class for use by command objects (described below). At runtime, the appearance of
dynamic links changes based on changes in the point database. They can be used to control
points or to display their status.
3. Command objects:
Command objects are graphical objects which do not generally change during runtime.
Command objects are used for screen navigation and class based point control.
Each part is built from graphical objects. The documents do not occupy the entire display area
because they must allow for the system header.
The selection method for objects is different between the runtime screen and the editor screen. The
runtime screen consists of both non-selectable and selectable objects. Non-selectable objects are
things such as background objects, while selectable objects are things such as dynamic links and
command buttons. Selectable objects in the runtime are surrounded by a 'selection border'. Clicking
or double-clicking anywhere in the border will select an object for an action.
Unlike the runtime screen, all objects are selectable in the editor. Objects in the editor can be
moved, resized and changed. Because of this, they appear differently on the screen. When an
object in the editor is selected, eight white 'grips' appear around it. The grips indicate spots that can
be used to resize the object. The object can be moved by clicking in the object, then dragging it to its
new location.
AutoCAD blocks comprising entities that are all supported will be converted into groups. For a list of
supported entities, refer to the “Runtime and Editor Limitations” section later in this chapter. If the
AutoCAD block contains one or more entities that are not supported, the block will not be converted.
This type of block will have grey grips. It can be selected for deletion and then be replaced by a
linked graphics object.
The actual actions that take place when an object is selected depend upon its context.
Both the graphics editor and runtime support user access level protection in varying degrees. Once
in the runtime, access level is enforced in three ways: screen access, command object access, and
point operations access. A logged on user can only access screens allowed for that level, or lower.
Once a screen is brought up, any command objects on it that are not accessible to the logged on
user do not appear as selectable. Screen access level and command object access level are
programmed by the graphics editor. Point operations (such as enable and disable) are protected in
the runtime as well. Point access levels are programmed by the Configurator.
3-2
Chapter 3 Graphics Editor
Main page Click the Graphics Editor function under the Tools menu of the TSW Configurator to launch
the graphics editor. Table 3-2 describes the main menu options in the editor.
Save: Saves the current document. Verify: Tests current document errors.
Save Template: Saves the current template. Preferences: Sets the editor preferences.
Print: Prints the current document. Exit: Terminates the editor session.
Import: Imports file formats .WGS, .DOC, 4190 .DAT, .SGT (Simplex Graphics Template), .DXF (from AutoCAD
R14, 2000), .DWG (from AutoCAD R9, R10, R11-12, R13, R14, 2000 - 2002, 2004 - 2006, 2007-2011).
3-3
Chapter 3 Graphics Editor
Main page
Copy: Copies the selected objects to the system Ungroup: Breaks a group back into its individual
clipboards. components.
Edit Paste: Pastes an object of valid type from the system Paste From: Pastes a clipboard object that was saved
clipboard to the document. elsewhere on the computer or backup drive
Select All: Selects all the objects on the current layer of Save As: Saves a copy of a screen to a new screen,
the document. with a different name.
Zoom Window: Selects an area to zoom in. Zoom Previous: Restores the previous view.
Zoom In: Enlarges a drawing. Pan: Pans over an area of the drawing.
View Zoom Out: Shrinks the drawing. Zoom: Zooms to a specified zoom level.
3-4
Chapter 3 Graphics Editor
Main page
Rotate/Flip: Objects may be rotated about the center of the bounding rectangle. Objects such as rectangles and
ellipses (which are based on rectangles) may be rotated by 90 degrees. Objects can be rotated and flipped in the
following manner:
• Rotate Left
• Rotate Right
• Flip Horizontal
• Flip Vertical
Color: Links the current shape’s color to the state of a
point. There are three available choices for state
linkage and the change link dialog box:
• A visible checkmark causes the color and the
Unlink Shape: Removes the shape link from the
object to be displayed.
current shape or group.
• A shaded check mark causes the object to be
hidden.
Link To • If the checkmark is not visible, the object is not
displayed.
Shape: Links the shapes of a current group to the state Unlink Command: Removes the command link from
of a point. the current shape or group.
Unlink Color: Removes the color link from the current shape or group
Contents: Displays the information located in the 'Graphics Editor Help File”.
Help
About: Displays the Product Version, Version Copyright, and License of the 4120 Graphics Editor.
3-5
Chapter 3 Graphics Editor
Main page Draw an object and right-click on the object. Click Modify Shape to modify the object’s
properties. Table 3-3 provides the explanation for functions in the editor.
Shape This area contains a thumbnail representation of the object you are currently editing.
This area is used to change the color of both the Pen and the Fill color, along with Line weight, background
hatching and Edge styles. See the descriptions that follow:
• Fill: The color of the button is the fill color for this object. To change the color, click Fill to show a system color
dialog box, and pick a new color. If the object does not require a fill color or a style, hollow is chosen and the
button is disabled.
Color
• Pen: The pen is the outline color for a shape or the color of the text for the text object. The color of the button
is the pen color for this object. To change the color of the pen, click on the button to bring up a system color
dialog box, where a new color can be picked.
• Line: Allows you to choose the weight of the line. Choices are thin, medium, and thick.
• Edge: Allows you to choose the style of the line. Choices are:
• Hatch: If the object has a fill color, the hatch is the pattern used by the fill brush. Choices are:
- None (solid)
- Horizontal (lines running horizontally)
- Vertical (lines running vertically)
- Forward (diagonal lines running from upper left to lower right)
- Backward (diagonal lines running from lower left to upper right)
- Crossed (lines running horizontally and vertically)
- Diagonal (diagonal lines running forward and backward)
Within this area, configure the origin (X and Y) and the height and width of the bounding rectangle. The units are in
Drawing Coordinates if the object is zoomable. The units are in Document Coordinates if the object is non-
zoomable.
Notes: 1. Drawing Coordinate units are defined within AutoCAD files. One drawing unit can represent one
millimeter, one centimeter, one mile and so forth. Decide on a unit when a new AutoCAD drawing is
created. The choice depends on the type of drawing. As the screen is zoomed and panned, the Drawing
Coordinates span the entire drawing space (not limited to the screen dimensions).
Location 2. Document Coordinate units are defined by the document extents for the screen (specified in the
Document Attributes dialog box of the TSW Graphics Editor) These extents are in pixels (screen
resolution).
3.When switching between zoomable and non-zoomable, the units will be converted between Drawing
Coordinates and Document Coordinates, and the numbers will change.
4.Non-zoomable object sizes/locations always maintain relative values (at 100% view level). If the
Graphics Editor window is resized, the non-zoomable objects will be repositioned/ resized to maintain
the same relative size/location. The sizes/positions are also recalculated whenever the screen is re-
opened within the Graphics Editor (e.g. on a different sized monitor).
• Tag ID: Identification number • Hollow: If checked, there is no fill color associated with this
associated with this object. object. If it is not checked, fill color will be used.
• Visible: If checked, the object is • Zoomable: When checked, this control zooms along with the
Miscellaneous
visible. If it is not checked, the object drawing.
is hidden.
• Permanent Color: The permanent color of this object.
More >> If there is a More > > button present, click on it to show the attributes dialog box for that particular object type.
3-6
Chapter 3 Graphics Editor
Bitmap Properties Right-click on an imported bitmap object, then click Modify Shape and then More >> to open
Editor main page the Bitmap dialog box used to load a new bitmap and turn scaling ON and OFF. Table 3-4
provides the explanation for function in the dialog box.
Note: A bitmap object can be inserted by selecting the Import Bitmap option in the Tools menu of the
graphics editor. The keyboard key sequence Alt+B can also be used.
Button properties Draw a button in the graphics editor and right-click on the button. Click Modify Shape and
editor main page then More >> to open the Button dialog box where you can edit button properties. Table 3-5
provides the explanation for function in the dialog box.
Note: A button can be drawn by selecting the Button option in the Tools menu of the graphics editor. The
keyboard key sequence Alt+U can also be used.
When you click this button, the system Open file dialog box appears, allowing you to
Bitmap
choose a bitmap for the face of the button.
When you click this button, the system Font selection dialog box appears, allowing you
Font
to choose font name, style, size and effects for the font used by the button.
Caption You can change the text for a button within the caption edit box.
3-7
Chapter 3 Graphics Editor
Main Page Right-click on a text box drawn in the graphics editor, then click Modify Shape and then More
>> to open the Text dialog box where text box properties can be changed. Table 3-6 provides
the explanation for function in the dialog box.
Note: A text box can be drawn by selecting the Text option in the Tools menu of the graphics editor. The
keyboard key sequence Alt+X can also be used.
The Font button brings up the System Font Selection dialog box, where you can
choose font, style, size, and effects for fonts installed on your system. If the Auto-Fit
option from the justification area is chosen, the size is overridden by the size of the
bounding rectangle.
Font
Note: Only True Type and Open Type fonts can be displayed properly by the Graphics
editor. The System Font Selection dialog box displays a note indicating which
font is a True Type or an Open Type font. Prior to saving the screen with the
selected font, verify that the text is displayed as expected in the Graphics Editor
main screen.
The text edit line contains the current text for this object. The following codes can be
used to insert specific information:
• $L: the point label
• $N: the point name
Note: $N macros do not work on grouped entities.
• $#: the system address for the point (example: 35-45-0 for card 35, point 45,
subpoint 0)
Text • $V: the value that triggers the alarm (depending on the device, may be
temperature, smoke (obscuration), AMZ value and so on). Analog Pseudo
Points are supported.
• $A: the % value that triggers the alarm
• $VU: for ANAMON devices, the value that triggers the AMZ ($V), along with the
unit of measurement ($U)
• $T: the description for the graphic file
• $I: the ID for the graphic file (internally generated)
• $S: the name for the graphic file
• Left: Left-justify the text within the bounding rectangle
• Right: Right-justify the text within the bounding rectangle
• Center: Center the text horizontally within the bounding rectangle
Justification • Vertical: Center the text vertically within the bounding rectangle
• Auto-Fit: Use a font size that allows the text to best fill the bounding rectangle.
This size takes precedence over the point size chosen from the Font Selection
dialog box.
3-8
Chapter 3 Graphics Editor
Main page In the graphics editor, click File and then Attributes to display the Document Attributes
dialog box. Table 3-7 provides the explanation for functions in the dialog box.
Note: The Document Attributes dialog box can also be opened by right-clicking in an empty space in the
graphics editor.
Note: When the TSW Graphics Editor is used to create a new screen on a multi-
monitor system, the document extents default to the screen resolution of
the main display monitor. If necessary, prior to starting the editor, use the
Options Windows Control Panel Display/Screen Resolution dialog box to shift
the main display to a different monitor.
• Background Color: Clicking on the color button displays a dialog box where
the background color for the document is chosen. As in AutoCAD,
background colors are limited to 255.
• Touch Size: The Apply Touch Size checkbox must be checked for the
feature to be enabled. It also needs to be checked for the Coverage Zones
feature to be available. The numeric value entered in the Touch Size field
defines – in inches – the minimum size at which the “touched” graphics will
enable control selection. When the graphic is zoomed and becomes smaller
than the specified value, controls will not be “touchable”.
• Screen Default Zoom Level: Enter a numeric value representing the
percentage for the zoom feature when the screen is loaded, either in the
graphics editor or at runtime.
• Block Pan and Zoom Operations at Runtime: When this checkbox is
checked, the user will be unable to zoom and pan on a graphic in the TSW
application.
• Autofill: Selecting a level automatically gives access to levels greater than
Required the level you selected.
Access Level • Access Level: The access level required to view this document under the
runtime.
Continued on next page
3-9
Chapter 3 Graphics Editor
Main page
This value indicates the percentage for the zoom of an image that is pasted in the
Graphics screen. Two buttons are available:
Icon Pasting • Overwrite with Current Zoom Level: Click on this button to overwrite the
Zoom Level zoom level indicated with the current zoom level of the icons.
• Restore Icon Pasting Zoom Level: Click on this button to restore the zoom
level value to what was indicated originally.
It is a section of a graphics screen in which objects will be shown all the time,
regardless of pan and zoom operations. The objects in this area will not hide any
part of the drawing. The dedicated area and the graphics screen are separated by
a red vertical or horizontal line.
Dedicated
Area
Figure 3-2. Dedicated area
• Define Dedicated Area: Enables or disables the dedicated area in the
graphics screen.
• Width: Determines the amount of space that the dedicated area will
occupy on the graphics screen. This can also be done by clicking and
dragging the red separation line on the graphics screen.
• Left: The dedicated area will be placed on the left side of the graphics
screen.
• Right: The dedicated area will be placed on the right side of the
graphics screen.
• Top: The dedicated area will be placed at the top of the graphics screen.
• Bottom: The dedicated area will be placed at the bottom of the graphics
screen.
• Splitter Color: Defines the color of the Dedicated area divider line.
• Splitter Width: Defines the width of the Dedicated area divider line.
3-10
Chapter 3 Graphics Editor
Main page In the graphics editor, click File and then Classes to display the Class Names dialog box,
where classes can be created and managed. Table 3-8 provides the explanation for functions in
the dialog box.
Delete In the Class Name list area, click to highlight the class to be deleted and then click
Delete to remove it.
In the Class Name list area, click to highlight the class that needs to be renamed
Rename
and then click Rename. An input dialog box appears prompting for a new name
Class Name A list of all classes available in the current document is displayed.
3-11
Chapter 3 Graphics Editor
Import main page In the graphics editor, click File and then Import to display the File Import dialog box where
the file can be selected. After a file is chosen, the Import dialog box is displayed. Table 3-9
provides an example of import options for a DXF format file. The user can specify on which
layer to place the imported object or import the original layers in the DXF file.
Note: Various source formats can be imported. When converting from 4190 .DAT files, the editor preserves
all information in the .DAT file except for travel keys or other information in Easel format. Importing
from 4190 .DAT files causes the following mappings:
• Type 1 Status Icons: converted to color links
• Type 2 Status Icons: converted to shape links
• Type 3 Status Icons: converted to color links
• Command Keys: deleted
• Title: converted to screen title
• Subtitle: deleted
Imported status icons containing database point references that cannot be resolved appear on the
map with a comment field showing the original point ID. The user must then resolve the links
individually.
Preserve Original DXF Layer All layers defined in the imported file are maintained.
Import all Layers to all layers defined in the imported file are combined and placed
BACKGROUND in the new screen, on the layer called Background.
The CAD line types not supported by the Graphics Editor are
Import as Solid Edge
replaced by solid lines and can be edited.
Import as Partially Supported The CAD line types not supported by the Graphics Editor are
Shape visible but cannot be edited.
Export main page The Export option in the File menu displays a window from where you can specify the
location where you want to save the file. You can enter a file name and select from AutoCAD
.DWG and .DXF file formats.
Import an existing Use the following steps to overwrite and existing screen by importing a screen that already
screen exists in the job:
1. Click File and then Import.
2. Select a screen and click OK to import it.
3. Click OK in the dialog box saying that a file under this name already exists and asking you
to change the name.
4. In the Save As dialog box select the existing screen and click Yes to overwrite.
3-12
Chapter 3 Graphics Editor
Main page Documents may be created in layers. This can ease the creation of elaborate documents. One
suggestion is to put objects associated with different classes on their own layer. In the graphics
editor, click File and then Layer... to display the Layer Control dialog box. Table 3-10
provides a description of the functions in the dialog box.
Sets the highlighted layer to the active layer. Any object drawn is drawn on
Set
the active layer.
Moves the highlighted layer to the back of the screen. All other layers will be
To Back
drawn on top of this layer.
Moves the highlighted layer to the front of the screen. This layer will draw on
To Front
top of all other layers.
Delete Deletes the highlighted layer. A prompt to confirm the deletion appears.
Rename Rename the highlighted layer. A prompt for the new name appears.
Copy the highlighted layer to a new layer. A prompt asking for the name
Copy
appears.
The objects on the highlighted layer are copied to one of the other layers
currently listed. A prompt asking for the layer to merge with appears,
Merge
followed by a prompt to delete the old layer. If Yes is chosen, the current
layer is deleted. If No is chosen, the current layer is not deleted.
3-13
Chapter 3 Graphics Editor
Manage In the graphics editor, click File and then Manage to display the Manage Documents dialog
documents dialog box which is used to manage the list of documents available for the current job. Table 3-11
box provides the explanation for functions in the dialog box.
Toggles the highlighted document as the initial screen used in the runtime.
Set Initial If a document is set as the initial screen, the name will be preceded by a *
in the list of documents.
Editor In the graphics editor, click File and then Preferences to display the Editor Preferences
preferences dialog box which is used to manage the appearance and the functionality of the graphics editor.
dialog box Table 3-12 provides the explanation for functions in the dialog box.
Put a checkmark in the Use the Template File for New Documents checkbox to
Template enable the Browse button, which is used to pick a template document.The screen is
pre-filled with objects from the template file when a new screen is created.
• Grid On: Shows the grid.
• Snap To Grid: When dragging and sizing objects, they will jump to the nearest
Spacing grid point.
• Width: Difference between grid points on the X-axis.
• Height: Difference between grid points on the Y-axis.
• Show Tool Palette: When toggled on, makes the floating Tool palette visible.
• X-Position: Determines the horizontal position of the Tools palette.
Palette • Y-Position: Determines the vertical position of the Tools palette.
• Toolbar Layout: The four available options determine the shape of the Tools
palette.
If more than one database is available, the database associated with the editor can
Database
be chosen.
3-14
Chapter 3 Graphics Editor
Main page In the graphics editor, right-click on a shape and then click Link to Command to open the
Command Link dialog box. Double-click the following options to open the Command
Configuration dialog box:
DISABLE
ENABLE
DISARM
ARM
ON
OFF
PULSE
ALARM ACK
PRIORITY 2 ACK
SUPERVISORY ACK
TROUBLE ACK
INFOR MESSAGE
Table 3-13 provides the explanation for functions in the Direct Output dialog box and the
Class Scope dialog box.
When a non-zoomable object is created (or modified) when the current zoom level is not
100%, a warning message is displayed. To verify the current zoom level, follow the steps
below:
1. Click View from the main menu of the graphics editor.
2. Click Zoom to open the Zoom To dialog box and verify the current zoom level.
For best results, any size or location changes to non-zoomable objects should be done at 100%
zoom level. This ensures that non-zoomable objects maintain relative positions if TSW is run
on different sized monitors, such as if a TSW client is run on a wide-screen laptop.
If this checkbox is selected, the command runs directly when a user during runtime
chooses this point from the graphics screen.
Direct Output If this checkbox is cleared, choosing this object at runtime highlights all objects that
are associated with the classes chosen in the Act On list mentioned below. A user
can click one of the highlighted objects and the command will affect that object.
• Act On: The list of classes used by this command object.
• Don’t Act On: The list of classes not used by this object. Act On and Don’t Act
Class Scope
On are mutually exclusive and combined represent all classes associated with
this document.
3-15
Chapter 3 Graphics Editor
Point database A dynamic link connects an editor object to a point in the 4120 Dynamic Link Operations Point
database. Dynamic links have the ability to change according to the state of a point. The
graphics system supports two types of dynamic links: color and shape links. They are directly
analogous to status icons in the 2120 Color Graphics product. They are capable of changing
color and shape respectively based on discrete value changes.
When a symbol is placed on a MAP, a dialog box appears prompting for configuration
information. The information prompted for depends upon the type of the link being added.
Usually, point linkage information must be provided.
Note: An object can be set as hidden for any of the available states.
Classes Classes are logical groupings of objects and can be used for dynamic links. When objects are
added to the .MAP file, they can be defined as part of a class, such as “Control Class”. This
class can then be referenced generically by command objects. For example, the user may want
to add some objects on the screen that represent lights in a building. By placing the objects into
a class called “Lighting Class”, the user can then add a command object that acts on all items in
that class. Classes are not exclusive. It is possible for an object to be a member of more than
one class at a time. The sections that follow describe each link type and the information that
applies to it.
3-16
Chapter 3 Graphics Editor
Command editor
Main page Command objects form the basis for programming the end user interface. Commands can
either act directly on a point or be used to activate a class of objects. In the graphics editor,
right-click on a shape and then click Link to Command to open the Command Link dialog
box which gives access to different commands. Table 3-14 provides the explanation for
functions in that dialog box.
Autofill The access level required to use this command link under the runtime.
Action List The command you have chosen, along with its parameters.
Prompt for confirmation When selected (it is unchecked by default), this checkbox provides an
before sending option to have a prompt appear before sending the command for that
command to TSW Serv Command Link to the TSW server.
Attributes Use to show the Attributes dialog box for the visual attributes of the
button.
Configure Use to show the Command Configure dialog box for the command in
the action list.
Unlink Unlink this object from the point currently associated to the object.
To choose a command to associate with the current button, double-click on the command that
will be used. This places the command in the Action List. If the command requires additional
parameters, the Command Configuration dialog box appears. You can associate a series of
commands with the same button. In a series however, some commands cannot be followed by
another command; these are the following commands:
• EXIT
• GOTO
Double click GOTO to access GOTO Options and opens a window with two options:
1. Travel to Screen/Coverage Zone
Click Select Screen/Coverage Zone to open the Travel to Document dialog box.
Select the Travel To Coverage Zone check box to select a coverage zone from the drop down
list. Click OK.
Note: An error on build occurs if the Coverage Zone is deleted.
3-17
Chapter 3 Graphics Editor
To remove a command from the Action List, double-click on the command within the Action
List.
3-18
Chapter 3 Graphics Editor
Main page In the graphics editor, right-click on a shape and then click Link to Color Change to open the
Color Change Dynamic Link dialog box which is used to associate colors with the runtime
point states of the specified point. Table 3-15 provides the explanation for functions in the
dialog box.
Designates a coverage zone that the linked point will belong to, in
Primary Coverage Zone
the case where the point appears in multiple coverage zones.
This area is used to select a point to link to this object. Type the
point name in the Name field or pick a point from the list provided
with the F2 = Pick button. If the Primary Screen for this Point
Point Linkage
checkbox is checked, it is possible to jump to the primary screen
automatically if a point is activated at runtime. Refer to “Appendix A”
for more settings information.
• Autofill: Selecting a level automatically gives access to levels
greater than the level selected.
Required Access Level
• Access Level: The access level required to view this document
under the runtime.
Graphic Linkage Displays the shape and color of the object.
The list of possible states is defined here. The settings are modified
by double-clicking in the appropriate column.
Column 4 determines the actual color that you can select or set
from the color palette.
3-19
Chapter 3 Graphics Editor
Main page In the graphics editor, right-click on a shape and then click Link to Shape Change to open the
Shape Change Dynamic Link dialog box which is used to associate shape with the runtime
point states of the specified point. Table 3-16 provides the explanation for functions in the
dialog box.
Note: The Link to Shape Change option is visible after multiple objects have been grouped together by
clicking on the Edit menu option and then on Group.
Designates a coverage zone that the linked point will belong to, in the
Primary Coverage Zone
case where the point appears in multiple coverage zones.
This area is used to select a point to link to this object. To select a point,
type the point’s name in the Name field or pick a point from the list
provided with the F2 = Pick button. The Primary Screen for this Point
Point Linkage
checkbox allows you to automatically jump to the primary screen if a
point is activated at runtime. Refer to “Appendix A” for more settings
information.
• Autofill: Selecting a level automatically gives access to levels
greater than the level selected.
Required Access Level
• Access Level: The access level required to view this document
under the runtime.
Displays the shape and color of the object. It also changes the order of
Graphic Linkage
shapes in the group.
The list of possible states is defined here. The settings are modified by
double-clicking in the appropriate column.
Column 4 determines the actual color that you can select or set
from the color palette.
Shape Control The buttons are used to loop through the shapes in the group
3-20
Chapter 3 Graphics Editor
Coverage zones
Defining coverage In the graphics editor, click File and then Coverage Zone to display the Coverage Zones
zones dialog box which is used to define coverage zones. Table 3-17 provides the explanation for
functions in the dialog box.
Note: The Touch Size feature must be enabled (click File and then Attributes) to enable the Coverage
Zone function.
Add Click Add to enter the name for a new coverage zone.
Note: When first created, the coverage zone square is grey, indicating that the zone is not
visible on the graphic. The square is green if the zone is visible.
Show All This button makes all coverage zones visible on the graphics.
Delete This button is used to delete a selected coverage zone from the list.
Hide This button makes a selected coverage zone invisible on the graphic.
Linking points After a coverage zone has been defined, you can link it to specific points by following the steps
below:
1. On the graphic, draw a rectangle over the points to be covered.
2. With the rectangle selected, click the Link To menu and click the Coverage Zone option.
All linked points within the selected rectangle will belong to the specified coverage zone.
3. In the Coverage Zone Link dialog box, select a zone from the Available Coverage Zones
drop down list and click OK.
Points that are linked to a coverage zone are listed in the Assignments box of the Coverage
Zones dialog box.
3-21
Chapter 3 Graphics Editor
Multi-Point Device In the case of a multi-point device, it is allowed to have one icon represent multiple points,
Link instead of one icon for each point. In the graphics editor, this icon is allowed to link to multiple
color or shape links. Once the icon is linked to multiple points, the Unlink option in the Link
To menu will contain a sub-menu lists all the linked points. Clicking on the icon opens a list of
all points associated with the icon. Selecting one point shows the point status and control
dialog box for the point.
Graphics keys
Table 3-1
Drawing Keys File Control Keys Editing Keys Zoom and Pan Keys Rotation Keys Z-Order Keys
Ctl+Up Arrow or
Ctrl+N:
Alt+A: Ctrl+X: Ctl+Mousewheel Ctl+F:
Create a new <: Rotate left
Draw an arc Cut to clipboard backward: Brong object to front
document
Zoom out
Ctl+Down Arrow or
Ctrl+O:
Alt+B: Ctrl+C: Ctl+Mousewheel Ctl+B:
Open an existing >: Rotate right
Draw a bitmap Copy to clipboard forward: Send object to back
document
Zoom in
Ctrl+A:
Ctl+”-” (minus):
Alt+G: Save the current Ctrl+S: Down Arrow:
Alt+V: Flip vertical Move object down in
Draw a polygon document under a Save to disk Pan down
Z-order
different name
Ctrl+L:
Alt+N: Invoke layer Shift+*:
Right Arrow: Pan right
Draw a line management dialog Select all objects
box
Ctrl+M:
Alt+Return:
Alt+M: Invoke manage
Invoke shape Left Arrow: Pan left
Draw a metafile document dialog
editor dialog box
box
Alt+O:
Ctrl+I: Ctl+G: Ctrl-D:
Draw a rounded
Import a document Group objects Toggle grid ON or OFF
rectangle
Alt+P: Ctl+U:
Use pointer tool Ungroup objects
Alt+R:
Draw a rectangle
Alt+X:
Draw text
Alt+U:
Draw a button
Alt+Z:
Draw a spline
3-22
Chapter 3 Graphics Editor
Capacities
Maximum number of screens Limited to 65535 screens (or by disk size)
Directory All files created by the editor and used by the runtime are identified on the disk by a unique
Hierarchy and File three letter extension. The files are arranged in a hierarchy which facilitates sharing screens
Name Extensions across nodes in a network environment.
In-Use Copies vs. The directory structure described below refers to the in-use copy of each particular file. Each
Edit Copies component subdirectory in the hierarchy contains a TEMP subdirectory. This directory is used
to hold the 'Edit' copy of the graphics files. The 'Edit' copy of the graphics files becomes the 'in-
use' copy when the build operation is performed from the TSW Configurator. The graphics
editor allows the user to selectively edit either copy.
3-23
Chapter 3 Graphics Editor
Directory and file The sample system shown below illustrates the file and directory hierarchy used by the editor
hierarchy and the runtime:
NETJOBS Network Directory
3-24
Chapter 3 Graphics Editor
3-25
Chapter 3 Graphics Editor
Monitor status The following sections describe the color defaults for Dynamic Link Objects.
Note: By default, the Disabled state is inactive. At runtime, it will be treated simply as trouble and change to
the Trouble color. If you activate the Disabled state, then the default color is orange (see Table 3-18,
Table 3-19, Table 3-21, Table 3-24, and Table 3-25). The color can be changed.
3-26
Chapter 3 Graphics Editor
3-27
Chapter 3 Graphics Editor
3-28
Chapter 3 Graphics Editor
AutoCAD entity The following AutoCAD entity types are supported by the Graphics Import utility:
types
• LINE
• POLYLINE
• CIRCLE
• ELLIPSE
• ARC
• SOLID
• LWPLINE
• TEXT
• MTEXT (if not rotated)
• INSERT (if all entities in the block are supported)
• IMAGE (if originated from bitmap)
3-29
Chapter 3 Graphics Editor
Controlling the In the TSW, 100% screen zoom level means showing and centering the whole screen regardless
appearance of the of display resolution, window size, or width/height ratio. By default, the screen default zoom
runtime screen level for any screen is set to 100% for upgraded DOC screens, imported DOC screens,
imported .DWG/.DXF files, and screens created in the graphics editor.
It is recommended to leave the screen default zoom level at 100% so that at the runtime, when
a screen is loaded with the 100% screen default zoom level, it is stretched to fit the runtime
window.
Note: At runtime, because of a different font size, toolbar size, or changing to another graphics window
mode (fixed, floating, dockable), the graphics window size will vary. Usually, the runtime graphics
window is smaller than the one in the configurator. This will make the absolute screen/drawing size
smaller than in the graphics editor, and extra empty space on sides of the runtime graphics window
may be visible. In order to match the runtime graphics screen as close as possible with the editor,
either resize the runtime Graphics window to be close to the editor or to make the width/height ratio
of the runtime Graphics window to be close to the editor.
For objects that can’t be zoomed in on, they always stay at the same position relative to the window
size (not bounding rectangle).
Set document After Importing a .DWG file into the graphics editor, the Document Extents defaults to the
extents after DWG current display resolution. The Document Extents determines the absolute location of non-
import zoomable objects in the graphics window. It can be changed it by invoking the Document
Attributes dialog box from the File menu.
Controlling icon As the icon size will change when zooming in or out, set the screen to the appropriate zoom
size when level before pasting icons. At runtime, the icon will be displayed approximately in the touch
duplicating size that is specified for the screen when auto jump occurs or its associated coverage zone is
selected.
Command button When upgrading IMS graphics screens, the zoomable attribute is enabled for each command
visibility button. To ensure that command buttons are always visible at runtime when zooming in or out,
change the attribute to non-zoomable.
For best results, it is recommended that whenever non-zoomable buttons are placed outside the
dedicated area, the IMS screens set the Document Attributes option to block Pan & Zoom
operations at runtime. In order for the buttons to maintain relative position, the IMS screens
must always stay at 100%. If a screen does not block Pan & Zoom operations at runtime, all
non-zoomable objects should be placed in the dedicated area.
Note: Non-zoomable objects must always be positioned at 100% zoom level to maintain relative positions
on different sized monitors.
Maintaining the The zoom level can inadvertently change if objects are added beyond the current drawing
current drawing extents.
area
To avoid this, start by drawing a bounding rectangle (invisible or hollow with no edge) and
then draw all objects in the rectangle.
Sequence for When creating new screens, in order to achieve the best result, the following steps are
creating new recommended.
screens
1. Prepare CAD drawing according to the Screen Writing Guidelines.
2. Import CAD drawing to the graphics editor.
3. Check the document extents to be the one you want to work with.
Continued on next page
3-30
Chapter 3 Graphics Editor
Sequence for 4. Draw a bounding rectangle from the bottom left corner to the upper right corner. Refer to the
creating new preceding section “Maintaining the current drawing area”.
screens
5. Add Command and Travel buttons within the dedicated area.
6. Enable Touch Size feature, define and add Coverage Zones.
7. Determine the zoom level in which the point link icons will be pasted (this can be done by
zooming window into a coverage zone area) and then obtain the zoom level at that stage. Go
to Attributes dialog box and click Overwrite with Current Zoom Level to remember this
zoom level. Before pasting the icons, go to the Attributes dialog box and click Restore
Icon Pasting Zoom Level to zoom to this level to ensure icons are in the same size.
8. Start to copy and paste icons at the selected zoom level.
Moving selected The Editor Preferences dialog box needs to be opened by clicking on the File menu and then
objects with the on the Preferences option. When the Snap to Grid checkbox is checked, objects will move to
keyboard arrow the nearest grid point. When the Snap to Grid checkbox is unchecked, the move increment is
keys based on “DrawingunitIncrement” value specified in the Gred.ini file. This value can be
adjusted by using the + or - keys on the keyboard and each move increment value must be at
least one pixel.
Note: When a large screen is viewed at lower zoom levels, the drawing units are very dense. In this case,
the calculated move increment can be less than one pixel. As a result, objects cannot be moved by
selecting them and using the arrow keys of the keyboard. To work around this issue, zoom into the
screen until the grid is visible or until the objects can be moved.
Copying and When copying objects from one graphics screen and pasting them to another, the Document
pasting objects Extents and Dedicated Area size/location must be the same on both graphics screens.
from one screen Otherwise the objects appear deformed. Avoid copy/paste of already linked icons.
to another
3-31
Chapter 4. Configuring TSW Remote Client and TSW
Workstation for client operation
Procedure 1. Add a TSW (server) PC and Remote Client PCs onto customer’s LAN or dedicated Fire
Alarm LAN. Refer to “Appendix A” and the “TrueSite Workstation Client/Server
Worksheet” in Chapter 3 of document 579-834: TrueSite Workstation Installation &
Checkout Instructions.
a. Give the necessary PC details to the customer’s IT department. Examples of those
details may be the OS, the computer manufacturer or the model.
b. Get the IP-address and/or the computer name to be used by the DHCP.
2. If using a TR dongle and working on the TSW (server) PC, log on to the TSW Configurator
as a Level 7 user.
3. Click the Hardwares workspace pane option and then click TCP/IP in the hardwares list.
Note: If the TCP/IP option is not already in the hardwares list, it needs to be added by clicking on the
Add button and then selecting TCP/IP from the Select Hardware dropdown list in the
Hardware Configuration dialog box.
4. If supervised clients will be connecting to the TSW (server) PC, put a checkmark in the
Supervised Remote Client(s) checkbox and enter the description for each supervised
client in the Supervised Remote Client(s) tab. Click OK when finished.
5. Click the Access Controls workspace pane option and set the access levels to Client access
allowances for each type of client.
6. Click the Connection Passcode workspace pane option and enter the new passcode for the
client to server connection. Click OK when finished.
Note: The Ctrl+B keyboard key combination can be used instead of the Build function.
8. When the build is complete, save the job and exit the TSW Configurator.
9. Launch the TSW Runtime application on the TSW (server) PC and login as a Level 7 user.
11. In the Feature Control dialog box that appears type the feature code that has been
supplied with the order paperwork. Click OK when finished.
12. Click File on the menubar and then click Administrator’s Settings.
13. In the Administrator’s Settings dialog box, select which set of features to unlock when
using the TR dongle. Click OK when finished.
14. Launch the TSW Remote Client application on the TSW Remote Client PC.
4-1
Chapter 4 . Configuring TSW Remote Client and TSW Workstation for client operation
Procedure 16. In the Application Setup dialog box that appears, click the Operation tab.
17. Select either the Supervised Remote Client or the Non-Supervised Remote Client
option.
18. If configuring the Remote Client to auto-connect to the TSW PC, click the Auto-connect
tab. Then:
a. Enter the server IP-address or computer name in the Workstation Identifier area.
b. Enter the TCP/IP port to be used for communicating in the TCP/IP Port area. This port
number is usually 8831.
c. Enter the connection passcode for the client in the Connection Passcode area.
d. Click Enable Auto-connect to the test the connection.
20. Click File in the Remote Client application and then click Connect.
21. In the Connect window that appears, make sure the contents of the Workstation
Identifier, TCP/IP Port and Connection Passcode areas are correct. Click Connect.
22. If the Remote Client PC is supervised select which client this computer corresponds to,
when prompted.
You have now successfully configured the TSW Remote Client and TSW Workstation
applications for client operation. You have also tested that configuration by logging-on the
Remote Client application and connecting it to the TSW application located on the TSW
(server) PC.
Note: The TR dongle is for temporary use only. Customer or TrueSite Graphic Annunciator dongle must be
in place for normal customer use. See document 579-835: TrueSite Workstation Operation and Appli-
cation Instructions for details on Customer or TrueSite Graphic Annunciator dongles.
4-2
Chapter 5. TFXnet Editor
Introduction The TFXnet Editor is used to make final adjustments to the converted data after a FireGraph
conversion. For details about the conversion and limitations of the converted job, refer to
document 579-1035. The configuration changes will only affect the TSW. The TFXnet Editor
does not replace the Autocall CONSYS tool or have any effect on FireGraph or TFX products.
The TFXnet Editor can be used to make point configuration changes to the TFXnet point
representations available for externalizing in the TSW, such as changing a TFX point’s custom
label or its point type, if the default one is not suitable. It can be useful, for example, in a case
where a job site is under frequent change (e.g., walls are moved, interior building spaces are
renamed, devices are added or removed, etc.).
In addition, the TFXnet Editor is used to modify the mapping of the FireGraph priorities to the
TSW. The tool also allows you to adjust event code to FireGraph event class mapping.
The TFXnet Editor shows TFXnet information from a Grab-It point of view. Thus, the shadow
node for the TSW can be viewed and its points modified from the TFXnet Editor.
The Network Programmer shows the TFXnet from the point of view of the TSW. Thus, the
shadow node cannot be viewed from the Network Programmer. Instead, the TSW resulting
from the FireGraph conversion is the node shown.
The TFXnet Editor can also be used to modify subnet settings and network parameters for the
TSW.
Navigation ................................................................................................................................5-2
Menus .......................................................................................................................................5-3
5-1
Chapter 5 . TFXnet Editor
Navigation
Starting the Once the FireGraph job conversion is done, the TFXnet Editor can be launched using one of
TFXnet editor three following ways from the Network Programmer’s Job Directory (nodes view) window:
1. In the main menu, click Job and then Edit TFXnet.
2. Right-click for the context menu and select Edit TFXnet.
3. If the nodes are unconverted FireGraph nodes or TFX nodes, double- one of them.
Note: If a Simplex 4100U/4100ES panel with a TFXi card was part of a FireGraph Grab-It project, then after
the job conversion it is presented as a TFX panel node by the TFXnet Editor and the Network
Programmer.
Navigating the Depending on the type of node selected in the top part of the screen, different sub-windows can
TFXnet Editor be accessed in the left column of the window.
If a TFX panel is selected, the following menus are accessible:
• Points
• Event Codes to Classes
Figure 5-1. Available Menus in the Left Panel when Selecting a TFX Panel
If the shadow node for TSW, or an unconverted FireGraph node, is selected, the following
menus become available (“Shadow” is displayed with the Node Type in parentheses. See
Figure 5-2):
• Points
• FireGraph Priorities to TSW Response
• TFXnet network parameters
• TFXnet Subnet
• Event Codes to Classes
• Controls
Figure 5-2. Available Menus in the Left Pane when Using a FireGraph Point
When one of the menus of the left pane is selected, the arrow keys can be used to go up and
down to select a different menu item. Once a menu item has been selected in the left pane, the
right pane automatically refreshes to show the selected topic.
5-2
Chapter 5 . TFXnet Editor
Menus
Points view When the selected node is a TFX panel, the Points View shows the points belonging to the
panel.These are treated as public points that ca be selectively externalized in the TSW using the
TSW Configurator. The attributes of the public points can be edited in Points View.
When the selected node is a TSW shadow node, the TFXnet Editor’s Points View presents a list
of all of the shadow points belonging to the obsolete FireGraph node, replaced by the TSW.
Notes: 1. Shadow points are used to annunciate specific status of the TFXnet at the TSW, namely:
• Network communication faults
• Panel offline troubles
2. The shadow points are also used in the TSW’s implementation of alarm silence, system reset,
and manual evac.
FireGraph When the selected node is a TSW shadow node, the mapping of FireGraph priorities can be
priorities viewed and modified to correspond to TSW response.
mapping
FireGraph priorities organize TFX event codes into categories of ordered importance. The
quantity of FireGraph priorities, their textual descriptions, and their numeric ranking can differ
across FireGraph jobs, since they are configurable in Grab-It.
The list of priorities is migrated over from the Grab-It configuration as part of the conversion
process. From the priorities edit workspace, the way event codes for each category are handled
at runtime by TSW can be changed by choosing from a list of TSW responses.
Notes: 1. The content of the priorities workspace (i.e., the list of priorities displayed) are the priorities
defined in the Grab-It project file set for the FireGraph job converted.
2. An initial mapping of Priority to TSW Response will be determined during the conversion process.
IMPORTANT: The person configuring the job must have the proper knowledge of the desired runtime
operation when setting up the mapping of FireGraph priorities to TSW response.
Neither the TFXnet Editor nor the TSW Configurator will error-check.
5-3
Chapter 5 . TFXnet Editor
Menus, continued
TFXnet network When the selected node is a TSW shadow node, the network-related parameters used by the
parameters TSW’s TFXnet network driver can be viewed or modified.
The values for these parameters are set to defaults as a result of the FireGraph conversion. The
network parameter settings will not be converted automatically, since they are not kept in the
Grab-It project file set. The values can be changed.This information can be found in CONSYS,
except T1 timeout which can be found in the TFXi configuration. For more information, refer
to section “4.2.4 - Edit Network”, document 850-463.
TFXnet subnet For subnet editing, the workspace in the pane to the right provides checkboxes to
select/de-select TFXnet node numbers, ranging from 1 to 62, to compose the subnet associated
with the selected TSW shadow node. For more information, refer to the Project Details Table,
document 850-463.
Note: The TFXnet Editor error-checks that the node numbers are actually configured or in use.
5-4
Chapter 5 . TFXnet Editor
Menus, continued
TFX event codes When the selected node is a TFX panel, it is possible to view the Event Codes and how they
to class mapping map to FireGraph Event Classes. For more information, refer to the sections on Panel File
(*.pnl), Event File (*.evt), and Style Files (*.sty) of document 850-463.
At the TSW
The mapping of TFX Event Codes to Classes is used at runtime by the TSW’s TFX event-code-
processing logic to interpret an incoming TFX event code and to cause the expected state
change on the TFX point represented in the TSW.
The TFX Event Codes to Classes workspace can be used to change the event code to class
association, by providing a drop-down list of valid FireGraph Event Classes to associate with
an event code. The selection list of valid FireGraph Event Classes contains all Event Classes
defined for the FireGraph job.
Usually the Event Codes to Class mapping brought forward from the Grab-It project does not
have to be modified.
Note: Changing the Event Class associated with an Event Code may change the Event Code to Event
Class mapping for other nodes on the TFXnet, depending on how the Event Codes were set up in the
Grab-It project.
However, this mapping needs to be updated if a new device tied to a previously unused User
Event Code at a TFX pane is added. To update the mapping:
• Using the TFX CONSYS programmer, assign an event to one of the unused User Events
and associate it with the new point.
• Add the device as a new point belonging to the TFX panel, using the TFXnet Editor. To
add a point:
1. In the Points menu, click Edit and then Add.
2. Fill in the Address, the TFX Device Type, the Style, the Device Point, the Point Type,
and the Custom Label fields.
• Assign an event class to the same User Event Code for that TFX panel, from the Event
Code to Classes workspace.
5-5
Chapter 5 . TFXnet Editor
Menus, continued
Controls When the selected node is a FireGraph (shadow node or unconverted FireGraph), view and
modify the configuration settings of the FireGraph controls used for issuing Alarm Silence,
System Reset, and Manual Evac from the TSW. During the FireGraph job conversion, the
attributes for these three controls are not converted, but instead are set to default values. For
more information, refer to the Controls section in Appendix C.
IMPORTANT: If changing any of the Group, the Rising Event, or the Falling Event values
in Grab-It, those same values need to be changed in the TFXnet Editor.
Note: There are two entries for the LB0 S3 address in case you select System Reset from the TSW without
first selecting Alarm Silence (the selection order is important for the TFXnet).
Group
Choose from list of groups or event codes brought forth from Grab-It project
Rising Event
file set for the FireGraph job.
Falling Event
Check on or off
Latching Latching defaults to “not checked” for Alarm Silence and System Reset.
Latching defaults to “checked” for Manual Evac.
Notes: 1. If renumbering a TSW shadow node, the Detach FireGraph window will be displayed. Click Yes to
confirm the renumbering.
2. If renumbering a TFX node or an unconverted FireGraph node, the window will not be displayed.
3. If renumbering an unconverted FireGraph to the same node as the TSW, the Attach FireGraph
confirmation dialog will be displayed.
5-6
Chapter 5 . TFXnet Editor
Editing features
Copy node The TFXnet Editor will refresh the top part of the screen.
A 4100U/4100ES-TFXi node or a TFX panel can be added to the TFXnet configuration after
the FireGraph conversion, by copying an existing TFX node. The new node will look like a
TFX node and is editable from the TFXnet Editor. Addressable points have to be added
manually in the points workspace of the resulting node.
To copy a node:
1. Select a node in the top section of the screen
2. Select Edit and then Copy Node...
3. In the Copy node window, fill in the fields Node Name, Node Description, and select a
Node Type. Click OK when finished.
The node type of the new node to be created can be changed. The node numbers to copy is
restricted to available nodes for the TFXnet network, in the range of 1 to 62.
Note: “Copy Node” is disabled whenever a row is being edited in the bottom right pane or when you are
renumbering a node.
The new node created contains the following configuration information from the node being
copied:
• Non-addressable points (Addressable points from the origin node are not copied to the
new node. Addressable points must be added manually in the Points View).
• The Event Codes to Classes mapping.
5-7
Chapter 5 . TFXnet Editor
Insert and delete The Insert key from the keyboard is a shortcut that allows you to add a point. When in the
Points view, pressing the Insert key will automatically add a row for a new point. The Delete
key from the keyboard is a shortcut that allows you to delete a point. When a row is selected in
the Points view, pressing the Delete key will make the Delete Points window pop up, asking to
confirm your action.
Making field edits In the Points view, when adding or modifying a point, all fields must be correctly filled in.
• A new point cannot be saved if information is missing or invalid.
• An edited row cannot be exited until the row is correctly filled in. To leave the row, you
have to press the Esc key. If you were adding a point, the row will be deleted.
• If need to cancel the addition of a point because some information is missing or invalid
(the invalid row will be identified with a white exclamation point in a red circle), select the
row and press the Esc key.
• If the error cannot be understood, place the cursor over the exclamation point. A note will
be displayed indicating the detected problem.
Note: Until all the edited rows are correctly filled in, the Add and Delete features will be disabled.
To edit a field, double click on the appropriate field. Depending on what is required as a value,
either enter text or select the appropriate choice in a drop down menu.
5-8
Chapter 6. Configuring TSW for ULC Listed Systems
Configuring a job When you configure a TSW job for a ULC listed system, you must set the following options:
• System Options/Preferences - select both Auto Jump and Always Jump to Active List.
• System Options/Operations - select Annunciate Common Troubles in order to detect
ground faults.
• Color Definition: Set the background color to yellow for both Priority2 and Supervisory.
Do not change Alarm (Red) or Trouble (Yellow).
• Must resound for alarms that are not cleared within 24 hours.
Add external reminder points P233, P234, P235, and P236 to the TSW job from ES
Panel nodes.
• Do not add any external security points to the TSW job. TSW is not yet approved for
Canadian Security Listings.
• On networks with voice evacuation, no control is allowed at any access level.
For Access Controls/Operator Access/Runtime/System Wide functions, turn off Alarm
Silence, System Reset, and All Acknowledge functions at all access levels.
• On networks without voice evacuation, limited control (Acknowledge, Silence, Reset) is
allowed at access level 2 or higher.
6-1
Appendix A. Advanced configuration with gred.ini
The gred.ini File The file gred.ini contains settings specific to the IMS/TSW graphics editor (GRED) and
runtime graphics, with both TSW and IMS using the same sections of the file. Table A-1 lists
some options that can be configured in the file.
IMPORTANT: Back-up the gred.ini file prior to making any changes to it.
sos.ini file The file SOS.ini file contains settings specific to the IMS/TSW Configurator and Runtime
applications. Table A-2 lists some options that can be configured in the file.
IMPORTANT: Back-up the SOS.inifile before you make any changes to it.
BackUpLogs=TRUE/FALSE
By default, when the number of historical jobs stored in the backup
directory reaches the maximum, old historical jobs are overwritten.
This is an alternative option to back up old historical logs to the job
runtime directory under RUNTIME\log\backup. Set this option to TRUE
before you start the TSW server.
Under Section
[GCC32] TSW also generates an XML file of each volume backed up to the direc-
tory, with the same filename and a .xml extension. If there are more than
100 log files backed up to the directory, the TSW displays a warning mes-
sage to the user every 24 hours.
Note: If the user receives a deleting existing Historical Log volumes warning,
and proceeds with the build, all of the log volumes are removed. The XML
files are not removed.
A-1
Appendix B. Filling TSW lists
Overview The TSW lists, L0-L58 require manual addition of external points on 4100 nodes. The lists
should be filled with a careful understanding of the operations and behaviors desired in TSW
and 4100 nodes. The following is a general description of the steps needed to fill these lists.
Individual job sites may need to modify their configuration from this general case to achieved
expected operations.
Phone Circuits, Speaker Circuits (L90 can autogen), A113, A48, A56, A94, P34, P35, P36,
P37, P38, P48, P85, P86, P87, P89, P90, P92, P93, P95, P96, P98, P99, P101, P102, P104,
P105, P107, P108, P110, P111, P113, P114, P116, P117, P119, P120, P122, P123, P125, P126,
P128, P129, P131, P135, P137, P141, P143, P144, P145, P152, P153, P156, P189, P204(s),
P212(s), P217(s), P220(s), P223, or P83 or P84
In the TSW Configurator, bring the above points in as external points, and add them to the lists
shown in Table B-1.
Note: L6 to L52 should be filled with points from VCC nodes only. L8 should not be filled.
B-1
Appendix B. Filling TSW lists
B-2
Appendix B. Filling TSW lists
B-3
Appendix C. Configuring for TFXnet support
Introduction Once properly configured, the TSW can monitor external points from the TFXnet.
Note: It is not possible to make TSW points public to the TFXnet for another node to monitor.
Terminology Designated Receiving Unit (DRU): A node on TFXnet that has been designated to receive
TFXnet events and messages for display and/or acknowledgement. The TSW system can
serve as a DRU for a TFX panel sending point events to the TSW. It is not possible to
configure a TSW to send events over TFXnet to a DRU.
Shadow Node: After running the FireGraph Conversion Wizard, the converted FireGraph
node configuration is referred to as the “shadow node” of the TSW. The shadow node is not an
independent physical node on the TFXnet network, but is the TSW’s conceptual tie-in to the
TFXnet and the TFXnet way of handling things. The TSW and its shadow node have the same
node number when viewed from the configuration tools. The shadow node cannot be viewed
at TSW runtime.
Shadow Points: “Shadow points” refer to local, system points built into the FireGraph node,
(which was replaced with the TSW node) that are re-used by the TSW for TFXnet operation.
The FireGraph Conversion Wizard converts the points and makes them available to the TSW
Configurator for tagging and importing into the TSW.
Adding a TFXnet In order to set up a TSW to support the TFXnet, it is mandatory to run the FireGraph
port to the TSW Conversion Wizard on a FireGraph's Grab-It project, since it is impossible to manually add a
TFXnet port using the TSW Configurator.
For more details on Job conversion, refer to document 579-1035: FireGraph to TrueSite
Workstation Job Conversion Manual.
Deleting the Deleting the TFXnet network port also deletes points that were externalized from the TFXnet
TFXnet port and action message references to the deleted external points.
! WARNING: Once you delete the port, you will not be able to re-establish it.
C-1
Appendix C. Configuring for TFXnet support
Configuring Use the TSW Configurator to change the COM port used by the TFXnet port/card after the
settings for the conversion. Follow the steps below:
TFXnet port/card
1. In the TSW Configurator, click Hardware and then select the TFXnet network port.
Note: For information on how to change additional TFXnet port/card parameters, refer to section “TFXnet
network parameters ” in Chapter 5.
Baud rate, parity, data bits, stop bits will be non-configurable and
therefore not displayed.
For more details on Job conversion, refer to document 579-1035: FireGraph to TrueSite
Workstation Job Conversion Manual.
Mapping external After the conversion, you can review the TFX panel or the FireGraph points available for
TFX points and mapping using the TFXnet Editor. The converted device type, point type and/or custom label of
shadow points to a TFX point can be modified using the TFXnet Editor.
the TSW
Notes: 1. For more details on how to add external TFX points or a shadow point to the TSW, refer to the
“Adding points ” section in Chapter 2.
2. The node number used to identify the shadow node from the Add Externals dialog will be the
same as the node number of the TSW replacing the FireGraph. Once a shadow point is
externalized, the TSW Configurator represents the point the same way it represents an external
TFX point.
Configuring IMPORTANT: For more details on the graphic editor, refer to Chapter 3: “Graphics Editor”.
graphics
1. Importing FireGraph Graphics Maps
The AutoCAD .DWG or .DXF files used in the FireGraph Grab-It project must be manually
imported.
C-2
Appendix C. Configuring for TFXnet support
5. Cause Alarm Points from Different JobSite Areas to Display in Different Colors
This allows the graphics device icons to have a distinctive color for the different job site areas
when they go into alarm. However, the banner buttons, active lists, and acknowledge boxes use
the colors of the alarm categories.
To configure graphic color-links for device icons from the graphics editor:
1. In the graphics editor, select an individual device from building area A. Choose an
identifiable color scheme for its color-links.
2. Repeat step 1 for remaining devices, one-by-one, from building area A.
3. Select an individual device icon from building area B. Choose an identifiable color scheme
for its color-links.
4. Repeat step 3 for the remaining devices, one-by-one, from building area B.
Converting The Conversion Wizard can convert only one FireGraph node. To convert a secondary
secondary FireGraph node at a multi-FireGraph job site, you need to make a copy of your job using the
FireGraph to TSW TSW Configurator’s Save As function. Follow the steps below:
using Save As
1. Choose the FireGraph node which best represents the job site and run it through the
Conversion Wizard.
2. Manually finish the TSW configuration by tagging external TFX points, importing the
graphics DWG/DXF files, assigning dynamic links to graphics objects, setting up for Alarm
Silence, System Reset, etc.
3. Once the configuration is done, click File and then Save As in the TSW Configurator to
duplicate the converted TSW project to stand as the replacement for a remaining FireGraph
node at the site.
4. Type in a new name and specify the node number of the FireGraph to overwrite.
Note: The TSW Configurator’s Save As (Make New Copy) feature cannot be used to create a TSW node at
a job site where a FireGraph did not exist before.
C-3
Appendix C. Configuring for TFXnet support
Renumbering the If renumbering the FireGraph node, the TFX panel may need to be re-programmed for the new
TSW node TSW address.
If renumbering the TSW node, all TSW nodes on the 4120 network must be rebuilt and
re-downloaded.
If it is absolutely necessary to renumber a TSW after the conversion:
1. Use the TFXnet Editor to renumber the shadow node of the TSW to an unused node number
i. Select the FireGraph in the Node Number combo box of the main window.
ii. Select Edit and then the Renumber Node... menu.
iii. Select a free number in the New node number combo box and click OK.
iv. Click Yes in the Detach FireGraph window.
v. Select File and then the Save option. Click Exit when the save is complete.
Note: When the shadow node is detached, it becomes a normal FireGraph node. Any shadow points in the
TSW become external from the normal FireGraph.
2. Use the TSW Configurator’s Save As option to rename and renumber the TSW node to the
same node number used in Step 1.c, as well as to rename the TSW and return it to the
original name. For more details, refer to section “Converting secondary FireGraph to TSW
using Save As ”.
Note: Any external points from the FireGraph node now become shadow points for the TSW.
When a TFX Panel When a different TFXnet node is configured as the “network supervisor” for TFXnet, the TSW
is the TFXnet cannot be set as the Master Timekeeper. To verify the TSW’s Master Timekeeper settings:
supervisor
1. In the TSW Configurator, click System Options.
2. In Operations, ensure the Master Timekeeper checkbox is unchecked.
In order to annunciate node missing status in this configuration, the points from the Network
Supervisor node must be externalized at the TSW. Using TSW Configurator’s point
configuration editor, select points shown in Table C-2 and externalize them in the TSW job.
For details, refer to section “Mapping external TFX points and shadow points to the TSW ”.
Table C-2. Points from Network Supervisor Node to Externalize to Annunciate Node
Missing Status
Meaning
Point Address
Note: custom label varies by job
C-4
Appendix C. Configuring for TFXnet support
Making TSW the The TSW serves as the “network supervisor” for the TFXnet when the TSW job is built with
TFXnet the Master Timekeeper setting selected. To verify the TSW’s Master Timekeeper settings:
supervisor
1. In the TSW Configurator click System Options.
2. In Operations, ensure the Master Timekeeper checkbox is checked.
When the TSW is configured as the TFXnet network supervisor, the TSW broadcasts a
Network Status Enquiry to all TFXnet nodes at regular intervals.
Note: The interval can be configured using the TFXnet Editor, as a Supervision Option. If the TSW does not
send Network Status Enquiry messages to a TFX panel within the time bounds, the TFX panel will
report an “unsupervised panel” fault.
IMPORTANT: The TSW Configurator cannot error-check whether there are multiple TFXnet nodes set
as the “network supervisor.” It is the responsibility of the person configuring the job to
ensure that only one node is configured.
Shadow Points for TFXnet Node Missing Status (when the TSW is the network supervisor):
In order to annunciate node missing status, when the TSW is serving as the TFXnet Supervisor,
the TSW must be configured with shadow points. Using the TSW Configurator’s point
configuration editor, select the shadow points shown in Table C-3 and externalize them in the
TSW job. For more information, refer to section “Mapping external TFX points and shadow
points to the TSW ”.
Meaning
Point Address
Note: custom label varies by job
Making the TSW In order to annunciate TFXnet port and card status, the TSW must be configured with shadow
monitor TFXnet points. Using the TSW Configurator point configuration editor, select the shadow points shown
port and card in Table C-4 and externalize them in the TSW job. For more information, refer to section
status “Mapping external TFX points and shadow points to the TSW ”
C-5
Appendix C. Configuring for TFXnet support
Meaning
Point address
Note: custom label varies by job
Meaning
Point address
Note: custom label varies by job
MP P17 NET Ring Cont’ Fault TLI reported degraded style 7 fault
Note: If you want a Pri2 Reset to cause a System Reset on TFXnet, add the System Reset point (LB0 S3) to
the local TSW list L2.
The configuration steps for adding points to system lists are the same for the TSW, whether for
TFXnet or the Simplex 4120 network.
C-6
Appendix C. Configuring for TFXnet support
IMPORTANT: Since there is no feedback from panels on the TFXnet that a manual evac is
in progress, the TSW only visually indicates that a request for a manual evac
was sent out over TFXnet.
Isolate / De- Disabling a TFX point from the TSW causes the point to be isolated at the TFX panel.
Isolate a point Enabling a TFX point from the TSW causes the point to be de-isolated at the TFX panel.
If a TFX point is configured with a Simplex point type supporting the disabled state, when the
point is isolated at the owning TFX panel, the point will be in the Trouble active list, and the
primary state will be displayed as “disabled”.
!
WARNING: Re-enabling the point causes it to flash (needing to be acknowledged) in the
Trouble active list, in an individual acknowledge system.
For more information, refer to the topic Isolate/De-Isolate a group of TFX points from TSW
Graphics in the section “Workarounds for FireGraph features not directly supported in TSW ”
within this chapter.
C-7
Appendix C. Configuring for TFXnet support
At runtime, the pre-alarm event code should cause the pre-alarm point to appear in the Pri2
Active List. The alarm event code should cause its companion point to appear in the Fire
Active List.
The TSW supports TFX point isolate/de-isolate as disable/enable operations. The TSW is not
aware of TFX zones or groups. The following are solutions:
• Link the command button with the disable function to the graphics class of points (see
Class Scope in the section “Command Configure dialog box ” in Chapter 3).
• Link the command button with the disable function to the list of points (see Direct Output
in the section “Command Configure dialog box ” in Chapter 3).
Note: For more details on how to use the Command Configure dialog box, refer to Chapter 3: Graphics
Editor.
C-8
Appendix D. Functions available under the Operator
Access menu
Introduction This appendix lists the TSW runtime and Configurator functions that can be configured for
use at specific user access levels. These functions are grouped under the Operator Access
(Runtime) and Operator Access (Configurator) tabs of the Access Controls option of the
TSW Configurator. Select a category from the Categories dropdown list to display a different
set of functions.
Operator Access The tables in this section list the functions, menus and buttons of the TSW runtime
(Runtime) application.
Functions Descriptions
Historical Log Set the access level required to view the Historical Log tab.
Service Set the access level required to view the File menu.
Set the access level required to view the operator Historical Log.
Operators Log Set the access level required to add Operator Notes to the
Historical Log.
View Active List Set the access level required to view the Alarm Lists.
Set Time and Date Set the access level required to set the system Time and Date.
Editors Set the access level required to start the TSW Configurator.
Set the access level required to view the Point Status and Control
Status and Control
tab.
Graphics Set the access level required to view the Graphics tab.
Utility Control Set the access level required to view the Control Windows tab.
Audio Control Set the access level required to view the Audio Control subtab
under Control Windows.
Set the access level required to view the Phone Control subtab
Phone Control
under Control Windows.
Fire Panel Network Set the access level required to view the Network tab.
Site Information Set the access level required to view the Site Info tab.
D-1
Appendix D. Functions available under the Operator Access menu
Alarm Silence Set the access level required to silence an alarm using the Alarm
Silence button.
System Reset Set the access level required to reset the TSW using the System
Reset button.
Security System Reset Set the access level required to perform a Security System Reset on
a system.
Quiet PC Set the access level required to silence the PC sounder.
Fire Acknowledge Set the access level required to acknowledge Fire Alarms.
Security Acknowledge Set the access level required to acknowledge Security (or PRI2)
conditions.
Supervisory Acknowledge Set the access level required to acknowledge Supervisory (or
SUPV) conditions.
Trouble Acknowledge Set the access level required to acknowledge Trouble conditions.
Print Reports Set the access level required to print various event reports using the
Print Reports button.
Set the access level required to download fire network nodes into
Network Download the system using the Network Download subtab in the Network
tab. This option is only valid for 4120 networks.
Terminal Mode Set the access level required to use the Terminal Mode subtab
under the Network tab.
Set the access level required to check channel status on a network
Channel Status node using the Channel Status subtab under the Network tab. This
option is only valid for 4120 networks.
Set the access level required to open the Type In Feature Code
Type In Feature Code
Dialog dialog box. Feature Codes are used to install and unlock features
within TSW.
Set the access level required to assign points to Test Mode. Test
Test Mode Mode provides a history log to provide documented proof that a
system is being tested as required.
Set the access level required to acknowledge RAID event
RAID Activity Acknowledge notifications. RAID is a computer data storage scheme that mirrors
contents of a disk in case of a catastrophic disk failure.
Set the access level required to use the TSW email functionality,
Email Management
accessible though the Email Management button.
D-2
Appendix D. Functions available under the Operator Access menu
Set the access level required to change a points status to On, Off or
On/Off/Auto
Auto.
Change User Pseudo Set the access level required to modify the status of a user-defined
Status pseudo point.
Change TrueAlarm Set the access level required to modify the sensitivity of a
Sensitivity TrueAlarm point.
Clear Peak Value Set the access level required to change the peak value of a point.
Clear Alarm Verification Set the access level required to clear the tally of an Alarm
Tally Verification point.
Set the access level required to place points in Simulator mode and
Simulator Mode access the Simulator tab in TSW. This mode allows you to take the
system offline to simulate events in real time.
Change System Point/ Set the access level required to change the status of a system point
DACR Restore or to carry out a DACR Restore operation.
Functions Descriptions
Exit/Disconnect Set the access level required to exit the TSW runtime application or
disconnect the TSW Remote Client from the TSW Server.
Job Selection Set the access level required to use the Open Job button from the
File menu.
Set the access level required to use the Network Diagnostics tool. It
Network Diagnostics is accessible by clicking on the Host Diagnostics button in the
Network menu.
Calibrate Screen Set the access level required to calibrate the TSW touchscreen.
About Set the access level required to open the About TSW screen.
Printer Setup Set the access level required to setup a printer for use with TSW.
D-3
Appendix D. Functions available under the Operator Access menu
Change Volume Label Set the access level required to edit the label of a selected
Historical Log volume.
Export Volume Set the access level required to export a selected Historical Log
volume.
Delete Volume Set the access level required to delete a selected Historical Log
volume.
Set the access level required to backup a selected Historical Log
Backup Volume
volume to a storage unit.
Restore Volume Set the access level required to restore a selected, backed-up
Historical Log volume.
Functions Descriptions
Moving Toolbars and Set the access level required to reposition TSW toolbars and
Windows windows.
Set the access level required to use the Application Setup dialog
box, located under the File menu. Application Setup allows you to
Application Setup
configure the connection, operation and graphic preferences of
TSW.
Set the access level required to change user interface preferences,
UI Preferences accessible by clicking on the User Preferences button in the File
menu.
Operator Access The tables in this section list the functions, menus and buttons of the TSW Configurator
(Configurator) application.
Functions Descriptions
File Menu Set the access level required to open the File menu.
Edit Menu Set the access level required to open the Edit menu.
Tools Menu Set the access level required to open the Tools menu
Help Menu Set the access level required to open the Help menu
D-4
Appendix D. Functions available under the Operator Access menu
Reports Set the access level required to generate and print reports, using
the Reports/Printer button.
Set the access level required to create a new job using the New
New (Create Job)
button.
Set the access level required to load an existing job to the
Open (Load Job)
Configurator using the Open button.
Save Job Set the access level required to save an existing job using the Save
Job button.
Unload Job Set the access level required to remove a job from the memory
using the Unload Job button.
Exit Configurator Set the access level required to exit the Configurator using the Exit
button.
Functions Descriptions
Job Builder Set the access level required to build TSW jobs using the Job
Builder button.
Error Check Set the access level required to see if any errors were generated
during a build using the Error Check button.
Set the access level required to install jobs located on a floppy disk
Load from Floppy
using the Load From Floppy button.
Set the access level required to load a job on a floppy disk using the
Make Floppies
Make Floppies button.
Functions Descriptions
Set the access level required to add, delete and modify points using
Point Configuration
the Points button.
Set the access level required to customize the format of the node
Action Message Editor name when it appears in the TSW Runtime using the Action
Messages option.
Hardware Configuration Set the access level required to add, delete and modify elements
making up the system using the Hardware option.
Set the access level required to enable the logging of various
Point/Event Vectoring events to selected ports, using the Port Vectoring option. In this
case, a port is an output or storage device such as a monitor, printer
or email.
Set the access level required to enable/disable system operations
System Options
and behaviors, using the System Options option.
D-5
Appendix D. Functions available under the Operator Access menu
Display Colors Set the access level required to select the colors used in TSW
runtime displays, using the Color Definitions option
Set the access level required to provide general job information,
General Information
using the General Information option.
Set the access level required to display a log of job modifications,
Revision History
using the Revision History option.
Set the access level required to configure access levels to various
Access Level Editor Configurator and TSW Runtime commands. Use the Access
Controls option.
Operators Authorization Set the access level required to configure operator access levels,
Editor using the Operators option.
Graphics Editor Set the access level required to launch the graphics editor, which is
used to create runtime screens that can be used by TSW.
Audio Control Set the access level required to define the audio control screens
appearing in TSW Runtime, using the Audio Control option.
Set the access level required to configure rows of buttons that will
Utility Control perform system functions and control operations on points. Use the
Utility Screens button.
Set the access level required to select the type of audio operation
Audio Options (None, Standard or Canadian) needed for the job. Use Audio
Options.
System Access Configure Set the access level required to control access to functions in TSW
and TSW Remote Client, using the System Access option
Connection Passcode Set the access level required to change the passcode to all TSW
clients. Use the Connection Passcode option.
Set the access level required to customize the format of a node
Node Name Configuration name when it appears in TSW Runtime. Use the Node Name
option.
Sound Set the access level required to configure the job to (optionally) use
a separate WAV file to play during alarms using the Sound option.
D-6
Appendix D. Functions available under the Operator Access menu
Delete Points Set the access level required to delete points from the points list
using the Delete button in the Points screen.
Set the access level required to add points to the list using the Add
Add Points
button in the Points screen.
Set the access level required to edit the custom label for a point in
Edit Custom Label
the points list.
Edit Point Type Set the access level required to edit the point type for a point in the
points list.
Assign Action Message Set the access level required to map messages to different point
states using the Action Message button in the Points screen.
Toggle Class (PUB/LOC) Set the access level required to switch tagged points between Local
and Public using the Toggle button in the Points screen.
Functions Descriptions
Edit Site Message Set the access level required to edit the contents of a site message.
Edit User Label Set the access level required to edit the label of a custom user
message.
Edit User Message Set the access level required to edit the contents of a custom user
message
Delete User Message Set the access level required to remove a custom user message
from the message list.
Add/Copy User Message Set the access level required to add or copy a custom user
message.
Edit System Message Label Set the access level required to edit the label of a system message.
Edit System Message Set the access level required to edit the contents of a system
message.
Edit Site Message Label Set the access level required to edit the label of a site message.
D-7
Appendix D. Functions available under the Operator Access menu
Add Hardware Set the access level required to add new hardware to the system
using Add in the Hardware screen.
Set the access level required to delete hardware from the system
Delete Hardware
using the Delete button in the Hardware screen.
Set the access level required to edit settings for each piece of
Edit Hardware system hardware. Double click on each hardware item to edit
settings.
Functions Descriptions
Add Operators Set the access level required to add a new operator to the system
using the Operators option.
Delete Operators Set the access level required to delete current operator from the
system using the Operators option.
Edit Operator Info Set the access level required to edit information for an existing
operator using the Operators option.
Functions Descriptions
Runtime Access Set the access level required to edit user runtime access levels for
the TSW Runtime functions.
Configurator Access Set the access level required to edit user access levels for the
Configurator functions.
D-8
Index
Numerics
24-Hour Time Format .............................................................................................................................2-31
4100 Master Slots ...................................................................................................................................3-28
A
About TSW Confgurator ...........................................................................................................................1-7
Access Controls Option ..........................................................................................................................2-38
Account Settings .......................................................................................................................................1-3
Ack Options ............................................................................................................................................2-31
Action Messages Option .........................................................................................................................2-27
Add Action Messages .............................................................................................................................2-28
Add BMUX (2120) Point .........................................................................................................................2-24
Add DACR Points ...................................................................................................................................2-25
Add Digital / Analog Pseudo Points ........................................................................................................2-24
Add Event Account .................................................................................................................................2-21
Add External Points ................................................................................................................................2-23
Add List Pseudo Point ............................................................................................................................2-24
Add Operator ..........................................................................................................................................2-36
Add Points ..............................................................................................................................................2-23
Add Utility Screen ...................................................................................................................................2-34
Adding a TFXnet Port to the TSW ........................................................................................................... C-1
Adding DACR Accounts and Points .......................................................................................................2-21
Adding Points to a Network ....................................................................................................................2-17
Advanced Configuration with gred.ini ...................................................................................................... A-1
Alarm Category .......................................................................................................................................2-41
Alarm Silence inhibit ...............................................................................................................................2-29
Alert Central ..............................................................................................................................................2-7
Always Display Runtime Header ............................................................................................................2-30
Analog with Output Status ......................................................................................................................3-26
Annunciate Common Troubles ...............................................................................................................2-30
Annunciate Extra Node Troubles ............................................................................................................2-30
Annunciate Network Troubles ................................................................................................................2-30
Apply Button ...........................................................................................................................................2-26
Assign Action Messages ........................................................................................................................2-26
Assign Action Messages Button .............................................................................................................2-26
Assign Points to a Selected Message ....................................................................................................2-28
Auto Ack .................................................................................................................................................2-29
AutoCAD Entity Types ............................................................................................................................3-29
Auto-Cck 2120’s Unknown/Unacked Points ...........................................................................................2-32
AutoJump ...............................................................................................................................................2-30
Automatic Alarm Response Across Network Loops ...............................................................................2-17
B
Beep for Unacked Points ........................................................................................................................2-29
Beep on Button Press .............................................................................................................................2-32
Bitmap Properties Editor / Button Properties Editor .................................................................................3-7
Build ..........................................................................................................................................................1-4
Building Multi-Loop Networks .................................................................................................................2-18
C
Cancel Icon .............................................................................................................................................2-23
Celcius Temperature Format ..................................................................................................................2-32
Class
I
Index
D
DACR Port ................................................................................................................................................2-8
Defining Coverage Zones .......................................................................................................................3-21
Defining the DACR Port ..........................................................................................................................2-21
Delete DACR Account ............................................................................................................................2-21
Delete Utility Screen ...............................................................................................................................2-34
Deleting the TFXnet Port ......................................................................................................................... C-1
Detaching TSW from a Network Loop ....................................................................................................2-19
Device Type
Points Option ....................................................................................................................................2-22
Digital Pseudo Status .............................................................................................................................3-27
Directory and File Hierarchy ...................................................................................................................3-24
Directory Hierarchy and File Name Extensions ......................................................................................3-23
Displaying Channel Status Information ..................................................................................................2-19
Document Attributes Dialog Box ...............................................................................................................3-9
Double-Click Shows Action Message .....................................................................................................2-31
Dynamic Link Operations .......................................................................................................................3-16
E
Edit
Graphics Editor ..................................................................................................................................3-4
II
Index
F
Feedback Analog Pseudo Status ...........................................................................................................3-27
File
Graphics Editor ..................................................................................................................................3-3
File Menu ..................................................................................................................................................1-2
Filtering ...................................................................................................................................................2-23
FireGraph Priorities Mapping ....................................................................................................................5-3
Fixed Common Trouble Offsets ..............................................................................................................2-30
Flash Normal if All Unack Normal ...........................................................................................................2-30
G
Generic Port .............................................................................................................................................2-7
Graphic Output Status ............................................................................................................................3-28
Graphic Screens .....................................................................................................................................2-22
Graphics Editor .........................................................................................................................................1-4
Graphics Editor Concepts .........................................................................................................................3-2
Graphics Key Functions .........................................................................................................................3-22
Graphics Keys ........................................................................................................................................3-22
Graphics Programming Tips ...................................................................................................................3-30
GRED.INI ................................................................................................................................................. A-1
H
Header Always Go to Active List ............................................................................................................2-30
Help
Graphics Editor ..................................................................................................................................3-5
Help Menu ................................................................................................................................................1-7
Help Topics ...............................................................................................................................................1-7
Historical Log ............................................................................................................................................2-9
I
Import / Export Dialog Boxes ..................................................................................................................3-12
Importing CID Points ..............................................................................................................................2-21
Inactivity Timeout ....................................................................................................................................2-32
Index
Points Option ....................................................................................................................................2-22
Input Status ............................................................................................................................................3-28
Insert and Delete
TFXNet Editor ....................................................................................................................................5-8
In-Use Copies vs. Edit Copies ................................................................................................................3-23
ISA UL Card .............................................................................................................................................2-7
Isolate / De-Isolate a Point ...................................................................................................................... C-7
III
Index
L
Label
Points Option ....................................................................................................................................2-22
Layer Control Dialog Box ........................................................................................................................3-13
Link To
Graphics Editor ..................................................................................................................................3-5
Link to Color Dialog Box .........................................................................................................................3-19
Link to Shape Dialog Box .......................................................................................................................3-20
Linking Points .........................................................................................................................................3-21
List Pseudo Status ..................................................................................................................................3-27
Log In ........................................................................................................................................................1-3
Log Off ......................................................................................................................................................1-3
Loging In ...................................................................................................................................................1-x
Loging In with a New Job ......................................................................................................................... 1-x
Loging In with an Existing Job .................................................................................................................. 1-x
Loop
Points Option ....................................................................................................................................2-22
M
Main Menu Commands
Graphics Editor ..................................................................................................................................3-3
Maintaining the Current Drawing Area ...................................................................................................3-30
Make Local .............................................................................................................................................2-25
Make Public / Make Local .......................................................................................................................2-25
Make Public Button .................................................................................................................................2-25
Making Field Edits
TFXNet Editor ....................................................................................................................................5-8
Making the TSW Monitor TFXnet Port and Card Status .......................................................................... C-5
Making TSW the Multi-Loop Annunciator ...............................................................................................2-10
Making TSW the TFXnet Supervisor ....................................................................................................... C-5
Manage Documents Dialog Box .............................................................................................................3-14
Manual Point Entry .................................................................................................................................2-21
Mapping External Points to the TSW Node ............................................................................................2-16
Mapping External TFX Points and Shadow Points to the TSW ............................................................... C-2
Master Timekeeper .................................................................................................................................2-30
Message ID
Action Messages ..............................................................................................................................2-27
Message Label
Action Messages ..............................................................................................................................2-27
Monitor Status ........................................................................................................................................3-26
More Info ................................................................................................................................................2-26
More Info Button .....................................................................................................................................2-26
Moving Selected Objects with the Keyboard Arrow Keys .......................................................................3-31
Multi-Point Device Link ...........................................................................................................................3-22
N
Name
Points Option ....................................................................................................................................2-22
Navigating in the TFXnet Editor ................................................................................................................5-2
Network Interface Card (NIC) ...................................................................................................................2-4
Network Repeater Card ............................................................................................................................2-5
New ..........................................................................................................................................................1-2
Node
IV
Index
O
Open .........................................................................................................................................................1-2
Operator Access (Configurator) ...................................................................................................... 2-39, D-1
Operator Access (Runtime) ............................................................................................................ 2-39, D-1
Operators Option ....................................................................................................................................2-36
Output Status ..........................................................................................................................................3-28
P
Pencil Icon ..............................................................................................................................................2-23
Point Class
Points Option ....................................................................................................................................2-22
Point Database .......................................................................................................................................3-16
Point Type
Points Option ....................................................................................................................................2-22
Points List ...............................................................................................................................................2-28
Points Option ..........................................................................................................................................2-22
Points View
TFXNet Editor ....................................................................................................................................5-3
Printer .......................................................................................................................................................2-9
Q
Quad Serial Port Card ..............................................................................................................................2-7
Quantity / Add Row .................................................................................................................................2-34
Quiet PC on First Ack .............................................................................................................................2-29
R
References
Action Messages ..............................................................................................................................2-27
Registry Configuration ..............................................................................................................................1-4
Remove Action Messages ......................................................................................................................2-28
Remove Operators .................................................................................................................................2-36
Remove Points .......................................................................................................................................2-25
Remove Row ..........................................................................................................................................2-34
Rename Utility Screen ............................................................................................................................2-34
Renumbering Node
TFXNet Editor ....................................................................................................................................5-6
Renumbering the TSW Node .................................................................................................................. C-4
Reports .....................................................................................................................................................1-5
Reverse Active List Display ....................................................................................................................2-30
Revert Button ..........................................................................................................................................2-26
Rows
Screen Options ................................................................................................................................2-33
Runtime and Editor Limitations ...............................................................................................................3-23
S
Save .........................................................................................................................................................1-2
Select Point Category .............................................................................................................................2-28
Sequence for Creating New Screens ........................................................................................... 3-30, 3-31
V
Index
T
TCP/IP Interface .......................................................................................................................................2-6
Text Properties Editor ...............................................................................................................................3-8
TFX Event Codes to Class Mapping ........................................................................................................5-5
TFXnet Editor ................................................................................................................................... 5-1, 6-1
TFXnet Network Parameters ....................................................................................................................5-4
TFXnet Subnet .........................................................................................................................................5-4
Time Synch Port .......................................................................................................................................2-8
Tools
Graphics Editor .......................................................................................................................... 3-4, 3-5
Tools Menu ...............................................................................................................................................1-4
TSW Filling Lists ...................................................................................................................................... B-1
U
Use Point Name as Label .......................................................................................................................2-34
User Interface .......................................................................................................................................... 1-xi
V
View
Graphics Editor ..................................................................................................................................3-4
Viewing Network Attendance Topology from TSW .................................................................................2-18
W
WAV File .................................................................................................................................................2-41
When a TFX Panel is the TFXnet Supervisor .......................................................................................... C-4
Workarounds for FireGraph Features not Directly Supported in TSW .................................................... C-8
Workspace Pane ......................................................................................................................................2-1
VI
579-844
Rev. U
© 2018 Johnson Controls. All rights reserved. All specifications and other information shown were current as of document revision date and are subject to change without notice.