A6V101007430 en
A6V101007430 en
User Guide
2022-05-28
Table of Contents
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.
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.
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.
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 [ ].
Safety Symbols
The following table lists the safety symbols used in this manual to draw attention to
important information.
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.
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.
System Recommendations
For optimized system performance, Siemens recommends the following tuning
policies:
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.
Complete the following procedure to install Siemens Workbench and set up system-
related parameters.
– 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.
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
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.
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].
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].
Importing the Siemens N4 Certificate in the JACE platform is done during the first
time the workbench is installed.
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.
1. Click on the tool bar to open the 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.
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.)
See also
Siemens N4 Appliance Related Files [➙ 14]
Complete the procedure Before Installing the Siemens N4 Appliance [➙ 13] before
performing these steps.
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.
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.
If you have customized the hierarchies or do not want them replaced, do not remove
the definitions
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).
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.
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.
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.
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
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.
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.
b. Click Upgrade.
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.
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.
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.
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.
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.
Niagara Supervisor
A Niagara Supervisor typically has a single BACnet/IP link, as shown in the following
figure.
For this type of network layout, follow the instructions in the section Configuring a
Niagara Supervisor BACnet/IP Links.
For this type of network layout, follow the instructions in the section Configuring N4
JACE station BACnet/IP Links [➙ 29].
For this type of network layout, follow the instructions in the section Configuring N4
JACE station BACnet MS/TP Links [➙ 31].
– 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.
Parameter Notes
Network Number The number of the BACnet network to which the station’s IP port is
connected.
● 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.
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.
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.
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.
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.
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.
Lexicons allow user to view Workbench in other languages, you may install them if
you wish.
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.
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).
Installation Step
1 Discovering BACnet Devices on the Network [➙ 38]
3 Adding the PPCL and Point Editor Functions [➙ 41] to Siemens 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.
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.
A device and device folder must be under BacnetNetwork. A device can also be in a
devicefolder1.
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.
User Interface
2 3 4
5
6
① 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.
⑦ 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.
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.
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.
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.
◈ Click Save.
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:
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.
① 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.
⑤
⑥ 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.
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:
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.
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.
◈ 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.
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.
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.
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)
Points is the PointDeviceExtension (not the point folder). This folder type can be
used as a regular folder.
Troubleshooting
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
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.
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.
3. In the Facets section, select Metric from the Unit Conversion drop-down menu.
4. Click Save.
① 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.
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.
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.
Fig. 20: Default relationship between the Area objects and the Site object.
NOTICE
If you plan to customize the site, do this before the procedures Discovering
Devices on the Network and Adding Controllers.
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.
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.
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
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.
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.
Prerequisite
The station’s site structure is configured. For more information, see the section
Configuring a Site Structure [➙ 61].
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.
– 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.
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.
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.
◈ 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.
Siemens_Day_Ngt_Schedule
The Siemens_Day_Ngt_Schedule is a Niagara Enum schedule with the following key
characteristics:
Table 5: Siemens_Day_Ngt_Schedule.
Tags sie:DayNightSchedule
Table 6: Siemens_Day_Ngt_Schedule.
Property Notes
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.
Siemens_OpMode_Schedule
The Siemens_OpMode_Schedule is a Niagara Enum schedule with the following key
characteristics:
Table 7: Siemens_OpMode_Schedule.
Tags sie:opModeSchedule
① 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.
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]).
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.
Device Feature
TalonTC Local Scheduling, Remote Scheduling
1. Right-click a BACnet device with one or more schedule objects and then select
Actions > Bacnet Schedule Export Manager.
– Select a schedule object to synchronize and then click on the down arrow next
to the Add button and select Niagara.
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.
The Siemens_Customer account is preconfigured for users that are limited to everyday operation and
monitoring of the building system.
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.
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.
◈ 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.
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.
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.
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.
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).
◈ 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.
③ 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.
◈ In the Nav pane, select and expand Hierarchy, Apps, Charting, and then Chart
View.
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.
NOTE:
Use the same step to see native Niagara point history information.
4. Restart the station and then logon through the Operator View (browser window) to
view your customized logon screen.
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.
1. From the Windows Start menu, select All Programs > Siemens Workbench
4.x.x.x folder > Uninstall.
Advanced Topics
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.
4. Follow the wizard prompts to select the site and area, just as you would for any
other device.
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.
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.
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
6622 Terminal Box (VAV) Electric Reheat or Baseboard Radiation (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)
6641 Unit Conditioner VAV Pressure Dependent with Hot Water Heat
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
6634 & 6636 VAV Series Fan or Parallel Fan and Electric Heat
6635 & 6637 VAV Series Fan or Parallel Fan and Hot Water Reheat
RDYs
VFD and PM
The BACnet Driver supports the following applications.
Application Number Description
N/A BT300 Variable Frequency Drive (VFD) *
* 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.
14125 DXR2E/M12 VAV Series Fan with Hot Water Heat and Supply Temp Control
14127 DXR2E/M12 VAV Parallel Fan with Hot Water Heat and Supply Temp Control