Export Tags
Export Tags
NiagaraAX-3.6
April 5, 2011
NiagaraAX Export Tags
For Supervisor Auto-Configuration
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 and Windows are registered trademarks, and Windows NT, Windows 2000, Windows XP Professional, and Internet
Explorer are trademarks of Microsoft Corporation. Java and other Java-based names are trademarks of Sun Microsystems Inc. and
refer to Sun's family of Java-branded technologies. 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, Niaga-
raAX Framework, and Sedona Framework are registered trademarks, and Workbench, WorkPlaceAX, and AXSupervisor, are trade-
marks of Tridium Inc. All other product names and services mentioned in this publication that is known to be trademarks, regis-
tered trademarks, or service marks are the property of their respective owners.
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v
Export tag FAQs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v
What’s new in the AX-3.6 exportTags module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vi
Document Change Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vi
NiagaraAX-3.6
iii
NiagaraAX Export Tags
April 5, 2011
NiagaraAX-3.6
iv
NiagaraAX Export Tags
PREFACE
Preface
• Export tag FAQs
• What’s new in the AX-3.6 exportTags module
• Document Change Log
NiagaraAX-3.6
v
NiagaraAX Export Tags for AxSupervisor Auto-Configuration
What’s new in the AX-3.6 exportTags module Preface
April 5, 2011
Q: Can a JACE build its NiagaraNetwork from export tags in other JACEs?
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.6
vi
NiagaraAX Export Tags for AxSupervisor 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 stations and a Supervisor.
NiagaraAX-3.6
1–1
NiagaraAX Export Tags for AxSupervisor Auto-Configuration
Add the NiagaraNetwork Export Tag extensions Chapter 1 – Export Tags Quick Start
April 5, 2011
The extension is under the NiagaraNetwork, and includes children “Category Filters” and “Alarm Source
Info”. You can leave properties in them at default values for now. For more details, see “About the Super-
visorExportTagNetworkExt” on page 2-7.
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 optionally
configure other properties of that JoinProfile, in order to use export tags. See the next procedure, “Enable
the JoinProfile for a 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
NiagaraAX-3.6
1–2
NiagaraAX Export Tags for AxSupervisor Auto-Configuration
Chapter 1 – Export Tags Quick Start Add the NiagaraNetwork Export Tag extensions
April 5, 2011
Edits to other properties in this JoinProfile are often optional. In general, usage often applies to very large
systems. For more details, see “Editing the Join Profile” on page 2-12.
Note the station bog file specifies the parent “container/folder structure” only, and is not meant for
individual components.
Step 2 If a AX-3.5 system, you usually edit this file to add new folders, as shown being done in Figure 1-5.
NiagaraAX-3.6
1–3
NiagaraAX Export Tags for AxSupervisor Auto-Configuration
Add export tags Chapter 1 – Export Tags Quick Start
April 5, 2011
Note: Starting in AX-3.6, the importance of the station bog file is diminished, as you can define the container/
foilder structure directly from property sheets of export tags,in the “Station Slot Path” properties, as an
alternate to this “template method”. For more details, see.
However, for a AX-3.5 system, it is recommended you continue with this procedure, and do as much ‘pre-
definition” as possible before adding export tags.
Figure 1-6 Save station bog file each time when done with changes
Otherwise, when configuring export tags, the desired “Station Slot Path” will not appear for selection.
For additional details, see “About the Station (.bog) File” on page 2-14.
NiagaraAX-3.6
1–4
NiagaraAX Export Tags for AxSupervisor Auto-Configuration
Chapter 1 – Export Tags Quick Start Add export tags
April 5, 2011
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.
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,
• If a AX-3.6 or later system, enter a desired slot path to use on the Supervisor station for the fold-
er 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:
NiagaraNetwork
-JaceStationName
-Ground_Floor
_AHU2
Other options are also available. See “Station Slot Path considerations” on page 2-18.
Or, (if desired) use the “station bog file method” required for AX-3.5, described next.
• If a AX-3.5 system, click open folder, to see the Select Parent Target dialog. Expand
the niagaraStation 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 “station bog file” to specify a new target folder structure—see “Verify and
optionally edit the Station (.bog) File” on page 1-3 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.
For further details, see “About PxViewTags” on page 2-20.
Step 4 Click Save after finishing all property changes.
NiagaraAX-3.6
1–5
NiagaraAX Export Tags for AxSupervisor Auto-Configuration
Add export tags Chapter 1 – Export Tags Quick Start
April 5, 2011
Adding PointTags
Point tags create Niagara proxy points on the Supervisor, under the Points container of the NiagaraSt-
ation that represents this subordinate (JACE) station. In some cases you may wish to limit usage to only
those points you need for “output links” or control logic in the Supervisor, because of the “Niagara virtual
point” feature automatically provided in PxViewTags.
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,
• If a AX-3.6 or later system, enter a desired slot path to use on the Supervisor station for the
point folder to conain this Niagara proxy point.
For example, if you enter slot:points/AHU2
Upon a Join, at the Supervisor station, this proxy point is created in a Niagara points folder at
this location:
NiagaraNetwork
-JaceStationName
-Points
_AHU2 (Niagara points folder created as a result of the Station Slot Path)
Other options are also available. See See “Station Slot Path considerations” on page 2-18.
Note: For any point tag on a proxy point, Station Slot Path must always begin with: slot:points
This ensures the Niagara proxy point is fully operational on the Supervisor.
Or, (if desired) use the “station bog file method” required for AX-3.5, described next.
• If a AX-3.5 system, you can accept the default “slot:points” (for root of Points under the Nia-
garaStation), or click open folder, to see the Select Parent Target dialog with station
container Points highlighted.
Note: You may edit the “station bog file” to add NiagaraPointsFolders under Points—see
“Verify and optionally edit the Station (.bog) File” on page 1-3 for details. You should not select
any parent folder other than Points, or point folders under Points
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.
For further details, see “About PointTags” on page 2-25.
Step 4 Click Save after finishing all property changes.
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.
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,
• If a AX-3.6 or later system, enter a desired slot path to use on the Supervisor station for the ar-
chive folder to conain the Niagara history import descriptor.
For example, if you enter slot:histories/Floor1
Upon a Join, at the Supervisor station, the history import descriptor is created in a Niagara ar-
chive folder at this location:
NiagaraNetwork
NiagaraAX-3.6
1–6
NiagaraAX Export Tags for AxSupervisor Auto-Configuration
Chapter 1 – Export Tags Quick Start Add export tags
April 5, 2011
-JaceStationName
-Histories
_Floor1 (Niagara archive folder created as a result of the Station Slot Path)
See See “Station Slot Path considerations” on page 2-18 for more details.
Note: For any HistoryImportTag, Station Slot Path must always begin with: slot:histories
This ensures the history import descriptor is fully operational on the Supervisor.
Or, (if desired) use the “station bog file method” required for AX-3.5, described next.
• If a AX-3.5 system, you can accept the default “slot:histories” (for root of Histories under
the NiagaraStation), or click open folder, to see the Select Parent Target dialog with
station container Histories highlighted.
Note: You may edit the “station bog file” to add NiagaraArchiveFolders under Histories—see
“Verify and optionally edit the Station (.bog) File” on page 1-3 for details. You should not select
any parent folder other than Histories, or archive folders under Histories. Note that Niagara
archive folders are a new feature starting in AX-3.5, available to organize history descriptors of
any type (import, systemImport, export).
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.
For further details, see “About HistoryImportTags” on page 2-26.
Step 4 Click Save after finishing all property changes.
Adding SystemHistoryImportTags
Add one or more SystemHistoryImportTags anywhere in the subordinate (JACE) station to import
histories on the Supervisor using the “System Tags” feature, first introduced in AX-3.4. Each tag creates
a Niagara system history import descriptor in the Supervisor, under the Histories container of the Niaga-
raStation that represents this subordinate (JACE) station.
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).
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,
• If a AX-3.6 or later system, enter a desired slot path to use on the Supervisor station for the ar-
chive folder to conain the Niagara history import descriptor.
For example, if you enter slot:histories/SysHistories
Upon a Join, at the Supervisor station, the history import descriptor is created in a Niagara ar-
chive folder at this location:
NiagaraNetwork
-JaceStationName
-Histories
_SysHistories (Niagara archive folder created as a result of the Station Slot Path)
See See “Station Slot Path considerations” on page 2-18 for more details.
Note: Any SystemHistoryImportTag’s Station Slot Path must always begin with: slot:histories
This ensures the history import descriptor is fully operational on the Supervisor.
Or, (if desired) use the “station bog file method” required for AX-3.5, described next.
• If a AX-3.5 system, you can accept the default “slot:histories” (for root of Histories under
the NiagaraStation), or click open folder, to see the Select Parent Target dialog with
NiagaraAX-3.6
1–7
NiagaraAX Export Tags for AxSupervisor Auto-Configuration
Add export tags Chapter 1 – Export Tags Quick Start
April 5, 2011
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.
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-29.
AddingScheduleExportTags
Among the different types of export tags, ScheduleExportTags are 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.
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).
NiagaraAX-3.6
1–8
NiagaraAX Export Tags for AxSupervisor Auto-Configuration
Chapter 1 – Export Tags Quick Start Add export tags
April 5, 2011
• 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 “station bog file” to specify a new target folder structure—see “Verify and
optionally edit the Station (.bog) File” on page 1-3 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.
For further details, see “About ScheduleExportTags” on page 2-30.
Step 5 Click Save after finishing all property changes.
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 using 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,
regardless if a AX-3.6 or AX-3.5 system.
NiagaraAX-3.6
1–9
NiagaraAX Export Tags for AxSupervisor Auto-Configuration
Add export tags Chapter 1 – Export Tags Quick Start
April 5, 2011
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/subReport2.txt (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 specifes 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.
For further details, see “About FileImportTags” on page 2-32.
Step 7 Click Save after finishing all property changes.
Adding ComponentTags
Component tags replicate components on the Supervisor, for limited “general purpose” usage. Often,
they 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.
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.
1. In the Supervisor Station property, click the control and select the Supervisor station,
then click Save.
2. For Station Slot Path,
• If a AX-3.6 or later system, enter a desired slot path to use on the Supervisor station for the fold-
er to conain this component.
For example, if you enter slot:Setpoints/Htg
Upon a Join, at the Supervisor station, this component is created in a folder at this location:
NiagaraNetwork
-JaceStationName
-Setpoints (Folder created as a result of the Station Slot Path)
-Htg (Folder created as a result of the Station Slot Path)
See See “Station Slot Path considerations” on page 2-18 for more details.
Or, (if desired) use the “station bog file method” required for AX-3.5, described next.
• If a AX-3.5 system, you can accept the default “slot:” (for root of the NiagaraStation), or click
open folder, to see the Select Parent Target dialog.
Note: You may edit the “station bog file” to add parent folders—see “Verify and optionally
edit the Station (.bog) File” on page 1-3 for details.
Step 3 Click Save after finishing all property changes.
For further details, see “About ComponentTags” on page 2-33.
NiagaraAX-3.6
1–10
NiagaraAX Export Tags for AxSupervisor Auto-Configuration
Chapter 1 – Export Tags Quick Start Issue Join commands
April 5, 2011
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
addition, a brief Job popup “Subordinate Join” notification appears near your PC’s system tray area.
Note: You can also issue a Join in the subordinate station as a “right-click action” on the Subordinate-
ExportTagNetworkExt, or the on Supervisor station as listed in the Join Profile Manager view.
NiagaraAX-3.6
1–11
NiagaraAX Export Tags for AxSupervisor Auto-Configuration
Issue Join commands Chapter 1 – Export Tags Quick Start
April 5, 2011
However, you only get the “automatic” ending Job Log popup if you use the Join button in the Job Profile
Manager.
NiagaraAX-3.6
1–12
NiagaraAX Export Tags for AxSupervisor Auto-Configuration
CHAPTER 2
NiagaraAX Export Tag Concepts
This section provides conceptual details on the “Export Tags” feature introduced in AX-3.5, including the
an engineering overview, the exportTags palette, various export tag components, and related views.
The following main sections are included:
• “Export tags engineering overview” on page 2-2
• “exportTags palette” on page 2-5
• “About the SupervisorExportTagNetworkExt” on page 2-7
• “About CategoryFilters” on page 2-8
• “About the SubordinateExportTagNetworkExt” on page 2-11
• “Station Slot Path considerations” on page 2-18
• “About PxViewTags” on page 2-20
• “About PointTags” on page 2-25
• “About HistoryImportTags” on page 2-26
• “About ScheduleImportTags” on page 2-29
• “About ScheduleExportTags” on page 2-30
• “About FileImportTags” on page 2-32
• “About ComponentTags” on page 2-33
• “ComponentTag example (ExportTagProgram)” on page 2-34
NiagaraAX-3.6
2–1
NiagaraAX Export Tags for AxSupervisor Auto-Configuration
Export tags engineering overview Chapter 2 – NiagaraAX Export Tag Concepts
About a Join April 5, 2011
Figure 2-1 Export tags in subordinate station create components, histories, and files in Supervisor
Supervisor
Station
Subordinate
Station
3.6 or
later
NiagaraStation option
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.
In a AX-3.5 system, as part of the “JoinProfile” on a subordinate station, a “station bog file” determines
the container/folder structure used under the NiagaraStation on the Supervisor. Each export tag refer-
ences a specific location in this station bog, which is used as the parent container for its associated
exported component.
In a AX-3.6 or later system, you can use this same “station bog file” method, or optionally specify directly
within each export tag the container/folder to build on the Supervisor station. For related details, see
“Station Slot Path considerations” on page 2-18.
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.6
2–2
NiagaraAX Export Tags for AxSupervisor Auto-Configuration
Chapter 2 – NiagaraAX Export Tag Concepts Export tags engineering overview
April 5, 2011 About the JoinProfile
NiagaraAX-3.6
2–3
NiagaraAX Export Tags for AxSupervisor Auto-Configuration
Export tags engineering overview Chapter 2 – NiagaraAX Export Tag Concepts
About the Join process April 5, 2011
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 bog file. The Supervisor then merges the station bog file (and/or if a AX-3.6 or later
system, 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.
Join process from subordinate
If the Join is issued from the subordinate station, the same process steps occur as shown in Figure 2-2,
plus an extra, initial connection step from the subordinate to the Supervisor, as shown in Figure 2-3.
NiagaraAX-3.6
2–4
NiagaraAX Export Tags for AxSupervisor Auto-Configuration
Chapter 2 – NiagaraAX Export Tag Concepts exportTags palette
April 5, 2011 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 case the subordinate’s JoinProfile would require a valid “Default Subordinate User” entry, typically
with “superuser” permissions, and possibly other values in the “Default Subordinate IP Address” and
“Default Subordinate Port” properties. For further details, see “Editing the Join Profile” on page 2-12.
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.
NiagaraAX-3.6
2–5
NiagaraAX Export Tags for AxSupervisor Auto-Configuration
exportTags palette Chapter 2 – NiagaraAX Export Tag Concepts
About the Join process April 5, 2011
NiagaraAX-3.6
2–6
NiagaraAX Export Tags for AxSupervisor Auto-Configuration
Chapter 2 – NiagaraAX Export Tag Concepts About the SupervisorExportTagNetworkExt
April 5, 2011 About the Join process
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-34.
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.
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 very large systems, where a Supervisor may have dozens or per-
haps even hundreds (or more) subordinate 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-13.
• 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.
NiagaraAX-3.6
2–7
NiagaraAX Export Tags for AxSupervisor Auto-Configuration
About CategoryFilters Chapter 2 – NiagaraAX Export Tag Concepts
About the Category Filter Manager April 5, 2011
• 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-13.
The following subsections provide more details on a Supervisor’s export tag Category Filters:
• About the Category Filter Manager
• 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 (,).
NiagaraAX-3.6
2–8
NiagaraAX Export Tags for AxSupervisor Auto-Configuration
Chapter 2 – NiagaraAX Export Tag Concepts About CategoryFilters
April 5, 2011 Adding CategoryFilters
• 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.
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.
NiagaraAX-3.6
2–9
NiagaraAX Export Tags for AxSupervisor Auto-Configuration
About CategoryFilters Chapter 2 – NiagaraAX Export Tag Concepts
Adding CategoryFilters April 5, 2011
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).
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 on page 8.
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.
NiagaraAX-3.6
2–10
NiagaraAX Export Tags for AxSupervisor Auto-Configuration
Chapter 2 – NiagaraAX Export Tag Concepts About the SubordinateExportTagNetworkExt
April 5, 2011 About the Join Profile Manager
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:
• About the Join Profile Manager
• Editing the Join Profile
• About Station Info
• About the Station (.bog) File
• About the Export Tag Summary Manager
• Actions on the SubordinateExportTagNetworkExt
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, you may use this 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.
NiagaraAX-3.6
2–11
NiagaraAX Export Tags for AxSupervisor Auto-Configuration
About the SubordinateExportTagNetworkExt Chapter 2 – NiagaraAX Export Tag Concepts
Editing the Join Profile April 5, 2011
Default columns displayed 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 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.
• Station File
Shows the local file ord to the “station bog file” that acts as the folder/container “template” used on
the NiagaraStation that represents this station, as it will be exported to the Supervisor station.
Buttons at the bottom of this view allow you to Edit many of these properties in the JoinProfile for the
selected Supervisor station, as well as issue a Join command (complete with ending Job Log popup).
See the next section “Editing the Join Profile” for more information.
NiagaraAX-3.6
2–12
NiagaraAX Export Tags for AxSupervisor Auto-Configuration
Chapter 2 – NiagaraAX Export Tag Concepts About the SubordinateExportTagNetworkExt
April 5, 2011 About Station Info
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.6
2–13
NiagaraAX Export Tags for AxSupervisor Auto-Configuration
About the SubordinateExportTagNetworkExt Chapter 2 – NiagaraAX Export Tag Concepts
About the Station (.bog) File April 5, 2011
Figure 2-15 Example Station Info properties (slot sheet, property sheet)
NiagaraAX-3.6
2–14
NiagaraAX Export Tags for AxSupervisor Auto-Configuration
Chapter 2 – NiagaraAX Export Tag Concepts About the SubordinateExportTagNetworkExt
April 5, 2011 About the Export Tag Summary Manager
property. This is also covered briefly in the “Export Tags Quick Start” procedures. Also see “Station
Slot Path considerations” on page 2-18.
Note: Remember to save the bog file after any changes. Right-click the bog file and select Save. See Figure 2-16.
Figure 2-17 shows the relationship of the JoinProfile’s “Station File” property and the resulting file folder
and station bog file created, using property defaults.
Figure 2-17 Station bog file created in file space of JACE station
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-17 example, where the Supervisor station (and NiagaraStation that represents it) is named
“AxSuper_35”, this results in a file named: AxSuper_35_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 station bog file to be created—otherwise, Join errors may
result. Be aware that this does not delete (or rename) the original station bog file.
NiagaraAX-3.6
2–15
NiagaraAX Export Tags for AxSupervisor Auto-Configuration
About the SubordinateExportTagNetworkExt Chapter 2 – NiagaraAX Export Tag Concepts
About the Export Tag Summary Manager April 5, 2011
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. An Edit button lets you make changes to one or more selected
export tags, providing access to a few common properties that include “Enable”.
Note: Starting in AX-3.6, a “Set All Supervisor Station Names” button is also available, to globally
set the “Supervisor Station” property in all export tags. For more details, see “Actions on the Subordinate-
ExportTagNetworkExt” on page 2-17.
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 information.
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.6
2–16
NiagaraAX Export Tags for AxSupervisor Auto-Configuration
Chapter 2 – NiagaraAX Export Tag Concepts About the SubordinateExportTagNetworkExt
April 5, 2011 Actions on the SubordinateExportTagNetworkExt
• 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, this applies only to the first export tag.
• 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 station bog 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.
• Join
A way to issue the Join from this JACE station.
• Set All Supervisor Station Names
(AX-3.6 and later) Allows you to globally specify the target NiagaraStation that represents the Su-
pervisor, applied to the “Supervisor Station” property in all the export tags in this station. If you in-
voke this, a confirmation popup dialog appears, after which a selection list of NiagaraStations in the
station’s NiagaraNetwork appear.
This can be useful if you have copied in saved devices (from previous jobs) that contain export tags
naming other Supervisor stations, as one example. Or, if you did not set the “Supervisor Name”
property in export tags already added, either by mistake or by design.
Note: This same command is also available in the (AX-3.6 or later) Export Tag Summary Manager
view on this component.
NiagaraAX-3.6
2–17
NiagaraAX Export Tags for AxSupervisor Auto-Configuration
Station Slot Path considerations Chapter 2 – NiagaraAX Export Tag Concepts
BFormat options in Station Slot Paths April 5, 2011
If you add a PxViewTag on the Room_21 points folder (it has a Px view you are exporting), you can
set its slot path to:
slot:EastWing\%deviceFolderPath%
This results in the following folder structure under the Supervisor’s NiagaraNetwork:
JaceStationName (existing NiagaraStation that represents the JACE)
EastWing (folder)
Floor_1 (folder)
Room_21 (folder)
where the last two folders were added by the BFormat value. The SubstitutePxView is on the
Room_21 folder.
NiagaraAX-3.6
2–18
NiagaraAX Export Tags for AxSupervisor Auto-Configuration
Chapter 2 – NiagaraAX Export Tag Concepts Station Slot Path considerations
April 5, 2011 Conclusions
• slot:%networkFolderPath%
This replicates container structure in the JACE station from the “network downwards”. For example
if the station has a BacnetNetwork with an architecture like this:
BacnetNetwork (network component)
EastWing (device folder)
BnetDev43 (device component)
Floor_1 (points folder)
Room_21 (points folder)
If you add a PxViewTag on the Room_21 points folder (it has a Px view you are exporting), you can
set its slot path to:
slot:%networkFolderPath%
This results in the following folder structure under the Supervisor’s NiagaraNetwork:
JaceStationName (existing NiagaraStation that represents the JACE)
EastWing (folder)
BnetDev43 (folder)
Floor_1 (folder)
Room_21 (folder)
where all folders were added by the BFormat value. The SubstitutePxView is on the Room_21 folder.
This option is likely not as useful as the “deviceFolderPath”, unless a “network-centric” organization
of folders is desired.
Conclusions
Experimentation is recommended on one or two export tags to verify expected results, especially if using
the BFormat options. However, dynamic folder creation provided in AX-3.6 and later is expected to help
simplify the export tag process, as some found the “station bog file” process to be too big of an abstraction.
NiagaraAX-3.6
2–19
NiagaraAX Export Tags for AxSupervisor Auto-Configuration
About PxViewTags Chapter 2 – NiagaraAX Export Tag Concepts
PxViewTag properties April 5, 2011
About PxViewTags
The PxViewTag is potentially the most important of all export tags, 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 operations such as
creating Niagara virtual points, importing referenced image files, and so on, are all handled automatically.
Note: See “Adding PxViewTags” on page 1-5 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-22).
NiagaraAX-3.6
2–20
NiagaraAX Export Tags for AxSupervisor Auto-Configuration
Chapter 2 – NiagaraAX Export Tag Concepts About PxViewTags
April 5, 2011 PxViewTag properties
• PxView
The name of the local PxView that will be exported to the Supervisor station, at the slot parent slot
path above. Click the drop-down control for a list of available PxViews.
• Required Permissions
Required user permissions to access the exported PxView. Click the double-arrow control for the
Edit Permissions dialog (Figure 2-23). Default permissions are operator read (r).
• 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-23.
NiagaraAX-3.6
2–21
NiagaraAX Export Tags for AxSupervisor Auto-Configuration
About PxViewTags Chapter 2 – NiagaraAX Export Tag Concepts
PxViewTag action April 5, 2011
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-24).
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).
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-26.
NiagaraAX-3.6
2–22
NiagaraAX Export Tags for AxSupervisor Auto-Configuration
Chapter 2 – NiagaraAX Export Tag Concepts About PxViewTags
April 5, 2011 About ord substitution overrides
Figure 2-26 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-27).
Figure 2-27 View dialog from View control in property sheet of SubstitutePxView (on Supervisor)
Due to the extreme length of ords to virtual components, only the leading part of ords are shown above.
Figure 2-28 Example boundLabel with hyperlink in the original PxView in subordinate (JACE) station
NiagaraAX-3.6
2–23
NiagaraAX Export Tags for AxSupervisor Auto-Configuration
About PxViewTags Chapter 2 – NiagaraAX Export Tag Concepts
About ord substitution overrides April 5, 2011
In this example, when viewing this on the Supervisor, instead of Services, the desired target is the
UserService. 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-29 View dialog, Choose from Px edit (from PxViewTag property sheet)
As shown in Figure 2-29, 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-26).
Figure 2-30 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.
• Any other types of ords to mention?
NiagaraAX-3.6
2–24
NiagaraAX Export Tags for AxSupervisor Auto-Configuration
Chapter 2 – NiagaraAX Export Tag Concepts About PointTags
April 5, 2011 PointTag properties
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 (as well as ComponentTags). Note that starting in AX-3.5, 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-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 PointTags:
• PointTag properties
PointTag properties
Double-click a PointTag for its property sheet (Figure 2-31).
NiagaraAX-3.6
2–25
NiagaraAX Export Tags for AxSupervisor Auto-Configuration
About HistoryImportTags Chapter 2 – NiagaraAX Export Tag Concepts
HistoryImportTag properties April 5, 2011
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 “Adding HistoryImportTags” 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 HistoryImportTags:
• HistoryImportTag properties
HistoryImportTag properties
Double-click a HistoryImportTag for its property sheet (Figure 2-32).
NiagaraAX-3.6
2–26
NiagaraAX Export Tags for AxSupervisor Auto-Configuration
Chapter 2 – NiagaraAX Export Tag Concepts About SystemHistoryImportTags
April 5, 2011 SystemHistoryImportTag properties
About SystemHistoryImportTags
Add a SystemHistoryImportTag anywhere in the station to import histories on the Supervisor
using the “System Tags” feature, first introduced in AX-3.4. Each tag creates a Niagara system history
import descriptor in the Supervisor, under the Histories container of the NiagaraStation that represents
this subordinate (JACE) station. Corresponding histories are immediately available in the Supervisor.
Note: See “Adding SystemHistoryImportTags” 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 SystemHistoryImportTags:
• SystemHistoryImportTag properties
SystemHistoryImportTag properties
Double-click a SystemHistoryImportTag for its property sheet (Figure 2-33).
NiagaraAX-3.6
2–27
NiagaraAX Export Tags for AxSupervisor Auto-Configuration
About SystemHistoryImportTags Chapter 2 – NiagaraAX Export Tag Concepts
SystemHistoryImportTag properties April 5, 2011
NiagaraAX-3.6
2–28
NiagaraAX Export Tags for AxSupervisor Auto-Configuration
Chapter 2 – NiagaraAX Export Tag Concepts About ScheduleImportTags
April 5, 2011 ScheduleImportTag properties
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, this makes the tagged schedule 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-8 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-34).
NiagaraAX-3.6
2–29
NiagaraAX Export Tags for AxSupervisor Auto-Configuration
About ScheduleExportTags Chapter 2 – NiagaraAX Export Tag Concepts
ScheduleExportTag properties April 5, 2011
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 slave schedule on the Supervisor, read-only and fixed as the schedules slot
(Schedules extension) of the NiagaraStation that represent this subordinate (JACE) station.
• Execution Time
Execution time selections for the NiagaraScheduleImport descriptor that results on the Supervisor,
where the default is Manual. Other selections include Daily or Interval, where each has a number
of selectable parameters.
Note that by default, the corresponding NiagaraScheduleExport descriptor created on the local sub-
ordinate (JACE) station has an Execution Time of Interval, at every 5 minutes.
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 NiagaraStation. In that way, the imported
“slave” schedule is pre-configured, matching the (typically) already configured “master” schedule, as it
resides in the Supervisor.
To use a ScheduleExportTag to “slave” to an existing schedule in the Supervisor, you first need to know
its ord in that station (component path)—in which case, use of this tag is not really needed. Instead, you
would enter that ord in the “Supervisor Id” property of the schedule’s ScheduleImportExt.
Or, you can use a ScheduleExportTag with a new schedule to result in 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 subordinate (JACE) station.
Note: See “AddingScheduleExportTags” on page 1-8 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-35.
NiagaraAX-3.6
2–30
NiagaraAX Export Tags for AxSupervisor Auto-Configuration
Chapter 2 – NiagaraAX Export Tag Concepts About ScheduleExportTags
April 5, 2011 ScheduleExportTag properties
Figure 2-35 ScheduleImportExt property sheet example, showing child ScheduleExportTag properties
NiagaraAX-3.6
2–31
NiagaraAX Export Tags for AxSupervisor Auto-Configuration
About FileImportTags Chapter 2 – NiagaraAX Export Tag Concepts
FileImportTag properties April 5, 2011
About FileImportTags
Starting in AX-3.5, 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 Super-
visor station. A corresponding 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 “Adding FileImportTags” on page 1-9 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-20.
The following sections provide more details on FileImportTags:
• FileImportTag properties
FileImportTag properties
Double-click a FileImportTag for its property sheet (Figure 2-36).
NiagaraAX-3.6
2–32
NiagaraAX Export Tags for AxSupervisor Auto-Configuration
Chapter 2 – NiagaraAX Export Tag Concepts About ComponentTags
April 5, 2011 ComponentTag properties
folder) appended to “_Import”. For example, if the File is “file:^console.txt”, 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/subReport2.txt (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.
About ComponentTags
The ComponentTag is an available “general purpose” export tag, to replicate the tagged (parent)
component under the NiagaraStation component on the Supervisor. 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”).
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 “Adding ComponentTags” 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.
• ComponentTag properties
• ComponentTag example (ExportTagProgram)
ComponentTag properties
Double-click a ComponentTag for its property sheet (Figure 2-37).
NiagaraAX-3.6
2–33
NiagaraAX Export Tags for AxSupervisor Auto-Configuration
About ComponentTags Chapter 2 – NiagaraAX Export Tag Concepts
ComponentTag example (ExportTagProgram) April 5, 2011
Figure 2-38 Example ExportTagProgram copied into a station, with configured ComponentTag
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-38. 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.
NiagaraAX-3.6
2–34
NiagaraAX Export Tags for AxSupervisor Auto-Configuration
Chapter 2 – NiagaraAX Export Tag Concepts About ComponentTags
April 5, 2011 ComponentTag example (ExportTagProgram)
Figure 2-39 shows the ExportTagProgram opened in the Program Editor, unmodified (as copied
from the palette).
NiagaraAX-3.6
2–35
NiagaraAX Export Tags for AxSupervisor Auto-Configuration
About ComponentTags Chapter 2 – NiagaraAX Export Tag Concepts
ComponentTag example (ExportTagProgram) April 5, 2011
NiagaraAX-3.6
2–36
NiagaraAX Export Tags for AxSupervisor 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.6
3–1
NiagaraAX Export Tags for AxSupervisor Auto-Configuration
Export Tag Plugin Guides Summary Chapter 3 – Export Tag Plugin Guides
April 5, 2011
NiagaraAX-3.6
3–2
NiagaraAX Export Tags for AxSupervisor Auto-Configuration
CHAPTER 4
Export Tag Component Guides
These component guides provides summary help on exportTags components.
NiagaraAX-3.6
4–1
NiagaraAX Export Tags for AxSupervisor Auto-Configuration
ExportTag Component Reference Summary Chapter 4 – Export Tag Component Guides
April 5, 2011
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 station bog 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-25.
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-20.
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-30.
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-29.
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-13.
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.6
4–2
NiagaraAX Export Tags for AxSupervisor Auto-Configuration
Chapter 4 – Export Tag Component Guides ExportTag Component Reference Summary
April 5, 2011
exportTags-SupervisorExportTagNetworkExt
The SupervisorExportTagNetworkExt 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-27.
NiagaraAX-3.6
4–3
NiagaraAX Export Tags for AxSupervisor Auto-Configuration
ExportTag Component Reference Summary Chapter 4 – Export Tag Component Guides
April 5, 2011
NiagaraAX-3.6
4–4
NiagaraAX Export Tags for AxSupervisor Auto-Configuration