Export Tags
Export Tags
NiagaraAX-3.7u1
Confidentiality Notice
The information contained in this document is confidential information of Tridium, Inc., a Delaware corporation (“Tridium”). Such
information, and the software described herein, is furnished under a license agreement and may be used only in accordance with
that agreement.
The information contained in this document is provided solely for use by Tridium employees, licensees, and system owners; and,
except as permitted under the below copyright notice, is not to be released to, or reproduced for, anyone else.
While every effort has been made to assure the accuracy of this document, Tridium is not responsible for damages of any kind,
including without limitation consequential damages, arising from the application of the information contained herein. Information
and specifications published here are current as of the date of this publication and are subject to change without notice. The latest
product specifications can be found by contacting our corporate headquarters, Richmond, Virginia.
Trademark Notice
BACnet and ASHRAE are registered trademarks of American Society of Heating, Refrigerating and Air-Conditioning Engineers.
Microsoft, Excel, Internet Explorer, Windows, Windows Vista, Windows Server, and SQL Server are registered trademarks of
Microsoft Corporation. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Mozilla and Firefox are trademarks
of the Mozilla Foundation. Echelon, LON, LonMark, LonTalk, and LonWorks are registered trademarks of Echelon Corporation.
Tridium, JACE, Niagara Framework, NiagaraAX Framework, and Sedona Framework are registered trademarks, and Workbench,
WorkPlaceAX, and AXSupervisor, are trademarks of Tridium Inc. All other product names and services mentioned in this publica-
tion that is known to be trademarks, registered trademarks, or service marks are the property of their respective owners.
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii
Export tag FAQs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii
What’s new in the AX-3.7u1 exportTags module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viii
Document Change Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viii
NiagaraAX-3.7u1
iii
NiagaraAX Export Tags
May 31, 2013
NiagaraAX-3.7u1
iv
NiagaraAX Export Tags
May 31, 2013
exportTags-JoinProfileManager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–1
exportTags-ExportTagSummaryManager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–2
NiagaraAX-3.7u1
v
NiagaraAX Export Tags
May 31, 2013
NiagaraAX-3.7u1
vi
NiagaraAX Export Tags
PREFACE
Preface
• Export tag FAQs
• What’s new in the AX-3.7u1 exportTags module
• Document Change Log
NiagaraAX-3.7u1
vii
NiagaraAX Export Tags for Supervisor Auto-Configuration
What’s new in the AX-3.7u1 exportTags module Preface
May 31, 2013
A: This is not recommended, because of the extra memory consumed by the “Supervisor” JACE. Also,
because JACEs are not typically licensed for Niagara “virtual” components, they could not take advantage
of “PxViewTags”.
NiagaraAX-3.7u1
viii
NiagaraAX Export Tags for Supervisor Auto-Configuration
Preface Document Change Log
May 31, 2013
recommended. Other changes were made in the “About the Join process” section, in diagrams for a
“Supervisor Join” (Figure 2-2 on page 4) and a “Subordinate Join” (Figure 2-3 on page 5).
• Published: January 29, 2010
Initial document.
NiagaraAX-3.7u1
ix
NiagaraAX Export Tags for Supervisor Auto-Configuration
Document Change Log Preface
May 31, 2013
NiagaraAX-3.7u1
x
NiagaraAX Export Tags for Supervisor Auto-Configuration
CHAPTER 1
Export Tags Quick Start
This section lists export tag requirements and provides procedures to use export tags in a system with
one or more subordinate JACE stations and a Supervisor. The following sections are included:
• “Export tag requirements” on page 1-1
• “Add the NiagaraNetwork Export Tag extensions” on page 1-2
• “Add the SupervisorExportTagNetworkExt” on page 1-2
• “Add the SubordinateExportTagNetworkExt” on page 1-2
• “Enable the JoinProfile for the Supervisor NiagaraStation” on page 1-3
• “Verify and edit the station [Link] file” on page 1-4
• “Add export tags” on page 1-6
• “Adding PxViewTags” on page 1-6
• “Adding PointTags” on page 1-7
• “Adding HistoryImportTags” on page 1-8
• “Adding SystemHistoryImportTags” on page 1-8
• “Adding ScheduleImportTags” on page 1-9
• “Adding ScheduleExportTags” on page 1-10
• “Adding FileImportTags” on page 1-11
• “Adding ComponentTags” on page 1-11
• “Issue Join commands” on page 1-12
• “Join from the Supervisor” on page 1-12
• “Join from the subordinate (JACE) station” on page 1-13
NiagaraAX-3.7u1
1–1
NiagaraAX Export Tags for Supervisor Auto-Configuration
Add the NiagaraNetwork Export Tag extensions Chapter 1 – Export Tags Quick Start
Add the SupervisorExportTagNetworkExt May 31, 2013
The extension is now under the NiagaraNetwork, and includes child nodes “Category Filters” and “Alarm
Source Info”. You can leave properties in them at default values for now. For more details, see “About the
SupervisorExportTagNetworkExt” on page 2-7 and “About CategoryFilters” on page 2-8.
NiagaraAX-3.7u1
1–2
NiagaraAX Export Tags for Supervisor Auto-Configuration
Chapter 1 – Export Tags Quick Start Add the NiagaraNetwork Export Tag extensions
May 31, 2013 Enable the JoinProfile for the Supervisor NiagaraStation
The extension is under the NiagaraNetwork, and includes two special views. By addition, it automatically
creates a “JoinProfile” child under each NiagaraStation component in the subordinate’s NiagaraNetwork.
In the subordinate’s NiagaraNetwork, only the NiagaraStation that represents the Supervisor is of interest
when working with export tags. You must enable the JoinProfile under this NiagaraStation, and typically
configure other properties of that JoinProfile, in order to use export tags. See the next section, “Enable
the JoinProfile for the Supervisor NiagaraStation”.
Note: A NiagaraStation for the Supervisor should already be in the subordinate’s NiagaraNetwork, providing the
Supervisor station had a NiagaraStation added (and correctly configured) to connect to the subordinate.
In case this NiagaraStation shows a status of disabled:
• Expand its Client Connection child and make sure that the (Fox) Port, Username, and Password are
correct for station connection back to the Supervisor.
• Enable the parent NiagaraStation (from its property sheet), and issue a right-click Ping action. Ver-
ify that its status is ok.
In case the JACE is not currently installed on the LAN with the Supervisor, you can still work with export
tags, but you will not be able to “Join”, much less ping, the Supervisor. However, in this case you may wish
to configure the “Default” connection properties under the JoinProfile of the Supervisor NiagaraStation in
the subordinate. For related details, see “Editing the Join Profile” on page 2-13.
NiagaraAX-3.7u1
1–3
NiagaraAX Export Tags for Supervisor Auto-Configuration
Add the NiagaraNetwork Export Tag extensions Chapter 1 – Export Tags Quick Start
Verify and edit the station [Link] file May 31, 2013
Step 4 Providing the JACE is configured to use SSL for station connections, that is Foxs (Fox SSL), an option
available starting in AX-3.7, change the “Default Subordinate Use Fox SSL” property from the default
false to true, and click Save. This property is shown encircled above, but has not been changed yet.
Note that Foxs is not supported in JACE-2 or -4/5 series hosts (JACEs that use the IBM J9 JVM), so if
working in one of these stations, this property must be left false. Typically, if the JACE is configured for
SSL, you have it opened now in Workbench using a “Station SSL Connection” (Foxs, showing icon ).
Note: Complete details on SSL in AX-3.7 and later hosts are in the NiagaraAX SSL Connectivity Guide.
Edits to other properties in this JoinProfile are often optional. In general, usage often applies to very large
systems. For more details on all JoinProfile properties, see “Editing the Join Profile” on page 2-13.
Note: Starting in AX-3.7u1, when issuing a Join from a subordinate JACE station, and that station does not
already exist in the Supervisor, the “Default Subordinate User Password” property must be configured with
a valid password for the selected “Default Subordinate User”. If no valid user and password has been
entered the Join will fail due to authentication errors.
After enabling the JoinProfile, the next task to do in this station is “Verify and edit the station [Link]
file”.
NiagaraAX-3.7u1
1–4
NiagaraAX Export Tags for Supervisor Auto-Configuration
Chapter 1 – Export Tags Quick Start Add the NiagaraNetwork Export Tag extensions
May 31, 2013 Verify and edit the station [Link] file
Note the [Link] file specifies the parent “container/folder structure”, and is not meant for adding
individual components. However, properties of this niagaraStation and its “device components” are used.
Step 2 As needed, edit properties of the NiagaraStation (representing this JACE) as it needs to be configured on
the Supervisor station, including properties of its “device extensions” such as Alarms and Users. Note
that upon any export tag “Join”, these property values overwrite any property values in the corresponding
NiagaraStation component in the Supervisor station.
To do this, expand the niagaraStation node under the supervisorStationName_profile.bog
file and access property sheet views as if working with a “live” station.
For example, if “network users” (copied from the Supervisor) are, or will be, used in this JACE station,
under its Users device extension, set the “Sync Out Enabled” property to true. For related details, see
“About the niagaraStation [Link] file” on page 2-18 and “Device extension properties importance in
[Link] file” on page 2-19.
Step 3 Optionally, you can also edit this file to add new folders, as shown being done in Figure 1-5.
Later, when you are “tagging up” components in this station, note that each export tag has a “Station Slot
Path” property in which you specify the parent folder. You can either type a slot path in directly (so that
the folder will be made “dynamically” on the Supervisor), or else click a “folder” link. This folder link
opens a dialog to this niagaraStation in the JACE’s “[Link]” file—for parent selection only. You can
come back and edit this [Link] file whenever convenient, including between subsequent “Joins”.
Note: Remember to save the [Link] file each time when finished making changes. Right-click on the
supervisorStationName_profile.bog file and select Save, as shown in Figure 1-6.
NiagaraAX-3.7u1
1–5
NiagaraAX Export Tags for Supervisor Auto-Configuration
Add export tags Chapter 1 – Export Tags Quick Start
Adding PxViewTags May 31, 2013
Figure 1-6 Save [Link] file each time when done with changes
Adding PxViewTags
If your JACE station serves PxViews directly, and you wish to add any number of these PxViews at the
Supervisor station, you can do this easily using PxViewTags.
Note: Among the different types of export tags, PxViewTags offer the biggest return on engineering time when
considering the functionality provided. In some cases, they may preclude most use of PointTags, except
where “link control” in the Supervisor station requires Niagara proxy points.
To add PxViewTags
Step 1 Drag the PxViewTag from the exportTags palette onto the folder or container with the original PxView.
The Name dialog appears, in which you can accept “PxViewTag”, or enter another name, and click OK.
Note the resulting PxView on the Supervisor uses the name of the referenced PxView, and not this name.
Step 2 Double-click the PxViewTag to access its property sheet.
1. In the Supervisor Station property, click the control and select the Supervisor station,
then click Save.
2. For Station Slot Path, do either of the following:
• Enter a desired slot path to use on the Supervisor station for the folder to have this PxView. For
example, if you enter slot:Ground_Floor/AHU2
Upon a Join, at the Supervisor station, this Px view will be put on a folder at this location:
Note “BFormat” variables are an alternative, and can save engineering time. See “Station Slot
Path considerations” on page 2-21 and “BFormat options in Station Slot Paths” on page 2-22.
Or, (if desired) use the station “[Link]” file method”, described next.
NiagaraAX-3.7u1
1–6
NiagaraAX Export Tags for Supervisor Auto-Configuration
Chapter 1 – Export Tags Quick Start Add export tags
May 31, 2013 Adding PointTags
• Click open folder, for the Select Parent Target dialog. Expand the niagaraSta-
tion and select a target folder for the PxView to appear in the Supervisor station (default puts
the PxView on the root of the NiagaraStation).
Note: You may edit the “[Link] file” to specify a new target folder structure—see “Verify and edit
the station [Link] file” on page 1-4 for details.
3. In the Px View property, click the control and select the PxView for export, by name.
Step 3 Remaining properties of the PxViewTag are often left at defaults, noting briefly:
• Required Permissions — is Operator read (r) by default, click the control to change.
• Order Number — is 0 default. If assigning multiple PxViewTags to the same target station slot
path, assign a different order number to each one, to specify menu order of the views. The menu dis-
plays the views “highest number first”, that is, order number 2 above number 1 above number 0.
• File related properties (Create File Import, and File Import Name, Overwrite Policy, Execution
Time, Execution Time, Use Category Mask) relate to FileImportTags that may be created automat-
ically in support of the PxView export.
• Supervisor Px File Directory (and Media Directory) properties specify the Supervisor folder
locations for associated imported px and image files, respectively. Default values use “ord variables”
to duplicate the same folder organization on the JACE.
• Substitute Override Ords — provides a popup View dialog in which you can edit “sub-
stitute ords” used in the PxView to be created on the Supervisor, using the “Choose from Px” feature.
In many scenarios, this may be useful to change hyperlink destinations in Px bindings.
Step 4 Click Save after finishing all property changes.
For further details, see “About PxViewTags” on page 2-25, including subsection “About ord substitution
overrides” on page 2-28.
Adding PointTags
Point tags create Niagara proxy points on the Supervisor, under the Points container of the NiagaraS-
tation that represents this subordinate (JACE) station. Typically, you may limit usage to points you need
for “output links” or control logic in the Supervisor, because of the “Niagara virtual point” feature
automatically provided in PxViewTags. However, if using the scheme where all PxView tags use
“slot:points/%networkFolderPath” as “Station Slot Path”, it is recommended to add a PointTag to at
least one proxy point under each device with a PxView. For related details, see “BFormat options in
Station Slot Paths” on page 2-22.
Adding PointTags
Step 1 Drag the PointTag from the exportTags palette onto the proxy point or other target component.
The Name dialog appears, in which you can accept “PointTag”, or enter another name, and click OK.
Note the resulting Niagara proxy point uses the name of the referenced component, and not this name.
Step 2 Double-click the PointTag to access its property sheet.
1. In the Supervisor Station property, click the control and select the Supervisor station,
then click Save.
2. For Station Slot Path, do either of the following:
• Enter a desired slot path to use on the Supervisor station for the Niagara points folder to hold
this proxy point. Note the entered property value must begin with slot:points
For example, if you enter slot:points/Floor_4/AHU5
Upon a Join, at the Supervisor station, the resulting proxy point will be in this location:
Note “BFormat” variables are an alternative, and can save engineering time. See “Station Slot
Path considerations” on page 2-21 and “BFormat options in Station Slot Paths” on page 2-22.
Or, (if desired) use the station “[Link]” file method”, described next.
• Or, click open folder, for the Select Parent Target dialog. Expand the niagaraS-
tation and select a target container for the Niagara proxy point to appear in the Supervisor
station (default (slot:points) puts the proxy point in the root of the Points extension).
Note: You may edit the “[Link] file” to specify a new target folder structure—see “Verify and edit
the station [Link] file” on page 1-4 for details.
NiagaraAX-3.7u1
1–7
NiagaraAX Export Tags for Supervisor Auto-Configuration
Add export tags Chapter 1 – Export Tags Quick Start
Adding HistoryImportTags May 31, 2013
Step 3 Remaining properties of the PointTag are often left at defaults, noting briefly:
• Conversion — standard Conversion property for a Niagara proxy point, typically left at Default.
• Tuning Policy Name — standard Tuning Policy Name property for a Niagara proxy point. For
related details, see “Niagara Tuning Policy notes” in the Drivers Guide.
Step 4 Click Save after finishing all property changes.
For further details, see “About PointTags” on page 2-30.
Adding HistoryImportTags
Add a HistoryImportTag to the history extension of a point or component to import/archive that history
on the Supervisor. This tag creates a Niagara history import descriptor in the Supervisor, under the
Histories container of the NiagaraStation that represents this subordinate (JACE) station.
To add HistoryImportTags
Step 1 Drag the HistoryImportTag from the exportTags palette onto the point’s history extension, or if
desired, onto its child HistoryConfig extension (either location is acceptable).
The Name dialog appears. Either accept “HistoryImportTag”, or enter another name and click OK. Note
by default, the resulting Niagara history import descriptor uses the parent name of the history extension,
and not this name.
Step 2 Double-click the HistoryImportTag to access its property sheet.
1. In the Supervisor Station property, click the control and select the Supervisor station,
then click Save.
2. For Station Slot Path, either accept the default “slot:histories”, or else either:
• Enter a slot path to use on the Supervisor station for the Niagara archives folder to hold this his-
tory import descriptor. Note the entered property value must begin with slot:histories
Note “BFormat” variables are an alternative too. See “Station Slot Path considerations” on page
2-21 for more details. Or, (if desired) use the station “[Link]” file method”, described next.
• Or, click open folder, for the Select Parent Target dialog. Expand the niagaraS-
tation and select a target container under Histories for the Niagara history import de-
scriptor to appear in the Supervisor station (default “slot:histories” puts the import
descriptor in the root of the Histories extension).
Note: You may edit the “[Link] file” to specify a new target folder structure—see “Verify and edit
the station [Link] file” on page 1-4 for details.
Step 3 Most remaining properties of the HistoryImportTag are standard to Niagara history import descriptors,
noting briefly:
• History Import Name — name of the NiagaraHistoryImport descriptor, by default set using a
format variable, resulting in name similar to: “Remote_pointName”. Does not affect history name.
• Execution Time — standard selections for a Niagara history import.
• Config Overrides — standard selections for a Niagara history import, containing settings for
Capacity and Full Policy.
• On Demand Poll (Enabled and Frequency) — standard selections for a Niagara history import.
For related details on these four properties, see “History Import Edit” in the Drivers Guide.
• Use Category Mask — Boolean to specify whether the history imported by this tag will have
any export tag category filters applied to it (default is true). For related details, see “Adding Catego-
ryFilters” on page 2-9.
Step 4 Click Save after finishing all property changes.
For further details, see “About HistoryImportTags” on page 2-31.
Adding SystemHistoryImportTags
Add one or more SystemHistoryImportTags anywhere in the subordinate (JACE) station to import
histories on the Supervisor using the “System Tags” feature. Each tag creates a Niagara system history
import descriptor in the Supervisor, under the Histories container of the NiagaraStation that repre-
sents this subordinate (JACE) station.
To add SystemHistoryImportTags
Step 1 Drag the SystemHistoryImportTag from the exportTags palette anywhere in the station’s
Config space (you may wish to create a separate folder just to hold these tags).
NiagaraAX-3.7u1
1–8
NiagaraAX Export Tags for Supervisor Auto-Configuration
Chapter 1 – Export Tags Quick Start Add export tags
May 31, 2013 Adding ScheduleImportTags
The Name dialog appears. Either accept “SystemHistoryImportTag”, or enter another name and click OK.
By default, this is the name of the NiagaraSystemHistoryImport descriptor created in the Supervisor.
Step 2 Double-click the SystemHistoryImportTag to access its property sheet.
1. In the Supervisor Station property, click the control and select the Supervisor station,
then click Save.
2. For Station Slot Path, either accept the default “slot:histories”, or else either:
• Enter a slot path to use on the Supervisor station for the Niagara archives folder to hold this his-
tory import descriptor. Note the entered property value must begin with slot:histories
Note “BFormat” variables are an alternative too. See “Station Slot Path considerations” on page
2-21 for more details. Or, (if desired) use the station “[Link]” file method”, described next.
• Or, click open folder, for the Select Parent Target dialog. Expand the niagaraS-
tation and select a target container under Histories for the Niagara history import de-
scriptor to appear in the Supervisor station (default “slot:histories” puts the import
descriptor in the root of the Histories extension).
Note: You may edit the “[Link] file” to specify a new target folder structure—see “Verify and edit
the station [Link] file” on page 1-4 for details.
Step 3 In the System Tags Pattern property (last property listed in property sheet), enter one or more
System Tags, as used in history extensions in the subordinate (JACE) station. For related details, see the
section “Using System Tags to import Niagara histories” in the Drivers Guide.
Step 4 Most remaining properties of the SystemHistoryImportTag are standard to Niagara system history
import descriptors, noting briefly:
• History Import Name — name of the NiagaraSystemHistoryImport descriptor, where the de-
fault format variable results in the same name as the export tag itself.
• Execution Time — standard selections for a Niagara history import.
• Config Overrides — standard selections for a Niagara history import, containing settings for
Capacity and Full Policy.
• On Demand Poll (Enabled and Frequency) — standard selections for a Niagara history import.
For related details on these four properties, see “History Import Edit” in the Drivers Guide.
• Use Category Mask — Boolean to specify whether histories imported by this tag will have any
export tag category filters applied to them (default is true).
Note: For this export tag type, this feature is future use only—currently, only histories exported using
the HistoryImportTag can make use of the category mask feature.
Step 5 Click Save after finishing all property changes.
For further details, see “About SystemHistoryImportTags” on page 2-32.
Adding ScheduleImportTags
Although usage is expected to be infrequent, you can add a ScheduleImportTag onto an existing schedule
component (BooleanSchedule, NumericSchedule, etc.) in the subordinate (JACE) station. Upon a Join,
this creates a corresponding “slave” schedule in the Supervisor (and a Niagara ScheduleImportExt
descriptor), as well as a Niagara ScheduleExportExt descriptor in this subordinate (JACE) station.
Adding ScheduleImportTags
Step 1 Drag the ScheduleImportTag from the exportTags palette onto the schedule component.
The Name dialog appears. Either accept “ScheduleImportTag”, or enter another name and click OK. By
default, the resulting Niagara slave schedule (and ScheduleImportExt) in the Supervisor use the parent
name of the schedule component. By default, the ScheduleExportExt is named ScheduleNameExport.
Step 2 Double-click the ScheduleImportTag to access its property sheet.
Step 3 In the Supervisor Station property, click the control and select the Supervisor station.
Note that Station Slot Path is read-only at “slot:schedules” (Schedules under the NiagaraStation).
Step 4 If needed, change the Execution Time property settings.
Step 5 Click Save after finishing all property changes.
For further details, see “About ScheduleImportTags” on page 2-34.
NiagaraAX-3.7u1
1–9
NiagaraAX Export Tags for Supervisor Auto-Configuration
Add export tags Chapter 1 – Export Tags Quick Start
Adding ScheduleExportTags May 31, 2013
Adding ScheduleExportTags
Among the different export tag types, ScheduleExportTags may be the least “intuitive”. To use one, you
must have an existing Niagara schedule with ScheduleImportExt descriptor in the subordinate (JACE)
station, under the NiagaraStation that represents the Supervisor. Drag the ScheduleExportTag onto the
ScheduleImportExt component, that is, making it a child of the Niagara schedule import descriptor.
If you want to “slave” to an existing schedule in the Supervisor, you need to know its ord in that station
(component path)—in which case, use of this tag is somewhat redundant.
Or, you can use a ScheduleExportTag with a new schedule to create a new, blank, “master” schedule on
the Supervisor that corresponds to the “slave” schedule on the subordinate (JACE) station.
To add ScheduleExportTags
Step 1 In the Nav tree, expand the Schedules extension of the NiagaraStation that represents the
Supervisor, and double-click it for the Niagara Schedule Import Manager view. This view lists
schedules that are currently imported from the Supervisor (if any).
• If there are none, click the New button in the Schedule Import Manager to add a new schedule,
selecting the type in the first New dialog, and enter the desired name in the second New dialog. After
adding it, it should appear in the Nav tree with a Niagara ScheduleImportExt descriptor ( ext).
• If imported schedules already exist, expand a schedule in the Nav tree to see if its Niagara Sched-
uleImportExt descriptor ( ext) already has a ScheduleExportTag .
Step 2 Drag a ScheduleExportTag from the exportTags palette onto a schedule’s Niagara schedule
import descriptor ( ext).
The Name dialog appears. Either accept “ScheduleExportTag”, or enter another name and click OK. Note
by default, the resulting Niagara master schedule (and ScheduleExportExt descriptor) in the Supervisor
use the name of the (grandparent) schedule.
Step 3 Double-click the parent Niagara ScheduleImportExt descriptor ( ext) to access its property sheet,
which also contains the ScheduleExportTag (expand it also).
The following properties are key:
• Supervisor Id — (ScheduleImportExt) location of source Supervisor’s (master) schedule, using
syntax as follows:
slot:path
where path includes parent folder(s) and the name of the schedule component, for example:
slot:/Schedules/Ltg/LtgAnnex
for a schedule named “LtgAnnex” located in the “Schedules”, “Ltg” folder on the Supervisor.
If adding a new schedule, this property may be blank—it is populated upon a successful Join.
• Override Supervisor Id — (ScheduleExportTag) Boolean as to whether to override any ex-
isting Supervisor Id in the parent import descriptor, and use instead the “NiagaraStation-relative”
Override Supervisor Id Station Slot Path value (next property). By default, this is false.
Typically, you set this to true only when making an new master schedule on the Supervisor, at the
location specified in the next property (relative to the NiagaraStation that represents this JACE).
• Override Supervisor Id Station Slot Path — (ScheduleExportTag) Parent folder
location of the source Supervisor’s (master) schedule if “Override Supervisor Id” is set to true. The
default slot path is simply “slot:”, which means the root of the NiagaraStation that represents this
subordinate (JACE) station on the Supervisor.
Or, click open folder, to see the Select Parent Target dialog with station ready to expand.
Note: You may edit the “[Link] file” to specify a new target folder structure—see “Verify and edit
the Station (.bog) File” on page 1-4 for details.
When overriding the Supervisor Id, a new master schedule is created on the Supervisor in this parent
folder, named the same as the (grandparent) schedule component (slave) that has this export tag.
Step 4 The remaining ScheduleExportTag property is standard to Niagara schedule export descriptors, noting
briefly:
• Export Execution Time — standard selections for a Niagara schedule export to occur, using
trigger selections for mode and time, as well as last and next (calculated) times for schedule export.
Step 5 Click Save after finishing all property changes.
For further details, see “About ScheduleExportTags” on page 2-34.
NiagaraAX-3.7u1
1–10
NiagaraAX Export Tags for Supervisor Auto-Configuration
Chapter 1 – Export Tags Quick Start Add export tags
May 31, 2013 Adding FileImportTags
Adding FileImportTags
The FileImportTag lets you import a file (or entire folder of files) from the subordinate (JACE) station to
the Supervisor station. This tag creates a Niagara file import descriptor in the Supervisor, under the
Files device extension of the NiagaraStation that represents this subordinate (JACE) station, and
imports the associated file(s).
Note: When using PxViewTags, related file imports are automatically included in an “as-needed” manner,
without requiring use of FileImportTags.
To add FileImportTags
Step 1 Drag the FileImportTag from the exportTags palette and drop anywhere in the JACE station’s
component space (under Config)—no particular parentage is necessary.
The Name dialog appears. Either accept “FileImportTag”, or enter another name and click OK. By default,
the resulting Niagara file import descriptor (created on the Supervisor) uses this name.
Step 2 Double-click the FileImportTag to access its property sheet.
1. In the Supervisor Station property, click the control and select the Supervisor station,
then click Save.
2. For Station Slot Path, accept the default “slot:files” (for root of Files under the
NiagaraStation). This is the only valid parent for the resulting Niagara file import descriptor.
3. In File Import Name, either accept the default variable (%defaultFileImportName%), or enter
an explicit name for the Niagara FileImport descriptor. The default (variable) results in a name that
uses the name of source file (or folder) appended to “_import”.
Step 3 In the File property, you specify the local file or directory to import to the Supervisor. The default value
is “file:^”, which imports all objects in the local file space.
Click either:
• if a single file, the folder control for the File Chooser dialog.
• if a directory, the adjacent drop-down control, then choose Directory Ord Chooser from
the menu for the Directory Chooser dialog.
Navigate to the source file or directory in the dialog and then select it.
Example File property values are: file:^reports (for a “reports” directory in the local file space) and
file:^reports/moreReports/[Link] (for a single file found in a specific subdirectory).
Step 4 In the Supervisor Directory property, you can accept the default value using ord variables:
“file:^stations$(stationName)$(currentLocation)”, which replicates a similar file/subfolder
location on the Supervisor, but under a “stations” file subfolder organized by stations, including this one.
Or, you specify another explicit location under the Supervisor’s file space (file:^location).
Step 5 In the two other file import properties, you can accept default values or change, if needed.
• File Overwrite Policy — either Checksum (default) or Last Modified.
• Execution Time — standard selections for a Niagara file import.
Step 6 The Use Category Mask boolean specifies whether the imported file(s) will have any export tag
category filters applied to it (default is true). For related details, see “About CategoryFilters” on page 2-8.
Step 7 Click Save after finishing all property changes.
For further details, see “About FileImportTags” on page 2-36.
Adding ComponentTags
Component tags create a copy of the component from the source station and save it on the Supervisor,
for limited “general purpose” usage. Component tags do not create a proxy, meaning that if you change
properties on the component with the tag in the source station, those changes are not reflected in the
copy of the component located in the Supervisor station. Often, the component tags apply to source
components that have an “out” slot but have a “null” (or no) proxyExt, such as many found in the
kitControl module. Or, they may be used with “custom” components. In general, usage on any
“container” component is not recommended.
To add ComponentTags
Step 1 Drag the ComponentTag from the exportTags palette onto the target component.
The Name dialog appears, in which you can accept “ComponentTag”, or enter another name, and click OK.
Note the resulting component uses the name of the referenced component, and not this name.
Step 2 Double-click the ComponentTag to access its property sheet.
NiagaraAX-3.7u1
1–11
NiagaraAX Export Tags for Supervisor Auto-Configuration
Issue Join commands Chapter 1 – Export Tags Quick Start
Join from the Supervisor May 31, 2013
1. In the Supervisor Station property, click the control and select the Supervisor station,
then click Save.
2. For Station Slot Path, do either of the following:
• Enter a slot path to use on the Supervisor station for the container holding this component. The
default is “slot:”, which means the root of the NiagaraStation representing this JACE.
For example, if you enter slot:Stuff/Programs
Upon a Join, at the Supervisor station, the resulting component will be in this location:
“BFormat” variables are also an alternative. See “Station Slot Path considerations” on page 2-21.
Or, (if desired) use the station “[Link]” file method”, described next.
• Or, click open folder, for the Select Parent Target dialog. Expand the niagaraS-
tation and select a target container for the component to appear in the Supervisor station
(default (slot:) puts the component in the root of NiagaraStation).
Note: You may edit the “[Link] file” to specify a new target folder structure—see “Verify and edit
the station [Link] file” on page 1-4 for details.
Step 3 Click Save after finishing all property changes.
For further details, see “About ComponentTags” on page 2-38.
NiagaraAX-3.7u1
1–12
NiagaraAX Export Tags for Supervisor Auto-Configuration
Chapter 1 – Export Tags Quick Start Issue Join commands
May 31, 2013 Join from the subordinate (JACE) station
For related details about a Join (in general) as well as a Join from a Supervisor, refer to “About a Join” on
page 2-2 and “About the Join process” on page 2-4.
Figure 1-7 Join from subordinate’s Join Profile Manager view provides automatic Job Log popup
As shown in Figure 1-7, the Join executes and ends with a popup Job Log that lists all operations
performed in the Join. This lets you review all changes, and if desired, save (export) to a text file. In case
of any errors encountered in the Join, the job log can help locate specific export tag problems.
In addition, a brief Job popup “Subordinate Join” notification appears near your PC’s system tray area.
Note: Starting in AX-3.7, “Fox SSL” may be used in connections between the JACE stations and the Supervisor,
depending on configuration. In this case, note that initial Join attempts may fail due to “non-approved
certificate host name validation”. If so, you will see the appropriate errors in a Join’s job log. You must
manually approve certificates between the client and server before Joins can succeed. Typically you do this
from the “Allowed Hosts” tab of the “Certificate Management” view (on platform service: CertMan-
agerService) in the stations. For complete details on AX-3.7 and later SSL, refer to the NiagaraAX SSL
Connectivity Guide.
You can also issue a Join in the subordinate station as a “right-click action” on the Subordinate-
ExportTagNetworkExt, or on the Supervisor station as listed in the Join Profile Manager view.
However, if you invoke the Join using either of those methods, you do not see the “automatic” popup Job
Log dialog with all the details from the Join, as shown in Figure 1-7.
Note: In AX-3.7u1, when issuing a Join from a subordinate JACE station, and that station does not already exist
in the Supervisor, the “Default Subordinate User Password” property must be configured with a valid
password for the selected “Default Subordinate User”. If no valid user and password has been entered the
Join will fail due to authentication errors. For further details, see “Editing the Join Profile” on page 2-13.
For related details about a Join (in general) as well as a Join from a JACE, refer to “About a Join” on page
2-2 and “Join process from subordinate” on page 2-5.
NiagaraAX-3.7u1
1–13
NiagaraAX Export Tags for Supervisor Auto-Configuration
Issue Join commands Chapter 1 – Export Tags Quick Start
Join from the subordinate (JACE) station May 31, 2013
NiagaraAX-3.7u1
1–14
NiagaraAX Export Tags for Supervisor Auto-Configuration
CHAPTER 2
NiagaraAX Export Tag Concepts
This section provides details on the “Export Tags” feature first introduced in AX-3.5. Included is an
engineering overview, followed by details about the exportTags palette, various export tag components,
and related views.
The following main sections are included:
• “Export tags engineering overview” on page 2-2
• “About a Join” on page 2-2
• “About the JoinProfile” on page 2-3
• “About the Join process” on page 2-4
• “exportTags palette” on page 2-6
• “About the SupervisorExportTagNetworkExt” on page 2-7
• “About CategoryFilters” on page 2-8
• “About the Category Filter Manager” on page 2-8
• “Adding CategoryFilters” on page 2-9
• “About the SubordinateExportTagNetworkExt” on page 2-11
• “About the Join Profile Manager” on page 2-12
• “Editing the Join Profile” on page 2-13
• “About Station Info” on page 2-15
• “About the Export Tag Summary Manager” on page 2-16
• “About the Export Tag Summary Manager” on page 2-16
• “About the niagaraStation [Link] file” on page 2-18
• “Device extension properties importance in [Link] file” on page 2-19
• “Provisioning slot additions in a [Link] file” on page 2-20
• “Station Slot Path considerations” on page 2-21
• “BFormat options in Station Slot Paths” on page 2-22
• “About PxViewTags” on page 2-25
• “PxViewTag properties” on page 2-25
• “PxViewTag action” on page 2-27
• “About the Supervisor SubstitutePxView” on page 2-27
• “About ord substitution overrides” on page 2-28
• “About PointTags” on page 2-30
• “PointTag properties” on page 2-30
• “About HistoryImportTags” on page 2-31
• “HistoryImportTag properties” on page 2-31
• “About ScheduleImportTags” on page 2-34
• “ScheduleImportTag properties” on page 2-34
• “About ScheduleExportTags” on page 2-34
• “ScheduleExportTag properties” on page 2-35
• “About FileImportTags” on page 2-36
• “FileImportTag properties” on page 2-36
• “About ComponentTags” on page 2-38
• “ComponentTag properties” on page 2-38
• “ComponentTag example (ExportTagProgram)” on page 2-39
NiagaraAX-3.7u1
2–1
NiagaraAX Export Tags for Supervisor Auto-Configuration
Export tags engineering overview Chapter 2 – NiagaraAX Export Tag Concepts
About a Join May 31, 2013
Figure 2-1 Export tags in subordinate station create components, histories, and files in Supervisor
Supervisor
Station
Subordinate
Station
NiagaraStation
in Supervisor’s
Niagara Network
Join
Exported components are created in the Supervisor under the NiagaraStation component representing
the subordinate station that was joined. This includes Px views (complete with Niagara “virtual points”
and imported image files), history and file import descriptors, schedule import and export descriptors,
plus components such as Niagara proxy points.
As part of the “JoinProfile” on a subordinate station, a “[Link] file” on the JACE determines the
property values used in the corresponding NiagaraStation (including its device components) in the
Supervisor station. Optionally, this [Link] file can also determine the container/folder structure used
in this NiagaraStation in the Supervisor. Each export tag can reference a specific location in this
[Link] station, to be used as the parent container for its associated exported component.
Exported files and histories result in objects created in the Supervisor’s file space (Files) and history space
(History), in addition to their associated file and history import descriptors (components) created under
a NiagaraStation. Under the Files and History object spaces, created files and histories are automatically
organized by subordinate station (not shown in Figure 2-1).
The following sections explain more export tag concepts:
• About a Join
• About the JoinProfile
• About the Join process
About a Join
The Join command launches the export tag process on the Supervisor, where resulting changes are made
in the Supervisor’s database. Specifically, all component changes from a join apply to the NiagaraStation
(and its child components) that represents that subordinate.
NiagaraAX-3.7u1
2–2
NiagaraAX Export Tags for Supervisor Auto-Configuration
Chapter 2 – NiagaraAX Export Tag Concepts Export tags engineering overview
May 31, 2013 About the JoinProfile
NiagaraAX-3.7u1
2–3
NiagaraAX Export Tags for Supervisor Auto-Configuration
Export tags engineering overview Chapter 2 – NiagaraAX Export Tag Concepts
About the Join process May 31, 2013
visor under its NiagaraNetwork. In addition, this [Link] file holds various property values used in
this NiagaraStation (and its device extensions) on the Supervisor. For more details, see “About the niaga-
raStation [Link] file” on page 2-18.
Also, the Join Profile has a “Station Info” child container, empty by default. You can add string slots under
it and assign values that can provide organizational utility, useful in very large systems. For more details,
see “About Station Info” on page 2-15.
Figure 2-2 Join process steps when Join is issued from Supervisor station.
Connect to subordinate.
Disconnect.
As shown in this diagram, once connected, the Supervisor finds the JoinProfile on the subordinate and
opens its station “[Link] file”. The Supervisor then merges the [Link] file (and/or individual
“Station Slot Paths” in export tags) with the current NiagaraStation structure. Then the Supervisor finds
all enabled export tags on the subordinate, and performs the join, merging with existing components
under the NiagaraStation.
The Supervisor then disconnects. Details about the Supervisor Join are in its local job log.
Note: Starting in AX-3.7, “Fox SSL” may be used in connections between the JACE stations and the Supervisor,
depending on configuration. In this case, note that initial Join attempts may fail due to “non-approved
certificate host name validation”. If so, you will see the appropriate errors in a Join’s job log. You must
manually approve certificates between the client and server before Joins can succeed. Typically you do this
from the “Allowed Hosts” tab of the “Certificate Management” view (on platform service: CertMan-
agerService) in the stations. For complete details on AX-3.7 and later SSL, refer to the NiagaraAX SSL
Connectivity Guide.
NiagaraAX-3.7u1
2–4
NiagaraAX Export Tags for Supervisor Auto-Configuration
Chapter 2 – NiagaraAX Export Tag Concepts Export tags engineering overview
May 31, 2013 About the Join process
Figure 2-3 Extra initial connection in processes for Join issued from subordinate station
Connect to subordinate.
(use Default user/connection info if NiagaraStation
not already configured for subordinate).
Note that this method allows a new subordinate to be added to the NiagaraNetwork of the Supervisor
even in cases where the Supervisor is “unaware” of the remote host, providing the subordinate station’s
NiagaraNetwork has a NiagaraStation node representing the Supervisor, complete with configured Fox
client connection.
In this scenario the subordinate’s JoinProfile would require valid entries for “Default Subordinate User”
(typically a service account for station to station communications with full, admin-level, permissions,)
“Default Subordinate User Password”, “Default Subordinate IP Address”, and possibly “Default Subor-
dinate Port” properties. For further details, see “Editing the Join Profile” on page 2-13.
Note: Starting in AX-3.7, “Fox SSL” may be used in connections between the JACE stations and the Supervisor,
depending on configuration. In this case, note that initial Join attempts may fail due to “non-approved
certificate host name validation”. If so, you will see the appropriate errors in a Join’s job log. You must
manually approve certificates between the client and server before Joins can succeed. Typically you do this
from the “Allowed Hosts” tab of the “Certificate Management” view (on platform service: CertMan-
agerService) in the stations. For complete details on AX-3.7 and later SSL, refer to the NiagaraAX SSL
Connectivity Guide.
NiagaraAX-3.7u1
2–5
NiagaraAX Export Tags for Supervisor Auto-Configuration
exportTags palette Chapter 2 – NiagaraAX Export Tag Concepts
About the Join process May 31, 2013
exportTags palette
When “tagging up” a subordinate (JACE) station opened in Workbench, you can copy (drag and drop)
from the exportTags module’s palette, shown in Figure 2-4.
Note: Often, only a few types of export tag extensions are used—for example; PxViewTag, HistoryImportTag, and
possibly PointTag.
Each of these components is briefly described as follows:
• SupervisorExportTagNetworkExt
This is the only component that goes in the Supervisor station (not subordinate station). You copy
one into the NiagaraNetwork of the Supervisor. For configuration details on its properties and child
components, see “About the SupervisorExportTagNetworkExt” on page 2-7.
• SubordinateExportTagNetworkExt
You copy one into the NiagaraNetwork of a subordinate station. It provides two special views for
working with export tags, and also produces a JoinProfile container under each NiagaraStation com-
ponent in the station’s NiagaraNetwork. For configuration details on its properties, child compo-
nents, and views, see “About the SubordinateExportTagNetworkExt” on page 2-11
• PxViewTag
Use this export tag to export any PxView in the subordinate station up to the Supervisor station.
Copy it on the folder/container in the JACE station with the PxView, then specify it as a view on any
designated folder/container under the “[Link] file” (determines the NiagaraStation structure on
the Supervisor). Several properties in the tag require configuration.
PxViewTags are a powerful feature, and automatically encapsulate several other functions, including
“on demand” Niagara virtual components for real-time values, along with importing of any graphics
files used in the PxView. The resulting “virtual” or “substitute PxView” operates like the original Px-
View in the subordinate station, without the overhead of Niagara proxy points.
In some use cases, it is possible that PxViewTags may preclude the need for PointTags and Compo-
nentTags, comprising the vast majority of export tags in a subordinate station. For details, see “About
PxViewTags” on page 2-25.
• PointTag
Use a PointTag to export any control point or proxy point in the subordinate station as a Niagara
proxy point in the Supervisor station. Simply copy the PointTag onto the source point in the subor-
dinate station (for example, a Lonworks proxy point or BACnet proxy point). For details, see “About
PointTags” on page 2-30.
• HistoryImportTag
Use a HistoryImportTag to export a particular history in the subordinate station. Simply copy the
HistoryImportTag onto the point’s history extension, or alternatively, under the history extension’s
“HistoryConfig” child container. For details, see “About HistoryImportTags” on page 2-31.
• SystemHistoryImportTag
Use a SystemHistoryImportTag to export groups of histories in the subordinate station that have
matching “System Tags”, utilizing a feature introduced starting in AX-3.4. You can copy a System-
HistoryImportTag anywhere in the station. For details, see “About SystemHistoryImportTags” on
page 2-32.
• ScheduleImportTag
Use a ScheduleImportTag to designate an existing schedule on the subordinate station as a “master”,
thereby creating a “slave” schedule on the Supervisor station. Copy a ScheduleImportTag onto any
NiagaraAX-3.7u1
2–6
NiagaraAX Export Tags for Supervisor Auto-Configuration
Chapter 2 – NiagaraAX Export Tag Concepts About the SupervisorExportTagNetworkExt
May 31, 2013 About the Join process
existing schedule (BooleanSchedule, NumericSchedule, and so on) in the station. Usage of this ex-
port tag is expected to be infrequent. For details, see “About ScheduleImportTags” on page 2-34.
• ScheduleExportTag
Use a ScheduleExportTag to associate (or create) a “master” schedule on the Supervisor station with
a new “slave” schedule on the subordinate station. Copy a ScheduleExportTag onto the Niagara
ScheduleImportExt descriptor of a new schedule (BooleanSchedule, NumericSchedule, and so on)
in the station’s Schedules extension under the NiagaraStation for the Supervisor. For details, see
“About ScheduleExportTags” on page 2-34.
• FileImportTag
Use a FileImportTag to export a specific file or folder(s) of files to the Supervisor. Copy the FileIm-
portTag anywhere under the component space (Config) of the subordinate station, and configure
the source file ord in the “File” property. Note that file imports can also automatically occur as a re-
sult of using PxViewTags. For details, see “About FileImportTags” on page 2-36.
• ComponentTag
Use a ComponentTag to export a copy of a component other than a control point or proxy point, for
example a kitControl component or Program component.
Note: Component tags do not create a proxy. If you change properties on the component with the tag
in the source station, those changes are not reflected in the copy of the component located in the Super-
visor station.
Simply copy the ComponentTag onto the source component. You can specify the exported compo-
nent to be in any designated folder/container under the NiagaraStation (that represents the subor-
dinate). For details, see “About ComponentTags” on page 2-38.
• ExportTagProgram
This is an example Program component with a ComponentTag already applied, to demonstrate one
application of the ComponentTag. Usage allows automating any “post join” operations from any ad-
ditional supplied program logic, within the “template” design of the program code. Use is targeted
for users who are experienced with Program components. Possible post-join operations might in-
clude creating links. For details, see “ComponentTag example (ExportTagProgram)” on page 2-39.
The property sheet is the default view (no specialized views), with properties described as follows:
• Status
Read-only status of the network extension, typically “ok”.
• Category Filters
Container for any CategoryFilter export tag components, where usage is optional. The default view
is the Category Filter Manager, for adding, editing, and deleting CategoryFilter components.
For more details, see the next section “About CategoryFilters”.
• Alarm Source Info
A container slot you can use to differentiate export tag alarms (from a failed Join) from other alarms
in the station. See “About network Alarm Source Info” in the Drivers Guide for general details.
NiagaraAX-3.7u1
2–7
NiagaraAX Export Tags for Supervisor Auto-Configuration
About CategoryFilters Chapter 2 – NiagaraAX Export Tag Concepts
About the Category Filter Manager May 31, 2013
Note: The Supervisor’s AuditLog also records both successful and failed “exportTagJoin” jobs,
including information on changed slot values (old and new), and also the originating user.
• Station Folder Path
Allows usage of “Station Info” metadata in remote JACE stations to automatically, upon a Join, create
NiagaraStationFolders (device folders) on the Supervisor, to organize NiagaraStations under them.
To do this, this property value must use “ord variables” that correspond to known string slots that
have been added in the remote stations, under each JoinProfile, “Station Info” slot.
Typically, this feature is useful on extremely large systems, where a Supervisor may have many sub-
ordinate JACE stations.
• The default “slot:” is used for normal operation, meaning without creation of station folders.
• Optionally (although rarely used), you can append explicit text string(s), used by any subordi-
nate station Join, regardless of its JoinProfile. For example: “slot:test/Example” will put all
joined NiagaraStation components in a NiagaraStationFolder named “Example”, itself a child of
another NiagaraStationFolder named “test”.
• More typically, you append one or more ord variables, using a “$()” syntax for each hierarchi-
cal level of NiagaraStationFolder you want created. To work, each ord variable must match the
name of a string slot added to the “Station Info” container under a remote station’s JoinProfile.
For example, a value of: “slot:$(State)$(City)” that corresponds to remote Station Info
string slots “State” and “City”, will result in two levels of NiagaraStationFolders. Each folder will
be named the value of that slot, for example a “Virginia” folder may have subfolders “Richmond”
and “Norfolk”, each of which contains one or more NiagaraStation components.
For related details, see “About Station Info” on page 2-15.
• Profile Export Tags
Specifies whether to include “Join time” statistics in the job log for each Join, reported in millisec-
onds (ms) for each item evaluated in a “Pre-Join”, “Join Time”, and “Post Join” fashion. The default
is false, meaning no Join time statistics. Enabling may be useful in some cases where slower connec-
tions between the Supervisor and subordinate hosts are used, for example via GPRS modem.
• Log Limit
Specifies the maximum (line) entries allowed in any job log in the Supervisor for any export tag Join,
where the default is 600. If a job log exceeds this limit, earlier entries are not captured. Range is from
1 to 10,000. Note that if Profile Export Tags (above) is true, many additional line entries result.
About CategoryFilters
CategoryFilters is the frozen container slot of the SupervisorExportTagNetworkExt in a Supervisor
station, used to hold CategoryFilter components that specify security categories on objects created
via export tags. This container has no configuration properties; however, its importance is in its default
view, as well as any child CategoryFilter components.
Usage of export tag category filters is optional. However, in some larger Supervisor configurations, this
feature may be needed for “station level separation” of user access via security categories.
For example, consider a Supervisor that is accessed by two diverse organizations: “bigOil” and “clean-
Water”. Users from each organization need login access to monitor their own sites, including PxViews,
histories, and so on. However, it is important that they cannot see each other’s data. In this case, this
separation of access in the Supervisor can be quickly accomplished at the “NiagaraStation level” using
Category Filters.
A prerequisite of CategoryFilters is the configuration of “Station Info” under the JoinProfile in each
subordinate (JACE) station. This involves adding one or more string slots and assigning string property
values. Upon a Join, this metadata is exported to the Supervisor as properties of the “Station Info”
extension of the NiagaraStation component that represents each JACE station. For related details, see
“About Station Info” on page 2-15.
The following subsections provide more details on a Supervisor’s export tag Category Filters:
• About the Category Filter Manager
• Adding CategoryFilters
NiagaraAX-3.7u1
2–8
NiagaraAX Export Tags for Supervisor Auto-Configuration
Chapter 2 – NiagaraAX Export Tag Concepts About CategoryFilters
May 31, 2013 Adding CategoryFilters
Note: The order of CategoryFilters can be important, as they are evaluated in order from “top down”, as only one
CategoryFilter (and associated category mask) is applied to any NiagaraStation. In other words, category
masks are not “multiplexed” or “additive”.
As needed, use this view for adding, editing, reordering, and reviewing child CategoryFilter
components. Default columns displayed in the Category Filter Manager include the following:
• Name
Name of each CategoryFilter component, which must be unique.
• Station Info Property Filters
Currently configured “Station Info Property Filters”, using “slotName -> propertyValue” nota-
tion. If multiple filters, each is separated by a comma (,).
• Category Mask
The category(ies), by name, currently assigned to each CategoryFilter, where a comma (,) separates
each one if multiples are assigned.
Buttons at the bottom of this view allow you to make New or Edit existing CategoryFilter components.
See the next section “Adding CategoryFilters”.
Adding CategoryFilters
When you click New in the Supervisor’s export tag Category Filter Manager, a popup dialog
appears asking how many (the only type selectable is Category Filter). Following this, another popup
dialog for configuration appears, as shown in Figure 2-7.
NiagaraAX-3.7u1
2–9
NiagaraAX Export Tags for Supervisor Auto-Configuration
About CategoryFilters Chapter 2 – NiagaraAX Export Tag Concepts
Adding CategoryFilters May 31, 2013
If needed, use “wildcard” (asterisk) characters, for example “*Carolina*” for slot “State” could
potentially filter on “North Carolina” and “South Carolina”.
Use the plus control to add fields for additional name/value pairs, if needed in the filter match. If
using multiple pairs in the same filter, all must be true (match) to apply the category mask. If needed,
click the delete control to remove the fields for a name/value pair.
• Category Mask
Click the double-arrow control for a popup dialog listing available Categories in the Supervisor,
as shown in Figure 2-8.
Note: Category configurations (and names) vary greatly from one job to another. Your Supervisor
will have different category names and likely even more categories.
Click to select and deselect categories. If “Wildcard” is checked, this is similar to “Select All”, plus
any new (future) categories will also be selected. Other buttons are self-explanatory.
After adding the category mask, it appears in the New or Edit dialog using hexadecimal notation,
reflecting a bitmapped weighting by category indices, e.g. “14” or “ff”, or “*” if Wildcard is selected.
The Test Filter button allows you to check the configured “Station Info Property Filters” against the
Supervisor’s collection of “Station Info” in all of its NiagaraStation components (since the last Join from
each), and provides a “total match count” for each filter selected.
About applied CategoryFilters
Category filters are applied to components, files, and histories of a subordinate as represented in the
Supervisor, when you issue a Join from (or to) that station. Figure 2-9 shows the Category Browser view
in the Supervisor station following a Join from remote subordinate “subJACE_A”.
Figure 2-9 Example categories applied to components under a NiagaraStation in the Supervisor
In the Figure 2-9 example, “Station Info” in the subordinate’s JoinProfile includes two slots/values:
State=Virginia, City=Richmond. A matching CategoryFilter in the Supervisor applies a category mask
including categories “General”, “RegionEastMid”, “HVAC_core”, “Ltg_Core”, and “Operations” (some are
not visible in the figure).
NiagaraAX-3.7u1
2–10
NiagaraAX Export Tags for Supervisor Auto-Configuration
Chapter 2 – NiagaraAX Export Tag Concepts About the SubordinateExportTagNetworkExt
May 31, 2013 Adding CategoryFilters
Note: The order of CategoryFilters can be important, as they are evaluated in order from “top down”, as only one
CategoryFilter (and associated category mask) is applied to any NiagaraStation. In other words, category
masks are not “multiplexed” or “additive”. See Figure 2-6.
In addition to components under each NiagaraStation, categories are also applied to files and histories of
stations too. Figure 2-10 shows the Supervisor’s Category Browser in the Files and Histories sections.
Figure 2-10 Example categories applied to files and histories of a NiagaraStation in the Supervisor
Note: In the initial release of export tags, CategoryFilters do not apply to histories created as a result of a
SystemHistoryImportTag, only from HistoryImportTags. You must manually apply categories
to histories created with SystemHistoryImportTags, if necessary.
As shown by the drop-down “view selector” in Figure 2-11, there are two specialized views besides the
property sheet. The SubordinateExportTagNetworkExt property sheet only has these two items:
• Status
Read-only status of the network extension, typically “ok”.
• Log Limit
Specifies the maximum (line) entries allowed in any job log in this JACE station for any export tag
Join, where the default is 600. If a job log exceeds this limit, earlier entries are not captured. Range is
from 1 to 10,000.
The following sections describe other aspects of the SubordinateExportTagNetworkExt:
• Actions on the SubordinateExportTagNetworkExt
• About the Join Profile Manager
• Editing the Join Profile
• About Station Info
• About the niagaraStation [Link] file
• About the Export Tag Summary Manager
NiagaraAX-3.7u1
2–11
NiagaraAX Export Tags for Supervisor Auto-Configuration
About the SubordinateExportTagNetworkExt Chapter 2 – NiagaraAX Export Tag Concepts
Actions on the SubordinateExportTagNetworkExt May 31, 2013
Figure 2-12 Join Profile Manager is default view of SubordinateExportTagNetworkExt in JACE station
You can use this view for the initial setup and enabling of the JoinProfile for the Supervisor (click
to select this station, then click Edit). Later, this is the preferred view to launch Joins via the button at
the bottom of the view, in order to get the automatic popup Job Log dialog at the end of the Join.
Available columns to display in the Join Profile Manager include the following:
• Station Name
Reflects the name of the parent NiagaraStation in the JACE’s NiagaraNetwork.
• Last Join
Date/timestamp of the last Join of the local station to the Supervisor station. This is “null” in the case
of a newly-added SubordinateExportTagNetworkExt, before any Join has been issued. This value
should remain “null” for any peer JACE stations (those JoinProfiles should also remain disabled).
• Station Display Name
Shows any “display name” for the local station (if configured) as it should appear in the Supervisor
station. This feature is useful on larger jobs where station names are often short and cryptic, and oth-
erwise not easily identifiable.
• Default Subordinate User
Shows the local station user account the Supervisor should use to connect back to this station, upon
receiving an unsolicited Join request. Needed only if the Supervisor’s NiagaraNetwork is not already
configured with a NiagaraStation for this JACE, including the proper Fox Service client connection
user and password.
• Default Subordinate User Password
In AX-3.7u1 and later, this shows a “placeholder” for the local station user password the Supervisor
should use to connect back to this station, upon receiving an unsolicited Join request. This is needed
only if the Supervisor’s NiagaraNetwork is not already configured with a NiagaraStation for this
JACE, including the proper Fox Service client connection user and password.
• Default Subordinate IP Address
Shows the local host’s IP address the Supervisor should use to connect back to this station, upon re-
ceiving an unsolicited Join request. Needed only if the Supervisor’s NiagaraNetwork is not already
configured with a NiagaraStation for this JACE.
• Default Subordinate Port
Shows the software port the Supervisor should use for a Fox connection back to this station, upon
receiving an unsolicited Join request. Needed only if the Supervisor’s NiagaraNetwork is not already
configured with a NiagaraStation for this JACE.
NiagaraAX-3.7u1
2–12
NiagaraAX Export Tags for Supervisor Auto-Configuration
Chapter 2 – NiagaraAX Export Tag Concepts About the SubordinateExportTagNetworkExt
May 31, 2013 Editing the Join Profile
NiagaraAX-3.7u1
2–13
NiagaraAX Export Tags for Supervisor Auto-Configuration
About the SubordinateExportTagNetworkExt Chapter 2 – NiagaraAX Export Tag Concepts
Editing the Join Profile May 31, 2013
NiagaraAX-3.7u1
2–14
NiagaraAX Export Tags for Supervisor Auto-Configuration
Chapter 2 – NiagaraAX Export Tag Concepts About the SubordinateExportTagNetworkExt
May 31, 2013 About Station Info
Figure 2-14 Adding local station user credentials for Supervisor to connect back to this station
After adding these properties you can issue a Join from the JACE station. The new NiagaraStation (repre-
senting that JACE) is added, where it has all the pre-engineered PxViews, points, etc from its export tags.
If an incorrect user name or password (or no password) is used, the Join will fail with authentication
errors. Refer to the Job Log to confirm, as shown here:
Figure 2-15 Job Log shows Supervisor Authentication Failed error message
Station Info allows you to add string-value metadata about the subordinate (JACE) station, where it can
be used in different ways on export to the Supervisor station. Examples of possible Station Info properties
are “State”, “City”, “StoreNumber”, “ZipCode”, and so on.
NiagaraAX-3.7u1
2–15
NiagaraAX Export Tags for Supervisor Auto-Configuration
About the SubordinateExportTagNetworkExt Chapter 2 – NiagaraAX Export Tag Concepts
About the Export Tag Summary Manager May 31, 2013
Figure 2-17 Example Station Info properties (slot sheet, property sheet)
NiagaraAX-3.7u1
2–16
NiagaraAX Export Tags for Supervisor Auto-Configuration
Chapter 2 – NiagaraAX Export Tag Concepts About the SubordinateExportTagNetworkExt
May 31, 2013 About the Export Tag Summary Manager
This view lists all export tags currently in the station, with columns providing information on station
path as well as Supervisor station slot path, among other things. You can simply double-click any export
tag to go directly to its property sheet. There is also an Edit button for making changes to one or more
selected export tags, providing access to a few common properties that include “Enable”.
If needed, use this view to selectively “disable” one or more export tags—upon the next Join, this effec-
tively removes corresponding items from the Supervisor. To add these items back, simply re-enable the
export tags and issue another Join.
Default columns displayed in the Export Tag Summary Manager include the following:
• Name
The name of the export tag.
• Path
Component path of the export tag in the local station, relative to the station root.
• Status
Status of export tag, either “ok” (enabled) or “disabled”.
• Supervisor Station
Name of the export tag’s currently selected Supervisor station (NiagaraStation).
• Station Slot Path
Parent slot name for the exported object on the Supervisor, as configured in the export tag. Compo-
nent slots are relative to the NiagaraStation component representing this station on the Supervisor.
See the next section “Editing export tags in the Summary Manager” for more Edit information. Note
another button lets you globally set the “Supervisor Station” property value for all export tags. See “Speci-
fying the Supervisor station globablly in all export tags” on page 2-18.
Editing export tags in the Summary Manager
In the Export Tag Summary Manager, select one or more export tags, and then click the Edit button
for a popup dialog, as shown in Figure 2-19.
Figure 2-19 Edit dialog for export tags in Export Tag Summary Manager
NiagaraAX-3.7u1
2–17
NiagaraAX Export Tags for Supervisor Auto-Configuration
About the niagaraStation [Link] file Chapter 2 – NiagaraAX Export Tag Concepts
About the Export Tag Summary Manager May 31, 2013
• Name
Of selected export tag, editable only if a single tag selected. If multiple tags are selected, it reflects the
first export tag’s name.
• Enabled
Enabled property of the selected export tag(s), which can be toggled between true (default) and false.
(Possibly the most commonly edited export tag property in this view.)
• Supervisor Station
Name of the currently selected Supervisor station (NiagaraStation) in the selected export tag(s).
• Station Slot Path
Parent slot name for the exported object on the Supervisor, as configured in the export tag.
• If multiple tags are selected, you can batch edit the station slot path.
Note: Batch editing a number of tags for slot:points/AHU1 would only be useful for proxy
points being tagged under the AHU1 device in the JACE. However, you could batch edit the tags
for all proxy points in the JACE using something like slot:points/%networkFolderPath%.
• If a single export tag is selected, you can click on open folder, for the Select Parent
Target dialog, to select a parent container as saved in the [Link] file.
Click OK after making any changes in the Edit dialog of the selected export tag(s). Note a subsequent
Join is necessary for any changes to occur in the Supervisor station.
Specifying the Supervisor station globablly in all export tags
The Export Tag Summary Manager provides a button at the bottom of the view that you can use to
globally assign the “Supervisor Station” property value in all export tags in the station.
When you click the Set All Supervisor Station Names button at the bottom of the view, a
confirmation dialog appears (Figure 2-20).
Figure 2-20 Confirmation dialog and subsequent select Supervisor station dialog
As shown above, after confirmation (click Yes) another dialog appears. Click the drop-down control
for NiagaraStations in the station’s NiagaraNetwork—select the one for the Supervisor. When you click
OK, this globally sets the “Supervisor Station” property value in all export tags in the station.
Note: This command is also a right-click action on the SubordinateExportTagNetworkExt (Set All
Supervisor Station Names), which produces the same dialogs as shown in Figure 2-20 above.
NiagaraAX-3.7u1
2–18
NiagaraAX Export Tags for Supervisor Auto-Configuration
Chapter 2 – NiagaraAX Export Tag Concepts About the niagaraStation [Link] file
May 31, 2013 Device extension properties importance in [Link] file
Note the [Link] file is important for non-default properties of the “niagaraStation”, including also its
“device extensions”, for example the Alarms extension and Users extension. For related details, see
“Device extension properties importance in [Link] file” on page 2-19.
Note: You can also add new folders, point folders, and archive folders (containers) in the niagaraStation in this
[Link] file, saving it as you work. This allows you to select these items as the parent “Station Slot Path”
property when adding various export tags.
However, doing this is optional—alternatively, you can type a folder path directly in the “Station Slot Path”
property of an export tag, or use special “BFormat” variables instead. For related information, see “Station
Slot Path considerations” on page 2-21 and “BFormat options in Station Slot Paths” on page 2-22.
Figure 2-22 shows the relationship of the JoinProfile’s “Station File” property and the resulting file folder
and [Link] file created, using property defaults.
The default ord of the Station File property in the JoinProfile is:
file:^joinProfiles$(defaultStationFileName).bog
where the $(defaultStationFileName) portion is an ord variable that results in a .bog file named:
SupervisorStationName_profile.bog
In the Figure 2-22 example, where the Supervisor station (and NiagaraStation that represents it) is named
“Sup37_T1”, this results in a file named: Sup37_T1_profile.bog
Note: If you edit the Station File property after the JoinProfile has already been enabled, you need to disable
and then re-enable the JoinProfile for a new [Link] file to be created—otherwise, Join errors may
result. Be aware that this does not delete (or rename) the original [Link] file.
NiagaraAX-3.7u1
2–19
NiagaraAX Export Tags for Supervisor Auto-Configuration
About the niagaraStation [Link] file Chapter 2 – NiagaraAX Export Tag Concepts
Provisioning slot additions in a [Link] file May 31, 2013
Example of device extension properties are the Alarms extension’s property “Alarm Class”, and the Users
extension’s property “Sync Out Enabled” (used in “network users”). Default values for these two
properties are “Default Alarm Class” and “false”, respectively. However, it may be that non-default values
are wanted for these two properties in the Supervisor’s NiagaraStation (that models this JACE).
If working directly in the Supervisor station, you can set these property to non-default values. However,
note that those values will be overwritten upon the next Join of this JACE (unless of course they have the
same values in the [Link] file in that JACE).
Note: This can explain why after configuring “NiagaraStation properties” in the Supervisor station, that property
values in that NiagaraStation and/or in its device extensions are later seen to “revert to default values”.
Likely this happened following a Join, where that JACE’s [Link] file still has default property values.
Therefore, you should review property values in the [Link] file’s niagaraStation and its various device
extensions, and change any ones that need to vary from default values. Again, remember to Save the
[Link] file after making any changes.
Additionally, in cases where you are pre-engineering a JACE for eventual Join to a Supervisor, and want
to do as much engineering as possible in the JACE station (possibly even lacking access to the Supervisor
station), there are possible “property additions” that you may need to perform in the [Link] file. See
“Provisioning slot additions in a [Link] file” on page 2-20.
Step 4 In the popup Add Slot dialog (as shown above) enter the following:
• Name: provisioningNiagara_PlatformConnection (type in that exact string)
NiagaraAX-3.7u1
2–20
NiagaraAX Export Tags for Supervisor Auto-Configuration
Chapter 2 – NiagaraAX Export Tag Concepts Station Slot Path considerations
May 31, 2013 Provisioning slot additions in a [Link] file
In the property sheet, enter the necessary values for the Supervisor to make a platform connection to this
JACE, including:
• Port — 3011 (default) is typical for a “regular” (non-SSL) platform connection,
whereas 5011 is typical for a secure (platform SSL) connection.
• Credentials — Enter the platform username and password. These are the same credentials used
when making a Workbench platform connection to this JACE.
• Secure — false (default) specifies a “regular” (non-SSL) platform connection—this is appropriate
for any JACE-2 or -4/5 series host, or any JACE-6 or JACE-7 that is not configured for platform SSL.
Otherwise, if the JACE is configured to support platform SSL only, this must be set to true.
Step 8 Save the [Link] file (right-click the SupervisorName_profile.bog file and select Save).
By making these configuration changes to the [Link] file in the JACE’s file space, the client proxy in
the Supervisor will automatically be configured to use the appropriate platform connection parameters
for provisioning—including (if so configured) for a platform SSL connection.
NiagaraAX-3.7u1
2–21
NiagaraAX Export Tags for Supervisor Auto-Configuration
Station Slot Path considerations Chapter 2 – NiagaraAX Export Tag Concepts
BFormat options in Station Slot Paths May 31, 2013
Upon a Join creates a Niagara proxy point (under the Points extension of the NiagaraStation rep-
resenting this JACE) in the second of two levels of Niagara point folders.
• Or for a HistoryImportTag or SystemHistoryImportTag: slot:histories/Bldg_A/Floor_1
Upon a Join creates a Niagara history import descriptor (under the Histories extension of the
NiagaraStation representing this JACE) in the second of two levels of history archive folders.
You can also use special “BFormat” values within manually-typed Station Slot Paths. See “BFormat
options in Station Slot Paths”.
The JACE station has a PxView on the device component “EastWing”—a Px view that you are exporting.
If you add a PxViewTag on EastWing, and set its slot path to:
slot:points/%networkFolderPath%
NiagaraAX-3.7u1
2–22
NiagaraAX Export Tags for Supervisor Auto-Configuration
Chapter 2 – NiagaraAX Export Tag Concepts Station Slot Path considerations
May 31, 2013 BFormat options in Station Slot Paths
Upon a Join, this results in the following folder structure under the Supervisor’s NiagaraNetwork:
Assuming this slot path did not already exist because of other PointTags, or by previous manual definiton
via the “[Link]” file in the JACE, the EastWing component created in the Supervisor is a standard
“folder” component. As a result, it not visible in the Supervisor’s Niagara Point Manager view.
To improve this, it is recommended to use a PointTag on at least one proxy point of the device with the
PxViewTag. In this case, the EastWing folder (above) is deleted in the Supervisor station.
Then in the JACE station, a PointTag is added to the “RetAir” point under the “AHU2” points folder, with
its “Station Slot Path” property configured as: slot:points/%networkFolderPath%
Following another Join, because of the PointTag, all folders used to replicate the container structure are
Niagara Point Folders, including the “EastWing” container with the SubstitutePxView, as shown above.
Everything is now visible in the Niagara Point Manager view. Note this also allows you to manually
add more proxy points at a later time, if ever desired.
If all PxViewTags and PointTags use a Station Slot Path “slot:points/%networkFolderPath%” value,
this can keep everything exported to the Supervisor in the same (or at least similar) hierarchy as it is in
the JACE station. It also can save export tag editing time when duplicating a “template” device to create
all of the devices in the station.
%deviceFolderPath%
This replicates container structure in the JACE station from the “device downwards”, that is, below the
device component (but not including the device). For example, with the same station example described
in the previous “%networkFolderPath%” section, if you added the following station slot path to both
the PxViewTag on the BACnet “EastWing” device and also on a PointTag for one of its proxy points:
slot:points/%deviceFolderPath%
NiagaraAX-3.7u1
2–23
NiagaraAX Export Tags for Supervisor Auto-Configuration
Station Slot Path considerations Chapter 2 – NiagaraAX Export Tag Concepts
Conclusions May 31, 2013
This results in the following folder structure under the Supervisor’s NiagaraNetwork:
This is typically less desirable than using the “%networkFolderPath%” variable appended to “slot:points/”,
because all device-level Px views get “stacked” onto the NiagaraStation’s Points device extension.
However, if devices are engineered in the JACE using many point folders, perhaps with PxViews on those
point folders (instead of on device components), this may be a useful alternative.
See “%networkFolderPath%” on page 2-22 for a more universal example.
%[Link]%
This BFormat entry applies more to PxViewTag usage outside of any “points context”, as it creates a folder
named the same as the parent of the export tag. For example, if the JACE station has a folder “Setpoints”
with a PxViewTag added and configured with the following Station Slot Path:
slot:%[Link]%
or
slot:%[Link]%/this/that
where this and that are manually-entered slot paths, this is equivalent to entering
slot:Setpoints
or
slot:Setpoints/this/that
depending on the structure of the system. In this case, the “Setpoints” folder (with SubstitutePxView) will
be created in the root of the NiagaraStation component that represents this JACE station.
Conclusions
Experimentation is recommended on one or two export tags to verify expected results, especially if using
the BFormat options. However, dynamic folder creation is expected to help simplify the export tag
process, as many found the station “[Link]” process to be too time intensive.
NiagaraAX-3.7u1
2–24
NiagaraAX Export Tags for Supervisor Auto-Configuration
Chapter 2 – NiagaraAX Export Tag Concepts About PxViewTags
May 31, 2013 PxViewTag properties
About PxViewTags
The PxViewTag is potentially the most important of all export tags, at least in cases where existing
PxViews on subordinate (JACE) stations are desired on the Supervisor station. The PxViewTag simplifies
this, for the most part, as a “drag and drop” function. Related additional Supervisor background opera-
tions such as creating Niagara virtual points, importing referenced image files, and so on, are all handled
automatically.
Note: See “To add PxViewTags” on page 1-6 for a “quick start” procedure on working with these tags. The
remainder of this section explains more detailed aspects of working with this export tag type.
The following sections provide more details on PxViewTags:
• PxViewTag properties
• PxViewTag action
• About the Supervisor SubstitutePxView
• About ord substitution overrides
PxViewTag properties
Double-click a PxViewTag for its property sheet (Figure 2-23).
NiagaraAX-3.7u1
2–25
NiagaraAX Export Tags for Supervisor Auto-Configuration
About PxViewTags Chapter 2 – NiagaraAX Export Tag Concepts
PxViewTag properties May 31, 2013
• Order Number
Specifies the PxView priority order on the target parent slot in the Supervisor station, where 0 (de-
fault) is the lowest priority—any other positive integer value has a higher priority. This is useful if
you use multiple PxViewTags to export to the same Supervisor parent. In this case, assign each Px-
ViewTag a different order number. The “highest” ordered one will be the default view, and so on.
• Create File Import
Boolean to specify if to automatically create a Niagara FileImport descriptor in the Supervisor to
support referenced graphics; the default is true. Other file import-related properties follow.
• File Import Name
Name of the Niagara FileImport descriptor to create on the Supervisor, if needed. The default vari-
able %defaultFileImportName% creates an import descriptor named:
sourceParentName_sourcePxViewName_Import
For example, if a container named “AHU1” in the JACE has an exported PxView named “Graphic”,
the Niagara FileImport descriptor created on the Supervisor is named AHU1_Graphic_Import.
• File Import Overwrite Policy
Standard property for Niagara FileImport descriptors, it determines the policy used to overwrite im-
ported files on the Supervisor with changed source files on the JACE, when the file import executes.
The default is Checksum (differing), with Last Modified as the other choice.
• File Import Execution Time
Standard import execution time selections for Niagara FileImport descriptors, including Manual
(default) or either Daily or Interval, where the latter two have various selection fields.
• File Import Use Category Mask
Boolean to specify if CategoryFilters defined in the Supervisor should be applied to any file(s) im-
ported by this PxViewTag. The default value is true.
• Supervisor Px File Directory
Specifies the file ord to use in the Supervisor station’s file space for copied px files. The default uses
ord variables as: file:^stations$(stationName)$(currentLocation), the latter of which du-
plicates the source (JACE) file organization under the stations/stationName/ folder.
• Supervisor Px File Media Directory
Specifies the file ord to use in the Supervisor station’s file space for copied images files. The default
uses ord variables as: file:^stations$(stationName)$(currentLocation), the latter of which
duplicates the source (JACE) file organization under the stations/stationName/ folder.
Note: Although a Supervisor typically has a vastly greater capacity to store image files (and px files,
above) than does a JACE, in some cases you may wish to edit these two “Directory” properties to known
file ords on the Supervisor, to prevent unnecessary duplication of the same files.
• Substitute Override Ords
Provides a View control and dialog to choose bound ords in the source Px file and override them
with substitute or new ords. The typical application is to replace hyperlink ords that are no longer
“in context” when viewing the dynamic (exported) PxView in the Supervisor station.
For related details, see “About ord substitution overrides” on page 2-28.
NiagaraAX-3.7u1
2–26
NiagaraAX Export Tags for Supervisor Auto-Configuration
Chapter 2 – NiagaraAX Export Tag Concepts About PxViewTags
May 31, 2013 PxViewTag action
PxViewTag action
Unlike other export tags, the PxViewTag has a right-click action, Validate. Issuing this command runs
a “Px View Tag Validation” job, with a resulting popup Job Log (Figure 2-25).
Note: Job log details are also available in the station’s JobLogService, for each Px View Tag Validation job.
Validation checks bound ords in the PxView for their ability to be “virtualized” (resolved) on the Super-
visor station. In some cases, validation may fail upon one or more errors, and this job log will provide
troubleshooting data that names the particular ord(s).
Note: A warning does not always mean that the PxView will fail to resolve on the Supervisor station. For example,
using a relative ord of 'slot:' will generate a warning. However, in most cases that relative ord will render as
expected.
This feature helps you make any needed changes and revalidate before issuing a Join.
Essentially, each one is a “virtualized” PxView, which automatically resolves, at runtime, the necessary
items. Any source image files needed have already been copied via a Niagara FileImport descriptor.
Other items include dynamically-created Niagara virtual components to fetch real-time values. Looking
at a SubstitutePxView in the Px Editor, notice ords to these virtual components, as shown in Figure 2-27.
NiagaraAX-3.7u1
2–27
NiagaraAX Export Tags for Supervisor Auto-Configuration
About PxViewTags Chapter 2 – NiagaraAX Export Tag Concepts
About ord substitution overrides May 31, 2013
Figure 2-27 Real-time values come from dynamically created Niagara virtual components
The Px XML (in the copied Px file) is actually unchanged from the original, as ord substitution happens
at runtime. From the SubstitutePxView property sheet, use the View control to see a read-only dialog
comparing the original (old) ords to the substitute (new) ords (Figure 2-28).
Figure 2-28 View dialog from View control in property sheet of SubstitutePxView (on Supervisor)
Starting in AX-3.7 (and as shown in Figure 2-28 above). Niagara “virtual points”, which are utilized in
SubstitutePxView on a Supervisor, now have shortened “normalized” ord slot paths.
Figure 2-29 Example bound ord in the original PxView in subordinate (JACE) station
NiagaraAX-3.7u1
2–28
NiagaraAX Export Tags for Supervisor Auto-Configuration
Chapter 2 – NiagaraAX Export Tag Concepts About PxViewTags
May 31, 2013 About ord substitution overrides
In the Figure 2-29 example, when viewing this on the Supervisor, instead of the original binding (which
will not visualize correctly), the desired target is an equivalent WeatherReport component in the Super-
visor station. The PxViewTag property sheet provides a View control and dialog that you can use to
override such ords to different values.
From the PxViewTag property sheet, click the View control for a popup View dialog, then click the
Choose from Px button for a Choose from Px dialog, listing ords you can check one or more
to override.
Figure 2-30 View dialog, Choose from Px edit (from PxViewTag property sheet)
As shown in Figure 2-30, a checked ord provides an Edit dialog showing the “Old ORD”, along with a
“New ORD” field, in which you can manually type a new ord. This new ord should be relative to the
Supervisor station (and not the currently open JACE).
Note: In this case, note that the drop-down control to select the Component Chooser, File Ord
Chooser, and so on, is relative to the opened JACE station—and likely not helpful in this case.
After clicking OK to finish the override edit, the overridden ord appears in the View dialog (Figure 2-27).
Figure 2-31 Example overridden ord in View dialog (from PxViewTag property sheet)
Such overrides are now part of this PxViewTag configuration, which you can re-edit to add, delete, or
modify again before any Join operation.
Ords that do not virtualize
In addition to ords with a hyperlink, these other types of ords can cause issues in PxViewTags:
• Ords that contain a BQL query — these cannot resolve correctly.
• Ords to Workbench views on components in a remote station, for example the Current Weather
View example shown in Figure 2-29 on page 28. Virtual components do not provide access to the
Workbench views associated with the source components.
NiagaraAX-3.7u1
2–29
NiagaraAX Export Tags for Supervisor Auto-Configuration
About PointTags Chapter 2 – NiagaraAX Export Tag Concepts
PointTag properties May 31, 2013
About PointTags
The PointTag is useful when you need a permanent Niagara proxy point for an item in Supervisor
station, say for “output links” into station control logic. Or, perhaps if the JACE is not serving PxViews
and you wish to maximize “Supervisor configuration” via export tags before building PxViews.
Otherwise, because of the automatically provided “Niagara virtual point” feature of PxViewTags, you may
wish to limit the use of PointTags. Note that functionality was added to Niagara virtual points that makes
them, in some ways, more powerful than proxy points. For related details, see “About Niagara virtual
components” in the Drivers Guide.
Note: See “Adding PointTags” on page 1-7 for a “quick start” procedure on working with these tags. The remainder
of this section explains more detailed aspects of working with this export tag type.
The following sections provide more details on PointTags:
• PointTag properties
PointTag properties
Double-click a PointTag for its property sheet (Figure 2-32).
NiagaraAX-3.7u1
2–30
NiagaraAX Export Tags for Supervisor Auto-Configuration
Chapter 2 – NiagaraAX Export Tag Concepts About HistoryImportTags
May 31, 2013 HistoryImportTag properties
About HistoryImportTags
Add a HistoryImportTag to the history extension of a point or component to import/archive that
history on the Supervisor. Upon a Join, it creates a Niagara history import descriptor in the Supervisor,
under the Histories container of the NiagaraStation that represents this subordinate (JACE) station. A
corresponding history is immediately available in the Supervisor.
Note: See “To add HistoryImportTags” on page 1-8 for a “quick start” procedure on working with these tags. The
remainder of this section explains more detailed aspects of working with this export tag type.
The following sections provide more details on HistoryImportTags:
• HistoryImportTag properties
HistoryImportTag properties
Double-click a HistoryImportTag for its property sheet (Figure 2-33).
NiagaraAX-3.7u1
2–31
NiagaraAX Export Tags for Supervisor Auto-Configuration
About SystemHistoryImportTags Chapter 2 – NiagaraAX Export Tag Concepts
SystemHistoryImportTag properties May 31, 2013
Note: You can edit the “[Link] file” to add NiagaraArchiveFolders under Histories—see
“Verify and edit the Station (.bog) File” on page 1-4 for details. Do not select any parent folder
other than under Histories (property value must begin with slot:histories). Such folders are
used to organize Niagara history descriptors of any type (import, systemImport, export).
• History Import Name
The name of the Niagara HistoryImport descriptor that this tag creates on the Supervisor, by default
set using a format variable (%defaultHistoryImportName%). The history extension’s parent’s
name is used in this default variable, with results similar to: “Remote_pointName”.
• Execution Time
The standard execution time selections for a Niagara HistoryImport descriptor, where the default is
Daily at 2:00 AM, all days of the week. Other selections include Manual or Interval. For more de-
tails on this property and most remaining properties, see “History Import Edit” in the Drivers Guide.
Note: This property, as well as “Config Overrides” (capacity and fullPolicy) properties and both “On
Demand” properties, are all written to the Niagara HistoryImport descriptor upon a Join.
• Config Overrides
Standard selections for a Niagara HistoryImport descriptor, containing settings for:
• capacity — either Unlimited (default), or some finite number of records.
• fullPolicy — either Roll (default), or Stop.
• On Demand Poll Enabled
Standard selection for a Niagara HistoryImport descriptor. either true (default) or false.
For related details on this (and next) property, see “On demand properties in history import descrip-
tors” in the Drivers Guide.
• On Demand Poll Frequency
Standard selection for a Niagara HistoryImport descriptor, either Normal (default), Slow, or Fast.
• Use Category Mask
Boolean to specify whether the history imported by this tag will have any export tag category filters
applied to it (default is true). For related details, see “About CategoryFilters” on page 2-8.
About SystemHistoryImportTags
Add a SystemHistoryImportTag anywhere in the station to import histories on the Supervisor
using the “System Tags” feature. Each tag creates a Niagara system history import descriptor in the Super-
visor, under the Histories container of the NiagaraStation that represents this subordinate (JACE) station.
Corresponding histories are immediately available in the Supervisor.
Note: See “To add SystemHistoryImportTags” on page 1-8 for a “quick start” procedure on working with these
tags. The remainder of this section explains more detailed aspects of working with this export tag type.
The following sections provide more details on SystemHistoryImportTags:
• SystemHistoryImportTag properties
SystemHistoryImportTag properties
Double-click a SystemHistoryImportTag for its property sheet (Figure 2-34).
NiagaraAX-3.7u1
2–32
NiagaraAX Export Tags for Supervisor Auto-Configuration
Chapter 2 – NiagaraAX Export Tag Concepts About SystemHistoryImportTags
May 31, 2013 SystemHistoryImportTag properties
NiagaraAX-3.7u1
2–33
NiagaraAX Export Tags for Supervisor Auto-Configuration
About ScheduleImportTags Chapter 2 – NiagaraAX Export Tag Concepts
ScheduleImportTag properties May 31, 2013
About ScheduleImportTags
Add a ScheduleImportTag to any existing schedule (BooleanSchedule, NumericSchedule, etc.) in the
JACE station to have it, upon a Join, imported as a “slave” schedule on the Supervisor (along with a
Niagara ScheduleImportExt descriptor). Effectively, the tagged schedule is now the “master schedule”.
Because this is “the reverse” of the typical Supervisor/subordinate schedule configuration (master
schedule in Supervisor), usage of this export tag may be infrequent. Note this export tag also results in a
Niagara ScheduleExportExt descriptor in this subordinate (JACE) station.
Note: See “Adding ScheduleImportTags” on page 1-9 for a “quick start” procedure on working with these tags. The
remainder of this section provides more details on this export tag type.
• ScheduleImportTag properties
ScheduleImportTag properties
Double-click a ScheduleImportTag for its property sheet (Figure 2-35).
About ScheduleExportTags
Add a ScheduleExportTag as the child of an existing Niagara ScheduleImportExt under an existing
schedule component, that is, a BooleanSchedule, NumericSchedule, etc. that resides in the Schedules
extension of the NiagaraStation component that represents the Supervisor. Note this is the only valid
parent for this export tag type. Ordinarily, such a schedule (with a ScheduleImportExt) is created using
the online Discover feature in the Niagara Schedule Import Manager view of this Niaga-
raStation. In that way, the imported “slave” schedule is pre-configured, matching the (typically) already
configured “master” schedule, as it resides in the Supervisor.
NiagaraAX-3.7u1
2–34
NiagaraAX Export Tags for Supervisor Auto-Configuration
Chapter 2 – NiagaraAX Export Tag Concepts About ScheduleExportTags
May 31, 2013 ScheduleExportTag properties
To use a ScheduleExportTag to “slave” to an existing schedule in the Supervisor, you must know that
Schedule’s ord (component path) in the Supervisor station—in which case, use of this tag is actually not
needed. Instead, you could just enter that ord in the “Supervisor Id” property of the schedule’s Schedule-
ImportExt.
Or, you can use a ScheduleExportTag with a new schedule to create (as a result of a Join) a new, blank,
“master” schedule on the Supervisor that corresponds to the “slave” schedule on the subordinate (JACE)
station. This may be how this export tag is used the most. Using this method, you first manually make a
new schedule in the Schedules extension of the NiagaraStation (for the Supervisor) in the JACE station,
using the Niagara Schedule Import Manager view. Then, add this ScheduleExportTag to its
ScheduleImportExt, and configure it to “override” the Supervisor Id station slot path. Upon a Join, the
new schedule on the Supervisor resides under the NiagaraStation component that represents this subor-
dinate (JACE) station.
Note: See “To add ScheduleExportTags” on page 1-10 for a “quick start” procedure on working with these tags.
The remainder of this section provides more details on this export tag type.
The following sections provide more details on HistoryImportTags:
• ScheduleExportTag properties
ScheduleExportTag properties
To see the tag in context, double-click the parent ScheduleImportExt descriptor ( ext) to see its
property sheet, then expand the ScheduleExportTag, as shown in Figure 2-36.
Figure 2-36 ScheduleImportExt property sheet example, showing child ScheduleExportTag properties
NiagaraAX-3.7u1
2–35
NiagaraAX Export Tags for Supervisor Auto-Configuration
About FileImportTags Chapter 2 – NiagaraAX Export Tag Concepts
FileImportTag properties May 31, 2013
About FileImportTags
You can import files from one NiagaraAX station to another. The FileImportTag imports either a single
file or an entire folder of files from the subordinate (JACE) station to the Supervisor station. A corre-
sponding Niagara FileImport descriptor is created in the Supervisor, under the Files device extension
of the NiagaraStation that represents this subordinate (JACE) station. For related details, see “About
Niagara file imports” in the Drivers Guide.
Note: See “To add FileImportTags” on page 1-11 for a “quick start” procedure on working with these tags. The
remainder of this section provides more details about this export tag type.
Note that file imports are also included in an “as-needed” manner when using PxViewTags, without a
need for separate FileImportTags. For related details, see “About PxViewTags” on page 2-25.
The following sections provide more details on FileImportTags:
• FileImportTag properties
FileImportTag properties
Double-click a FileImportTag for its property sheet (Figure 2-37).
NiagaraAX-3.7u1
2–36
NiagaraAX Export Tags for Supervisor Auto-Configuration
Chapter 2 – NiagaraAX Export Tag Concepts About FileImportTags
May 31, 2013 FileImportTag properties
• Status
Read-only status of the export tag, typically “ok”, unless “disabled” (Enabled=false).
• Enabled
Whether the tag will attempt an export on the next Join (true, the default) or not (false).
• Supervisor Station
Click the drop-down control to select the NiagaraStation that represents the Supervisor (with en-
abled JoinProfile).
Note: After selection, you must Save before you can use the folder (Select Parent Target) feature
of the next property. Also, add (and delete ) controls exist to specify more than one Supervisor
station; however, this configuration is rarely expected.
• Station Slot Path
Parent slot path for the FileImport descriptor on the Supervisor, relative to the “Files” extension of
the NiagaraStation that represents this station.
Note: Leave this at the default value slot:files (the only valid value).
• File Import Name
Name for the Niagara FileImport descriptor created in the Supervisor station. The default value ia a
variable (%defaultFileImportName%), which results in a name that uses the name of source file (or
folder) appended to “_Import”. For example, if the File is “file:^[Link]”, using defaults the
name of the FileImport descriptor is console_Import. If desired, you can edit to an explicit name.
• File
Specifies the local file or directory to import to the Supervisor. The default value is “file:^”, which
imports all objects in the station’s local file space.
To select, click one of the right-side controls, either:
• if a single file, the folder control for the File Chooser dialog.
• if a directory, the adjacent drop-down control, then choose Directory Ord Chooser
from the menu for the Directory Chooser dialog.
Example File property values are: file:^reports (for a “reports” directory in the local file space)
and file:^reports/moreReports/[Link] (for a single file found in a specific subdi-
rectory).
• Supervisor Directory
Specifies the target file directory on the Supervisor, in which file(s) are imported. The default value
uses ord variables: “file:^stations$(stationName)$(currentLocation)”, to replicate a sim-
ilar file/subfolder organization on the Supervisor, under a “stations” file subfolder for each station,
including this one. Or, specify an explicit location in the Supervisor’s file space (file:^location).
If the specified directory does not already exist, it will be created upon a Join.
Note: Using the default (variable) property value, if choosing a directory, note its contents (including
all sudirectories) are imported “one folder up” from the source (JACE) file location. To include the
structure of the chosen directory itself, append it to the end of the variable, that is: /directoryName.
For example, if importing a directory “reports” (File=^reports), enter a Supervisor Directory
property value of file:^stations$(stationName)$(currentLocation)/reports
• File Overwrite Policy
The standard File Overwrite Policy property for a Niagara FileImport descriptor, either Checksum
(default) or Last Modified.
• Execution Time
The standard Execution Time property for a Niagara FileImport descriptor, where the default is
Manual. Other selections include Daily or Interval, where each provides a number of related pa-
rameters.
• Use Category Mask
Boolean to specify whether the file(s) imported by this tag will have any export tag category filters
applied (default is true). For related details, see “About CategoryFilters” on page 2-8.
NiagaraAX-3.7u1
2–37
NiagaraAX Export Tags for Supervisor Auto-Configuration
About ComponentTags Chapter 2 – NiagaraAX Export Tag Concepts
ComponentTag properties May 31, 2013
About ComponentTags
The ComponentTag is an available “general purpose” export tag, to replicate the tagged (parent)
component under the NiagaraStation component on the Supervisor. Component tags create a copy of the
component from the source station. They do not create a proxy. For example, if you change properties on
the component with the tag in the source station, those changes are not reflected in the copy of the
component located in the Supervisor station. In general, it may be best for a component that has an “out”
slot, but has either a “null” (or no) proxyExt, such as many found in the kitControl module. Usage on
any “container” type component is generally not recommended.
Note: A ComponentTag can also replicate a “custom” component, including a “Program” component. An
example is included in the exportTags palette, in the Examples folder (“ExportTagProgram”). Note that
starting in AX-3.7, the station user being used in the Join process (Fox connection to Supervisor) must have
“super user” privileges for a ComponentTag on a Program object to function correctly.
Unlike PointTags, components made from ComponentTags are not Niagara proxy points. Therefore, you
can specify them to be located anywhere under the NiagaraStation component (that models this station)
in the Supervisor station.
Note: See “To add ComponentTags” on page 1-11 for a “quick start” procedure on working with these tags. The
remainder of this section provides more details on this export tag type.
• ComponentTag properties
• ComponentTag example (ExportTagProgram)
ComponentTag properties
Double-click a ComponentTag for its property sheet (Figure 2-38).
NiagaraAX-3.7u1
2–38
NiagaraAX Export Tags for Supervisor Auto-Configuration
Chapter 2 – NiagaraAX Export Tag Concepts About ComponentTags
May 31, 2013 ComponentTag example (ExportTagProgram)
The purpose of this Program is to provide a “template” that automatically executes upon completion of
an export tag Join, such that “custom operations” can be automated. This allows a user experienced in
writing Niagara (Java) programs to insert the necessary code to make links, or do whatever else may be
needed. In this way, it can be considered an extension of the exportTags API.
Note that the Program has a “Remove After Completion” property, as shown in Figure 2-39. By default,
this property is true, meaning that the Program is exported to the Supervisor, executes following the
Join, and then is removed from the station database. To retain the Program component on the Supervisor,
set this property to false.
Figure 2-40 shows the ExportTagProgram opened in the Program Editor, as copied from the palette.
Figure 2-40 ExportTagProgram “template” code (unmodified)
NiagaraAX-3.7u1
2–39
NiagaraAX Export Tags for Supervisor Auto-Configuration
About ComponentTags Chapter 2 – NiagaraAX Export Tag Concepts
ComponentTag example (ExportTagProgram) May 31, 2013
NiagaraAX-3.7u1
2–40
NiagaraAX Export Tags for Supervisor Auto-Configuration
CHAPTER 3
Export Tag Plugin Guides
Plugins provide views of components, and can be accessed many ways—for example, double-click a
component in the tree for its default view. In addition, you can right-click a component, and select from
its Views menu. For summary documentation on any view, select Help > On View (F1) from the
Workbench menu, or press F1 while the view is open.
NiagaraAX-3.7u1
3–1
NiagaraAX Export Tags for Supervisor Auto-Configuration
Export Tag Plugin Guides Summary Chapter 3 – Export Tag Plugin Guides
May 31, 2013
NiagaraAX-3.7u1
3–2
NiagaraAX Export Tags for Supervisor Auto-Configuration
CHAPTER 4
Export Tag Component Guides
These component guides provides summary help on exportTags components.
NiagaraAX-3.7u1
4–1
NiagaraAX Export Tags for Supervisor Auto-Configuration
ExportTag Component Reference Summary Chapter 4 – Export Tag Component Guides
May 31, 2013
exportTags-JoinProfile
As a result of adding a SubordinateExportTagNetworkExt in the NiagaraNetwork of a JACE
station, a Join Profile component is created under each NiagaraStation component, including the one
that represents the Supervisor. That Join Profile contains all information needed when a “Join” command
is issued, including (when enabled) the “station (bog) file” created on the JACE.
This [Link] file allows you to model how the Supervisor’s NiagaraNetwork will model the subor-
dinate JACE, following a join—and all subsequent rejoins. The JoinProfile also contains a StationInfor-
mation (Station Info) container, to optionally classify the station using string values.
For more details, see “About the JoinProfile” on page 2-3 and “About the SubordinateExportTagNet-
workExt” on page 2-11.
exportTags-PointTag
Point Tags are used to export selected components to the Supervisor station as Niagara proxy
points. They are similar to ComponentTags, but include additional properties for Conversion type
and (NiagaraNetwork) Tuning Policy Name. In general, use a PointTag for any source proxy point in the
JACE station, that is any component that has a working (non-null) ProxyExt of any type. For more details,
see “About PointTags” on page 2-30.
exportTags-PxViewTag
A PxView Tag is used to export entire an entire PxView from the JACE station to the Supervisor
station. Automatically included is all underlying exports of files (graphic images) used, as well as ords
to Niagara virtual points needed for real-time values. The exported PxView can be specified as a view on
any container under the NiagaraStation representing the subordinate JACE. An “order number” allows
multiple PxViews to be exported to the same container. For details, see “About PxViewTags” on page 2-25.
exportTags-ScheduleExportTag
A Schedule Export Tag creates a Niagara ScheduleExportExt descriptor and “master” schedule on
the Supervisor station that corresponds to a “slave” schedule on the JACE station. It must be a child
of an existing Niagara ScheduleImportExt. Usage is expected to be more typical than the ScheduleIm-
portTag, which creates a “slave” schedule on the Supervisor station. For details, see “About ScheduleEx-
portTags” on page 2-34.
exportTags-ScheduleImportTag
A Schedule Import Tag creates a Niagara ScheduleImportExt descriptor and “slave” schedule on the
Supervisor station, and a corresponding Niagara ScheduleExportExt descriptor on the JACE station.
It can be added under any schedule component in the source JACE station. Usage is expected to be infre-
quent, as typically “master” schedules are in the Supervisor. For details, see “About ScheduleImportTags”
on page 2-34.
exportTags-StationInformation
StationInformation (Station Info) appears in two places: first, as source: in each JACE station, under
the JoinProfile of the NiagaraStation that represents the Supervisor. By default, this container slot is
empty. However, from its slot sheet you can add one or more slots of type baja:String, entering a string
Name to describe each slot; for example: State or City. From the property sheet you can then enter
string values in each added slot.
Upon a JACE station join, this Station Info is exported to the Supervisor station, appearing under the
NiagaraStation component for that JACE. This data can be utilized in various ways in the Supervisor,
including BQL queries, “automatic station folder creation” (from the “Station Folder Path” property of the
SupervisorExportTagNetworkExt), and in CategoryFilters that use Station Info property values to apply
security categories to objects (components, files, and histories) under that NiagaraStation. For more
details, see “About Station Info” on page 2-15.
exportTags-SubordinateExportTagNetworkExt
The Subordinate Export Tag Network Ext is required in any JACE station that needs to use export
tags. Copy it from the exportTags palette to the NiagaraNetwork in the JACE station.
The default view is the Join Profile Manager, in which the JoinProfile for the Supervisor appears,
and must be enabled. Use the Join button in this view to issue a join command that includes a popup
Job Log at the end, useful for review.
Another view on the SubordinateExportTagNetworkExt is the Export Tag Summary Manager. This
provides a tabular listing of all export tags used in the local station. Each row provides a hyperlink to the
specific export tag. For more details, see “About the SubordinateExportTagNetworkExt” on page 2-11.
NiagaraAX-3.7u1
4–2
NiagaraAX Export Tags for Supervisor Auto-Configuration
Chapter 4 – Export Tag Component Guides ExportTag Component Reference Summary
May 31, 2013
exportTags-SupervisorExportTagNetworkExt
The Supervisor Export Tag Network Ext is required in the Supervisor station to benefit from export
tags. Copy it from the exportTags palette to the Supervisor station’s NiagaraNetwork. A few config-
uration properties are found on its property sheet, with no other views.
Among child components, the SupervisorExportTagNetworkExt contains a CategoryFilters
container with a Category Filter Manager view. Use it to create, edit, and delete Category-
Filter components. For more details, see “About the SupervisorExportTagNetworkExt” on page 2-7.
exportTags-SystemHistoryImportTag
A System History Import Tag creates a Niagara SystemHistoryImport descriptor on the Supervisor,
to import histories based upon “System Tag” property values. System tag importing of histories was
first introduced in AX-3.4.
The System History Import Tag includes configuration properties of the Niagara SystemHistoryImport
descriptor, including the “System Tag Patterns”, “On Demand Poll” properties, and “Config Override”
properties. Also included is a “Use Category Mask” property. For more details, see “About SystemHisto-
ryImportTags” on page 2-32.
NiagaraAX-3.7u1
4–3
NiagaraAX Export Tags for Supervisor Auto-Configuration
ExportTag Component Reference Summary Chapter 4 – Export Tag Component Guides
May 31, 2013
NiagaraAX-3.7u1
4–4
NiagaraAX Export Tags for Supervisor Auto-Configuration
Enabling 'Fox SSL' for communications between JACE stations and the Supervisor offers secure encrypted connections, which is essential for protecting data integrity and confidentiality. Challenges during initial setup include potential Join failures due to 'non-approved certificate host name validation' errors, requiring meticulous configuration of SSL certificates. Users must manually approve certificates between client and server, typically managed via the 'Allowed Hosts' tab in the 'Certificate Management' view. Without proper certificate approval, connections may be insecure or fail, complicating the integration of subordinate stations into the Supervisor .
A 'profile.bog file' serves as the template modeling the JACE station's structure as it is represented in the Supervisor's NiagaraNetwork during integration. It is automatically created upon enabling the JoinProfile and encompasses the folder/container hierarchy of the subordinate station. Users can edit this file to customize the structure and properties of the NiagaraStation and its device components as needed, including specifying new folder structures for data organization such as 'NiagaraPointFolders'. This flexibility allows precise configuration and adaptation to specific network architecture or user requirements, ensuring optimal integration outcomes .
The 'Join Profile Manager' in a JACE station is accessed via the SubordinateExportTagNetworkExt. To use it, open the JACE station in Workbench, expand the Config Drivers/NiagaraNetwork container, and double-click the relevant network extension for its Join Profile Manager view. In this view, the Supervisor station is selected and the Join button is clicked to execute the Join process, which ends with a popup Job Log showing performed operations. This manager facilitates station integration by enabling JACE stations to join and synchronize with the Supervisor station, even when the Supervisor is initially unaware of these stations, thus automating integration and creating a unified operational structure. A 'Station File' property links to a local 'profile.bog file' which models the JACE station's representation in the Supervisor's NiagaraNetwork, ensuring consistent and correct architecture replication. Joining from a JACE also includes automatic logging of the Join, which aids in tracking and troubleshooting any issues .
SSL certificate management in NiagaraAX platforms poses challenges such as failed Join attempts due to unapproved certificate host names, requiring manual intervention in certificate validation. To address these challenges, robust strategies include implementing standardized certificate management procedures, automating certificate renewals and approvals using scripts or integration with centralized certificate management tools, and maintaining detailed documentation of certificate properties and validation states. Regular audits and checks ensure trust and minimize misconfigurations. Additionally, leveraging Niagara's Certificate Management tools, like the 'Allowed Hosts' tab in CertManagerService, ensures structured handling and approval of certificates to substantiate secure connections across JACE and Supervisor stations .
'Export Tag Category Filters' are employed within the SupervisorExportTagNetworkExt to impose security categorizations based on 'Station Info' metadata. These filters are prioritized and implemented from top down, where only one CategoryFilter is applied to a NiagaraStation at any time, preventing multiplexing. Structuring involves defining ordered CategoryFilters aligned with organizational or network access policies, ensuring that data access is tightly controlled and that sensitive data is secured against unauthorized users, thus enforcing station-level access separation efficiently .
To set up a 'HistoryImportTag', drag the tag from the exportTags palette into the JACE station's Config space. Double-click it to access its property sheet, then configure properties such as the 'Supervisor Station' and 'Station Slot Path', ensuring 'Station Slot Path' starts with 'slot:histories'. The tag facilitates integration by creating a Niagara history import descriptor in the Supervisor, under the NiagaraStation's Histories container. This integration consolidates historical data management, making subordinate history available in the Supervisor and facilitating historical data analysis and reporting .
'Station Info' properties within a JoinProfile allow the addition of string slots to store organizational metadata about each station. This capability provides enhanced organizational utility in large networks, facilitating systematic data tagging, hierarchical station organization, role-based access controls, and operational reporting. When Joins occur, these properties are transferred and used to effectively classify and manage stations under the Supervisor, optimizing network management and ensuring consistent application across vast and complex system infrastructures .
'CategoryFilters' in a Supervisor station are utilized within the SupervisorExportTagNetworkExt's CategoryFilters container. These filters automatically apply security categories to subordinate NiagaraStations, based on matching 'Station Info' slot/values, ensuring access control and resource segmentation. They facilitate system security by enabling separation of access between diverse organizations sharing a Supervisor, like ensuring users from 'bigOil' and 'cleanWater' organizations can monitor their specific data without viewing each other's. Each filter, once defined, is evaluated in order, allowing precise and hierarchical application of access controls, thus enhancing the system's robustness against unauthorized access .
'SystemHistoryImportTags' are pivotal for importing subordinate JACE station histories into the Supervisor system under the NiagaraStation's Histories container. These tags create descriptors in the Supervisor, enabling centralized access to JACE data archives. The 'Station Slot Path' property defines where these import descriptors are housed on the Supervisor relative to the NiagaraStation, necessitating paths beginning with 'slot:histories'. By default, it uses 'slot:histories,' but can be manually set to specify customized or organized archive folders, crucial for maintaining structured and accessible data management. This customization facilitates differentiated history management strategies across different Niagara installations .
The 'Join' process from the Supervisor involves connecting to the subordinate station, finding its JoinProfile, and merging enabled export tags into the Supervisor's structure. It includes meticulous job logging for reviewing operational changes. Conversely, a 'Join' from a JACE station occurs even if the Supervisor initially lacks a corresponding entry, enabling discovery and initial setup directly from the subordinate. The Supervisor-initiated Join is typically more structured, while the JACE-initiated approach offers flexibility and autonomy, facilitating integration in decentralized network configurations .