Action is a slot that defines a behavior that can be invoked on a component.
This term indicates one of two levels of permissions (admin and operator) available in NiagaraAX. Admin and Operator levels are also specified by the terms read, write, and invoke. So you may have
permission-levels of: operator Read, operator Write admired, domineered, and so on.
This term typically describes a system or application user that can perform certain high-level functions that other users cannot perform.
An agent is a special object type that provides services for other object types. Agents are registered on their target types via the module manifest and queried via the registry interface.
Alarms provide the ability to be notified when a special event occurs. See AlarmConsole or AlarmPortal for more information.
In NiagaraAX-3.x, animation allows you to change, or “update” graphics based on data values that come from object sources that are connected (or “bound”) to them. In the PxEditor, right-click a property and select animate. For more details, see the NiagaraAX Graphics Guide section “Animating Graphics”.
API is a Application Programming Interface. It defines how software engineers access the capabilities of software like the Niagara Framework.
A small Java program that can be embedded in an HTML page. Applets differ from full-fledged Java applications in that they are not allowed to access certain resources on the local computer, such as files and serial devices (modems, printers, etc.), and are prohibited from communicating with most other computers across a network. The common rule is that an applet can only make an Internet connection to the computer from which the applet was sent. See also BAppletView.bajadoc for more technical information.
Archive is a history that is stored in a different station from where it originated.
The Audit keeps a history of changes made by users. If enabled, it registers itself as the Auditor for the system when the service is started. One of the important aspects of security is the ability to analyze what has happened after the fact. See AuditHistoryService for more information.
BACnet refers to data communication protocol for Building Automation and Control Networks. Developed under the auspices of the American Society of Heating, Refrigerating and Air-Conditioning Engineers (ASHRAE), BACnet is an American national standard, a European pre-standard, and an ISO global standard. The protocol is supported and maintained by ASHRAE Standing Standard Project Committee 135. See the BACnet Guide for more information on BACnet in the Niagara Framework.
Baja is a term coined from Building Automation Java Architecture. The core framework built by Tridium is designed to be published as an open standard. This standard is being developed through Sun's Java Community Process as JSR 60. See Baja vs. Niagara in the Developer Guide for more information.
Bajadoc is the Baja reference documentation. Baja reference documentation includes both Java API details as well as Baja
slot documentation. See BajadocViewer for more information.
A Binding is used to bind a Widget to a data source. Bindings are bound to one Object using an Ord. Subclasses are registered
as agents on the type of objects to which they can be bound to. For more details, see the NiagaraAX Graphics Guide section “Data binding”.
A Bog file contains baja components. It can be a complete database or any collection of components. A bog file is a special file that can describe components in a database. All views can be used on components in a bog file just as if they were in a station. See “Bog Files” in the NiagaraAX Developer Guide for more information.
Bookmark identifies a single bookmark. See Bookmarks and About the bookmark side bar for more information.
BooleanPoint defines a read only control point with only an output element. See also, Types of control points.
BQL is an acronym for Baja Query Language. BQL has a select statement similar to the select statement of Structured Query Language (SQL). It is typically used to provide programmable access to information in Niagara. See “BQL” in the NiagaraAX Developer Guide for more details.
The "bql" Scheme is used to encapsulate a BQL query.
The build tool is used to build the Niagara Framework itself. You may utilize this build tool to manage your own Niagara modules. See “build.html” in the Developer Guide for more information.
A chart is a graphical representation of data. The HistoryChart is a view that allows you to view and configure charts of histories. See Types of history views for more information.
The client part of a client-server architecture. Typically, a client is an application that runs on one computer and relies on a server to perform some operations. For example, an email client is an application that enables you to send and receive e-mail.
A collection represents a group of objects, known as its elements. Some collections allow duplicate elements and others do not. Some are ordered and others unordered. See Collection.bajadoc for more technical information.
Color stores a color specification via an alpha, red, green, and blue component. See BColor.bajadoc for more information.
Command typically refers to an Action in the Niagara Framework. See About point actions for more information on point commands.
A component is the primary building block of the Niagara Framework. See also, About components.
A composite allows you to expose child slots of a component as slots on the parent. See About composites for more information.
Connect refers to entering a valid address for a system to establish a connection, a user name and password. A connection
creates an active session for use of the system.
Console provides a simple runtime console for managing and debugging the station. See About the console for more information.
Containers allow you to logically group components. The current container is the component that contains the components in the display window. See baja-component Containers for more information.
Context is used in operations that may perform differently depending on their context. Examples include operations that may require auditing or localization.
The control module provides normalized components for representing control points. All control points subclass from the ControlPoint base class. Control points are typically used with the driver framework to read and write points in external devices. See “Control” in the NiagaraAX Developer Guide for more information.
In the narrowest terms, control points refer to the 8 point types found in the Baja control palette under the “Points” folder.
See About control points.
In broader terms, control points include other components found in both the control and kitControl palettes. Most of these are "classed" from the 8 basic point types. See Other control components.
ControlPoint is the base class for all point types in the Baja control architecture. A ControlPoint typically maps to one value being read or written via a driver. All ControlPoints have a StatusValue property called "out". ControlPoints inherit from BooleanPoint, EnumPoint, NumericPoint and StringPoint.
If the predefined proxyExt is not a NullProxyExt then the point is considered a proxy point which means that it is a local representation of a point which actually exists in an external device. The driver framework is used to maintain synchronization.
Manage Credentials is available in the main menu by selecting . You can Reset or Remove selected Credentials or Remove All Credentials.
Cascading style sheet.
The CSV ("Comma Separated Values") file format is used to exchange data between applications. CSV is one format option that may be used for exporting data from tables in some NiagaraAX views (for example, history tables).
Daemon typically refers to the Niagara platform daemon, the server process required by a Niagara host to run a station. There is also a separate “dialup daemon” to handle dialup modem functions.
Database is used to store information. Examples of databases include the registry or a station database.
Debug refers to testing or correcting software. The NiagaraAX Program Debugger provides debug capability for program components.
This action, available from the workbench toolbar removes the selected links.
All modules include zero or one dependencies element. This element contains zero or more dependency elements which enumerate the module's dependencies. Dependencies must be resolved by the framework before the module can be successfully used. Each dependency has one required attribute. The name attribute specifies the globally unique name of the dependent module. A dependency may also specify a bajaVersion and/or a vendor version. If the bajaVersion attribute is declared then it specifies the lowest bajaVersion of the dependent module required. It is assumed that higher versions of a module are backward compatible, thus any version greater than the one specified in a dependency is considered usable. Likewise the vendor and vendorVersion may be specified to declare a dependency on a specific implementation of a module. The vendor attribute may be specified without the vendorVersion attribute, but not vise versa. The required embed attribute specifies whether the dependency should be enforced on embedded Niagara devices.
The ModuleSpaceView supports the ability to right click a module and display all its dependencies. These dependencies are as declared by the module's manifest. To compute the dependencies needed to use a specific API a new Dependencies command has been added to the BajadocViewer Menus. This command will compute all the classes and modules required to use a specific class in the API.
DeviceExt is the abstract base class for device extensions which provide feature integrations between the device's native protocol and model and the NiagaraAX framework-normalized model. See BDeviceExt.bajadoc for more information.
Directory is the file type used to represent directories in “file space” implementations. See BDirectory.bajadoc for more information. See also, Types of space and Types of files.
Status disabled means a user manually disabled the component using the enabled property (enabled = false). Disabled always propagates down. For example if you set the network to “disabled”, that forces all child devices disabled, which then forces all proxy points under each device disabled. See also, About point status.
You may logoff a connection (for example, a platform, station, or application) by right-clicking the object in the tree and select . This allows you to close a session without removing it from the tree. The “disconnected” object appears dimmed in the nav tree. Right-click and select to reestablish a connection to the object.
Discover allows you to find items that are defined using a driver’s framework. Refer to the Drivers Guide sections “About Device Discover, Add, and Match (Learn Process)” and “About Point Discover, Add, and Match (Learn Process)” for related examples.
Security domains may be assigned to any component or set of components in the system. For example, security domains may
be used to assign components into application domains such as hvac, fire, and lighting or security domains can be used to
assign components into customer groups such as tenant 1, tenant 2, etc.
This term indicates a communication error at the network or device level. “Down” always propagates downward in a relational
hierarchy. Down is controlled by the pingFail and pingOk methods. The reason why a device is down is always stored in the health.lastFailCause property.
Download refers to passing data down to a device. You may download a station from its supervisor.
This term is used for software that provides a device-specific (or protocol-specific) framework for integration with another system. In NiagaraAX drivers have "manager” views that provide a consistent look and feel for configuring and learning of devices and points. The cornerstone of the driver tools is the ability to support batch edits and Learns. See also, “Driver Framework” in the NiagaraAX Developer Guide.
The elements define the hierarchical structure of a document. The majority of elements have opening and closing tags. Within these tags, text or even the whole documents can be found. There are empty elements which contains only opening tags without any content.
An element may also model one single piece of information in the baja control architecture. The most common types of elements are:
BooleanElement
NumericElement
EnumElement
StringElement
All elements regardless of their value type share common attributes. Every element has a status property which provides a consistent mechanism to convey point status. Each element also contains a priority level for informational purposes. If the priority is PriorityLevel.none, this is not a prioritized element.
Elements are basic building blocks from which larger, more sophisticated control points are created. A control point contains one or more input elements and one or more output elements. Elements can also be linked between Baja Objects to move data.
Enumeration represents a value data item which has a fixed set of possible values. This set of values is called the Enumeration's Range. The standard enumerations include:
alarm:AlarmRecordTypes
alarm:AlarmTransition
baja:Month
baja:Weekday
control:AlarmState
control:AlarmType
control:CollectionState
control:DisableAction
control:LoopAction
control:NotifyType
control:PriorityLevel
control:Reliability
control:TotalizationInterval
driver:ArchiveMode
driver:ArchiveResult
driver:ArchiveState
driver:PollFrequency
driver:ProxyState
See Enum Range Dialog or BEnum.bajadoc for more information.
EnumPoint defines a read only control point with only an output element. See also, Types of control points.
Export refers to providing data from the system for external use. You can export any Table found in the workbench (anything built with bajaui:Table). The Table options menu (that little button to the right of the header), includes a Print and Export command. These commands allow you to export the table to PDF, HTML, or CSV (ExcelFile). The export uses the current sort order and visible columns you have displayed. The Niagara Framework also exports its Database to XML for backup and conversion.
Extensions allow plug-in functionality to support features such as alarming and historical data collection. See also, About point extensions.
Facets contain meta data – or additional data about an object. For example, “units of measurement” is a type of facet. See
also, About point facets.
Faults always propagate downward in a hierarchy relationship. The framework performs "fatalFault" checking such as making
sure a device is under the right network type. Fatal faults are also the mechanism used to perform licensing checks. Developers
can also manage fault condition using the configFail() and configOk() methods. The reason a component is in fault is always stored in the faultCause property.
A term that refers to a line in a license file that specifies a capability (“feature”) for the associated framework. A feature is uniquely identified by a vendor and feature name. It contains an expiration and a set of optional properties. See also, “Workbench license manager” in the NiagaraAX-3.x Platform Guide.
This term (and icon) represents a file object in the file system of a session. See also, See also, Types of files.
The "file" scheme is used to identify files on the file system. All file Ords resolve to instances of javax.baja.file.BIFile. File queries always parse into a FilePath. File Ords include the following types:
Authority Absolute: "//hostname/dir1/dir2"
Local Absolute: "/dir1/dir2"
Sys Absolute: "!lib/system.properties"
Station Absolute: "^config.bog"
Relative: "myfile.txt"
Relative with Backup: "../myfile.txt"
Sys absolute paths indicate files rooted under the Niagara installation directory identified via Sys.getBajaHome(). User absolute paths are rooted under the user home directory identified via Sys.getUserHome(). In the case of station VMs, user home is the directory of the station database.
Filter is used to select specified items. An example is the Alarm Console Filter.
Find allows you to search for the selected string. The shortcut is F5. See Search Find for more information.
Find Files allows you to find the all occurrences in the files. See Search Find Files for more information.
Find Next allows you to find the next occurrence of the selected string. The shortcut is Ctrl-F (hold down Ctrl and press F).
Find Prev allows you to find the previous occurrence of the selected string. The shortcut is Ctrl-Shift-F (hold down Ctrl and Shift and press F).
Flags are boolean values which are stored as a bitmask on each slot in a Baja Object. Some flags apply to all slot types,
while some only have meaning for certain slot types.
This object is a folder container in the file system of a session. See also, Folder.
Format is used to format Objects into Strings using a standardized formatting pattern language. The format String is normal text with embedded scripts denoted by the % percent character (use %% to insert a real %). A script is one or more calls chained together using the . dot operator. Calls are mapped to methods using reflections. Given call "foo", the order of reflection mapping is:
special call (see below)
getFoo(Context)
getFoo()
foo(Context)
foo()
get("foo")
The following special functions are available to use in a script:
time() calls Clock.time() to get current time as an AbsTime
lexicon(module:key) gets the specified lexicon text
Examples of formats:
"hello world"
"my name is %displayName%"
"my parent's name is %parent.displayName%"
"%value% {%status.flagsToString%} @ %status.priority%"
"%time().toDateString%"
* "%lexicon(bajaui:dialog.error)%"
Fox is a proprietary protocol which is used for all network communication between Stations as well as between the workbench
and stations. Fox is a multiplexed peer to peer protocol which sits onto of a TCP connection.
The "fox" Scheme is used to establish a Fox session. Fox is the primary protocol used by Niagara for IP communication. A "fox" query is formatted as "fox:" or "fox:<port>". If the port is not specified, then the default 1911 port is assumed.
FROM is the mechanism to choose the extent. This may be a history or a class in a station. See ExtentBuilder for more information.
A Glyph is a visual representation.
In some views, this command allows you to go to a file that has been indexed with the file indexer. The shortcut is Ctrl-F7 (hold down Ctrl and press F7). See Search Goto File for more information.
In some views, this command allows you to go to a line number in the file. The shortcut is Ctrl-G (hold down Ctrl and press G). See Search Goto Line for more information.
The "h" Scheme is used to resolve a component by its handle. Handles are unique String identifiers for components within a componentSpace. Handles provide a way to persistently identify a component independent of any renames which modify a component's slot path.
Help refers to the electronic documentation available. It includes electronic manuals as well as context specific help.
History is an ordered Collection of timestamped records. Each history is identified by a unique id. Histories can be periodically
archived to a remote history database (archive). A history database is a set of histories. History: is also used as a Scheme
in Ords to refer to collected histories. See also, About Histories.
This term refers to a default page that appears as soon as you login to a station or application. In Niagara you can use
navigation files (“nav” files) to create a unique navigation tree, including a home page, for each user or user-type. For
related details, see the NiagaraAX Graphics Guide section “About the Nav file”.
This is a term for a hardware system (or platform) that provides the operating environment for Niagara application. In a
navigation tree, the host node is used to depict the platform, which is the first level of the navigation tree. Hosts always
represent a physical piece of hardware. Localhost is a term used to indicate the local machine.
HTTP is short for HyperText Transfer Protocol, the underlying protocol used by the World Wide Web (World Wide Web). HTTP
defines how messages are formatted and transmitted, and what actions Web Servers and browsers should take in response to various
commands. For example, when you enter a URL in your browser, this actually sends an HTTP command to the Web Server directing
it to fetch and transmit the requested Web Page. The other main standard that controls how the World Wide Web works is HTML,
which covers how Web Pages are formatted and displayed.
HTTP is called a stateless protocol because each command is executed independently, without any knowledge of the commands that came before it. This is the main reason that it is difficult to implement World Wide Web sites that react intelligently to user input. This shortcoming of HTTP is addressed in a number of technologies, including Java, JavaScript and cookies.
An icon is a graphical representation. Icons are used in the workbench toolbar and nav tree.
Image is a representation of a raster image.
Import refers to receiving data from an external source. The Niagara Framework imports its Database from XML for backup and conversion.
The "ip" Scheme is used to identify a BIpHost instance. Ords starting with "ip" are always absolute and ignore any base which may be specified. The body of a "ip" query is a DNS hostname or an IP address of the format "dd.dd.dd.dd".
Java is a high-level programming language developed by Sun Microsystems. Java source code files (files with a .java extension)
are compiled into a format called bytecode (files with a .class extension), which can then be executed by a Java interpreter.
Compiled Java code can run on most computers because Java interpreters and runtime environments, known as Java Virtual Machines
(VMs), exist for most operating systems, including UNIX, the Macintosh OS, and Microsoft Windows. Bytecode can also be converted
directly into machine language instructions by a just-in-time compiler (JIT).
Java is a general purpose programming language with a number of features that make the language well suited for use on the World Wide Web. Small Java applications are called Java Applets and can be downloaded from a Web Server and run on your computer by a Java-compatible World Wide Web browser. For more information, seehttp://java.com andhttp://java.sun.com/.
JavaScript refers to the standard scripting language used in HTML documents. Microsoft Internet Explorer support is discussed
at http://msdn.microsoft.com/scripting/jscript/default.htm. Mozilla support is discussed at http://www.mozilla.org/js/index.html See http://www.ecma-international.org/publications/standards/Ecma-262.htm for more information on the official Standard ECMA-262 ECMAScript Language Specification.
Language Code refers to ISO 639 language code -- two letter, lower-case preferred. See http://www.loc.gov/standards/iso639-2/langcodes.html for the list.
Learn allows you to discover and add items that are defined using the driver framework. Refer to the Drivers Guide sections “About Device Discover, Add, and Match (Learn Process)” and “About Point Discover, Add, and Match (Learn Process)” for related information.
A lexicon is used to provide alternative text for the workbench interface. For example, the text in menus, actions, and other things can be changed by using a custom lexicon entry. Lexicons also provides support for non-English languages. See also, About lexicons and “Notes on English (en) lexicon usage” in the NiagaraAX Lexicon Guide.
Links are the relationships defined between components. Links provide the means to pass data between components. See “Links”
in the Developer Guide for more information.
Local is a scheme used in Ords. It is both a host scheme and a session scheme. It represents Objects found within the local VM. See also, About schemes.
Log is used to log events. The LogHistoryService keeps a History of Niagara log records. If enabled, it registers itself as the LogHandler for the system when the service is started.
Logoff refers to removing a user from an active session so that a password will have to be entered to logon for use of the system.
Logon is the act of entering a valid address, user name and password. This creates an active session for use of the system.
Match is a feature provided in manager views that provide a “Discover” function. After discovery, the match feature makes
it easier to properly configure and add objects (for example, points) to a “discovered” network.
The Multipurpose Internet Mail Extensions (MIME) provide a mechanism to determine file type in a standardized way.
The first step in understanding the Niagara architecture is to grasp the concept of modules. Modules are the smallest unit
of deployment and versioning in the Niagara architecture. A module is:
A JAR file compliant with PKZIP compression
Contains a XML manifest in meta-inf/module.xml
Is independently versioned and deployable
States its dependencies on other modules and their versions
See About modules, or modules in the Developer Guide for more information.
The "module" Scheme is used to access BIFiles inside the module jar files. The module Scheme uses the "file:" Scheme's formatting where the authority name is the module name. Module queries can be relative also. If the query is local absolute then it is assumed to be relative to the current module. Module queries always parse into a FilePath. See also, About schemes.
Monitor refers to observing. The Ping Monitor periodically calls ping on all the “pingable” objects to monitor network and
device health. PingMonitor provides built-in support to generate alarms when pingables are down. Refer to the Drivers Guide section “About Monitor” for more details.
Mozilla is a browser used to access Web Pages from a Web Server. See http://www.mozilla.org/index.htmlfor more information.
Name Map defines a new Display Name for a Language Code. You can Add Name Map to provide a new Display Name for a Language Code. A blank Language Code is used for all languages. You Right-click on the Property displayNames to delete or rename Name Map and displayNames_xx to delete or rename Name Map (xx) where xx is the Language Code. Bajadoc is available at BNameMap.bajadoc.
Nav File stores XML nav markup. It allows you to define a navigation tree. You may use the NavFileEditor to modify this file. Bajadoc is available at BNavFile.bajadoc. For more details, see the NiagaraAX Graphics Guide section “About the Nav file”.
Network is a collection of devices. In WorkbenchAX, the Device Manager view provides a summary of an attached network. See
“About Network architecture” in the Drivers Guide for more information.
The Niagara Framework is a system designed to manage and control information. Its primary application is for control systems because of its powerful and flexible integration capabilities. The system is made up of Stations that run the components of the Niagara Framework and views that provide the ability to view and command these components. See “Baja vs. Niagara” in the NiagaraAX Developer Guide for more information.
In NiagaraAX, this term is used to indicate “data normalization”. This refers to the process of making data and features from various different communications protocols work together so that they can be integrated. The Niagara framework provides a way to normalize data across various protocos so that it may be viewed and controlled from a single user interface.
The null flag indicates that the associated value should not be used. It represents a “don't care” condition. It is used in combination with priority arrays so that points may take or release control of their level in a priority array based on their current state. It is also used in math, logic and other application blocks that take a variable number of inputs. Any input with the null flag set is ignored.
NumericPoint defines a read only control point with only an output element. Bajadoc is available at BNumericPoint.bajadoc.
An Object is the base class required for all objects which conform to the Baja model. See BObject.bajadoc for more technical
information. See Object Model in the Developer Guide for more information on the model.
Offline refers to accessing a Bog File file directly when the Station is not running.
Open allows you to open any of the following:
Ctrl-L
Ctrl-O
Ctrl-Shift-O
Open Daemon (Niagarad)...
See the File menu reference for more information.
This term indicates one of two levels of permissions (admin and operator) available in NiagaraAX. Admin and Operator levels are further specified by the terms read, write, and invoke. So you may
have permission-levels of: operatorRead, operatorWrite adminRead, adminWrite, and so on.
allow you to customize the workbench for the way you use it. It can be selected from the main Menu by selecting ->. See Types of Workbench options for more information.
Ord is an "Object Resolution Descriptor". An ORD is Baja's universal identification system for integrating heterogeneous naming systems into a single string. An ORD is composed of one or more queries. Each query has a Scheme which identifies how to parse and resolve the query into an Object.
ord := query (ws "│" ws query)* query := scheme ws ":" ws body scheme := alpha (alpha │ digit)* body := bodyChar (bodyChar)* alpha := "a"-"z" │ "A"-"Z" digit := "0"-"9" bodyChar := 0x32 - 0x127 except "│" ws := (space)*
Also see “Naming” in the NiagaraAX Developer Guide, and About ORDs.
Overridden indicates that the user has manually set the value of a component.
Palettes allow you to save copies of your work for future use and are commonly associated with modules. Palette files may
reside under a station file system or as part of a module. Also see About palettes and To create a palette.
In a workbench view, the part of the locator bar that shows your current path (not including the view selector) is referred to as the pathbar. The pathbar automatically updates each time a new view is selected to display the Ord of each view. It also allows you to select part of the Ord, by clicking on it, to select a destination. See About the locator bar for more information.
Permissions define what rights a user has within each of the categories in a station. There are two Niagara permission levels: operator and admin. Within both levels, separate options exist for read access, write access, and invoke (action) access. See also, permissions.
This function provides the capability to make Properties of a component visible in the Wiresheet view of the component.
See also, Pin Slots.
Platform is the Niagara Platform Definition. See also, NiagaraAX Platform Guide.
A This is the term for a visualization (or view) for a component. A WbPlugin is a widget designed to provide plugin functionality in the Workbench tool environment.
Point extensions allow control point behavior to be extended in a consistent manner. Each property of a ControlPoint that
subclasses from a PointExtension is considered an extension on the point. Extensions allow plug-in functionality such as alarming
and historical data collection via special hooks that a ControlPoint provides to PointExtension.
Print provides automatic generation of a PDF for a view. Most standard widgets including labels, point widget, tables, Charts,
and most layout panes are handled. Access to the PDF visualization is through the Print command in both Workbench and browser
views.
Profiles provide NiagaraAX software engineers with the ability to customize both the desktop Workbench and the Web Workbench
interface. In addition, the type of profile used to login to the station can result in certain views being inaccessible even
if the user has permissions to access the view. For more details, see the NiagaraAX Graphics Guide section “About profiles”.
Properties are the visible data associated with a component. They provide the primary means of interacting with components. Most components properties are visible in the component property sheet” view.
Proxy is used locally to represent a remote object. See About the proxy extension for more information.
ProxyExt is the point extension supported in ControlPoints which are proxies for point data in an external system. See About the proxy extension.
A Px file contains Baja components. It can be a complete Database or any Collection of components. A Px File is a special
file that can provide a visualization for components in a Database. The PxEditor is a view used to create and modify Px files.
All views can be used on components in a Px just as if they were in a Station. For details, see the NiagaraAX Graphics Guide section “About Px files”.
Query is part of an "Object Resolution Descriptor". An ORD is composed of one or more queries. Each query has a scheme which identifies how to parse and resolve the query into an object. A query is made up of a scheme and a body. Also see, “Naming” in the NiagaraAX Developer Guide About ORDs.
For an enum typ comopnent, this is a range of ordinal/name pairs. Also, see Enum Range Dialog or Effect of facets on point actions.
This toolbar button or menu item causes an Action to be redone. It is only available after an undo. The shortcut is Ctrl-Alt-Z (hold down Ctrl and Alt and press Z).
This toolbar button or menu item refreshes a page after its source has been edited, or if you encounter a reason to reload
the view.
The registry is a term for a small Database built by Niagara Framework whenever it detects that a module has been added, changed, or removed. The registry may be used to interrogate the system for summary information about the modules, types, Ord Schemes, and Agents installed without loading modules into memory.
Rename allows you to change the name of a component. It is available on a component’s popup menu.
This toolbar and popup menu command is used to open Reorder dialog box when viewing a component’s slot sheet. A reorder
command is also available in the Point Manager view and in the Px Editor.
This search function feature allows you to replace the next occurrence in the currently opened file.
Replace Files allows you to replace the all occurrences in the files.
This command restarts the selected station.
Scheme is part of an "Object Resolution Descriptor". The scheme identifies how to parse and resolve the query into an Object. The scheme "local" is both a Host scheme and a session scheme. It represents objects found within the local VM. Some common schemes include:
ip Scheme
fox Scheme
file Scheme
module Scheme
station Scheme
slot Scheme
handle Scheme
spy Scheme
bql Scheme
See “Naming” in the Developer Guide and About ORDs.
Security in the Niagara framework covers some broad topics:
Authentication: Logging in and verifying a user
Encryption: When and how to use cryptography to secure data
Permissions: Configuring and verifying user Permissions on objects
Auditing: Logging user actions to create an audit trail
The heart of the Niagara security architecture is embodied by the UserService. The UserService contains a Table of SecurityDomains (see Security model overview), Profiles (see Security model overview), and Users. Domains are used to build groups of objects with common security needs. Profiles are used to define Permissions across zero or more Domains. Users are assigned to a Profile and used to represent an entity (human or machine) requiring authentication and security checks. See Security in the Developer Guide for more information.
This is the primary statement used to access information in a Database. See workbench:ProjectionBuilder for more information.
The selection is the set of currently selected items. Most operations in the system act on the selected items.
A Java program that runs as part of a network service, typically an HTTP Web Server and responds to requests from clients. The most common use for a servlet is to extend a Web Server by generating World Wide Web content dynamically. For example, a client may need information from a database; a servlet can be written that receives the request, gets and processes the data as needed by the client and then returns the result to the client. Applets are also written in Java but run inside the JVM of an HTML browser on the client. Servlets and Applets allow the server and client to be extended in a modular way by dynamically loading code which communicates with the main program via a standard programming interface. See also HttpServlet.bajadoc for more technical information.
Sidebar allows you to choose whether to view sidebars by selecting ->-> from the main menu. You can also select which sidebars you would like to view. See About side bars for more information.
Slots are the building blocks for defining Niagara components. There are three types of slots:
Property
Action
Topic
Also see About slots.
The "slot" Scheme is used to resolve a Value within a Complex by walking down a path of slot names. Slot queries always parse into a SlotPath. Also see About slots and About ORDs.
Space defines a group of Objects which share common strategies for loading, caching, lifecycle, naming, and navigation. Also see Types of space.
The "spy" scheme is used to navigate spy pages. The javax.baja.spy APIs provide a framework for making diagnostics information easily available. Also see Types of schemes.
SQL is an acronym for Structured Query Language. SQL is an American National Standards Institute (ANSI) standard for accessing Database systems.
Stale indicates that a situation has occurred which renders data untrustworthy. How stale is determined is a driver specific issue. However the common case is that a period of time has elapsed without a successful read. TuningPolicy provides a staleTime property for configuring this period of time.
Station is the component which represents a station in the Baja framework. See About stations, or “Station” in the Developer Guide for more information.
The "station" Scheme is used to resolve the componentSpace of a station Database. Also see Types of schemes
Status provides a bit mask for various standardized status flags in the Baja control architecture. Plus it provides for arbitrary extensions using facets. Also see, About point status
StatusColors are configurable by the baja lexicon and accessible by the Status API. You may use the Lexicon Editor to change these values. Entries include alarm, disabled, fault, down, overridden and stale :
Status.alarm.bg=#FFFF0000 Status.alarm.fg=#FFFFFFFF Status.disabled.bg=#FFD88AFF Status.disabled.fg=#FF000000 Status.fault.bg=#FFFFAA26 Status.fault.fg=#FF000000 Status.down.bg=#FFFFFF00 Status.down.fg=#FF000000 Status.overridden.bg=#FF86BEFF Status.overridden.fg=#FF000000 Status.stale.bg=#FF00FF00 Status.stale.fg=#FF000000
The WireSheet options allow you to choose whether to Show Status Colors. Also see, status flags.
StatusFormat is used to provide a simple pattern language for formatting status values. Patterns are strings with script commands embedded using the % character:
"Value=%value% Status=%status%"
Examples:
%value% = value using facets
%value(precision=2)% = value using 2 decimal places
%value(units=null)% = value using facets with no units
%value(units=null│precision=i:2)% = combination of previous two
%status% = status fully specified
{%status.flags%} %status.facets% = same as %status%
%status.flags% = status flags, but not facets
%status.facets% = status facets, but not flags
%status.activeLevel% = status active level
%value% {%status.flags%} @ %status.activeLevel%
The BNF grammar for the pattern language:
script := valScript │ statusScript valScript
:= "value" [ "(" valFacets ")" ] valFacets := valFacet [ "│"
valFacet ]* valFacet := valAddFacet │ valRemoveFacet
valAddFacet := name "=" value valRemoveFacet := name
"=null" value := DataUtil.marshal & unmarshal statusScript
:= "status" [ "." statusSubset ] statusSubset
:= statusFlags │ statusFacets │ statusFacetKey
statusFlags := "status.flags" statusFacets := "status.facets"
statusFacetKey := "status." nameAlso see, the Engineering Note document, BFormat (Baja Format) Property Usage.
StringPoint defines a read only control point with only an output element. Bajadoc is available at BStringPoint.bajadoc.
See also, Types of control points.
Subclasses provides a subclass tree of all that are subclassed from this item.
Tab allows you to view multiple views in the same Window. See Creating tabs in the view pane for more information.
Table displays a grid of rows and columns. See also, Table controls and options.
An element bounded by the marks "<" and ">" is a tag. Tags are used to mark the semantic or the structure of a document.
HTML and XML use tags. A sample is the tag <title> to mark the beginning of a title. See HTML Tags in the WbHtmlView for more information on tags supported by the HtmlView plugin.
A Toolbar is a row of button used to provide quick access to commonly used features. In the Niagara Framework there are two rows of buttons on the toolbar. The first are the common buttons that are always available. The second are the buttons based on the current view, mode and Selection. See also, About the toolbar
Topic defines a slot which indicates an event that is fired on a component. Also see About slots
This reverses the last Action as if it had not been performed. In Niagara it is only available for some actions. The shortcut
is Ctrl-Z (hold down Ctrl and press Z).
Up Level allows you to go to the next level up. The shortcut is Alt-Up. See Types of toolbar icons for more information.
Upload refers to receiving data from a device. In Niagara you may upload a station to its supervisor so that you have a backup of its database.
Uniform Resource Identifiers (URIs, aka URLs) are short strings that identify resources in the World Wide Web: documents, images, downloadable files, services, electronic mailboxes, and other resources. They make resources available under a variety of naming schemes and access methods such as HTTP, FTP, and Internet mail addressable in the same simple way.
URI is an extensible concept: there are a number of existing addressing schemes, and more may be incorporated over time.
Uniform Resource Locator (URL) is the standard way of addressing over the Internet. The Niagara Framework uses this convention for many of its resource locations.
This term represents is a valid name. It is used to logon to the system with a valid password.
There are many ways to view your system. One way is directly in the tree. In addition, you can right-click on an item and select one of its views from the popup menu. Plugins also provide views of components. See About the view selector and Viewing components for more information.
A Web Server is a computer that delivers (serves up) Web Pages. Every Web server has an IP address and possibly a domain name. For example, if you enter the URL http://www.niagaraframework.com/ in your browser, this sends a request to the server whose domain name is niagaraframework.com. The server then fetches the page named index.html and sends it to your browser. Any computer can be turned into a Web server by installing server software and connecting the machine to the Internet. There are many Web server software applications, including public domain software from NCSA and Apache, and commercial packages from Microsoft, Netscape and others.
The Where clause is used to specify that only certain rows of the Table are displayed, based on the criteria described in that Where clause. See workbench:QualifierBuilder for more information.
Widget is a class used to create light weight user interface components which can seamlessly be used in both the bajaui toolkit and in a 1.1 Applet environment.
A Window is a graphical area used to present a view of the system. This can refer to the primary window with Locator and
tree or user created windows. See Creating Additional Windows for more information.
Wizards are used to guide the user through common tasks. Some common wizards include:
New Station Wizard
Commissioning Wizard
New Module Wizard
This is the name for Niagara's Integrated Development Environment (IDE) for non-programmers.
eXtended Markup Language (XML) is a standard for tagging data. It is a subset of the Standard Generalized Markup Language (SGML) like HTML. See XML in the Developer Guide for more information.
Copyright © 2000-2014 Tridium Inc. All rights reserved.