Document: User Guide

R
Product: TrueSite Workstation Mobile Client

Introduction The TrueSite Workstation (TSW) Mobile Client is an application (app) designed to let the user
access, monitor and use a TSW remotely through a mobile device.

Technical TSW Requirements:

Requirements • TrueSite Workstation software revision 3.03 or higher.
Mobile Device Requirements:

iOS Android
Mobile • iPhone
Device Type • iPod touch
All smartphones and tablets with Android Version 4 or
• iPad
higher are supported
Software Revision 6 or
Revision higher

Connection to a wireless network:

The device must be able to connect to the same Local Area Network (LAN) as the TSW*. This
connection can be done through a VPN connection.

*For more information on this connection consult the Connection Worksheet in Appendix A.

Legend When a set of instructions pertain exclusively to one type of device it will be preceded by the
device’s icon:

= Smartphone, iPhone and iPod touch instructions.

= Tablet and iPad instructions.

In this This publication discusses the following topics:

publication
Topic Page

Add-In Installation and Configuration 2

App Installation and Configuration 4
App Languages 5
Operation 6
Troubleshooting 10
Appendix A- Connection Worksheet 12

© 2015 Tyco Fire Protection Products. All rights reserved. All specifications and other information shown were current as of document 579-1154
revision date and are subject to change without notice.
TYCO, SIMPLEX, and the product names listed in this material are marks and/or registered marks. Unauthorized use is strictly prohibited.
Rev. B
iPhone, iPod touch and iPad are trademarks of Apple Inc. Android is a trademark of Google Inc.
 TSW Mobile

Add-In Installation and Configuration

Add-In The mobile client add-in enables the TSW to be accessed from a mobile device. The add-in is
Installation and already installed as part of the TSW installation and is activated by a feature code.
Configuration
To activate the add-in:
1. Obtain the feature code 4190-5067 by contacting an authorized Simplex product
representative.
2. Enter the feature code in the TSW. Refer to the TSW Operation & Application Instructions
(579-835) for more information on entering feature codes.

To configure the add-in:

Once the feature code has been activated the user can enable mobile access by configuring mobile
access codes.
1. From the TSW user interface, open the “Help” menu and select the “Feature Control” menu
item to access the Feature Control dialog. If the feature code was successfully activated, the
Mobile Access Codes group will be enabled.
Note: The user may need to log into the TSW at a higher access level to be able to access the Feature
Control dialog. This is configurable by following the path: Configure > Operator Access > Runtime
Access Levels > System-Wide Functions > Feature Control in the Configurator.

2. Type in the access code for read-only or full control access. Alternatively, you can click the
Generate buttons to generate random codes.
Note: Leaving both access codes blank disables mobile access to the TSW.

3. Once the user clicks on “OK”, the changes to the access codes are effective immediately. These
access codes will be required when adding a workstation to the mobile device list. This
operation is explained later in the document.

Note: Even if you type or generate the Full Control access code, you may need to enable control
operations through Configurator. Consult the section Enable Full Control.

Figure 1. Feature Control Window

2
 TSW Mobile

Add-In Installation and Configuration, continued

Enable Full
Control WARNING: Enabling control operations for the TSW Mobile Client may affect your
! compliance with the local fire code.

Although Mobile connectivity is enabled on all new TSW jobs and upgraded jobs, the default
access setting for the TSW is set to “read-only” for mobile clients.
In order for mobile clients to control the TSW remotely, an authorized technician must enable the
control operations supported by the mobile app.

To enable Utility and Audio controls:

The following menu items are supported by the mobile app.
1. Open the TSW job in the Configurator.
2. In Configure > System Access > Main Menu Item Visibility, enable the following options for
the 3rd party user interface by clicking in the check-box beside:
• Utility Control
• Audio Control
Note: For user interface configuration details consult the TSW Configuration Guide 579-844.

To enable the following System-Wide Functions for a 3rd party user interface:
The following System-Wide Functions are supported by the mobile app.
1. Open the TSW job in the Configurator.
2. To enable the functions, go to Configure > System Access > System-Wide Functions, enable the
following options for the 3rd party user interface by clicking in the check-box beside:
• Alarm silence
• System reset
• Security system reset
• Fire Acknowledge
• Security Acknowledge
• Supervisory Acknowledge
• Trouble Acknowledge
Note: For user interface configuration details consult the TSW Configuration Guide 579-844.

To create a special operator for the mobile device:

1. Open the TSW job in the Configurator.
2. In Configure > Operator Definition:
• In Operator Definition create a new operator profile*.
3. To adjust the access levels for the new operator:
• Go to Configure > Operator Access > Runtime Access Levels.
• Adjust the access level for the new operator*

* Consult the TSW Operator Manual 579-835 for complete instructions.

3
 TSW Mobile

App Installation and Configuration

App installation The Mobile Client app must be installed on the user’s mobile device.
To install the device app:
• Navigate to a mobile app store from your device.
• Search the store for “TSW Mobile”.
• Install the app by following the screen prompts.
Figure 2. App Icon

App Display The app’s display varies with the type of device being used.

On a smartphone, iPhone or iPod touch:

All the operations made on these devices take place in the same window. To switch from the
Workstations window to the Action window:
1. Tap on the workstation you want to expand.
2. The Action window will open and display the specifics of that workstation.
3. To return to the Workstations list either swipe the screen from left to right or tap the Disconnect
button.

On a tablet or an iPad:
The app on a tablet consists of two windows. A Workstations window and an Action window.
To edit the way these two windows appear on the tablet:
1. Press and hold a finger on the window you want to reposition.
2. A selection of configuration options will appear.
3. Slide the finger to the desired screen configuration.

Note: All devices support both portrait and landscape views. To change views, simply change the device’s
position from vertical (portrait view) to horizontal (landscape view). When using a device with a smaller
screen, positioning the device in landscape mode allows the user to view the full diagnostic message.

Workstations List Action Window Workstations List Action Window

Add Button Edit Button

Add Button Edit Button

Disconnect Actions
Button Button Disconnect Actions
Button Button

Icons

Screen Configurator

Icons

Figure 3. Application Overview (TSW Mobile App for iOS is Shown as an Example)

4
 TSW Mobile

App Languages

Supported The app will automatically be loaded in the device’s language, provided that the language is
Languages supported. The following languages are supported by the app:
• Arabic • Hebrew
• Chinese (Simplified) • Russian
• English • Spanish
• French

Standard messages from the TSW will be displayed on the device in the app’s default language.
Example:
Standard message on an English TSW: ALARM SILENCE REQUESTED
Message that appears on a French app: SILENCE SIGNAUX DEMANDÉE

Custom messages from the TSW* will be displayed on the device in the same language as they
are displayed in the TSW.
Example:
Custom message on a French TSW: ALERTE ATTAQUE ZOMBIES
Message that appears on the English app: ALERTE ATTAQUE ZOMBIES

* Custom messages include point labels, point types, statuses, as well as utility and audio control
labels.

5
 TSW Mobile

Operation

TSW Mobile The operations listed in this section can be performed on the TSW remotely from the Mobile
Client App Client app.
Operations IMPORTANT: Be aware of software security risks when working remotely on the TSW.
Be sure that the wireless network you are working from is secure.

Adding a workstation:
Android iOS

1. To add a workstation to the list, tap the
Workstations button ( ) and
then the Add button ( ).
2. Enter the label, the access code, and the authority.
• The label is any text that would help you to
identify a particular workstation.
• The authority is the IP address or the name of the
computer where the TSW is installed, optionally
followed by the port number.
• The access code is the same code that was
entered into the Feature Control dialog. See Add-
In Installation and Configuration in the Installation
and Configuration section on page 2.
3. Tap on the Save button.
1. To add a workstation to the list, tap the
Add button (+).
2. Enter the label, the authority, and the
access code.
• The label is any text that would help
you to identify a particular
workstation.
• The authority is the IP address or the
name of the computer where the
TSW is installed, optionally followed
by the port number.
Note: If the app determines that it cannot
use the entered authority, it will not
allow you to save the workstation
settings. If the app suspects that
there is a typo in IP address
entered, it will issue a warning but
will still allow you to save the
workstation settings. See the
Troubleshooting section for a
detailed explanation.

• The access code is the same code

Figure 4. Adding a Workstation Dialog
that was entered into the Feature
Control dialog. See Add-In
Installation and Configuration in the
Installation and Configuration section
on page 2.
3. Tap on the Save button.

Figure 5. Adding a Workstation Dialog

6
 TSW Mobile

Operation, continued

TSW Mobile Connecting to a workstation:

Client App
Operations Android iOS

1. Tap the workstation you want to connect to. 1. Tap the workstation you want to connect to.

Note: Be sure to have exited Edit mode before
connecting to a workstation. To exit “Edit”
mode, tap the “Save” or “Cancel” button
in the top bar to return to the to the
workstations list.
Note: Be sure to have exited Edit mode before
connecting to a workstation. To exit “Edit”
mode, tap the “Done” button in the top bar
to return to the Workstations window’s
regular state.

2. When the connection process starts: 2. When the connection process starts:
• The prompt “Receiving active lists…” is
• The prompt “Receiving active lists...” is
displayed at the top of the screen.
displayed under the workstation name.
• As the connection process progresses,
• As the connection process progresses, the
the prompt will change to “Receiving utility
prompt will change to “Receiving utility
controls…”.
controls...”
• After the initial state is completely loaded,
• As soon as the connection is established,
the prompt will disappear.
the prompt disappears.

Login protocol (iOS and Android):

There is no login dialog upon connection. The

login dialog appears only when you attempt
to perform an operation.
The login dialog will reappear after the
following operations:
• The app was switched into background.
• The device has locked or timed out. Figure 6. Login Dialog (iOS)

• Attempting to perform an operation, not

authorized for the add-in (see the Add-In
Installation and Configuration section on
page 2).
• If you entered incorrect credentials or the
operation is not authorized for that
operator.
Figure 7. Login Dialog (Android)

Changing operators:
• To change the operator, leave the app or lock the device.
• When you go back to the app and request an operation it will allow you to change operators.
Note: There is no Log Off function.

Continued on next page

7
 TSW Mobile

Operation, continued

TSW Mobile Using system-wide functions (iOS and Android):

Client App System wide functions are available from the actions button in
Operations the top bar after you connected to a workstation.
• Alarm Silence
• System Reset
• Priority 2 Reset Figure 8. System-Wide
System-wide operations are always accessible by the user in the Functions Menu (iOS)
mobile app. Even if read-only access code is used. Even if they
are not enabled (see Enable Full Control). Under these
conditions though, they will require a login when invoked, but
they will fail with “The operation is unauthorized”
When a system-wide function is invoked, the prompt displayed
at the top of the screen will be the same prompt as seen in the
TSW status bar*.
*See the Supported Languages section on page 5.
Figure 9. System-Wide Func-
tions Menu (Android)

Working with active lists (iOS and Android): iOS Android

Four active lists are accessible from the app: Fire, Priority 2, Supervisory,
Trouble Fire Priority 2

These lists are independent from the system or operator access levels.
Highlighted rows represent unacknowledged points.
• Tap a point to bring up an action sheet with the action message Supervisory Trouble

specific to the point. If the point is unacknowledged, there will be

Acknowledge button. Selected Unselected
• The number of unacknowledged points and the total number of
points in each list is displayed in a badge next to the icon of the list.
1/1

- For example: A badge with “3/3” represents 3 unacknowledged Icon with

Notification Badge
trouble points. A badge with “1/3” represents 1 unacknowledged Figure 10. List Icons
trouble point and 2 acknowledged ones. A badge with “3”
represents 3 acknowledged trouble points.

Deleting a workstation (Android):

To delete a workstation, tap and hold the workstation you want to remove until a new set of
options (one of which is Delete) appears at the top of the screen.

8
 TSW Mobile

Operation, continued

TSW Mobile
Working with control windows:
Client App
Operations
Utility and Audio Controls* are available from the Controls tab.

Android iOS

To use this feature: To use this feature:

1. Tap the Controls button at the top of the 1. Tap on the Controls Icon at the bottom of the
screen. screen.
2. Utility and Audio section will appears as 2. Utility and Audio section will appear as
configured in the TSW. configured in the TSW.

Note: Phone controls are not available in the app. Note: Phone controls are not available in the app.

Controls
Figure 11. Controls Button (Android)
Figure 12. Controls Icon (iOS)

*These options must be enabled for mobile applications in the Configurator prior to being
accessed by the Mobile Client. See the Enable Full Control section on page 3.

9
 TSW Mobile

Troubleshooting

Operations This section contains the explanations and solution to frequently encountered problems.
Problems
Table 1. Operation Problems

Problem Probable Causes and Solutions

Save button is • The Label, the Authority or the Access Code fields are empty: Ensure
disabled that all fields are filled out.
• The computer name is invalid: Verify the computer name. Generally,
the computer name is up to 64 characters long and contains only
alphanumeric characters, dots, and dashes. If the computer name
includes a port number, be sure the number is between 1 and 65535.

Error Messages This section contain the probable causes and solutions for error messages.

Table 2. Error Messages

Error Message Probable Causes and Solutions

“The supplied IP • The app does not recognize the IP Address. The IP address is 4 groups
address may be of numbers separated by dots. Each number is between 1 and 255
invalid” inclusively. Example of a valid IP Address: 192.168.1.32

“Error • At the start of a session the app cannot communicate with the
communicating workstation.
with the 1. Verify that the device has network connectivity.
workstation”
2. Verify that the TSW add-in is running:
- From TSW application UI, access Help > Features Control and verify
that at least one access code is entered. If the Mobile Access Code
group is disabled:
• Entered feature code does not have Mobile Connectivity (use
Help > Feature Summary to verify). See add-in Installation and
Configuration for more details.
• The job configuration was changed to disable mobile connectivity
all together. See step #6.
- Verify that there is no “3RDP CLIENT MISSING: Mobile” trouble which
indicates catastrophic failure of the add-in. If there is such trouble,
restart the TSW
3. Try to access the add-in from another computer on the same LAN. Type
https://computer-name-of-tsw/PublishData.svc/ into browser’s address
bar. If a page appears, troubleshoot the connectivity of the mobile
device. If the browser displays search results or an error message, the
firewall or the HTTPS service maybe misconfigured.
4. Verify that the firewall and the HTTPS service were configured correctly.
- On the computer where the workstation is installed, open Start >
Control Panel > System and Security > Windows Firewall > Advanced
Settings, and verify that the inbound rule with Program: Any, Local
Port: 443, Profile: Domain, Private exists and is enabled.
- On the same computer, verify that the output of the command “netsh
http show sslcert” contains the information about IP:port:[::]:443 and
0.0.0.0:443 (replace 443 with the port, configured for the add-in).

Continued on next page

10
 TSW Mobile

Troubleshooting, continued

Error Messages Table 2. Error Messages (Continued)

Error Message Probable Causes and Solutions

“Error 5. Verify that port 443 (the default port) is available and is the port being used. To
communicating verify which port is being used:
with the
- Open mobile.config in the TSW’s job folder.
workstation”
For example, c:\netjobs\site\tsw1\mobile.config
- If you see a line <port>1443</port>, the add-in uses non-standard port.
• Verify that firewall allows incoming connections on this port.
• Add “:1443” to the authority of the TSW on the mobile device.
• Repeat check #4 using the new port number.
6. Open the TSW job in the Configurator. In Configure> Hardware, open the TCP/IP
Interface, or add it if it is missing. In the TCP/IP interface:
- Check Supervised 3rd Party Client(s)
- In the available 3rd party client slot, type “Mobile” (without quotes, preserving
the case).
7. If the above checks fails, re-install and restart the TSW.

“Error • During the session the app lost the connection with the workstation.
communicating 1. Verify that the device still has a network connection.
with the
2. Verify that the workstation is still running.
workstation”
3. Verify that the add-in is running.
Once the connectivity is restored, the prompt will disappear and the user can
continue operations normally, without having to restart the workstation.
Note: Restarting a workstation can cause the content on the screen of a remote
device monitoring it to reset itself.

Note: Additional troubleshooting information is available from the debug output on the TSW computer and
from the device console. Contact a technical support representative for details on how to access this
information.

Custom Label If custom labels containing a large amount of wide characters (q, w, m) were used as button names
Issues for the Utility and Audio controls, the button names will not be displayed correctly on the mobile
device due to size restrictions.

For example: A two-line label such as “AWESOME WOMBAT” will be unreadable on mobile
devices.

This can be fixed by editing the custom button labels in the Configurator.

Figure 13. Example of an Incompatible

Custom Label (iOS)

11
 TSW Mobile

Appendix A- Connection Worksheet

Connection To successfully connect to a TSW from a mobile device, the user will require:
Worksheet
TSW Workstation (Server)

Computer Name: _________________ or

TCP/IP Address: _____._____._____._____
TCP/IP Port: _____ (if different from default 443; see Troubleshooting section)

The computer name and IP address are found by executing ipconfig /all from the command
prompt on the TSW PC.

The computer name will be on the line, starting with “Host Name”
(e.g. Host Name . . . . . . . . . . . . : BRO1WKD149-WIN7)

The IP address will be on the line, starting with “IPv4 Address” under Local Area Connection or
similar (e.g. IPv4 Address. . . . . . . . . : 10.38.192.236(Preferred)

Local Wireless Network:

Name (SSID): __________

[ ] Hidden network

Security mode and credentials:

[ ] WEP. Password (WEP key): ___________
[ ] WPA. Password (WPA shared key): ____________
[ ] WPA2. Password (WPA shared key): _____________
[ ] WPA Enterprise. User name: ____________ Password: _____________
[ ] WPA2 Enterprise. User name: ______________ Password: _____________

Consult the local IT help desk for information about the local wireless network.

Detailed instructions on how to connect an iOS device to a wireless network are available from
Apple support site: http://support.apple.com/kb/HT5569 . The website includes troubleshooting
info.
Consult the support site if the device cannot connect to the network, for example, see http://
support.apple.com/kb/TS3727 .

After a successful connection is established to a network, the user can verify that they are on the
same network as TSW by checking the IP address of the device. As an example, the steps for an
iOS device are shown below:
• Tap Settings on the home screen of the device
• Tap Wi-Fi

• Tap the or (depending on the version of iOS) next to your network

The IP Address should be very similar to the IP address of the TSW (e.g. 10.38.192.121). The
local IT help desk can verify that the device is on the correct network.

579-1154
R Rev. B