0% found this document useful (0 votes)
115 views112 pages

A6V101007430 en

Siemens N4 Appliance

Uploaded by

marklmendoza
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
115 views112 pages

A6V101007430 en

Siemens N4 Appliance

Uploaded by

marklmendoza
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 112

Siemens N4 Appliance

User Guide

A6V101007427_en_--i Smart Infrastructure

2022-05-28
Table of Contents

How to Use This Manual ....................................................................................6


Overview ............................................................................................................8
Network and System Requirements .....................................................................8
System Recommendations ..................................................................................8
Siemens N4 Appliance Compatibility....................................................................9
Install/Upgrade to Siemens N4.10.2/4.11.1 Workbench..................................10
Installing Siemens Niagara Workbench (N4.10.2/4.11.1) ....................................10
Obtaining a License ............................................................................11
Installing Siemens N4 Appliance for using Siemens Device Templates and Pre-
configured Services ........................................................................................13
Before Installing the Siemens N4 Appliance ........................................13
New Installation - Supervisor (PC) Station ...........................................18
Upgrade - Supervisor (PC) Station ......................................................19
New Installation - Controller (JACE) Station ........................................20
Upgrade - Controller (JACE) Station ...................................................23
Updating Installed Devices ..................................................................24
Configuring the Siemens station to use PPCL and Point Editors (if not
used before) ....................................................................................25
Configuring the Required Networks ....................................................................34
Configuring a BACnet/IP Network .......................................................34
Configuring a BACnet MS/TP Network ................................................35
Network Statistics ...............................................................................36
Using the Siemens N4 Appliance (PPCL and Point Editors) .........................38
Discovering and Adding Devices ........................................................................38
Discovering BACnet Devices on the Network ......................................38
Adding Controllers ..............................................................................40
Adding the PPCL and Point Editor Functions ......................................41
Folder Feature for Devices ..................................................................41
Using the PPCL Editor .......................................................................................42
User Interface .....................................................................................43
Creating a new PPCL Program ...........................................................44
Opening the PPCL Editor and Viewing an Existing PPCL Program ......45
Importing a PPCL Program .................................................................45
Exporting a PPCL Program .................................................................47
Modifying a PPCL Program .................................................................48
Deleting a PPCL Program ...................................................................48
Using the PTEC Point Editor ..............................................................................49
PTEC Point User Interface ..................................................................49
Adding Point Editor Functions .............................................................50

2 | 112 2022-05-28 A6V101007427_en_--i


Opening the Point Editor and Viewing Points...................................... 50
Adding PTEC Points .......................................................................... 50
Modifying a PTEC Point ..................................................................... 51
Deleting a PTEC Point ....................................................................... 51
Using the Point Editor ....................................................................................... 51
Point User Interface ........................................................................... 51
Discovering Points ............................................................................. 52
Adding Points..................................................................................... 53
Adding Points to the N4 Database...................................................... 53
Using the Point Editor Application ...................................................... 54
Editing Points in PX Controllers .......................................................... 54
Modifying a Point in Another Tool ....................................................... 54
Deleting a Point ................................................................................. 55
Folder Feature for Points.................................................................... 56
Troubleshooting ................................................................................................ 56
Running Sie Update Db does not cause Point and PPCL Editors to
appear ............................................................................................ 56
Using the Siemens N4 Appliance (Device templates and pre-configured
services) ....................................................................................................... 59
Siemens N4 Appliance Views ........................................................................... 59
Configuring a Site Structure ............................................................... 61
User Accounts ................................................................................... 69
Identifying and Configuring TNM Local Devices ................................................ 71
Determining if a Station Local Device is Needed ................................ 71
Configuring a Station Local Device ..................................................... 72
Using Station Local Devices ............................................................... 74
Discovering Devices on the Network ................................................................. 74
Adding Controllers ............................................................................................ 76
Deleting an ALN or FLN Device.......................................................... 78
Configuring Schedules ...................................................................................... 79
Built-in Schedules and Schedule Editor Views .................................... 79
Creating Additional Schedules ........................................................... 84
Synchronizing Station Schedules with BACnet Schedule Objects ....... 85
Configuring User Accounts................................................................................ 88
Operator View................................................................................................... 90
Existing Schedules in Operator View .................................................. 91
Opening the Alarm Console ............................................................... 93
Using the Charting View Feature ........................................................ 94
Customizing the Logos ..................................................................................... 97
Configuring a Landing Page..........................................................................100
Uninstalling Siemens Workbench .................................................................101
Advanced Topics ...........................................................................................102
Adding a LocalDeviceAhu object to the station .................................................102

A6V101007427_en_--i 2022-05-28 3 | 112


Updating Device Names and Hierarchies ......................................................... 106
Appendix A - Supported Applications .......................................................... 109
Appendix B - Application Templates Notes.................................................. 111

4 | 112 2022-05-28 A6V101007427_en_--i


Copyright Notice

Copyright Notice
Notice
Document information is subject to change without notice by Siemens Industry, Inc.
Companies, names, and various data used in examples are fictitious unless otherwise
noted. No part of this document may be reproduced or transmitted in any form or by
any means, electronic or mechanical, for any purpose, without the express written
permission of Siemens Industry, Inc.
All software described in this document is furnished under a license agreement and
may be used or copied only in accordance with license terms.
For further information, contact your nearest Siemens Industry representative.
Copyright 2021 Siemens Industry, Inc.

To the Reader
Your feedback is important to us. If you have comments about this manual, please
submit them to: SBT_technical.editor.us.sbt@siemens.com
Product or company names mentioned herein may be the trademarks of their
respective owners.
Printed in the USA.

Cybersecurity disclaimer
Siemens provides a portfolio of products, solutions, systems and services that
includes security functions that support the secure operation of plants, systems,
machines and networks. In the field of Building Technologies, this includes building
automation and control, fire safety, security management as well as physical security
systems.
In order to protect plants, systems, machines and networks against cyber threats, it is
necessary to implement – and continuously maintain – a holistic, state-of-the-art
security concept. Siemens’ portfolio only forms one element of such a concept.
You are responsible for preventing unauthorized access to your plants, systems,
machines and networks which should only be connected to an enterprise network or
the internet if and to the extent such a connection is necessary and only when
appropriate security measures (e.g. firewalls and/or network segmentation) are in
place. Additionally, Siemens’ guidance on appropriate security measures should be
taken into account. For additional information, please contact your Siemens sales
representative or visit https://www.siemens.com/global/en/home/company/topic-
areas/future-of-manufacturing/industrial-security.html.
Siemens’ portfolio undergoes continuous development to make it more secure.
Siemens strongly recommends that updates are applied as soon as they are available
and that the latest versions are used. Use of versions that are no longer supported,
and failure to apply the latest updates may increase your exposure to cyber threats.
Siemens strongly recommends to comply with security advisories on the latest
security threats, patches and other related measures, published, among others, under
https://www.siemens.com/cert/en/cert-security-advisories.htm.

A6V101007427_en_--i 2022-05-28 5 | 112


How to Use This Manual

How to Use This Manual


About This Manual
This manual is written for the user of the Siemens N4 Appliance. It is designed to help
you become familiar with the application.
This section provides an overview of the manual, explains document conventions and
symbols used throughout the manual and how to access help.

How This Manual Is Organized


This manual contains the following sections in the following order:
● Overview explains the Siemens N4 Appliance functions.
● Installation describes the installation and setup of system-related parameters.
● Using the Siemens N4 Appliance describes how to use Siemens N4 Appliance.
● Uninstalling Siemens Workbench provides a procedure to remove the Siemens
Workbench program from your computer.

Document Conventions
The following table lists conventions to help you use this manual in a quick and
efficient manner.

Convention Examples

Numbered Lists (1, 2, 3…) indicate a 1. Turn OFF power to the field panel.
procedure with sequential steps. 2. Turn ON power to the field panel.
3. Contact the local Siemens Industry representative.

Conditions that must be completed or met ⊳Composer software is properly installed.


before beginning a task are designated with a ⊳A Valid license is available.
⊳.
1. Select Start > Programs > Siemens > GMS >
Intermediate results (what will happen Composer.
following the execution of a step), are
designated with a ⇨. ⇨The Project Management window displays.
2. Open an existing project or create a new one.
Results, which inform the user that a task was
completed successfully, are designated with a ⇨The project window displays.
⇨.

Actions that should be performed are specified Type F for Field panels.
in boldface font. Click OK to save changes and close the dialog box.

Error and system messages are displayed in The message Report Definition successfully
Courier New font. renamed displays in the status bar.

New terms appearing for the first time are The field panel continuously executes a user-defined set
italicized. of instructions called the control program.

This symbol signifies Notes. Notes provide additional


information or helpful hints.

Cross references to other information are For more information on creating flowcharts, see
indicated with an arrow and the page number, Flowcharts [→92].
enclosed in brackets: [→92]

Placeholders indicate text that can vary based Type A C D H [username] [field panel #].
on your selection. Placeholders are specified
in bold print, and enclosed with brackets [ ].

6 | 112 2022-05-28 A6V101007427_en_--i


How to Use This Manual

Safety Symbols
The following table lists the safety symbols used in this manual to draw attention to
important information.

Symbol Meaning Description

NOTICE CAUTION Equipment damage may occur if a procedure or instruction is not


followed as specified. (For online documentation, the NOTICE displays
in white with a blue background.)

CAUTION Minor or moderate injury may occur if a procedure or instruction is not


followed as specified.

WARNING Personal injury or property damage may occur if a procedure or


instruction is not followed as specified.

DANGER Electric shock, death, or severe property damage may occur if a


procedure or instruction is not followed as specified.

How to Contact Us
Your feedback is important to us. If you have comments about this document, please
submit them to the following email address:
SBT_technical.editor.us.sbt@siemens.com.

A6V101007427_en_--i 2022-05-28 7 | 112


Overview
Network and System Requirements

Overview
The Siemens N4 Appliance (Siemens_N4_Appliance_3_00_104) is an automated
Niagara station builder for Niagara 4 with pre-defined and customizable
configurations. Using the Siemens N4 Appliance simplifies the Niagara station setup
process by providing automation, customizable templates, default presets and license-
free PX-based application graphics. It has been tested following Siemens quality
procedures that provide a repeatable high-quality result.
Siemens N4 Appliance provides the following utilities:
● Siemens N4 PPCL and point editors to add/delete/edit PPCL programs and points
for Siemens Actuating Terminal Equipment Controllers (ATEC) and Programmable
Terminal Equipment Controllers (PTEC) and field panels (PXC and TC).
● Siemens N4 device templates with graphics for DXRs, RDYs, ATECs and PTECs.
● Siemens N4 pre-configured services: Siemens tag library, alarm classes,
category/roles/users, and hierarchy.
● Pre-configured views, which include the following:
– AHU field panel rollup view.
– Floor/area summary view.
– IP and MS/TP network traffic information view.

Hardware
● Compatible with the TNM-8000/SLX-8000.
● Compatible with Talon N4 Supervisor/SLX N4 Supervisor.
● Compatible with TC/PXC field panels Version 3.3 and later.

Network and System Requirements


Operating System: Windows 7 64-bit and Windows 10 64-bit.
Browser Support:
● Microsoft Internet Explorer (IE) 9, 10 or 11, Edge, Chrome, or Mozilla Firefox
current versions.
● Cookies must be enabled. This is done by selecting Options from the Tools menu
in most browsers.
Memory: 1 GB minimum, 4 GB or more recommended for larger systems.
Hard Drive: 4 GB minimum, more recommended depending on archiving
requirements.
Network Support: Ethernet adapter (10/100 MB with RJ-45 connector).

System Recommendations
For optimized system performance, Siemens recommends the following tuning
policies:

8 | 112 2022-05-28 A6V101007427_en_--i


Overview
Siemens N4 Appliance Compatibility

Siemens N4 Appliance Tuning Policy Recommendations.


Policy Value Notes
Min Write Time 0 minutes (default) Applies to writable points. Specifies the minimum amount of time allowed
between writes. Provides a method to throttle a rapidly-changing value so that
only the last value is written.
If this property value is 0 (default), this rule is disabled and all value changes
attempt to write.

Max Write Time 0 minutes (default) Applies to writable points. Specifies the maximum “wait time” before rewriting the
value, in case nothing else triggers a write. Any write action resets this timer.
If this property value is 0 (default), this rule is disabled (no timed rewrites). This is
how often you want the station to take control over the BACnet device.

Write on Start False (default) Applies to writable points. Determines behavior at station startup.
● If True, a write occurs when the station first reaches “steady state.”
● If False (default), a write does not occur when the station reaches “steady
state.”
This setting allows the station to take control of the BACnet device when it first
starts. Doing this can put a load on the station while it is trying to start by adding
multiple write commands to the station.

Write on Up True (default) Allows the station to take control when the device transitions from Down to Up.

Write on Enable True (default) Allows the station to take control when the device transitions from Disabled to
Enabled.

Stale Time 10 minutes Confirms that the device is working properly, but raises awareness that a point
(varies based on polling has not been updated in a reasonable amount of time.
policy) A longer period of time for slower polling rates and a shorter period of time for
faster polling rates.

UseCOV False (true for the If set to True, and assigned points are under a BacnetDevice that supports the
Siemens_COVPpolicy, false Subscribe COV service, any necessary updates (Niagara proxy subscriptions)
for the Siemens polled are attempted using BACnet COV subscriptions to the device.
policies) If the subscription attempt succeeds, the Read Status property of the point’s
BacnetProxyExt displays COV.
If the subscription attempt for a proxy point fails, normal polling is used and the
Read Status property displays Polled.

Use Confirmed COV True (default) If UseCOV is enabled (set to True) and assigned points are under a
BacnetDevice that supports Confirmed COV notifications, any necessary updates
(Niagara proxy subscriptions) are attempted using BACnet Confirmed COV
subscriptions to the device.
If UseCOV is not enabled (set to False), the value of this property is ignored (true
for the Siemens_COVPpolicy, false for the Siemens polled policies).

COV Subscription 15 minutes The lifetime, in minutes, for which Niagara will subscribe for COV notifications,
Lifetime and then, if necessary, periodically re-subscribe.
A value of zero means an indefinite lifetime, although this is not guaranteed to
persist across resets of the server device.
Note: Do not use zero in Siemens installations!
If UseCov is set to False, the value of this property is ignored.

Siemens N4 Appliance Compatibility


Siemens N4 Appliance Version 3.10 is compatible with Niagara N4 Version
4.10.2.52/4.11.1.16.

A6V101007427_en_--i 2022-05-28 9 | 112


Install/Upgrade to Siemens N4.10.2/4.11.1 Workbench
Installing Siemens Niagara Workbench (N4.10.2/4.11.1)

Install/Upgrade to Siemens N4.10.2/4.11.1


Workbench
This procedure is required for all use cases.

Complete the following procedure to install Siemens Workbench and set up system-
related parameters.

Installing Siemens Niagara Workbench


(N4.10.2/4.11.1)
Siemens Workbench software files are available on Niagara Central.
1. Do the following in the Siemens N4 Appliance section:
– Select the latest *.zip file in the Siemens N4 Appliance Supervisor section and
click Save As.
– Select a distribution folder on your computer to unzip (extract) the files.
2. In the root distribution folder, double-click Installer_x64.exe.
3. Click Next after the Siemens Workbench Installation Program wizard opens.
4. Select Yes and click Next to accept the End User License Agreement.
 The default destination folder for Siemens Workbench installation displays:
C:\Siemens\SiemensWorkbench-4.10.2/4.11.1.x.x.
5. Keep all default settings and click Next.
 If the installation folder does not exist, you are prompted by the system to
create it.
 The default folder for Niagara Daemon User Home displays:
C:\ProgramData\Niagara4.10.2/4.11.1 \tridium
6. Keep the default setting and click Next.
7. If this is the first time installing Siemens Workbench, set the password used to
encrypt sensitive information on the file system. Otherwise, continue with the next
step.
The password must contain:
– 10 characters
– One lowercase character
– One uppercase character
– One digit
8. If desired, select one or both check boxes to create Start Menu or Desktop
shortcuts and click Next.
 A progress bar displays during the installation.
 A confirmation message displays with the following options selected:
– Launch Workbench.
– Install and Start Platform Daemon.

10 | 112 2022-05-28 A6V101007427_en_--i


Install/Upgrade to Siemens N4.10.2/4.11.1 Workbench
Installing Siemens Niagara Workbench (N4.10.2/4.11.1)

– Copy Niagara Daemon Data From Prior Version (only displays if a prior
version exists).
9. Clear the check box(es) for any options that should not run and click Finish.

Obtaining a License

NOTICE
If a previous version of Siemens Workbench was installed and you are
connected to the Internet, you should automatically receive a new license. This
may not automatically occur on a computer with the Siemens corporate load of
Windows.
In this case, start Siemens Workbench and skip to the procedure Installing and
Configuring a Siemens N4 Appliance Station and Platform.

1. Start Siemens Workbench.


 The Request License dialog box displays.

2. Call the Siemens number listed in the dialog box and provide the information
displayed, or download/email the license from your Niagara Central licensing
portal.
3. Once you receive the license *.zip file, save it to your computer and extract its
contents.
4. Navigate to the location where Siemens Workbench is installed and open the
security folder.
 The default location is C:\Siemens\SiemensWorkbench-4.10.2/4.11.1 .x.x.
5. Copy the *.license file(s) into the target host’s licenses folder.
Note: You can rename any license file without affecting it. For example, you can
change the name from Tridium.license to MyHost2.license to keep from

A6V101007427_en_--i 2022-05-28 11 | 112


Install/Upgrade to Siemens N4.10.2/4.11.1 Workbench
Installing Siemens Niagara Workbench (N4.10.2/4.11.1)

overwriting an existing license file with the same name.

6. Copy any *.certificate files into the certificates folder. These files come with the
License file.
7. Start Siemens Workbench.
 The Siemens Workbench welcome screen displays.

Next Steps
Review the options in the following table and then go to the relevant section for
installation/upgrade of Siemens N4 Appliance. The Siemens N4 Appliance software
package is available Niagara Central.

Status Installation/Upgrade Procedure


You have used Siemens N4 device templates and pre- Installing Siemens N4 Appliance for using Siemens
configured services Device Templates and Pre-configured Services [➙ 13]
This section also discusses adding the usage of N4
PPCL and Point editors.

12 | 112 2022-05-28 A6V101007427_en_--i


Install/Upgrade to Siemens N4.10.2/4.11.1 Workbench
Installing Siemens N4 Appliance for using Siemens Device Templates and Pre-configured Services

Status Installation/Upgrade Procedure


You have used Siemens N4 PPCL and Point editors Installing N4 appliance for Using PPCL and Point
Editors [➙ 25]
This section also discusses adding the usage of N4
device templates and pre-configured services.
None of above Read the section “Installing Siemens N4 Appliance for
using Siemens devices templates and pre-configured
services.
● The type of installation is a new installation on
Workbench or JACE.
● To configure the station to use PPCL and Point
editors, go to Installing N4 appliance for Using
PPCL and Point Editors [➙ 25].
NOTICE! Communication links must be configured!
After Siemens N4 Appliance is installed, complete the
procedure Identifying and configuring the station
communication links [➙ 26].

Installing Siemens N4 Appliance for using


Siemens Device Templates and Pre-configured
Services

Before Installing the Siemens N4 Appliance


This section describes prerequisites for the installation. The following preparation
steps are required:
● Determining the type of installation
● Extracting Siemens N4 Appliance files
● Installing Siemens N4 Certificate Chain
● Providing passphrase to config.bog
● Running “InstallUpdateFiles.bat” to automatically copy Siemens update files,
device templates and Siemens modules to their prospective folders.

Determining the Type of Installation


The following sections describe the available types of installation. You must choose an
installation type before starting the installation process, as the installation procedures
will vary based on type.
Table 1: Siemens N4 Appliance Installation Types

Installation Type Description


New Installation - Covers installation of the Siemens N4 Appliance on a newly created N4
Supervisor Supervisor (PC) station. See New Installation - Supervisor (PC) Station [➙ 18].

Upgrade - Supervisor Covers upgrade of an N4 Supervisor station from Siemens N4 Appliance 1.10 to
Siemens N4 Appliance 3.00. See Upgrade - Supervisor (PC) Station [➙ 19].

A6V101007427_en_--i 2022-05-28 13 | 112


Install/Upgrade to Siemens N4.10.2/4.11.1 Workbench
Installing Siemens N4 Appliance for using Siemens Device Templates and Pre-configured Services

Installation Type Description


New Installation - Covers installation of the Siemens N4 Appliance on a newly created N4
JACE Controller (JACE) station. See New Installation - Controller (JACE) Station
[➙ 20].

Upgrade - JACE Covers upgrade of an N4 Controller station from Siemens N4 Appliance 1.10 to
Siemens N4 Appliance 3.00. See Upgrade - Controller (JACE) Station [➙ 23].

Siemens N4 Appliance Related Files


Siemens N4 Appliance Files are incorporated with the Niagara 4.10 release. The
folder should contain the following:

Fig. 1: Content of the Siemens N4 Supervisor folder.

The Siemens appliance files are in modules, templates and UpdateFiles.


InstallationUpdateFiles.bat is a batch file that will be used in the installation and is
discussed in the next sections.

Installing Siemens N4 Certificate Chain


To run the Siemens N4 appliance, you need to install the Siemens N4 Certificate
Chain in Certificate Management via Platform and Tools.

Importing Siemens N4 Certificate Chain in Platform

Importing the Siemens N4 Certificate in the JACE platform is done during the first
time the workbench is installed.

 You have extracted the files from Siemens N4 Supervisor- 4.10.2/4.11.1.154.3 .

14 | 112 2022-05-28 A6V101007427_en_--i


Install/Upgrade to Siemens N4.10.2/4.11.1 Workbench
Installing Siemens N4 Appliance for using Siemens Device Templates and Pre-configured Services

1. In the Niagara workbench, go to Platform > Certificate Management > User


Trust Store > Import.

2. Navigate to the SiemensN4CeritificateChain.pem file.


3. Click Open.

4. Select all certificates.


5. Click OK.

A6V101007427_en_--i 2022-05-28 15 | 112


Install/Upgrade to Siemens N4.10.2/4.11.1 Workbench
Installing Siemens N4 Appliance for using Siemens Device Templates and Pre-configured Services

6. Enter an alias for the certificate and click OK. Repeat this step for each certificate.

 Your certificates are added to the User Trust Store via Platform.

Providing a passphrase to the config.bog file

This step is required to install/upgrade the Siemens N4 Appliance for Jace.

In the Niagara workbench, navigate to


\UpdateFiles\Siemens_Update_3_00\config.bog and double-click the config.bog
file.

16 | 112 2022-05-28 A6V101007427_en_--i


Install/Upgrade to Siemens N4.10.2/4.11.1 Workbench
Installing Siemens N4 Appliance for using Siemens Device Templates and Pre-configured Services

Fig. 2: Assign passphrase – navigate to the config.bog file in Niagara workbench.

1. Click on the tool bar to open the Bog File Passphrase editor.

Fig. 3: Assign passphrase – bring up Bog File Passphrase editor.

2. Select the option Force the file to start using a different passphrase that you
specify…

3. Click Update and then in the tool bar to save the passphrase.
 A passphrase is now assigned to the config.bog file.

Running the InstallUpdateFiles.bat file to automatically


copy Siemens update files, device templates and
Siemens modules to their prospective folders
Running InstallUpdateFiles.bat automatically installs the following files sets:
● Siemens modules provide Siemens specific functionalities for the station. Most
installation cases require these modules.
● Siemens device templates are convenient for adding a Siemens device. See
Determine if Siemens N4 Appliance Templates should be installed [➙ 18] section
to determine if they should be installed.
● Station update files are used by the N4 Workbench to create a Siemens N4
Appliance station. They must be installed.

A6V101007427_en_--i 2022-05-28 17 | 112


Install/Upgrade to Siemens N4.10.2/4.11.1 Workbench
Installing Siemens N4 Appliance for using Siemens Device Templates and Pre-configured Services

Determine if Siemens N4 Appliance Templates should be


installed
Most cases require the template installation.
● Install templates in all new installation scenarios, Supervisor and JACE.
● Install templates in all upgrade scenarios, except if you have devices integrated
using Siemens N4 Appliance version 1.10 templates and you do not plan to
upgrade these to the current version templates after upgrading the station.

Run InstallUpdateFiles.bat
To run the batch file, you must use the Niagara console. In the Niagara console,
navigate to the folder that contains InstallUpdateFiles.bat.
1. Type InstallUpdateFiles.bat and press Enter.
2. Follow the prompts to complete the process. (You will be asked to confirm if you
want to copy and override old files.)

Fig. 4: Install Siemens Update Files by running InstallUpdateFiles.bat.

 The installation prerequisites are complete.


3. Use the appropriate following section for your installation type to complete the
installation processes.

See also
 Siemens N4 Appliance Related Files [➙ 14]

New Installation - Supervisor (PC) Station


This section covers the steps required to install the Siemens N4 Appliance on a newly
created N4 Supervisor (PC) station.

Complete the procedure Before Installing the Siemens N4 Appliance [➙ 13] before
performing these steps.

18 | 112 2022-05-28 A6V101007427_en_--i


Install/Upgrade to Siemens N4.10.2/4.11.1 Workbench
Installing Siemens N4 Appliance for using Siemens Device Templates and Pre-configured Services

1. Create a new empty station


a. From the Tools menu, create a new supervisor station of the appropriate type
for the target platform (i.e. Windows or Linux).

b. After setting the admin password, select copy it to secure platform for
“localhost” with “Station Copier.
2. Add services
NOTE: Do not manually install BacnetNetwork from the palette. The
sieUpdateStation process below will add a pre-configured BacnetNetwork with
pre-configured features.
Open the newly created station and do the following in the Palette sidebar:
a. Open the sieUtilities palette and drag SieUtilitiesService and
SieUpgradeStation into the station’s Config/Services folder.

b. Open the dashboard palette and drag DashboardService into the station’s
Config/Services folder.
3. Upgrade the station
Right-click the SieUpgradeStation service and select Actions/Sie Upgrade
Station.
 The station is converted to a Siemens N4 Appliance station.
4. Restart the station
Open Platform/Application Director and restart the new station.
 The installation is complete.

Upgrade - Supervisor (PC) Station


This section covers the steps required to update a Siemens N4 Appliance version 1.10
station to version 3.00.

NOTICE
Save a copy of your current Siemens Appliance 1.10 station!
Always use Station Copier to save a copy of your current Siemens Appliance 1.10
station before executing the upgrade procedure.

Complete the procedure Before Installing the Siemens N4 Appliance [➙ 13] before
performing these steps.

1. Add services
From the Palette sidebar, open the sieUtilities palette and drag
SieUpgradeStation into the station’s Config/Services folder.
2. (Optional) Remove hierarchy definitions
Version 3.00 of the Siemens N4 Appliance has removed unnecessary complexity
from its built-in navigation hierarchies. To take advantage of the changes, open
Config/Services/HierarchyService, and remove all of the hierarchy definitions
(Site, Devices, AHU, etc.) shown in the following Figure.

A6V101007427_en_--i 2022-05-28 19 | 112


Install/Upgrade to Siemens N4.10.2/4.11.1 Workbench
Installing Siemens N4 Appliance for using Siemens Device Templates and Pre-configured Services

If you have customized the hierarchies or do not want them replaced, do not remove
the definitions

Fig. 5: Hierarchy Definitions

3. Upgrade the station


Right-click the SieUpgradeStation service and select Actions/Sie Upgrade
Station.
 The station is converted to a Siemens N4 Appliance 3.00 station.
4. Restart the station
Open Platform/Application Director and restart the updated station.
 The installation is complete.
To update installed devices to Siemens N4 Appliance 3.00 templates, see Updating
Installed Devices [➙ 24].

New Installation - Controller (JACE) Station


This section covers the steps required to install the Siemens N4 Appliance on a newly
created N4 Controller (JACE) station.

Complete the procedure Before Installing the Siemens N4 Appliance [➙ 13] before
performing these steps.

 JACE has been commissioned to include the license, platform users, TCP/IP, and
minimum required modules (defaults during commissioning wizard).

20 | 112 2022-05-28 A6V101007427_en_--i


Install/Upgrade to Siemens N4.10.2/4.11.1 Workbench
Installing Siemens N4 Appliance for using Siemens Device Templates and Pre-configured Services

 Certifications are installed to the platform. See Installing Siemens N4 Certificate


Chain [➙ 14].
1. Create a new empty station
– From the Tools menu, create a new controller station of the appropriate type
for the target platform.
2. Copy the new empty station to the JACE
– Open the JACE platform (not the Supervisor platform) and use
Platform/Station Copier to copy a station to the JACE platform.
– Accept all required modules
 The new station is copied to JACE.
 The JACE platform restarts.

Fig. 6: JACE Platform Station Copier

3. After the finished restart, open the JACE platform (not the Supervisor platform)
and use Platform/Software Manager to copy modules to the JACE platform.
– Select haystack-rt, bacnetUtil-rt, and dashboard-rt/ux/wb
– Scroll down and select all of the following modules: sieUtilities-rt,
siemensAppliance-rt, siemensAppliance-ux, siemensAppliance-wb,
haystack-rt, dashboard-rt, dashboard-ux, dashboard-wb, batchJob-rt,
batchJob-wb, provisioningNiagara-wb, kitPxN4svg-wb and bacnetUtil-rt.
– Click Ok to satisfy all dependencies.
– Select Install.
– Click Commit.
 The station restarts.
 The new modules are sent to the JACE.

A6V101007427_en_--i 2022-05-28 21 | 112


Install/Upgrade to Siemens N4.10.2/4.11.1 Workbench
Installing Siemens N4 Appliance for using Siemens Device Templates and Pre-configured Services

Fig. 7: Siemens Modules

4. Do the following in File Transfer Client in the platform, to install the station
update files:
a. In the left pane, under Files on this computer, locate and open the
Siemens_N4_Appliance_3_00_100/UpdateFiles folder as shown in Figure 8,
Transferring the Siemens_Update Folder. Move the cursor over the path
configuration box to display the selected path. If you cannot find the
Siemens_N4_Appliance_3_00_100 folder, review the first section of this
document.

b. In the right pane, under Files on “[station_id]”, open /home/niagara/shared.


Your File Transfer Client view should appear similar to the view shown in Figure 8,
Transferring the Siemens_Update Folder.

c. Click the arrow pointing to the right to copy the folder and its content. A
Siemens_Update_3_00 folder will display in the right pane.

Fig. 8: Transferring the Siemens_Update Folder

5. Add Services
a. Log back into and open the restarted station. From the Palette sidebar, open
the sieUtilities palette and drag SieUtilitiesService and SieUpgradeStation into

22 | 112 2022-05-28 A6V101007427_en_--i


Install/Upgrade to Siemens N4.10.2/4.11.1 Workbench
Installing Siemens N4 Appliance for using Siemens Device Templates and Pre-configured Services

the station’s Config/Services folder.

b. From the Palette sidebar, open the dashboard palette and drag
DashboardService into the station’s Config/Services folder.
6. Upgrade the Station
Right-click the SieUpgradeStation service and select Actions/Sie Upgrade
Station.
 The station is converted to an N4 Appliance station.
7. Restart the Station
Open Platform/Application Director and restart the new station.
 The installation is complete.

Upgrade - Controller (JACE) Station


This section covers the steps required to update a Siemens N4 Appliance version 1.10
station to version 3.00.

NOTICE
Save a copy of your current Siemens Appliance 1.10 station!
Always use Station Copier to save a copy of your current Siemens Appliance 1.10
station before executing the upgrade procedure.

Complete the procedure Before Installing the Siemens N4 Appliance [➙ 13] before
performing these steps.

1. Update Modules in the JACE


a. Open the JACE platform (not the Supervisor platform) and use
Platform/Software Manager to copy modules to the JACE platform.

b. Click Upgrade.

c. Scroll down to find the siemensAppliance. (Select the following files:


siemensAppliance-rt/ux/wb), sieUtilities, and if not previously installed,
haystack-rt, bacnetUtil-rt, and dashboard-rt/ux/wb.

d. Click Commit. The new modules are sent to the JACE.


2. Restart the Station
Open Platform/Application Director and restart the new station.
3. Install the Station Update Files. The station update files are used by the JACE
station to create a Siemens N4 Appliance 3.00 station. In File Transfer Client:

a. In the left pane, under “Files on this computer”, locate and open the
Siemens_N4_Appliance_3_00_100/UpdateFiles folder as shown in the following
Figure. Move the cursor over the path configuration box to display the selected
path. If you cannot find the Siemens_N4_Appliance_3_00_100 folder, review the
first section of this document.

A6V101007427_en_--i 2022-05-28 23 | 112


Install/Upgrade to Siemens N4.10.2/4.11.1 Workbench
Installing Siemens N4 Appliance for using Siemens Device Templates and Pre-configured Services

b. In the right pane, under Files on “[station_id], locate and open


/home/niagara/shared. Your File Transfer Client view should look similar to the
view shown in Figure 9, Transferring the Siemens_Update Folder.

c. Click the arrow pointing to the right to copy the folder and its contents. You
should then see a Siemens_Update_3_00 folder in the right pane.

Fig. 9: Transferring the Siemens_Update Folder

4. Add Services
a. Log in to the restarted station.

b. From the Palette sidebar, open the sieUtilities palette and drag
SieUpgradeStation into the station’s Config/Services folder.
5. Upgrade the Station
Right-click on the SieUpgradeStation service and select Actions/Sie Upgrade
Station.
 The station is converted to an N4 Appliance station.
6. Restart the Station
Open Platform/Application Director and restart the new station.
 The Installation is now complete.
To update installed devices to Siemens N4 Appliance 3.00 templates, see section 8.

Updating Installed Devices


This section describes the process of upgrading devices integrated with Siemens N4
Appliance version 1.10 templates to new templates. The process is the same for
supervisor (PC) and controller (JACE) stations.
To upgrade device templates, perform the following procedures:

24 | 112 2022-05-28 A6V101007427_en_--i


Install/Upgrade to Siemens N4.10.2/4.11.1 Workbench
Installing Siemens N4 Appliance for using Siemens Device Templates and Pre-configured Services

1. Use the station’s Config/Services/TemplateService to perform the upgrade. Either


double-click TemplateService or right-click TemplateService and select
Views/AX Template Manager.

Fig. 10: AX Template Manager

2. Devices installed with older template revisions should be marked Out of Date.
a. Select templates to be updated and click Upgrade.
b. Alternately, click Upgrade All Out Of Date. Then click Commit to upgrade the
devices.
3. Restart the station after the upgrade procedure is complete.

Configuring the Siemens station to use PPCL and Point


Editors (if not used before)
Read this section if you have not previously used the Siemens N4 PPCL and Point
editors.

Installing the N4 Appliance


If you have not installed the Siemens N4 Appliance and created a station, continue
with Installing N4 Appliance for use PPLC and Point editors [➙ 25],
or,
If the N4 Appliance is installed, see Add SiemensUtilitiesServe and RunsieUpdaetd
Db [➙ 26] for enabling editors.

Installing N4 appliance for Using PPCL and Point Editors


1. With the N4 Appliance running, right-click the host and select Open Platform.
2. Open Application Director and stop any stations that are currently running on the
host.
3. Exit Niagara N4.
4. In the Niagara 4.8 console, navigate to the folder that contains
InstallUpdateFiles.bat in the Siemens_N4_Appliance_3_00_100 folder.

A6V101007427_en_--i 2022-05-28 25 | 112


Install/Upgrade to Siemens N4.10.2/4.11.1 Workbench
Installing Siemens N4 Appliance for using Siemens Device Templates and Pre-configured Services

5. Type InstallUpdateFiles.bat and press Enter.


6. Select the following at the prompts for copying and overriding old files:
– Yes for copying Siemens modules.
– No to the other two questions.

Fig. 11: Install Siemens Update Files by running InstallUpdateFiles.bat.

 The Siemens station is configured to use PPCL and Point Editors.

Add SiemensUtilitiesService and Run sieUpdate Db


1. Start a station (or create a new station and start it).
2. Add SiemensUtilitiesService from sieUtilities palette to Services.
3. If an integration already exists, right click SiemensUtilitiesService > action and
select sie update Db.
 The station is updated to the current release.
4. For a new station, continue with Identifying and Configuring the Station
Communication Links [➙ 26] to configure the station’s communication links.
If you have not used Siemens device templates and pre-configured services and
would like to use them, you need to re-do the integration. See Installing Siemens N4
Appliance for Using Siemens Device Templates and Pre-configured Services [➙ 13],
and select the installation type New installation on workbench or JACE.
You cannot convert existing integrations without Siemens device templates.

Identifying and configuring the station communication


links
Before configuring BACnet networks, you must identify the network layout. This
section includes example layouts that you can use to identify station communication
links that must be added and/or configured.

NOTE:
Since N4 / TNM Niagara stations may connect to devices using both BACnet/IP and
BACnet MS/TP ports, in some cases, more than one example in this section may
apply.
The devices outlined in this section are examples only. They are provided to illustrate
the types of devices that could be included on various types of networks.

26 | 112 2022-05-28 A6V101007427_en_--i


Install/Upgrade to Siemens N4.10.2/4.11.1 Workbench
Installing Siemens N4 Appliance for using Siemens Device Templates and Pre-configured Services

Niagara Supervisor
A Niagara Supervisor typically has a single BACnet/IP link, as shown in the following
figure.

Fig. 12: Computer-hosted Station.

For this type of network layout, follow the instructions in the section Configuring a
Niagara Supervisor BACnet/IP Links.

A6V101007427_en_--i 2022-05-28 27 | 112


Install/Upgrade to Siemens N4.10.2/4.11.1 Workbench
Installing Siemens N4 Appliance for using Siemens Device Templates and Pre-configured Services

N4 / TNM with BACnet/IP Link(s)


A Niagara station typically has a single BACnet/IP link, but may be configured with
two, as shown in the following figure.

Fig. 13: N4 / TNM Station with BACnet/IP Link(s).

For this type of network layout, follow the instructions in the section Configuring N4
JACE station BACnet/IP Links [➙ 29].

N4 / TNM with BACnet MS/TP Link(s)


A Niagara station without expansion modules may be configured with one or two
MS/TP links, as shown in the following figure. Expansion modules may be added to
provide additional MS/TP ports. Additional ports are configured using the same
instructions as on-board ports.
NOTE: For this configuration, only the PTEC editors are available.

Fig. 14: N4 / TNM Niagara Station with BACnet MS/TP Link(s).

For this type of network layout, follow the instructions in the section Configuring N4
JACE station BACnet MS/TP Links [➙ 31].

Adding a BACnet network and Siemens utilities to the


station
 You are connected to the station.

28 | 112 2022-05-28 A6V101007427_en_--i


Install/Upgrade to Siemens N4.10.2/4.11.1 Workbench
Installing Siemens N4 Appliance for using Siemens Device Templates and Pre-configured Services

1. In the Nav pane, expand Station > Config > Drivers.


2. From the menu bar, select Window > Side Bars > Palette.
 The Palette pane opens.
3. To add the BACnet network. NOTE: Do this only if you are not using templates.

– In the Palette pane, click Open and type bacnet in the filter field.
– Select the bacnet module and click OK.
– Drag-and-drop BacnetNetwork from the Palette pane onto Drivers in the Nav
pane and click OK.
4. To add the Siemens Utilities Service:

– In the Palette pane, click Open and type sie in the filter field.
– Select the SieUtilities module and click OK.
– Drag-and-drop SieUtilitiesService from the Palette pane onto Services in the
Nav pane and click OK.

5. In the Nav pane, right-click the station and select Save station.
 The configuration is complete and saved.

Configuring N4 JACE station BACnet/IP Links


1. In the Nav pane, expand Station > Config > Drivers > BacnetNetwork.
2. Double-click BacnetComm to display the Property Sheet.
3. In the Property Sheet, expand Network > Ip port > Link.

A6V101007427_en_--i 2022-05-28 29 | 112


Install/Upgrade to Siemens N4.10.2/4.11.1 Workbench
Installing Siemens N4 Appliance for using Siemens Device Templates and Pre-configured Services

4. Update the parameters as needed. Generally, the parameters in the following


table need to be configured.
5. Click Save to save the view.
When configured correctly:
● Status transitions to {ok}.
● Ip Address corresponds to the Platform/TCP/IP Configuration settings for the
selected port.
For additional network diagnostics, see the Network Statistics [➙ 36] section.
Table 2: Parameters for a Niagara station BACnet/IP Link.

Parameter Notes

Network Number The number of the BACnet network to which the station’s IP port is
connected.

Adapter The IP network port used to connect to the BACnet network.

● Select dm0 for the port marked Pri on the N4 / TNM enclosure.
● Select dm1 for the port marked Sec on the N4 / TNM enclosure.
If an expected port is missing from the drop-down list, use
Platform/TCP/IP Configuration to setup network ports.

Enabled Enables or disables the communication link.

Routing_Enabled ● If the N4 / TNM will have BACnet MS/TP devices connected to


any of its MS/TP ports (see the figure N4 / TNM with BACnet
MS/TP Link(s)) and communication between BACnet/IP devices
and the connected BACnet MS/TP devices is required, set
Routing_Enabled to true. When set to true, the N4 / TNM routes
messages between the BACnet/IP port and the MS/TP port(s).
● If the N4 / TNM will not have BACnet MS/TP devices connected
to any of its MS/TP ports (see the figure N4 / TNM with BACnet
MS/tP Link(s)) or communication between BACnet/IP devices and
the connected BACnet MS/TP devices is prohibited, set
Routing_Enabled to false.

Maintain_Routing_Enabled ● When set to false, the station automatically disables routing in the
presence of routing errors, such as router loops.
● When set to true, the station continues to attempt to route
messages even when routing errors are detected.

Configuring Multiple BACnet/IP Links


 To configure multiple BACnet/IP links do the following to ensure that the
preconfigured network statistics counters and views described in the Network
Statistics [➙ 36] section are available on the new link:

◈ Right-click and select Duplicate to duplicate one of the default links.

30 | 112 2022-05-28 A6V101007427_en_--i


Install/Upgrade to Siemens N4.10.2/4.11.1 Workbench
Installing Siemens N4 Appliance for using Siemens Device Templates and Pre-configured Services

Fig. 15: Configuring a Niagara station BACnet/IP Link.

Configuring N4 JACE station BACnet MS/TP Links


1. In the Nav pane, expand Station > Config > Drivers > BacnetNetwork.
2. Double-click BacnetComm to display the Property Sheet.
3. In the Property Sheet, expand Network > Ip port > Link.
4. Update the parameters as needed. Generally, the parameters in the following
table need to be configured.
5. Click Save to save the view.
When configured correctly:
Status transitions to {ok}.
For additional network diagnostics, see the Network Statistics [➙ 36] section.
Table 3: Parameters for a Niagara station BACnet MS/TP link.

Parameter Notes
Network Number The number of the BACnet network to which the station’s IP port is
connected.

Port Name The MS/TP network port used to connect to the BACnet network.
Enter COM1 or COM2, based on the port markings on the N4 / TNM
enclosure.

A6V101007427_en_--i 2022-05-28 31 | 112


Install/Upgrade to Siemens N4.10.2/4.11.1 Workbench
Installing Siemens N4 Appliance for using Siemens Device Templates and Pre-configured Services

Parameter Notes
Baud Rate The bit rate of the MS/TP network.

Mstp Address The MS/TP network MAC address for the N4 / TNM on the connected
MS/TP network. Zero (0) is usually a safe choice for this.

Enabled Enables or disables the communication link.

Routing_Enabled ● If BACnet MS/TP devices will be connected to more than one


MS/TP port of the N4 / TNM (see the figure SLX with BACnet
MS/TP Link(s)), and communication between BACnet MS/TP
devices on different ports is required, set Routing_Enabled to
true. When set to true, the N4 / TNM routes messages between
the BACnet MS/TP ports.
● If the N4 / TNM will have BACnet MS/TP devices connected to
only a single MS/TP port (see the figure SLX with BACnet MS/TP
Link(s)) use the Routing_Enabled setting determined in the
section Configuring N4 JACE station BACnet/IP Links [➙ 29].

Routing_Enabled ● If BACnet MS/TP devices will be connected to more than one


MS/TP port of the N4 / TNM (see the figure TNM with BACnet
MS/TP Link(s)), and communication between BACnet MS/TP
devices on different ports is required, set Routing_Enabled to
true. When set to true, the N4 / TNM routes messages between
the BACnet MS/TP ports.
● If the N4 / TNM will have BACnet MS/TP devices connected to
only a single MS/TP port (see the figure TNM with BACnet MS/TP
Link(s)) use the Routing_Enabled setting determined in the
section Configuring TNM BACnet/IP Links.

Maintain_Routing_Enabled ● False
The station automatically disables routing in the presence of
routing errors, such as router loops.
● True
The station continues to attempt to route messages even when
routing errors are detected.

Configuring Multiple MS/TP Links


 To configure multiple MS/TP links, do the following to ensure that the
preconfigured network statistics counters and views described in the Network
Statistics [➙ 36] section are available on the new link:

◈ Right-click and select Duplicate to duplicate one of the default links.

Configuring the BACnet Local Device


The station must have a valid BACnet Device Object Id that is unique on the BACnet
network.
To avoid conflicts with other BACnet devices on the network, Object Id defaults to -1,
which is an invalid value. If Object Id is left at -1, the station is not able to discover or
communicate with devices on the BACnet network.
 You have connected to the Siemens N4 Appliance station using the admin
account.
1. In the Nav pane, expand Station > Config > Drivers > BacnetNetwork.
2. Double-click Local Device to display the Property Sheet.

32 | 112 2022-05-28 A6V101007427_en_--i


Install/Upgrade to Siemens N4.10.2/4.11.1 Workbench
Installing Siemens N4 Appliance for using Siemens Device Templates and Pre-configured Services

3. In the Property Sheet, enter a unique Object Id in the range from 0 through
4194302. The Object Id must not be used by any other device on the BACnet
network.
4. Click Save to save the view.

Running the Station on an N4 Controller


1. Select File from the drop-down menu and select Open Platform.
2. Enter the IP address of the N4 Appliance Controller in the dialog box and select
OK.
3. If prompted to verify a certificate, select OK.
4. In the list of platform views, double-click Platform Administration to access those
tools.
5. In the platform administration window, select the Commissioning button.
6. In the Commissioning Dialog, make the following selections:
7. De-select or Select the license option, depending on if a license has been
deployed.
8. Unselect Lexicons.

Lexicons allow user to view Workbench in other languages, you may install them if
you wish.

9. Ensure synch with my local system date and time is selected.


10. Deselect Configure TCP/IP.
11. Click Next.
12. For Enable Runtime profiles, select UX and WB.
13. When prompted to choose a station to install on the Jace, select the station you
created in the previous procedure.
14. Select Auto Start and Start After Install.
15. If asked for a passphrase enter one.
16. Select copy Every File in the Station Directory and Subdirectories
17. In the Software Installation dialog, if Upgrade All Out of Date is disabled, select
Next. If Upgrade All Out of Date is enabled, select it.
18. Select Next.
19. In the Distribution File Installation, select Next
20. Change the passphrase, if required.
21. Change platform username and password, if required. Click Next.
22. In the Review Changes dialog box, click Finish.
23. Wait for the station to start. It can take 2 to 5 minutes.
 Connect to the platform and station with new passwords.

A6V101007427_en_--i 2022-05-28 33 | 112


Install/Upgrade to Siemens N4.10.2/4.11.1 Workbench
Configuring the Required Networks

Configuring the Required Networks


The Siemens N4 Appliancestation is semi-preconfigured with BACnet and MS/TP
network defaults. This section outlines the steps to complete the configuration with
data that is specific to the project (job site) where the station is used.

Configuring a BACnet/IP Network


 You have connected to the Siemens N4 Appliance station using the admin
account.
1. In the Nav pane, expand Station > Config > Drivers > BacnetNetwork.
2. Double-click BacnetComm to display the Property Sheet.
3. In the Property Sheet, expand Network > IP Port.
4. Enter the Network Number and verify the other BACnet network parameters. See
the Niagara N4.x BACnet Guide located in the C:\Siemens\SiemensWorkbench-
4.10.x.x\docs\docBacnet folder for more information.
5. Expand Link and select the network adapter used to connect to the BACnet
network.
Notice: There might be more than one adapter on a machine.
If an adapter is missing from the list, right-click on Link and select Actions >
Query for Adapters to refresh the list.
6. Set Enabled to True.
7. Set Maintain Routing Enabled to True if other BACnet networks are part of the
configuration.
8. Click Save to save the view.
When configured correctly:
● Ip Address corresponds to the computer’s settings for the selected network
adapter.
● Status changes to {ok}.

34 | 112 2022-05-28 A6V101007427_en_--i


Install/Upgrade to Siemens N4.10.2/4.11.1 Workbench
Configuring the Required Networks

Configuring a BACnet MS/TP Network

NOTE:
Only complete this procedure if the configuration does not use a Siemens field panel.
That is, if Siemens MS/TP devices are connected directly to MS/TP ports of the N4 /
TNMcontroller.

Configure an MS/TP port for each N4 / TNMcontroller. Each network number must be
unique on the network.
 You have connected to the Siemens N4 Appliancestation using the admin
account.
1. In the Nav pane, expand Station > Config > Drivers > BacnetNetwork > Bacnet
Comm.
2. Double-click Network to display the Property Sheet.
3. In the Property Sheet, expand MstpPort > Link.

A6V101007427_en_--i 2022-05-28 35 | 112


Install/Upgrade to Siemens N4.10.2/4.11.1 Workbench
Configuring the Required Networks

4. Update the following fields in the Property Sheet:


– Network Number: Enter the network number for the segment you are
connecting.
– Port Name: Enter the RS-485 port to be used on the N4 / TNM JACE
controller.
– Mstp Address: Enter a unique BACnet MAC address for that MS/TP port, in
decimal format, with a valid range from 0 (default) through 127. Up to four
MS/TP ports are supported depending on the host platform and licensing.

5. Click Save.
6. In the Nav pane, expand Network, right-click MstpPort and select Actions >
Enable.
 The MstpPort is enabled.

Network Statistics
Each default communication link in the N4 Appliance is preconfigured with a set of
communication throughput counters and a Network Statistics view. These counters
and views may be used to determine whether network traffic exists on the link (this is
available for both BACnet/IP and MS/TP).

36 | 112 2022-05-28 A6V101007427_en_--i


Install/Upgrade to Siemens N4.10.2/4.11.1 Workbench
Configuring the Required Networks

Fig. 16: Network Statistics View (example depicts MS/TP network).

A6V101007427_en_--i 2022-05-28 37 | 112


Using the Siemens N4 Appliance (PPCL and Point Editors)
Discovering and Adding Devices

Using the Siemens N4 Appliance (PPCL and


Point Editors)
The functionality in this section relies on the correct setup of the station, as shown in
the previous section.
This section outlines the following topics:
● Discovering devices and adding them to the database
● PPCL Editor overview and procedures
● Point Editor overview and procedures
NOTE: You can access the Appliance as a web server. Once the platform is open:
● Station running on a PC - point the browser to https://localhost (if the browser
and Station are running on the same PC or https:[IP address of the PC].
● Station running on an N4 Appliance Controller – point the browser to https://[IP
address of the N4 Appliance Controller].

Discovering and Adding Devices


Use the following workflow to discover devices on the network and add them to the
database:

Installation Step
1 Discovering BACnet Devices on the Network [➙ 38]

2 Adding Controllers [➙ 40]

3 Adding the PPCL and Point Editor Functions [➙ 41] to Siemens Devices.

Discovering BACnet Devices on the Network


 Siemens Workbench is open.

38 | 112 2022-05-28 A6V101007427_en_--i


Using the Siemens N4 Appliance (PPCL and Point Editors)
Discovering and Adding Devices

1. In the Nav pane, expand Station > Config > Drivers.


2. Double-click BacnetNetwork to display the Bacnet Device Manager.

3. Click Discover at the bottom of the Database pane.

 The Configure Device Discovery dialog box displays.

4. Update the following fields:


– Device Low Limit and Device High Limit: Enter a range of device instance
numbers for the discovery process.
– Networks: Select individual check boxes to limit the discovery to certain
networks or select the Send Global check box to discover devices on all
connected BACnet networks.

A6V101007427_en_--i 2022-05-28 39 | 112


Using the Siemens N4 Appliance (PPCL and Point Editors)
Discovering and Adding Devices

– NOTICE! The first time you perform the Discovery procedure, you must
select the Send Global check box. After the first successful discovery,
discovered BACnet networks are preselected, and it’s generally not
required to select the Send Global check box again.
5. Use the default setting for Wait Response Time and click OK.
 A progress bar displays during the discovery process.
 The Discovered list of devices displays when the process is complete.

Adding Controllers
Complete the following process for each device being added to the database:
1. Select a device in the Discovered list and click Add at the bottom of the pane.
You can also use multi-select to expedite this process. If you are planning to add
with a template, select the Dev Template mode expand/collapse button and
select the appropriate template for the device's application.
NOTE: If you are adding with templates, see the section Adding Controllers
[➙ 76].
 The Add dialog box displays.
2. Click OK.

40 | 112 2022-05-28 A6V101007427_en_--i


Using the Siemens N4 Appliance (PPCL and Point Editors)
Discovering and Adding Devices

 The device is added to the database.

Adding the PPCL and Point Editor Functions


This procedure adds the PPCL Editor and Point Editor functions to the device by
running the Sie Update Db process.

NOTICE
Any time you add a new device or points to Siemens Workbench, do the
following to update the database:
Right-click SieUtilitiesService and select Actions > Sie Update Db.

1. In the Nav pane, expand Station > Config > Services


2. Right-click SieUtilitiesService and select Actions > Sie Update Db.

Folder Feature for Devices


The purpose of the folder feature for devices is to allow you to organize your devices
within a BACnet device folder. Using this feature for devices will allow you to:
● Create and allow multiple folders on the same level.
● Allow devices and device folders on the same level.
● Allow five levels of nested device folders.

A6V101007427_en_--i 2022-05-28 41 | 112


Using the Siemens N4 Appliance (PPCL and Point Editors)
Using the PPCL Editor

A device and device folder must be under BacnetNetwork. A device can also be in a
devicefolder1.

Using the PPCL Editor


The PPCL Editor allows you to create, modify, or delete a Powers Process Control
Language (PPCL) program, as well as:
● Modify line numbers
● Enable or disable lines of code
● Delete lines of code
● Reset trace bits
● Import and export PPCL programs (or sections of programs) as text files
For more information about PPCL, see the APOGEE Powers Process Control
Language (PPCL) User's Manual (125-1896).
Table 4: PPCL Editor limits.

Attribute PXC / TC Series PTEC Device


Character limit per line 198 80

Line limit per program 32767 200

Line number range 1 through 32767 1 through 327671

Supported operations All PPCL Statements Assignment, ON, OFF, RELEASE, MAX, MIN,
SET, LOOP, TABLE, DBSWITCH,
IF/THEN/ELSE, GOTO, Comment

Program name PPCL programs must be named before they can be PPCL.PGM is the default program name. The
saved. The program name cannot be changed once program name cannot be edited.
the program is saved. Limited to 30 alpha-numeric
characters

Program priority Priority can be selected when creating or importing Priority is fixed at 15.
a new program. The priority cannot be changed
through the N4 Appliance once a program is saved.
Default is 16.

42 | 112 2022-05-28 A6V101007427_en_--i


Using the Siemens N4 Appliance (PPCL and Point Editors)
Using the PPCL Editor

PPCL Program Limitations


The following are not allowed in PPCL programs:
● Blank lines or lines that only contain a line number.
● Lines without a line number.
● Duplicate line numbers.
● Out-of-sequence line numbers.
● Line numbers that are outside the range of 1 through 32767.
● Lines that contain any of the following characters:
^~#;<>\|¶
PTEC PPCL Program Limitations
The limitations for a PPCL program that can reside on a PTEC are different from those
of a PPCL program that can reside on a field panel. For more information, see the
BACnet Programmable TEC (PTEC) User Manual (125-5051) and the APOGEE
PPCL User’s Manual (125-1896).
NOTE: If you copy and paste a program from Insight Program Editor to N4 PTEC
PPCL Editor and the pilcrow (¶) sign appears, please follow the steps below:
● Configure the INSIGHT/CT/DMA Program Editor to display the pilcrow(s)
● Select the text of the line that you wish to copy, but do not select the Pilcrow
● Copy the text (without Pilcrow(s) and paste into the N4 Appliance editor. NOTE:
You can also open the PPCL file in Notepad and copy/paste into N4.

User Interface
2 3 4

5
6

A6V101007427_en_--i 2022-05-28 43 | 112


Using the Siemens N4 Appliance (PPCL and Point Editors)
Using the PPCL Editor

① Command Bar
Contains the following functions:
● Syntax Check
Performs a basic syntax check. Select this function if you need to check the syntax of a PPCL
program after it is modified or imported.
● Enable or Disable
These buttons are disabled if the program contains unsaved changes.
– PXC / TC Series: A range of line numbers can be enabled or disabled. The line number
fields default to asterisks (*), which can be used for wildcarding.
– PTEC devices: The whole program is enabled or disabled.
● Clear Trace
Clears the trace bits of program lines. This button is disabled if the program contains unsaved
changes.
● Import
Loads a PPCL program file from the local computer or from a network share.
● Export
Saves the PPCL Editor content to a text file on the local computer or to a network share.

② Program Name (PXC / TC only)


Enter a name for the PPCL program. Limited to 30 alpha-numeric characters.
③ Line Increment
The line increment for adding a new line at the end of a program. Default is 10.
If a line is added and the next line number does not allow the desired increment setting, the line
number increments by 1.
④ Program Priority
The PPCL command priority. All commands within the program will be issued using that command
priority.
● PXC / TC Series: Priority can be selected when creating or importing a new program. T he
priority cannot be changed through the N4 Appliance once a program is saved. Default is 16.
● PTEC devices: The priority is fixed at 15.
⑤ Line Status pane
Displays the status of each PPCL line. The following flags may display:
E or D - The line is enabled or disabled.
T - The line has been traced (executed) since the last time the trace bit was cleared.
U - The line references a point that does not exist in the device.
F - The line contains a syntax error.

⑥ PPCL Text Edit pane


A multi-line text field with automatic line numbering and all basic editing features.

⑦ Status pane
Displays the results of a Syntax Check, Enable, Disable, Clear Trace or Save operation.

⑧ Save button
Saves new or modified contents to the device. New or modified lines are saved as disabled.

Creating a new PPCL Program


1. Open the platform and station, if necessary. For more details, see Opening a
Platform and Station.
2. In the Nav pane, expand Station > Config > Drivers > BacnetNetwork.
3. Complete one of the following:

44 | 112 2022-05-28 A6V101007427_en_--i


Using the Siemens N4 Appliance (PPCL and Point Editors)
Using the PPCL Editor

– Expand [PXC / TCdevice] and double click AddNewPxPpclProgram.


 PPCL Editor opens in the right pane.
 If the PTEC device contains a program, it is displayed.
4. To view a PXC / TCprogram, double click the program name in the Nav pane.

Opening the PPCL Editor and Viewing an Existing PPCL


Program
1. Open the platform and station, if necessary. For more details, see Opening a
Platform and Station.
2. In the Nav pane, expand Station > Config > Drivers > BacnetNetwork.
3. Do one of the following:
– Expand [PXC / TCdevice] and double-click the desired program.
– Expand [PTEC device] and double-click siePtecPpclProgram.
 PPCL Editor opens in the right pane.
 If the PTEC device contains a program, it is displayed.

Importing a PPCL Program


Use the procedures in this section to load a PPCL program file from the local
computer or from a network share.
● Multiple programs can be imported to a PXC / TC Series device.
● Only one program can be imported to a PTEC device. Importing a new program
overwrites any program already in the device.

PXC / TC Series
1. In the Nav pane, expand Station > Config > Drivers > BacnetNetwork > [PXC /
TC device]
2. Double-click AddNewPxPpclProgram.
 PPCL Editor opens in the right pane.
3. In the PPCL Editor, click Import.
 The File Chooser opens.
4. Navigate to the file location on your computer and click Open.
Hint: Click to display recently used file paths.
 The imported program displays in the PPCL Text Edit pane.
5. Enter a unique name in the Program Name field.
Note: The program name cannot be changed once the program is saved.
6. (Optional) Select a new value for the Program Priority.
7. Click Syntax Check to check the PPCL syntax.
 The result of the Syntax Check is displayed in the Status Pane below the Line
Status Pane. Depending on screen size and resolution, you may have to scroll
down.
8. If necessary, fix any syntax errors.
9. Click Save in the bottom right corner of the pane.

A6V101007427_en_--i 2022-05-28 45 | 112


Using the Siemens N4 Appliance (PPCL and Point Editors)
Using the PPCL Editor

10. Click Yes to confirm saving the program to the device.


11. Click OK to close the confirmation message.
 The imported program displays in the PXC / TCtree in the Nav pane.

Fig. 17: Location of PPCL programs in the Nav pane (AlarmHorn: Damper; SilenceAlarm).

PTEC
1. In the Nav pane, expand Station > Config > Drivers > BacnetNetwork > [PTEC
device].
2. Double-click siePtecPpclProgram.
 PPCL Editor opens in the right pane. If the PTEC device already contains a
program, it is displayed.
3. In the PPCL Editor, click Import.
 The File Chooser opens.

46 | 112 2022-05-28 A6V101007427_en_--i


Using the Siemens N4 Appliance (PPCL and Point Editors)
Using the PPCL Editor

4. Navigate to the file location on your computer and click Open.


Hint: Click to display display recently used file paths.
 The imported program displays in the PPCL Text Edit pane.
5. Click Syntax Check to check the PPCL syntax.
6. Fix any errors that are found.
7. Click Save in the bottom right corner of the pane.
8. Click Yes to confirm saving the program to the device.
9. Click OK to close the confirmation message.

Exporting a PPCL Program


PXC / TC Series
1. In the Nav pane, expand Station > Config > Drivers > BacnetNetwork > [ PXC /
TC device].
2. Double-click the program name in the Nav pane to display it in the PPCL Editor.
3. In the PPCL Editor, click Export.
 The File Chooser opens with PpclFile.pcl as the File name.
4. If desired, enter a new File name.
5. Select the network location for saving the file and click Save.

A6V101007427_en_--i 2022-05-28 47 | 112


Using the Siemens N4 Appliance (PPCL and Point Editors)
Using the PPCL Editor

PTEC
1. In the Nav pane, expand Station > Config > Drivers > BacnetNetwork > [PTEC
device].
2. Double-click siePtecPpclProgram.
3. The PTEC program is displayed in the PPCL Editor.
4. In the PPCL Editor, click Export.
 The File Chooser opens with PpclFile.pcl as the File name.
5. If desired, enter a new File name.
6. Select the network location for saving the file and click Save.

Modifying a PPCL Program


To modify a PPCL program, complete the following:
1. Open an existing PPCL program or create a new one.
2. In the PPCL Editor Window, make your desired changes to the PPCL program.
3. To run a basic syntax check, select Syntax Check.
Syntax Check searches for the following types of errors:
● Blank lines
● Missing line numbers
● Line numbers with no statements
● Duplicate line numbers,
● Out of sequence line numbers
● Line numbers out of range. (Valid range is 1-32767 inclusive)
● Illegal characters: ^ ~ # ; < > \ |
NOTE: The device performs error checking and displays error messages in the status
pane when the program is saved.

◈ Click Save.

Deleting a PPCL Program


To delete a program from the device and the N4 database and leave the program in
the device, follow these steps:

PXC / TC Series.
1. In the Nav pane, expand Station > Config > Drivers > BacnetNetwork > [PXC /
TC device]
2. Right-click on the program you want to delete and select Views >
SiePxPpclEditor.
 The program is removed from the N4 database and left in the device.
NOTE: You cannot delete using Sie Remove Px PPCL Program if the name contains
a special character, such as “$.”
To delete a program from the N4 database and leave the program in the device,
complete the following:

48 | 112 2022-05-28 A6V101007427_en_--i


Using the Siemens N4 Appliance (PPCL and Point Editors)
Using the PTEC Point Editor

1. In the Nav pane, expand Station > Config > Drivers > BacnetNetwork > [PXC /
TC Device].
2. Right click on the program you want to delete and select Delete.
 The program is removed from N4 database and left in the device.
3. Use FP Web UI or the HMI to delete the program from the field panel.

PTEC
To delete a program from the device and the N4 database, complete the following
steps:
1. Double click siePtecPpclProgram to open the editor.
2. Remove entire content in the editing pane and click Save (you are saving an
empty program).

NOTICE
You can only save an empty program. You cannot delete a PPCL program in PTEC.

Using the PTEC Point Editor


The Point Editor allows you to perform the following functions:
● Discover points on a PXC / TC and add them to the database.
● Create new points on a PXC / TC or PTEC.
● Modify and delete existing points on a PXC / TC or PTEC.
For information on point characteristics, see the APOGEE BACnet ALN Field Panel
User's Manual (125-3020).

PTEC Point User Interface

A6V101007427_en_--i 2022-05-28 49 | 112


Using the Siemens N4 Appliance (PPCL and Point Editors)
Using the PTEC Point Editor

① Point Name
Displays the point name. Maximum of 12 characters.
Type
Drop-down list for the point type (AO or BO).
Instance #
Displays the instance number (1,000 or higher).
Engineering Units
Drop-down list for the standard BACnet engineering units. This column is disabled for BO points.
State Text
Drop-down list for the state text used to indicate point value. This column is disabled for AO points.
Inactive Text
The value displayed when the point is in the inactive (0) state. This column is disabled for AO
points.
Active Text
The value displayed when the point is in the active (1) state. This column is disabled for AO points.
Default Value
Displays the default point value. This is a numeric field for AO points and a drop-down list for BO
points.

② Analog Output (AO) Point


③ Binary Output (BO) Point
④ Status pane
Displays the results of a Syntax Check or Save operation.


⑥ Syntax Check
Performs a basic syntax check.

⑦ Save button
Saves new or modified contents to the device.

When you select a PTEC device, the object list indicates the ability to select the
Custom Point Table. After selecting the Custom Point Table from the object list, the
PTEC Point Editor table displays, showing the custom application point objects. All
information is editable.

Adding Point Editor Functions


To edit the PXC / TC points or PTECs, first run the Sie Update Db command to make
the editor function visible. See Adding the PPCL and Point Editor Functions for details.

Opening the Point Editor and Viewing Points


Open the station, if necessary.
1. In the Nav pane, expand Station > Config > Drivers > BacnetNetwork > [PTEC
device] and then double-click siePtecPointTable.
2. The PTEC point table displays in the right pane.

Adding PTEC Points


1. Open the Station.
2. Navigate to Station > Config > Drivers > BacnetNetwork > [PTEC device]
3. Expand the PTEC device, and double click on siePtecPointTable.

50 | 112 2022-05-28 A6V101007427_en_--i


Using the Siemens N4 Appliance (PPCL and Point Editors)
Using the Point Editor

4. The PTEC Point Editor table displays, showing all custom points (user-defined
BACnet objects) in the PTEC device.
5. Click the + button at the bottom right of the PTEC Point Editor window.
 A new row displays in the PTEC Point Editor table. The new row is configured
for an AO type point by default:

6. Enter the new PTEC point information.


7. To check the Syntax at any point, select Syntax Check.
8. Click Save.
9. Click Yes at the "Press OK to Proceed Saving?" prompt
10. For PTEC, a point added by the Point Editor is not automatically added to the N4
point folder. Use the standard N4 point discover/add functions to add it to the N4
station.

Modifying a PTEC Point


To modify a PTEC point, complete the following:
 The Station is open.
1. Navigate to Station > Config > Drivers > BacnetNetwork > [PTEC Device]
2. Expand the PTEC device, and double click on the siePtecPointTable.
3. The PTEC Point Editor table displays, showing all custom points (user-defined
BACnet objects) in their PTEC device.
4. Modify point(s) in the table as desired.
5. To check the Syntax at any point, select Syntax Check.
6. Click Save and Yes in the ensuing pop-up window.

Deleting a PTEC Point


1. Double click siePtecPointTable to open the point editor.
2. Click anywhere on the row of the point to be deleted.
3. Click the (-) button in the lower right-hand corner.
4. Save changes.

Using the Point Editor

Point User Interface


In the Nav pane, select Station > Config > Drivers > [PXC / TC Device] > Points >
right click AddNewPxPoint > Views > Select the appropriate point type from the
options provided.
See below for an example.

A6V101007427_en_--i 2022-05-28 51 | 112


Using the Siemens N4 Appliance (PPCL and Point Editors)
Using the Point Editor

Sie Px Pt Editor Analog Physical

1. Point Type
2. Point values
3. Save button
All points added to a PX controller using the N4 PX point editor are automatically
added to the N4 database.

Discovering Points
To modify an existing point in a PXC, you must first add the point to the N4 database,
and then run SieUpdateDb, which will allow you to edit the point.
To add a point:
1. Navigate to Station > Config > Drivers > BacnetNetwork > [PXC / TC Device] >
Points.
2. Double-click on Points.
3. Click Discover.
4. Find and select to highlight the desired point.
5. Click Add.

If you need to rename a point, perform sieUpdateDb in the next steps first, and then
make the change.
● Navigate to Station > Config > Services > SieUtilitiesService.
● Right-click on SieUtilitiesService and select Actions > SieUpdateDb.

52 | 112 2022-05-28 A6V101007427_en_--i


Using the Siemens N4 Appliance (PPCL and Point Editors)
Using the Point Editor

Adding Points
1. In the Nav pane, expand Station > Config > Drivers > BacnetNetwork >
[device] > Points and then right click AddNewPxPoint, and select View.
2. Select the appropriate view for the point type you would like to add. See the Point
Editor View table below for details.

View Point Types

Sie Px Pt Editor Analog Physical LAI, LAO, LPACI

Sie Px Pt Editor Analog Virtual VLAI, VLAO, VLPACI

SIe Px Pt Editor Binary Physical LDI, LDO, L2SL, L2SP

SIe Px Pt Editor Binary Virtual VLDI, VLDO, VL2SL, VL2SP

SIe Px Pt Editor Multistate Output LFSSL, LFSSP, LOOAL, LOOAP

SIe Px Pt Editor Multistate Value LENUM

◈ Fill in the appropriate properties. Reference the APOGEE BACnet ALN Field
Panel User's Manual (125-3020) for more information.
NOTE: The N4 Appliance PXC / TC point editor currently does not have a slope-
intercept calculator. The following slope-intercept calculators can be found at the
following location: https://partnerportal.extranet.dc.siemens.com/en/download-and-
support/usbaapogeetools
● Launch Pad or FP Web UI through APOGEE ALN Tools Installation (requires
ability to connect directly to field panel using http connection).
● Commissioning Tool Point Editor
● Slope intercept calculator installed as a stand-alone application using
Commissioning Tool (use MEC as panel type for calculating slope intercept for
PXC / TC).
NOTE: If you have two or more panels on two or more Automation-Level Networks
(ALNs), the N4 Appliance will learn the state text from the first panel it communicates
with. See below for a workaround:
● Delete all panels from the N4 database except the panel with the unique state text
table.
● Navigate to Station > Config > Drivers > Bacnet Nework and delete
SiePxStateTextTable.
● Run Sie Update Db.
● This will add the point you created to the Points folder. To continue to view or
modify the point, double click the new point.
NOTE: When adding a point that exists at the panel and using N4 Point Discovery, if
the slope is greater than 20, an error message will display. If you discover a point
greater than 20, delete the existing point from the panel and add it via the N4
Appliance PXC / TCPoint Editor.

Adding Points to the N4 Database


Open the station, if necessary.

A6V101007427_en_--i 2022-05-28 53 | 112


Using the Siemens N4 Appliance (PPCL and Point Editors)
Using the Point Editor

To view an existing point in the N4 Database:


1. In the Nav pane, expand Station > Config > Drivers > BacnetNetwork >
[device] and then double-click Points.
2. Double click on the desired point.
 The editor displays in the right-hand pane.
3. To view a point that is not in the N4 Database:
4. Navigate to Config > Drivers > BacnetNetwork > [device] > double-click Points.
5. Click the Discover button.
6. Select the desired point and click Add.
7. Right click on Sie Utilities Service and select Sie Update Db.

Using the Point Editor Application


Tips for Using the Point Editor Application
During editing you cannot change the point type. For example, if you created an LAO
it cannot be changed to an LAI.

Editing Points in PX Controllers


Only points that exist in the N4 database can be edited. Points added using the N4
PXC / TC point editor are automatically added to the N4 database. PXC / TC points
not created using the N4 PXC / TC point editor must be added to the N4 database
before they are editable. See Adding Points to the N4 Database.
Open the station, if necessary.
To modify an existing point in the N4 Database:
1. In the Nav pane, expand Station > Config > Drivers > BacnetNetwork >
[device] and then double-click Points.
2. Double click on the desired point.
 The editor displays in a pop-up window.
3. Make the necessary modifications and click Save.
 The points are rearranged under the navigation tree

After saving and editing binary point types, an error message will display and the
point will need to be refreshed. To display the point, go to Nav > Points > double-
click the point to refresh.

Modifying a Point in Another Tool


If a point in the PXC / TC is modified using another tool (using the HMI or Launch
Pad), the point needs to be deleted from Niagara, discovered and then uploaded. To
do so:

54 | 112 2022-05-28 A6V101007427_en_--i


Using the Siemens N4 Appliance (PPCL and Point Editors)
Using the Point Editor

1. Right-click on the point in Niagara and select Delete. This deletes the point from
the N4 database and not from the field panel.
2. Double-click Points in the Project Nav (Station > Config > Drivers > Bacnet
Network > [PXC / TC Device] > Points).
3. Click Discover.
4. Click Add.
5. Expand Services in the project tree and right-click SieUtilitiesService.
6. Find Actions and select SieUpdateDb in the expanded menu.

Deleting a Point
Delete a point from the N4 database and from the device
 The platform and station are open.
1. In the Nav pane, expand Station > Config > Drivers > BacnetNetwork >
[device] > Points.
 The points in the N4 database are displayed.
2. Right-click the point you want to delete and select Views > Sie Delete PX Point.
 The point is removed from the N4 database and the device.

Fig. 18: Deleting a point.

Delete a point from the N4 database but leave it in the device


 The platform and station are open.

A6V101007427_en_--i 2022-05-28 55 | 112


Using the Siemens N4 Appliance (PPCL and Point Editors)
Troubleshooting

1. In the Nav pane, expand Station > Config > Drivers > BacnetNetwork >
[device] > Points.
 The points in the N4 database are displayed.
2. Right-click on the point you want to delete and select Delete.
 The point is removed from the N4 database.
NOTE: If you want to delete a point from the device that is not in the N4 database,
complete the following:
1. Discover the point
2. Run Sie Update Db
3. Delete the point (Views > Sie Delete Px Point)

Folder Feature for Points


The purpose of the folder feature for points is to allow you to organize your devices
within a BACnet point folder. Using this feature for points will allow you to:
● Create and allow multiple folders on the same level.
● Allow points and point folders on the same level.
● Allow five levels of nested point folders.

Points is the PointDeviceExtension (not the point folder). This folder type can be
used as a regular folder.

Points and BacnetPointFolder11 must be under Points. Points can also be in a


BACnet point folder or a regular folder.

Troubleshooting

Running Sie Update Db does not cause Point and PPCL


Editors to appear
One of the causes of the Sie Update Db not being able to create the objects for the
Point and PPCL Editors is if the station cannot bind to the webserver.
To determine if this is happening, navigate to Platform > Application Director and
search for an error message similar to the following:

56 | 112 2022-05-28 A6V101007427_en_--i


Using the Siemens N4 Appliance (PPCL and Point Editors)
Troubleshooting

INFO [08:32:30 01-Aug-16 CDT][javax.baja.web.BWebServer]


Scheduling restart in 5 seconds.
INFO [08:32:30 01-Aug-16 CDT][fox] FOX server started on port
[1911]
INFO [08:32:30 01-Aug-16 CDT][fox] FOXS server started on port
[4911]
INFO [08:32:30 01-Aug-16 CDT][sys] Niagara Runtime Environment:
4.1.27.20
INFO [08:32:30 01-Aug-16 CDT][sys] *** Station Started (1295ms)
[6948ms total] ***
niagara>INFO [08:32:31 01-Aug-16 CDT][history.db] Starting
async warmup of history config index...
INFO [08:32:31 01-Aug-16 CDT][history.db] Async history config
index warmup completed in 16 ms.
INFO [08:32:35 01-Aug-16 CDT][web] Jetty stopped.
SEVERE [08:32:35 01-Aug-16 CDT][javax.baja.web.BWebServer]
failed: java.net.BindException: Failed to bind to https port
[443], http port [80], or both
java.net.BindException: Failed to bind to https port [443],
http port [80], or both
at
com.tridium.jetty.BJettyWebServer.doStartWebServer(BJettyWebSer
ver.java:618)
at
javax.baja.web.BWebServer.startWebServer(BWebServer.java:228)
at javax.baja.web.BWebServer.doRestart(BWebServer.java:291)
at
auto.com_tridium_jetty_BJettyWebServer.invoke(AutoGenerated)
at
com.tridium.sys.schema.ComponentSlotMap.invoke(ComponentSlotMap
.java:1871)
at
com.tridium.sys.engine.EngineUtil.doInvoke(EngineUtil.java:61)
at javax.baja.sys.BComponent.doInvoke(BComponent.java:1206)
at javax.baja.util.Invocation.run(Invocation.java:46)
at
java.util.concurrent.Executors$RunnableAdapter.call(Executors.j
ava:511)
at java.util.concurrent.FutureTask.run(FutureTask.java:266)
at
java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExe
cutor.java:1142)
at
java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolEx
ecutor.java:617)
at java.lang.Thread.run(Thread.java:745)

To address this, open the Station and navigate to Station > Config > Services >
WebService and set the Http Port and Https port to different port numbers. For
example, try setting the Http Port to 81 and the Https port to 500.
If you need to troubleshoot further to determine if a specific port is in use, and which
program is using it, use the following procedure:
1. Run a command prompt as an Administrator.
2. Create and select a location to store a text file. For example, C:\N4_TS

A6V101007427_en_--i 2022-05-28 57 | 112


Using the Siemens N4 Appliance (PPCL and Point Editors)
Troubleshooting

3. Type the following commands and press Enter:


4. Netstat –a –n –p tcp –b > C:\N4_TS\tcpport01.txt
5. Netstat –ano > C:\N4_TS\tcpport_PID02.txt
Both text files will give you list of ports used for example in the line from tcpport01.txt
TCP 0.0.0.0:443 0.0.0.0:0 LISTENING
[vmware-hostd.exe]

This indicates that port 443 is taken by vmware-host.exe.


The other file lists file by PID (process ID), which is useful if the port shows “Cannot
obtain ownership information” rather than the name of an executable.
You can determine which process owns the process by looking in Task Manager. To
view PIDs, right click the Name column and selecting PID.

If you need to use a specific port that has a conflict, you will need to either stop the
program that is using the port or reconfigure that program to use a different port.

58 | 112 2022-05-28 A6V101007427_en_--i


Using the Siemens N4 Appliance (Device templates and pre-configured services)
Siemens N4 Appliance Views

Using the Siemens N4 Appliance (Device


templates and pre-configured services)
Recommendations for Metric Users

NOTE:
The user account setting only applies when using a browser. When using Siemens
Workbench, the user account setting is ignored, and the unit system is selected from
the Tools menu, Options > General, Unit Conversion.
For Siemens N4 Appliance Revision 1.00.102 and later, all Siemens FLN devices
must be configured for English units. The English-to-metric conversion is handled by
the station.

Configuring a User Account to Display Metric Units when using a Browser


Siemens Workbench unit conversions are set from the Tools menu, Options >
General, Unit Conversion.
1. From the Nav pane, expand and select Station, UserService, [user name] (for
example Siemens_Integrator).
2. Right-click the user name and then select AX Property Sheet.
 The Property Sheet displays.

3. In the Facets section, select Metric from the Unit Conversion drop-down menu.
4. Click Save.

Siemens N4 Appliance Views


Two customizable views are available in the Siemens N4 Appliance:
● Technical View (Workbench View)
● Operator View (Web Browser View)

A6V101007427_en_--i 2022-05-28 59 | 112


Using the Siemens N4 Appliance (Device templates and pre-configured services)
Siemens N4 Appliance Views

Technical View (Workbench View)


The Technical View provides access to all the features of the station. It is used by
building technicians (Siemens_Integrator user account type) to configure and
navigate through sites. The set of sidebar panes (Nav, Template, Palette, and so on)
are configurable from the Windows menu.

① Path bar
Displays the path bar of the current component selected from the Nav pane.

② View selector
Allows you to choose between the views available for the selected component.
③ Nav (Navigation) pane
Provides access to the configuration, operation and monitoring features provided by the station.
This is restricted by your user role.

④ Palette pane
Displays new station components, added by dragging items from this pane to the station in the Nav
pane.
⑤ Template pane
Displays the list of available device templates.

⑥ Header pane
Displays alarm count, current ID of the user and job name.

⑦ View pane
Displays the active view.

Operator View (Web Browser View)


The Technical View provides access to all the features of the station. It is used by
building technicians (Siemens_Integrator user account type) to configure and
navigate through sites. The set of sidebar panes (Nav, Template, Palette, and so on)
are configurable from the Windows menu.

60 | 112 2022-05-28 A6V101007427_en_--i


Using the Siemens N4 Appliance (Device templates and pre-configured services)
Siemens N4 Appliance Views

NOTICE
The Operator View cannot access the engineering and commissioning features of
the station.

The customizable Operator View is primarily used for daily operation and monitoring of
your customer site(s). This view is available through the station for
Siemens_Customer and Siemens_Balancer user account types.

① Pane selector
Allows you to enable and disable individual panes (Navigation, Palette and Search). In the default
customer view, only the Navigation pane is selectable.
② Nav (Navigation) pane
Provides access to the operation and monitoring features provided by the station. This is restricted
by your user account role(s).
③ View selector
Allows you to choose between the views available for the selected component.
④ Header pane
Displays alarm count, current ID of the user and job name.

⑤ View pane
Displays the active view.

Configuring a Site Structure


Default Configuration
The N4 Appliance provides a default Site object and two default Area objects, each
with predefined tags and structure relationships. The purpose of these default objects
is to simplify the process of creating a job-specific site structure.
The following figure displays the default tagged objects and predefined views. Links
between objects and views are defined by preconfigured Site and Area object
properties.

A6V101007427_en_--i 2022-05-28 61 | 112


Using the Siemens N4 Appliance (Device templates and pre-configured services)
Siemens N4 Appliance Views

Fig. 19: Default N4 Appliance Site Configuration (tags and views).

The following figure displays the default structure relationship between the Area
objects and the Site object. The relationships are defined using the Haystack site ref
tag (hs:site). These relationships are mandatory, and they are used to auto-generate
hierarchies for navigation and runtime processes.

62 | 112 2022-05-28 A6V101007427_en_--i


Using the Siemens N4 Appliance (Device templates and pre-configured services)
Siemens N4 Appliance Views

Fig. 20: Default relationship between the Area objects and the Site object.

Example for Creating a Job-Specific Site Structure

NOTICE
If you plan to customize the site, do this before the procedures Discovering
Devices on the Network and Adding Controllers.

This section provides an example for creating a job-specific Site structure.


● The example site is named MySite, and has three floors named Floor 1, Floor 2
and Floor 3.
● This example assumes that area summary views (for example,
Floor1Summary.px) are desired. If not, delete the summaryView slots from the
EastWing and WestWing objects before proceeding.

①Renaming Default Objects and Views


This step renames the default objects and views to create a partial-site structure.

A6V101007427_en_--i 2022-05-28 63 | 112


Using the Siemens N4 Appliance (Device templates and pre-configured services)
Siemens N4 Appliance Views

Fig. 21: Renaming default objects and views.

1. Navigate to Station > Siemens_Site and then expand Siemens_Site.


2. Right-click on DemoSite, select Rename and then assign a new name.
 MySite is used in this example.
3. Expand the site you renamed.
4. To rename the WestWing and EastWing Areas, right-clicking on each Area,
select Rename and then assign a new name.
 Floor1 and Floor2 are used in this example.
5. Navigate to Files/px/Siemens_Site_Views and rename the existing Area
Summary Views to match the new Area names.
6. Do the following in the Summary View property to reference the new summary
.px files:
– Open the AX Property sheet for each area (Floor1 and Floor2 are used in this
example).
– Click on the folder icon and select Files on Station > Siemens_Site_Views.
– Select the appropriate .px file. For example, Floor1Summary.px and
Floor2Summary.px.
– Select Open and then select Save in the Property Sheet window for each
Area.

64 | 112 2022-05-28 A6V101007427_en_--i


Using the Siemens N4 Appliance (Device templates and pre-configured services)
Siemens N4 Appliance Views

②Creating Additional Areas


This step adds another area for Floor3. The new area will have the same tags and
relations as the existing areas.
1. Right-click on one of the existing Area objects and select Copy.
2. Right-click on the Site object and select Paste Special.
3. Select the Keep all relations check box and then click OK.

 The new Area is added but is not named correctly.


4. Right-click on the new Area, select Rename and then assign a new name.
 Floor3 is used in this example.
5. Right-click on the new Area, select Set Display Name and then assign a new
name.
 Floor 3 is used in this example.
6. If desired, do the following to create a new Floor 3 summary view:
– In Files/px/Siemens_Site_Views, right-click on one of the existing Area
Summary Views. For example, Floor2Summary.px.
– Select Duplicate and name the new summary view. For example,
Floor3Summary.px.
– Right-click on the newly created Area in Config/Siemens_Site (for example,
Config/Siemens_Site/My Site/Floor 3) and open its AX Property Sheet.
– Set the Summary View property to reference the new summary .px file. For
example, Floor3Summary.px.
Click on the folder icon and select Files on Station > Siemens_Site_Views.
Select the appropriate .px file. For example, Floor3Summary.px.
Select Open and then select Save in the AX Property Sheet window for the
Area.

 The following figure shows the updated site structure.

A6V101007427_en_--i 2022-05-28 65 | 112


Using the Siemens N4 Appliance (Device templates and pre-configured services)
Siemens N4 Appliance Views

Fig. 22: Updated Site Structure.

③(Optional) Adding Floorplan Views


The N4 Appliance does not provide default floorplan views, but it does provide a
template to simplify the process of creating them. This step outlines how to create the
views.
1. In the Files/px/Siemens_Views folder, make three copies of _emptyView.px.
2. Name the new files Floor1View, Floor2View and Floor 3View.
3. Right-click on Config/Siemens_Site/My Site/Floor 1 and select Views/New
View.
4. Configure the New Px View as shown in the following figure. Select the new
floorplan view that was created in the preceding step.

66 | 112 2022-05-28 A6V101007427_en_--i


Using the Siemens N4 Appliance (Device templates and pre-configured services)
Siemens N4 Appliance Views

5. Click OK, and then select Reuse on the File Already Exists dialog.
6. Repeat this process for Floor 1 and Floor 2.
7. Edit the newly created views to make job-specific floorplan views.

Fig. 23: Completed Site Structure.

④Checking the Site Structure


1. In the Nav tree, right-click Hierarchy and select Refresh Tree Node.
2. Expand the Site hierarchy.
 The hierarchy should correspond to the contents of the Config/Siemens_Site
folder. In the Site hierarchy, right-click each floor and check for a summary view
and a floor view.

A6V101007427_en_--i 2022-05-28 67 | 112


Using the Siemens N4 Appliance (Device templates and pre-configured services)
Siemens N4 Appliance Views

Fig. 24: The Final Site Hierarchy.

Customizing Hierarchies
The default Hierarchy is provided so that you can rename the Site and Area names
and create new sites and areas.
You can customize hierarchies by adding/duplicating an area or site in the hierarchy.
You do this by using the duplicate function.

NOTE:
Site names can be renamed.
You can also duplicate sites using this procedure, except you do not have to perform
Steps 2 and 3. When you duplicate a site, you will also need to duplicate the
Siemens Summary View for the areas that were duplicated along with the site as
described in Steps 4 through 11.

68 | 112 2022-05-28 A6V101007427_en_--i


Using the Siemens N4 Appliance (Device templates and pre-configured services)
Siemens N4 Appliance Views

To Add an Area in the Hierarchy


1. From the Nav pane, expand Config, Siemens_Site, Demo_Site and then select
and right-click an area of the site (for example, West Wing) and then select
Duplicate.

– The Name dialog box displays.


2. Enter a name (for example, North Wing) for the area you are adding. Click OK.
3. Right-click the new area you added, and select Relation Mark.
4. Navigate to Station, Files, px, Siemens_Site_Views, and then expand
Siemens_Site_Views.
5. Duplicate the [Original Area Summary Name.px] and assign a [New Area
Summary Name.px].
6. Navigate to Station, Config, Siemens_Site, and expand Siemens_Site [Site
Name].
7. Right-click the new [Area Name] and select AX Property Sheet.
8. Expand Summary View, Px View.
9. Change the Px File to the new px file you created in Step 5, using the File Ord
Chooser or typing the file name.

User Accounts
The Siemens N4 Appliance provides the following customizable pre-defined user
accounts with specific rights that can be duplicated and modified to create job-specific
user accounts.
Siemens_Integrator

A6V101007427_en_--i 2022-05-28 69 | 112


Using the Siemens N4 Appliance (Device templates and pre-configured services)
Siemens N4 Appliance Views

● A technical user with unrestricted access (super user) to the station.


● Uses the station for operation, monitoring, engineering and commissioning of the
system.
● Can add, delete and modify station files and services, as well as read and write
device configuration data. Configuration data is accessed using the device’s
property sheet.
Siemens_Balancer
● A technical user with access to the station, but no access to the engineering and
commissioning features of the station.
● Uses the station for operation, monitoring and configuration of the system.
Siemens_Customer
● A user with limited access to the Technical View.
● Uses the station for everyday operation and monitoring of the system.

NOTE:
For cybersecurity reasons, there are no default passwords, even though the
Password and Confirm fields in the Property Sheet are filled out. Passwords for
default user accounts must be defined while configuring the Siemens N4 Appliance.

Configuring User Accounts


 You have logged in to the Siemens N4 Appliance station using the admin
account.
1. From the Nav pane, select and expand Config, Services, UserService, and then
double-click Siemens_Customer.
2. From the Property Sheet tab, in the Authenticator section, enter a password, for
example, Cust_001.
3. Leave all other settings at the default and click Save.

Creating new user accounts based on the default station accounts


1. Navigate to Station > Config > Services > User Service and select an account
to duplicate.
– For a customer account, select Siemens_Customer.
– For a dealer technical specialist account, select Siemens_Intergrator.
– For a Balancer account, select Balancer.
2. Right-click on the selected account and select Duplicate.
3. Select a name for the new account and click OK.
4. Double-click the new account to open the AX Property Sheet.
5. Enter a new password and confirm that password.
6. If you want, you can force the user to change their password and set Force Reset
at Next Logon accordingly.
7. Select Save.

70 | 112 2022-05-28 A6V101007427_en_--i


Using the Siemens N4 Appliance (Device templates and pre-configured services)
Identifying and Configuring TNM Local Devices

Identifying and Configuring TNM Local Devices

NOTE:
Only complete this procedure if the configuration does not use a Siemens field panel.
For example, if FLN devices are connected directly to MS/TP ports of the N4 /
TNMcontroller.
It is recommended that you restart the station after adding a N4 / TNMcontroller.
If the N4 station is acting as both a supervisory controller and an air handling unit
controller, see the topic Adding a LocalDeviceAhu object to the station [➙ 102] in
Advanced Topics.

In previous revisions, you had to add tags and relations manually to the Local Station
object in order to use the BacnetNetwork LocalStation object as a virtual field panel
or AHU controller. With Revision 1.10.xxx and later, templates are provided for
LocalDeviceTc and LocalDeviceAhu virtual devices, which eliminates the need to
manually add tags and relations.
This section outlines the following topics:
● Determining if a Station Local Device is Needed
● Configuring the Station Local Device, if one is necessary.

Determining if a Station Local Device is Needed


This topic outlines how to determine whether an N4 station local device is needed,
based on the job configuration.

When is a Station Local Device Needed?


A local device is typically needed when the N4 station is performing the supervisory
controller role that would normally be performed by one or more TCs (TALON
controllers/Siemens field panels). In this case, a LocalDeviceTc object should be
added to the station. For instructions, see the section Configuring a Station Local
Device [➙ 72].

A6V101007427_en_--i 2022-05-28 71 | 112


Using the Siemens N4 Appliance (Device templates and pre-configured services)
Identifying and Configuring TNM Local Devices

When is a LocalDeviceTc Object not Needed?


A LocalDeviceTc virtual supervisory controller object is not needed if TALON TC
controllers have been used to supervise all other BACnet devices, as shown in the
following figure. In other words, every ‘child’ BACnet device appears in the database
of a TC controller.

Fig. 25: TC Controller Example Topologies.

Configuring a Station Local Device


Typically, a TNM local device is needed in topologies that have FLN-class devices that
are not supervised by Siemens field panels.

Prerequisite
The station’s site structure is configured. For more information, see the section
Configuring a Site Structure [➙ 61].

Adding a LocalDeviceTc Object to the Station


The LocalDeviceTc template is used to create virtual ALN devices representing field
panels, and includes the hs:equip and sie:alnDevice tags.
1. Connect to the station using Siemens Workbench.
2. Open the Template sidebar

72 | 112 2022-05-28 A6V101007427_en_--i


Using the Siemens N4 Appliance (Device templates and pre-configured services)
Identifying and Configuring TNM Local Devices

3. Drag the LocalDeviceTc template onto the Config/SiemensUi folder

4. Follow the wizard prompts to select the site and area, just as you would for any
other device.
 The LocalDeviceTc object displays in the Site and Devices hierarchies in
place of a TC Controller.

A6V101007427_en_--i 2022-05-28 73 | 112


Using the Siemens N4 Appliance (Device templates and pre-configured services)
Discovering Devices on the Network

Using Station Local Devices


After a LocalDeviceTc object is added to represent a virtual field panel, the process
of integrating BACnet FLN devices using BACnet Device Manager is identical to the
process used with a real field panel. The same is true when a LocalDeviceAhu is
added.
Remember that, just like with real BACnet field panels, LocalDeviceTc virtual
controllers must be added first, followed by FLN devices.

Discovering Devices on the Network


Discovering BACnet Devices
 Siemens Workbench is open.

74 | 112 2022-05-28 A6V101007427_en_--i


Using the Siemens N4 Appliance (Device templates and pre-configured services)
Discovering Devices on the Network

1. In the Nav pane, expand Station > Config > Drivers.


2. Double-click BacnetNetwork to display the Bacnet Device Manager.

3. Click Discover at the bottom of the Database pane.

 The Configure Device Discovery dialog box displays.

4. Update the following fields:


– Device Low Limit and Device High Limit: Enter a range of device instance
numbers for the discovery process.
– Networks: Select individual check boxes to limit the discovery to certain
networks or select the Send Global check box to discover devices on all
connected BACnet networks.

A6V101007427_en_--i 2022-05-28 75 | 112


Using the Siemens N4 Appliance (Device templates and pre-configured services)
Adding Controllers

– NOTICE! The first time you perform the Discovery procedure, you must
select the Send Global check box. After the first successful discovery,
discovered BACnet networks are preselected, and it’s generally not
required to select the Send Global check box again.
5. Use the default setting for Wait Response Time and click OK.
 A progress bar displays during the discovery process.
 The Discovered list of devices displays when the process is complete.

Adding Controllers

NOTICE
Devices must be added in the following order:
1. TNM/TC devices (field panels), LocalDeviceTC, or LocalDeviceTC.
2. AHU controllers (including UEC).
3. All other devices.
Add a field panel or TNM before adding a UEC. Add an Ahu_UEC before adding
VAV devices.

Adding a Field Panel or UEC


1. From the Discovered list of installed device templates, select a Compact or
Modular controller.
2. Select the Template Mode toolbar button to display the list of installed device
templates.
3. Select one of the following in the Templates tab:
– If the device is a Compact or Modular controller that is performing AHU
control, select Ahu_IP.

76 | 112 2022-05-28 A6V101007427_en_--i


Using the Siemens N4 Appliance (Device templates and pre-configured services)
Adding Controllers

– If the device is a Compact or Modular controller that is not performing AHU


control, select Panel_IP.
– If the device is a UEC that is performing AHU control, select Ahu_Uec.
– If the device is a UEC that is not performing AHU control, select GenericMstp.
4. Click Add.

NOTE:
Select AHU_IP if the field panel controls an air handler that supplies air to pressure
independent variable air volume controllers.

5. Follow the wizard prompts by selecting the site for the field panel and then the
area. Click OK after each prompt.
6. The Template IO Bindings Results dialog box displays the configured relations.
Click OK.
7. The Edit dialog box displays, click OK to leave default configuration settings.

Adding a FLN Controller (non-VAV)


1. From the Discovered list of installed device templates, select a FLN device you
want to add.
2. From the Templates tab, select the corresponding template for the device
application number from the list. For example, a fan coil application, App_6641.
3. Click Add.
 Follow the wizard prompts by selecting the site for the device.
4. Click OK.
5. Select where the device is installed in the building. Since there is more than one
area, a selection must be made. Click OK.
6. Select the device’s parent field panel. If there is only one field panel, the panel is
pre-selected. Click OK.
– The Siemens N4 Appliance has one preconfigured Day/Night schedule. The
wizard prompts whether this schedule should be used to set the operating

A6V101007427_en_--i 2022-05-28 77 | 112


Using the Siemens N4 Appliance (Device templates and pre-configured services)
Adding Controllers

mode of the controller. If you want to use it, click OK. If not, de-select the
schedule object and then click OK
 The Template IO Bindings Results dialog box displays the configured
relations. Click OK.
7. The Edit dialog box displays. Click OK to leave default configuration settings.
8. Repeat, as necessary, for any remaining controllers.

Adding a VAV Device


1. From the Discovered list of installed device templates, select the VAV FLN device
that you want to add.
2. From the Templates tab, select the corresponding template for the VAV device
application number from the list. For example, App_6620.
3. Click Add.
 Follow the wizard prompts by selecting the site for the VAV device. If there is
only one controller, the site is pre-selected.
4. Click OK.
5. Select where the VAV device is installed in the building. Since there is more than
one area, a selection must be made. Click OK.
6. Continue with the wizard prompts.
7. Select the controller’s parent AHU field panel. If there is only one field panel, the
panel is pre-selected. Click OK.
8. Select the required two references necessary from the VAV to the AHU. Select the
AHU that supplies the VAV terminal box. Click OK.
– The Siemens N4 Appliance has one preconfigured Day/Night schedule for
PTECs and one preconfigured Comfort/Economy schedule for DXRs. A
prompt displays asking whether this schedule should be used to set the
operating mode of the VAV controller. Selecting this option means that the
schedule is stored at the station and it commands the Day/Night or
Comfort/Economy modes directly. Assuming that this is desired, click OK. If
not, de-select the schedule object and then click OK. If the schedule is to be
maintained at the Siemens Field panel or another device, do not select this
option.
 The Template IO Bindings Results dialog box displays the configured
relations.
9. Click OK.
10. The Edit dialog box displays. Click OK to leave default configuration settings.
11. Repeat, as necessary, for any remaining VAV devices.

Deleting an ALN or FLN Device


In the Technical View, you can select and delete any ALN or FLN device from the
database.
 The Siemens N4 Appliance station is open.

78 | 112 2022-05-28 A6V101007427_en_--i


Using the Siemens N4 Appliance (Device templates and pre-configured services)
Configuring Schedules

◈ In the Nav pane, select Hierarchy, Devices, select and right-click an ALN or FLN
device, select Actions, and then select Delete.
 Device is deleted from the Siemens N4 database.

Configuring Schedules
This section outlines the following topics:
● The built-in schedules and schedule editor views.
● How to create additional schedules.
● How to synchronize station schedules with Schedule Objects in BACnet devices.

NOTE:
When you create or edit a calendar object, there are four data types you can choose
from; Date, Date Range, Week and Day or Custom. You are able to use the first
three data types if you are not using wildcard entries, however, the Custom data
type is not available at this time.

Built-in Schedules and Schedule Editor Views


The N4 Appliance includes two predefined schedules, one day-night schedule for use
with Siemens PTEC/ATEC controllers, and one operating mode schedule for use with
Siemens controllers.

Fig. 26: Siemens Schedules.

The predefined schedules are located in the Config/Siemens_Schedules folder. If


additional schedules are needed, they should be added to this folder.
The predefined schedules may also be accessed from the Apps hierarchy. This is
typically how an end user would access the schedules to adjust times and modes at
runtime.

Siemens_Day_Ngt_Schedule
The Siemens_Day_Ngt_Schedule is a Niagara Enum schedule with the following key
characteristics:

A6V101007427_en_--i 2022-05-28 79 | 112


Using the Siemens N4 Appliance (Device templates and pre-configured services)
Configuring Schedules

Table 5: Siemens_Day_Ngt_Schedule.

Key Characteristic Notes


Range of values DAY (0), NIGHT (1)

Default Value NIGHT

Editor View Files/px/Siemens_Views/scheduleEditView.px

Tags sie:DayNightSchedule

Scheduler View (scheduleEditView)


The scheduler view is a standard N4 Appliance view with an embedded Niagara
schedule editor plugin component. Use of this component is described in the Schedule
plugins/Scheduler section of the document Scheduling overview in Niagara Help.

Fig. 27: Siemens_Day_Night_Schedule Editor View.

Default Weekly Schedule


The default weekly schedule is DAY from 8:00AM to 5:00PM Monday through Friday,
and default (NIGHT) for other days and times. Schedules are edited using the
scheduler view.

Default Special Event Days


Default special event days are defined in the Siemens_Holiday_Calendar. On these
days, the schedule will output its default value (NIGHT) for the entire 24-hour period.
The output value during special event days may be edited using the scheduler view.

80 | 112 2022-05-28 A6V101007427_en_--i


Using the Siemens N4 Appliance (Device templates and pre-configured services)
Configuring Schedules

Other Configuration Properties

Fig. 28: Siemens_Day_Night_Schedule Properties.

Table 6: Siemens_Day_Ngt_Schedule.

Property Notes

Default Output An editable value that defaults to NIGHT.

Facets Defines the range of values for the schedule. DO NOT CHANGE THIS
FACET! These values are defined in PTEC devices. If changed at the
station, schedules will not work properly.

Cleanup Special Events Leave at the default value of true unless there is a specific reason to
change it. If set to false, one-time special events are kept in the station
database after they have occurred, even though they will not occur again.

Tagging and Auto-Linking to New PTEC/ATEC Devices


The default Siemens_Day_Night_Schedule is preconfigured with the
sie:dayNightSchedule tag.
N4 Appliance device templates for PTEC and ATEC applications include an optional
link to a station schedule. When using BacnetDeviceManager to install a PTEC or
ATEC using a Siemens template, one of the dialogs allows the user to select an
existing schedule for auto-linking to the device’s DAY.NGT point. The user may select
a schedule from the list of compatible schedules or leave the DAY.NGT point unlinked
by deselecting all schedules.

Fig. 29: BacnetDeviceManager Schedule Linking Dialog DAY.NGT.

Notice in the Figure BacnetDeviceManager Schedule Linking Dialog (DAY.NGT), that


there is only one entry in the list of available schedules, even though there are two
predefined schedules in the N4 Appliance station. This is due to the fact that PTEC
and ATEC templates specify that only schedules with the sie:dayNightSchedule tag
should be shown in the selection dialog. Only schedules that are compatible with
Apogee DAY.NGT points should be given the sie:dayNightSchedule tag.

A6V101007427_en_--i 2022-05-28 81 | 112


Using the Siemens N4 Appliance (Device templates and pre-configured services)
Configuring Schedules

Siemens_OpMode_Schedule
The Siemens_OpMode_Schedule is a Niagara Enum schedule with the following key
characteristics:
Table 7: Siemens_OpMode_Schedule.

Key Characteristic Notes


Range of values Protect (1), Economy (2), PrComfrt (3), Comfort (4)

Default Value Economy

Editor View Files/px/Siemens_Views/scheduleEditView.px

Tags sie:opModeSchedule

Scheduler View (scheduleEditView)


The scheduler view is a standard N4 Appliance view with an embedded Niagara
schedule editor plugin component. Use of this component is described in the Schedule
plugins/Scheduler section of the document Scheduling in Niagara Help.

Default Weekly Schedule


The default weekly schedule is Comfort from 8:00AM to 5:00PM Monday through
Friday, and default (Economy) for other days and times. Schedules are edited using
the scheduler view.

Default Special Event Days


Default special event days are defined in the Siemens_Holiday_Calendar. On these
days, the schedule will output its default value (Economy) for the entire 24-hour
period. The output value during special event days may be edited using the scheduler
view.

82 | 112 2022-05-28 A6V101007427_en_--i


Using the Siemens N4 Appliance (Device templates and pre-configured services)
Configuring Schedules

Other Configuration Properties

① Default Output
An editable value. Default: Economy.
② Cleanup Expired Events
Leave at the default value unless there is a specific reason to change it. Default: True.
If set to False, one-time special events are kept in the station database after they have occurred,
even though they will not occur again.
③ Facets
Defines the range of values for the schedule.
DO NOT CHANGE THIS SETTING! These values are defined in DXR devices. If changed at the
station, schedules will not work properly.

Tagging and Auto-Linking to New DXR Devices


The default Siemens_OpMode_Schedule is preconfigured with the
sie:opModeSchedule tag.
N4 Appliance device templates for DXR and RDY applications include an optional link
to a station schedule. When using BacnetDeviceManager to install a DXR and RDY
using a Siemens template, one of the dialogs allows the user to select an existing
schedule for auto-linking to the device’s RM_OP_MODE point (Schedule_Mode for
RDY devices). The user may select a schedule from the list of compatible schedules
or leave the RM_OP_MODE point unlinked by deselecting all schedules.

A6V101007427_en_--i 2022-05-28 83 | 112


Using the Siemens N4 Appliance (Device templates and pre-configured services)
Configuring Schedules

Notice that in the Figure BacnetDeviceManager Schedule Linking Dialog


(RM_OP_MODE), there is only one entry in the list of available schedules, even
though there are two predefined schedules in the N4 Appliance station. This is due to
the fact that DXR and RDY templates specify that only schedules with the
sie:opModeSchedule tag should be shown in the selection dialog. Only schedules
that are compatible with System ONE operating mode points should be given the
sie:opModeSchedule tag.

Creating Additional Schedules


Siemens_Day_Ngt_Schedule
To create additional schedules intended for use with PTEC/ATEC DAY.NGT points,
duplicate Config/Siemens_Schedules/Siemens_Day_Ngt_Schedule and configure as
necessary. Duplicating an existing schedule will assure that the new schedule has the
correct tagging and enumerated value range. The new schedule will also use the
same special event calendar as the original.
Do not under any circumstances change the range facet on the schedule’s Properties
tab. Doing so will cause the schedule to work improperly. Also, do not remove the
sie:dayNightSchedule tag. Doing so will keep the new schedule from appearing in the
BacnetDeviceManager wizard (see the section Tagging and Auto-Linking to New
PTEC/ATEC Devices [➙ 81]).

Siemens_OpMode_Schedule
To create additional schedules intended for use with System ONE ROOM_OP_MODE
points (Schedule_Mode for RDY devices), duplicate
Config/Siemens_Schedules/Siemens_OpMode_Schedule and configure as
necessary. Duplicating an existing schedule will assure that the new schedule has the
correct tagging and enumerated value range. The new schedule will also use the
same special event calendar as the original.
Do not under any circumstances change the range facet on the schedule’s Properties
tab. Doing so will cause the schedule to work improperly. Also, do not remove the
sie:opModeSchedule tag. Doing so will keep the new schedule from appearing in the
BacnetDeviceManager wizard (see the section Tagging and Auto-Linking to New DXR
Devices [➙ 83]).

84 | 112 2022-05-28 A6V101007427_en_--i


Using the Siemens N4 Appliance (Device templates and pre-configured services)
Configuring Schedules

Other Schedules
To create schedules for other purposes, create a new folder under Config and copy a
schedule of the appropriate type from the schedule palette to the new folder.
Configure the new schedule as necessary. See the document DocScheduling in
Niagara Help for instructions.

Synchronizing Station Schedules with BACnet Schedule


Objects
The sections Built-in Schedules and Schedule Editor Views [➙ 79] and Creating
Additional Schedules [➙ 84] cover configuration and use of schedules running in the
N4 Appliance station. This approach works in all cases. However, many BACnet
devices include BACnet Schedule Objects, allowing them to provide scheduling of
local BACnet objects and in some cases remote BACnet objects. Local BACnet
objects are defined as objects on the same device as the Schedule object. Remote
BACnet objects are defined as objects in devices other than the device with Schedule
object. The ability to schedule local objects is referred to as local scheduling. The
ability to schedule remote objects is referred to as remote scheduling.
Table 8: Scheduling Capabilities by Device.

Device Feature
TalonTC Local Scheduling, Remote Scheduling

Talon PTEC/ATEC No scheduling

System ONE DXR/RDY Local Scheduling

In Niagara system, it is possible to leave the scheduling capabilities of BACnet


devices unused and to use Niagara station schedules exclusively. However, if use of
BACnet schedules is required, it is possible to synchronize these BACnet schedules
with station schedules, thereby allowing the N4 Appliance schedule editor views to
edit the BACnet schedules. In addition, a single N4 station schedule may be
synchronized with multiple BACnet schedules, thereby coordinating the operation of
the linked BACnet schedules.

The BACnet Schedule Export Manager


BACnet schedule synchronization is configured using the BACnet Schedule Export
Manager.

A6V101007427_en_--i 2022-05-28 85 | 112


Using the Siemens N4 Appliance (Device templates and pre-configured services)
Configuring Schedules

1. Right-click a BACnet device with one or more schedule objects and then select
Actions > Bacnet Schedule Export Manager.

2. In the BACnet Discover Schedules pane, click Discover.


 The Discovered pane is populated with the device’s BACnet Schedule objects.
3. Do the following to use the weekly and exception schedules from an N4 station
schedule to initialize the BACnet Schedule object:

86 | 112 2022-05-28 A6V101007427_en_--i


Using the Siemens N4 Appliance (Device templates and pre-configured services)
Configuring Schedules

– Select a schedule object to synchronize and then click on the down arrow next
to the Add button and select Niagara.

 The Add dialog box is displayed.


– In the Supervisor Ord field, select the station schedule that will be used as a
master.

4. Configure the following additional items in the Add dialog box:


– Priority for Writing: Default: 16 (lower values indicate higher priority).
Increase the scheduler priority so that scheduler commands are at a higher
priority than control program commands.
– Execution Time: Default: The schedule is sent to the panel every five
minutes. Since schedules are edited infrequently, increase the Interval so that
the schedule is sent less often.
5. Click OK to save your changes and close the dialog box.

A6V101007427_en_--i 2022-05-28 87 | 112


Using the Siemens N4 Appliance (Device templates and pre-configured services)
Configuring User Accounts

Configuring User Accounts


This section outlines the process for creating job-specific user accounts in an N4
Appliance station.

Default Configuration
The N4 Appliance UserService provides three example user accounts, each with a
predefined user role and Web UI profile. The purpose of these default accounts is to
simplify the process of creating job-specific user accounts.
Table 9: Example User Accounts.

Account Role Web UI Profile


Siemens_Customer sieOperator Limited to Operation and Monitoring Tasks

The Siemens_Customer account is preconfigured for users that are limited to everyday operation and
monitoring of the building system.

Account Role Web UI Profile


Siemens_Balancer sieAdvancedOper Limited to Operation and Monitoring Tasks

The Siemens_Balancer account is preconfigured for advanced users that may perform a limited set of
configuration tasks along with everyday operation and monitoring of the building system.

Account Role Web UI Profile


Siemens_Integrator sieIntegrator Full access to all Workbench Web functions

The Siemens_Integrator account is a superuser account equivalent to the built-in Niagara admin account.
Siemens_Integrator provides access to system engineering and configuration functions along with
everyday operation and monitoring of the building system.

Creating Job-Specific User Accounts


The sections below describe the process for creating an example set of job-specific
user accounts. The example user accounts are as follows:
Table 10: Example Job-Specific User Accounts.

Account Name Based on


Boiler Operator Gene Smith Siemens_Customer

fhood Flo Hood Siemens_Balancer

jtalon Joe Talon Siemens_Integrator

Creating New Accounts


This procedure creates a new account for Boiler Operator.
1. Right-click the Siemens_Customer account and click Duplicate.
2. Name the new account Boiler Operator.
3. Open the AX PropertySheet for Boiler Operator and configure the account.
4. Set the Password to a default value and set Force Reset At Next Login to true.
5. Set Enabled to true.
 The AX Property Sheet should appear as shown in the following figure.

88 | 112 2022-05-28 A6V101007427_en_--i


Using the Siemens N4 Appliance (Device templates and pre-configured services)
Configuring User Accounts

Fig. 30: Boiler Operator User Account.

6. Set other fields as necessary, then click Save.


7. Repeat this procedure for fhood and jtalon.

A6V101007427_en_--i 2022-05-28 89 | 112


Using the Siemens N4 Appliance (Device templates and pre-configured services)
Operator View

Fig. 31: Completed User Accounts.

Disable or Delete Example Accounts


After adding the new accounts, the best practice is to disable the example accounts so
that they cannot be used to log in to the system.

◈ In UserService, open the AX Property Sheet for each of the accounts listed in the
Table Example Job-Specific User Accounts and set Enabled to false.

Fig. 32: Disabling Example User Accounts.

Operator View
A default Operator View template is provided to give you a standard graphical layout.
The template can be customized to your specific requirements.

90 | 112 2022-05-28 A6V101007427_en_--i


Using the Siemens N4 Appliance (Device templates and pre-configured services)
Operator View

Existing Schedules in Operator View


Existing Schedules
The Siemens N4 Appliance Schedule Editor in Operator View is a browser-hosted
editor that allows you to view and edit pre-existing Niagara schedules created using
Siemens Workbench. The following schedule types are supported:
● Local schedules that run in the station, independent of Schedule objects in
BACnet devices.
● Local schedules that run in the station and are linked to Schedule objects in
BACnet devices by the BACnet Schedule Export Manager. When the schedule
editor modifies a local Niagara schedule that is linked to a BACnet schedule by the
Export Manager, all linked BACnet schedules are updated.

Fig. 33: Exported Schedules.

NOTE:
When you create or edit a calendar object, there are four data types you can choose
from; Date, Date Range, Week and Day or Custom. You are able to use the first
three data types if you are not using wildcard entries, however, the Custom data
type is not available at this time.

NOTE:
Using the every year wildcard will result in an error when synchronizing with the
Siemens field panel.

Schedule Selection
Appliance schedules are found in the Apps/Schedules folder. Selecting any of these
schedules opens the Schedule Editor in Operator View.

Schedule Editor in Operator View


The Schedule Editor in Operator View is a standard N4 Appliance template view with
the native N4 schedule editor in the View pane.
Weekly Schedule Tab

A6V101007427_en_--i 2022-05-28 91 | 112


Using the Siemens N4 Appliance (Device templates and pre-configured services)
Operator View

Special Events Tab

Editing a Schedule or Calendar Object


You can discover and edit existing schedule and calendar objects in Siemens field
panels. This procedure assumes you have existing schedule and calendar objects in a
Compact or Modular controller.

NOTE:
When you create or edit a calendar object, there are four data types you can choose
from; Date, Date Range, Week and Day or Custom. You are able to use the first
three data types if you are not using wildcard entries, however, the Custom data
type is not available at this time.

92 | 112 2022-05-28 A6V101007427_en_--i


Using the Siemens N4 Appliance (Device templates and pre-configured services)
Operator View

1. From the Nav pane, select and expand Hierarchy, Apps, Schedules, and then
select schedule or calendar object.
2. Double-click the selected schedule or calendar.
 The schedule displays in the Schedule Editor window/view.
3. From the upper-right corner, select the Edit Schedule drop-down menu, and then
select Edit Schedule.

4. Enter the modifications you wish to make for the schedule or calendar, and then
click Save.
If editing a calendar and entering the wildcards for a holiday, the holiday dates will
overwrite the field panel’s calendar object. This is visible through BACnet Object
browser or other application such as Field Panel Web UI (FP Web).

Opening the Alarm Console


The main console operator view consists of a standard placeholder view with the
Niagara-native AlarmConsole display in the View pane.
 The Siemens N4 Appliance station is open.

◈ In the Nav pane, select and expand Hierarchy, Apps, Alarms, right-click
MainConsole, select Views, and then Alarms Manager.

NOTE:
You can also open the Alarm Console by clicking the Alarms or Unacked counter in
the header.

A6V101007427_en_--i 2022-05-28 93 | 112


Using the Siemens N4 Appliance (Device templates and pre-configured services)
Operator View

① Name of the BACnet device.

② Name of the station numeric point.

③ Alarm class assigned to the device and the priority assigned to the alarm class..

④ Alarm class assigned to the point’s alarm extension and the priority assigned to the alarm class.
⑤ Standard Niagara alarm message for network connectivity loss.

⑥ Alarm message assigned to the point’s alarm extension.

Using the Charting View Feature


The Charting View feature, in Operator View, allows you to quickly view real-time and
historical values in a graphical stripchart format. It is generic, with a standard native
Niagara dashboard using the chart control from the WebChart palette.
There is only one Chart View. To create additional Chart Views, for example for each
device in the system, a dashboard view can be created and added to each device or
to one or more device templates.

Opening the Charting View


 The Siemens N4 Appliance station is open.

◈ In the Nav pane, select and expand Hierarchy, Apps, Charting, and then Chart
View.

94 | 112 2022-05-28 A6V101007427_en_--i


Using the Siemens N4 Appliance (Device templates and pre-configured services)
Operator View

Adding a History Extension to a Point

1. Select a point that you want to add a history extension. Right click on that point
and select View > AX Property Sheet.
2. Click on Palette and find the history palette.
3. Select the appropriate extension under the Extensions folder and drag it to the AX
property sheet.
4. Expand the history extension select Enabled: True.
5. Make any other desired configuration changes.
6. Click Save.

Viewing History Chart and History Table Views


The appliance has customer History Chart and Table views. They can be accessed
from the Histories folder for any device in the Hierarchy. Points will only display in this
folder if all of the following are true:
● Have a History Extension.
● Update Database and Add History Views were run after the History Extension
was added.
For more details, see Updating Device Names and Hierarchies [➙ 106]
Once the points have a History Extension right click on them and select History Chart
view or History Table view

Adding Real-Time Point Values without a History Extension


◈ From the Hierarchy tree, select one or more points and then drag-and-drop onto
the chart.
 No historical point information displays; only the point name.

A6V101007427_en_--i 2022-05-28 95 | 112


Using the Siemens N4 Appliance (Device templates and pre-configured services)
Operator View

Adding Real-Time Point Values with a History Extension


◈ From the Hierarchy tree, select one or more points and then drag-and-drop them
onto the chart.
 The history name displays, instead of the point name.

NOTE:
Use the same step to see native Niagara point history information.

96 | 112 2022-05-28 A6V101007427_en_--i


Using the Siemens N4 Appliance (Device templates and pre-configured services)
Customizing the Logos

Customizing the Logos


The following logos can be customized:
● The logo displayed on the logon screen.
● The logo displayed in the header of the work area.

Customizing the Logon Screen Logo


This procedure customizes the logo displayed on the login screen. By default, when
you login to the station using an Operator View (browser window), the Siemens logo
displays.
For more information, see the Tridium Web site for supporting documentation.
 You have created and saved a custom image you want to use on the logon
screen.
Note: The file must be named logo.jpg.
1. Copy your logo image to the file system of the station. The typical path is
C:\Users\[your user name]\Niagara4.x\tridium<StationName>\shared.
2. Rename the existing logo.jpg file. For example, logo_old.jpg.
3. In the Nav pane, drag your logo image from My File
System\UserHome\Stations\<StationName>\shared folder and drop it in the

A6V101007427_en_--i 2022-05-28 97 | 112


Using the Siemens N4 Appliance (Device templates and pre-configured services)
Customizing the Logos

station Files folder.

4. Restart the station and then logon through the Operator View (browser window) to
view your customized logon screen.

Customizing the Header Logo


This procedure customizes the logo displayed in the header of the work area.
For more information, see the Tridium Web site for supporting documentation.
 You have created and saved a custom image you want to use in the header of the
work area.
Note: The header logo file must be named headerLogo.jpg.
1. Copy your header logo image to the file system of the station. The typical path is
C:\Users\[your user name]\Niagara4.x\tridium<Station Name>\shared.
2. Rename the existing headerLogo.jpg file. For example, headerLogo_old.jpg.

98 | 112 2022-05-28 A6V101007427_en_--i


Using the Siemens N4 Appliance (Device templates and pre-configured services)
Customizing the Logos

3. In the Nav pane, drag your header logo image from My File System\UserHome
\Stations\<StationName>\shared folder and drop it in the station Files folder.

4. Restart the station and then open an application to see the customized header.

A6V101007427_en_--i 2022-05-28 99 | 112


Configuring a Landing Page

Configuring a Landing Page


This procedure sets the view when you first log in to the station.
1. Right-click Files, New, and then select NavFile.nav to add the landing page
(default background graphic).
2. In the Name for New File field, enter homePage.nav and then click OK.
 This is the homePage.nav file.
3. Expand the Files folder, right-click homePage.nav, and select Views, Nav File
Editor.
4. Select the Home icon and click Edit.
5. In the Edit dialog box, configure the .nav file as follows:
– Display name field: Home.
– Target Ord field: For example, Station: |slot:/Siemens_Site/DemoSite
(where DemoSite is the site name) or click the drop-down folder to browse
and select the site.
– Icon field: Default is, module://icons/x16/home.png.
6. Click OK.
 The controller setup is complete.

100 | 112 2022-05-28 A6V101007427_en_--i


Uninstalling Siemens Workbench

Uninstalling Siemens Workbench


NOTE:
This procedure assumes you have a Siemens Workbench 4.x.x.x shortcut in your
Windows Start menu. If not, then you must launch the uninstall program from the
Installation folder on your hard drive.

1. From the Windows Start menu, select All Programs > Siemens Workbench
4.x.x.x folder > Uninstall.

 The Siemens Workbench Uninstall Program opens.


2. Click Next.
 A confirmation screen displays when the uninstallation is complete.
3. Click Finish.

A6V101007427_en_--i 2022-05-28 101 | 112


Advanced Topics
Adding a LocalDeviceAhu object to the station

Advanced Topics

Adding a LocalDeviceAhu object to the station

NOTE:
Only complete this procedure if the configuration does not use a Siemens field panel.
For example, if FLN devices are connected directly to MS/TP ports of the N4 /
TNMcontroller.
It is recommended that you restart the station after adding a N4 / TNMcontroller.
If the N4 station is acting as both a supervisory controller and an air handling unit
controller, see the topic Adding a LocalDeviceAhu object to the station [➙ 102] in
Advanced Topics.

When is a Station Local Device Needed?


When the N4 station is acting as both a supervisory controller and an air handling unit
controller, a LocalDeviceAhu object should be added to the station. The
LocalDeviceAhu object contains a preconfigured rollup graphic and algorithm.
For instructions, see the topic Configuring a Station Local Device [➙ 103] in this
section.

Fig. 34: Supervisory Controller and AHU Controller Example Topology.

When is a LocalDeviceAhu Object Not Needed?


A LocalDeviceAhu virtual AHU controller object is not needed if the station is not
responsible for AHU control. UEC AHU examples are shown in the following figure.

102 | 112 2022-05-28 A6V101007427_en_--i


Advanced Topics
Adding a LocalDeviceAhu object to the station

Fig. 35: AHU Example Topologies.

Configuring a Station Local Device


The LocalDeviceAhu template is used to create virtual ALN devices representing
controllers performing both supervisory and AHU control. The LocalDeviceAhu
template includes the hs:equip, hs:ahu and sie:alnDevice tags.
1. Connect to the station using Siemens Workbench.
2. Open the Template sidebar

A6V101007427_en_--i 2022-05-28 103 | 112


Advanced Topics
Adding a LocalDeviceAhu object to the station

3. Drag the LocalDeviceAhu template onto the Config/SiemensUi folder

4. Follow the wizard prompts to select the site and area, just as you would for any
other device.

104 | 112 2022-05-28 A6V101007427_en_--i


Advanced Topics
Adding a LocalDeviceAhu object to the station

 The LocalDeviceAhu object displays in the Site, Devices, and AHU


hierarchies, in place of a UEC or another device used for AHU control.

Using Station Local Devices


After a LocalDeviceAhu object is added, representing a virtual field panel, the
process of integrating BACnet FLN devices using BACnet Device Manager is identical
to the process used with a real field panel.Remember that, just like with real BACnet
field panels and AHU controllers, LocalDeviceTc and/or LocalDeviceAhu virtual
controllers must be added first, followed by FLN devices.

A6V101007427_en_--i 2022-05-28 105 | 112


Advanced Topics
Updating Device Names and Hierarchies

Updating Device Names and Hierarchies


1. From the Nav pane, under the appropriate station, expand Config, Hierarchy,
Database.

2. Double-click Update Database.


3. In the Database Configuration Parameters area, select the options you want
applied to the database. See the following table for details on each option.
4. When you’re finished, click Update Database.

106 | 112 2022-05-28 A6V101007427_en_--i


Advanced Topics
Updating Device Names and Hierarchies

5. Right-click Hierarchy and select Refresh Tree Node.


 The display name updates on the screen.
6. Expand the Hierarchy tree to display the results of the navigation hierarchy.

Database Configuration Description


Paramater
Use BACnet Device Names? Replaces the default device name assigned by the BACnet Device
Manager with a variant of the BACnet Device Object name. The
BACnet Device Object name is first filtered to make it compatible
with the Niagara station naming requirements.

Force Read of BACnet Device Instructs the station to read BACnet Device Object names from the
Names? BACnet devices rather than read them from the station database. A
“force read” is only necessary if the Use BACnet Device Name
check box is selected and Update Database is run before the
station has uploaded all BACnet object data from the source BACnet
devices.
● If the Force Read of BACnet Device Names check box is
selected, the database update process runs slower.
● If the Force Read of BACnet Device Names check box is not
selected and Update Database is executed before the station
has uploaded all BACnet object data from the source BACnet
devices, some devices may not be renamed and errors will be
logged. To resolve this issue, wait a few minutes and click
Update Database again.

Set Access Categories? Configures point category settings based on the Siemens auth tags
applied to each point. If a point does not have Siemens auth tags
applied, it defaults to the User category.

A6V101007427_en_--i 2022-05-28 107 | 112


Advanced Topics
Updating Device Names and Hierarchies

Database Configuration Description


Paramater
Add Field Panel Relations? Configures a relation between each FLN device (PTEC, DXR or,
generic MS/TP) and its Siemens field panel. This relation is used to
construct the Devices and the Editors hierarchies. Note that Add
Field Panel Relations functions only if the FLN devices are added to
the field panel database while configuring the Siemens system. If the
Siemens field panel is used as a router, or if the FLN devices are
supervised by a BacnetNetwork Local Station, then leave the Add
Field Panel Relations check box unchecked to speed up the
database update process. In this case, set the parent panel relation
by using the BACnet Device Manager wizard.

Tag Imported Points? Configures a relation between each point and its parent device. Use
of Tag Imported Points is only necessary when points are imported
manually using the BACnet Point Manager. Siemens device
templates have predefined point relations.

Disable COVs for MSTP Devices? Instructs the station to use polling to collect point data from MS/TP
devices, rather than from COVs. This only applies to devices and
points configured to use COV reporting. Use of polling for MS/TP
devices will often make graphics and other functions more
responsive.

108 | 112 2022-05-28 A6V101007427_en_--i


Appendix A - Supported Applications

Appendix A - Supported Applications


BACnet PTECs
The BACnet Driver supports the following applications.
Application Number Description
6600 Terminal Box (VAV) Cooling Only

6601 Terminal Box (VAV) Cooling or Heating

6602 Terminal Box (VAV) Electric Reheat or Baseboard Radiation

6603 Terminal Box (VAV) Hot Water Reheat

6604 Terminal Box (VAV) Series Fan and 3 Stage Electric Reheat

6605 Terminal Box (VAV) Series Fan with Hot Water Reheat

6606 Terminal Box (VAV) Parallel Fan and 3 Stage Electric Reheat

6607 Terminal Box (VAV) Parallel Fan with Hot Water Reheat

6620 Terminal Box (VAV) Cooling Only (short board)

6621 Terminal Box (VAV) Cooling or Heating (short board)

6622 Terminal Box (VAV) Electric Reheat or Baseboard Radiation (short board)

6623 Terminal Box (VAV) Hot Water Reheat (short board)

6624 Terminal Box (VAV) Series Fan and 3 Stage Electric Reheat (short board)

6625 Terminal Box (VAV) Series Fan with Hot Water Reheat (short board)

6626 Terminal Box (VAV) Parallel Fan and 3 Stage Electric Reheat (short board)

6627 Terminal Box (VAV) Parallel Fan with Hot Water Reheat (short board)

6640 Unit Conditioner VAV Pressure Dependent Cooling or Heating

6641 Unit Conditioner VAV Pressure Dependent with Hot Water Heat

6650 Unit Conditioner 2-Pipe Fan Coil Cooling or Heating

6651 Unit Conditioner Fan Coil Unit Cooling or Heating

6652 Unit Conditioner Fan Coil Unit 2-Stage Cooling & Electric Heat

6653 Unit Conditioner Fan Coil Unit 2-Stage Cooling & Hot Water Heat

6654 Unit Conditioner Fan Coil Unit Cooling and Electric Heat

BACnet ATECs
The BACnet Driver supports the following applications.
Application Number Description

6630 VAV Cooling Only

6631 VAV Cooling and Heating

6632 VAV with Electric Heat or Baseboard Radiation

6633 VAV with Hot Water Heat

6634 & 6636 VAV Series Fan or Parallel Fan and Electric Heat

6635 & 6637 VAV Series Fan or Parallel Fan and Hot Water Reheat

RDYs

A6V101007427_en_--i 2022-05-28 109 | 112


Appendix A - Supported Applications

The BACnet Driver supports the following applications.

Application Number Description


14900 Conventional – Up to 3 Heating/Cooling Stages

14901 Heat Pump – Up to 2 Heating/Cooling Stages

VFD and PM
The BACnet Driver supports the following applications.
Application Number Description
N/A BT300 Variable Frequency Drive (VFD) *

N/A MD Series Power Meter *

* BT300 and MD Series Energy Meters do not have applications, if used with a Siemens field panel, any unused application number
from 10,000 through 11,999 can be used.

DXRE and DXRMs


The BACnet Driver supports the following applications.

Application Number Description


14020 DXR2E/M12 VAV Cooling Only

14022 DXR2E/M12 VAV 2-Stage Electric Heat

14023 DXR2E/M12 VAV Hot Water Heating

14123 DXR2E/M12 VAV Hot Water and Supply Temp Control

14024 DXR2E/M12 VAV Series Fan with 2-Stage Electric Heat

14025 DXR2E/M12 VAV Series Fan with Hot Water Heat

14125 DXR2E/M12 VAV Series Fan with Hot Water Heat and Supply Temp Control

14026 DXR2E/M12 VAV Parallel Fan with 2-Stage Electric Heat

14027 DXR2E/M12 VAV Parallel Fan with Hot Water Heat

14127 DXR2E/M12 VAV Parallel Fan with Hot Water Heat and Supply Temp Control

110 | 112 2022-05-28 A6V101007427_en_--i


Appendix B - Application Templates Notes

Appendix B - Application Templates Notes


● Applications 6622 and 6602 have a special virtual point, Baseboard Rad, that
determines whether or not a radiator displays.
● Application 6654 displays a damper or a valve depending on the value of the MTR
TIMING point.
– A MTR TIMING value of 124 and lower displays a damper.
– A MTR TIMING value of 125 and higher displays a cooling valve.
● In order for an RDY device to work with a schedule that is defined in the station or
another device, do not set the value of Parameter 107 to Disabled. Otherwise, the
ScheduleMode object will not be commandable, and Room Mode will not change
to the value that ScheduleMode is commanded to.
● For a BT300 drive, use the drive keypad to set the Field Bus Control and Field Bus
Reference functions to any value other than the Fieldbus value. This allows these
functions to command the BT300 drive in and out of fieldbus mode using the
Niagara N4 interface.
● The MD Series power meters have a series of virtual points to configure the
analog gauges on the graphic.
– Commanding Max Volts and Max Amps determines the range of the gauges.
– Commanding Ampere Ticks and Volt Ticks configures the number of steps
from the zero (0) value to the maximum value.

A6V101007427_en_--i 2022-05-28 111 | 112


Issued by
Siemens Industry, Inc.
Smart Infrastructure
1000 Deerfield Pkwy
Buffalo Grove IL 60089
+1 847-215-1000

© Siemens Industry, Inc., 2018-2022


Technical specifications and availability subject to change without notice.
A6V101007427_en_--i

You might also like

pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy