Skip to main content
51.2.0.5
51.2.0.2
Main navigation
Close navigation
51.2.0.5
51.2.0.2
Main
Main
Active Framework
btibCore
General
Components with advanced config
Radius
Shadow
Facets
Px Properties
zCore Converters
SFormat to Simple Converter
TimeRangeDefinition
BtibCore palette
BtibService
BtibLicenseUpdateView
SPalette
TaskStatistics
Logs
Log Folder
Log Console Tool
LogExt
LogGroup
SystemLogExt
Selection
SelectionFolder
OrdSelection
MultiOrdSelection
SubscriptionSelection
TypeSubscriptionSelection
SFormatSelection
Resources
GeneralResource
AggregationResource
ChartTypeResource
DeltaResource
ShadeResource
Configuring General Resources for histories
RollupIntervalResource
ResourceFolder
GenericResource
BogResource
WidgetResource
ResourceDefinition
GeneralResourceDefinition
NameResource
SFormat
SFormatHelper
SFormat Labs
SFormatTester
SFormatToStatusValue
Method
Method Breaking Change
MemoryMonitor
BqlLib
btibDataFlow
Get started with DataFlow
BtibDataFlow Palette
DataFlow Block
Source
SelectionBlock
ConstantBlock
ScheduleBlock
Row
DeltaBlock
RollupBlock
DistribBlock
Calculation
CommutativeBlock
SubtractBlock
DivideBlock
Column
SFormatColumnBlock
ExtractColumnBlock
RenameColumnBlock
SetFacetsColumnBlock
Table
ConcatBlock
GroupBlock
TagBlock
Utils Blocks
TableDebugBlock
Terminal
HistoryBlock
CsvFile
JsonFile
Deprecated blocks
Aggregate
History Export
History Quantize
Standardize
btibLonTools
BtibLonTools palette
SelectiveBindHandler
btibStrategy
Strategy
General strategy parameters
Trigger
AutomaticTrigger
ForwardTrigger
MacroTrigger
ManualTrigger
SubscriptionTrigger
TypeSubscriptionTrigger
Block
Basic
AddComponent
RemoveComponent
SetSlot
RemoveSlot
InvokeAction
AddLink
AddRelation
RemoveRelation
RemoveHistory
AddMultiple
SetFlags
SetFacets
Rename
SetDisplayName
View
AddPxView
SetPxView
AddWidgetInPx
SetSlotInWidget
SetWidgetLayout
AddBindingInWidget
SetSlotInBinding
Utils
Debug
Reorder
OrganizeWiresheet
Artifact
SFormatArtifact
EntityArtifact
QueryArtifact
FilterPredicateArtifact
FilterConditionArtifact
ResourceArtifact
CsvArtifact
Miscellaneous
Copy
Move
AddTags
AddSyntheses Block
InvokeTask
ExtractFromList
AssignInfoSourceToModel
Autotagging
Forward
ForwardBlock
ForwardLoop
ForwardDelayed
ForwardRecursive
Operator
If
IfMultiple
Switch
SwitchType
Split
IfSplit
SwitchSplit
File
AddDirectory
AddNavFile
AddNodeToNavFile
Permission
AddCategory
AddRolePermissions
AssignRoleToUser
AssignCategory
Time Strategy
Sleep
Http
Basic Get
Basic Post
StrategyFolder
StrategyController
CurrentStrategy
btibStructure
General Notions Structure
Theoretical notions
Component structure
BtibStructure palette
Aspect
Node Creator
Creating a Node
Manipulating a Node in the Creation Zone
Editing the properties of a Node
Advanced NodeCreator features
Adding properties to Nodes
Importing / Exporting an Excel file
Management of the allows relation - Office attached to a facade
Management of the IsInMultiple relation - The duplex apartment
Multiple ascendants for a NodeDefinition - Cabinets in floors and offices
Recursion management - Zone inside a zone
NodeDefinition
CategoryOverride
Node
InfoSource
Passing tags in history and alarm extensions
HistoryDisplayName management
AssignmentView
Assigning a source to a Node
Inheritance of assignment from another source
AssignmentView advanced functions
Assignments to Multiple Nodes of an Aspect
Debug mode
Hiding a drop-down list during selection of a Node
InfoRemoteSource
Group
NodeGroupDefinition
NodeGroup
NodeTag
SourceTag
NodeRelation
SourceRelation
Importer
BsoProjectImporter
Dictionary
SFormatLevelDef
SortedLevelDef
SortingAlgorithm
NameListSortAlgorithm
NameSortAlgorithm
SortedGroupLevelDef
SortedListLevelDef
SortedQueryLevelDef
SortedRelationLevelDef
Propagation between stations
Initial step Configure your NiagaraNetworks
Model Propagation
Step 1 Configure the model propagation
Step 2 Launch a model propagation
Step 3 Configure the model propagation triggers
Source Propagation
Step 1 Configure the source propagation
Step 2 Launch a source propagation
Extension Propagation
Step 1 Configure the extension propagation
Step 2 Launch an extension propagation
GenericRemoteExt
GenericRemoteComponent
Propagation Diagnostic
InfoSource Propagation Browser
Propagation Components
ModelDeviceExt
AspectSyncTask
SourceDeviceExt
SourceSyncTask
SyncChannelController
SyncTaskController
btibStructure Workbench commands
Paste Model
Paste Source
Batch Assignment
Batch Inheritance
Glossary
btibToolkit
BtibToolkit palette
Alarm
AlarmCount
AlarmSynthesis
EnhancedHttpPostRecipient
HttpPostRecipient
LastAlarm
LocalAck
MultipleAlarmCounter
RecipientSwitch
ResetCountOffNormalTimes
SetHyperlinkOrd
SingleAlarmCounter
SlackRecipient
SlackRecipient Tutorial
StaleAlarmExt
Control
BooleanMeterDemux
BooleanToTrigger
CustomLeadLagRuntime
EnumMeterDemux
FirstStatusBooleanToStatusNumeric
MeanValue
NumericOneShot
NumericToTrigger
RSLatch
Sequence
btibToolkit Conversion
BqlColumnToStatusEnum
BqlToComponents
ComponentsToJson
DoubleToPoint
FormatToFacets
FormatToOrd
NumericFacets
PointToDouble
SFormatToFacets
SFormatToStatusString
StatusBooleanToLoopAction
StatusEnumToStatusString
StatusNumericToHex
StatusNumericToRelTime
StatusStringToFacets
StatusStringToSpecialEvent
StatusStringToStatusEnum
StatusStringToStatusNumeric
TransformStatusString
BooleanToEnum
Delay
EnumDelay
NumericDelay
StringDelay
Deprecated
StringToFacets
Email
AlarmEmailRecipient
EnumToMail
ReportEmailRecipient
StringToMail
btibToolkit Extensions
BooleanLastValidExt
EnumLastValidExt
NumericLastValidExt
StringLastValidExt
ExternalStatusOverrideExt
MeterExt
PermanentSubscribeExt
PointCheckExt
PointLogExt
ActionLogExt
StatusOverrideExt
SetNumericFallbackOnDelayExt
SetBooleanFallbackOnDelayExt
BBooleanCovIntervalHistoryExt
BEnumCovIntervalHistoryExt
BNumericCovIntervalHistoryExt
BStringCovIntervalHistoryExt
ManualHistoryExt
Global Command
BooleanGlobalCommand
EnumGlobalCommand
GlobalCommandExt
NumericGlobalCommand
StringGlobalCommand
Log
ActionLogExt (extension)
LogHistoryRecipient
PointLogExt (extension)
PointSelector
BooleanPointSelector
EnumPointSelector
NumericPointSelector
StringPointSelector
Report
ExportSourceBuilder
LogsExportSource
PersonalizedExportSource
TriggerSwitch
FileSource
StringToFile
FtpReportRecipient
ScheduleSelector
EnhancedBooleanScheduleSelector
EnhancedEnumScheduleSelector
EnhancedNumericScheduleSelector
EnhancedStringScheduleSelector
SmartOperator
SmartStatus
SmartAdd
SmartAverage
SmartMin
SmartMax
SmartAnd
SmartOr
SmartTimeTotalizer
SmartCountTotalizer
SmartNumericTotalizer
Summary
AlarmSourceNameSummary
BqlSize
NumericDataSummary
Time
DynamicTimeRangeBuilder
TimeAdd
TimeAddToDate
TimeBuilder
DateFormatter
Util
ClearHistories
ClearHistoryRecords
ClearHistoriesRecordsAfter
EnhancedHttpGet
EnhancedHttpPost
EqualsNaN
EqualsNull
FacetsSwitch
GenerateLink
HyperlinkSort
PowerCheck
ResetCategoryMask
StringSwitch
MultiGenerateLinks
RelationChecker
StopStationCommand
HistoryRecordsCleaner
Weather
Souscrire Un Abonnement Ć MĆ©tĆ©o France Pour Recevoir Les DJU
SunPosition
btibVision
BtibVision palette
btibVision Alarm
AlarmTableBuilder
AlarmTableBuilderView
AlarmTableView
DataSet
DataItem
DataSet (component)
FlexView
FlexView Main Concepts
Slider
Page
Card
Menu
Header
Footer
Import a FlexView
FlexView Advanced Concepts
Add edit mode in browser
Applying conditions on pages and cards
Master Slave behavior between cards
Setup user rights - View mode only
Update of Selections
FlexView Cards
AddResource
AlarmExtension
AlarmSummary
AssignmentSummary
ChartBookmark
ChartBuilder Card
ChartViewer
ComponentViewer
ConnectorDatabaseMaintenance
ConsumptionReportTable
ControlPointSummary
DataSetFilter
DeviceInformation
DynamicControl
EnhancedBoundTable Card
EPC
Gauge
HeatMap
HistoryExtension
HistoryListSelector
LiveChart Card
LogConsole
MapLocationView
Markdown
MaterialMenu
MultiPointCommand
NodeCreator Card
PeriodSelector
PointCommands
PointInformation
PxFileViewer
QueryToComponentViewer
QueryToMarkdown
RangeSlider (Card)
RankingChart
RelationExplorer
SimpleGauge
StatusHeader
TaggingSummary
TagHistoryListSelector
WebBrowser
MultiPointResetExt Card
Flew Views Examples
Create a list of component to display their respective view
FrameLayout
Container
Hierarchy item
Hyperlink
Title
View Item
Map
MapCoordinates
MapLocationContainer
Creating and configuring an Arcgis for Developers account
MapAddress
ClusterConf
MarkerDisplayValue
MarkerDisplaySFormat
MarkerEnhancedHyperlink
NodeDrawerFolder
NodeDrawer
Px file and sources configuration
Remote Node Creation With Virtualization
Remote Node Propagation
SourceSelectionTag
RangeSlider
RangeItem
RangeSlider (Component)
UIKit
btibVision Extensions
MultiPointsResetExt
LiveChart
LiveColumn
LivePie
LiveSpiderWeb
LiveStackedColumn
Pane
OverBorderPane
OverCanvasPane
ActiveProExcelExportButton
BqlToWidgets
ConfirmSaveButton
EnhancedBoundTable
EnhancedSlider
FlexWidgetLoader
MaterialLogin
SoundWidget
ChartBuilder
btibVisionLib
EnhancedScheduler
š ļøImplementation
š¢ Key Features
ā ļø Current Limitations
Active Pro
btibMacro
Get started with Macros
Step 1 Record a macro
Step 2 Play a Macro
Step 3 Modify a macro
Step 4 Go beyond with macros
Macro blocks
Add Component for macro
Add Link for macro
Add Multiple for macro
Add Relation for macro
Invoke Action for macro
Remove Component for macro
Remove Slot for macro
Set Facets for macro
Set Flags for macro
Set Slot for macro
btibExcel
Get started with Niagara and Excel
Step 1 Get licensed
Step 2 Export your first station to Excel
Step 3 Import your first Excel file
Excel Generalities
Main concepts
Composition of an Excel File
Main datasheet columns
All datasheet Columns
Supported Excel Functions
Excel features
Common features
Create a point with a specific proxy ext
Use Niagara templates
Components Sheet Features
Add tags
Set addresses for networks devices and points
Set alarm extensions
Set history extensions
Set facets
Remove tags
Set conversions
Define links
Remove links
Define relations
Remove relations
Define assignments (Active-Framework)
Remove assignments (Active-Framework)
Define inheritance (Active-Framework)
Remove inheritance (Active-Framework)
Read any slot value
Set any slot value
Add SubComponent
Remove a component
Rename a Component
Trigger actions on import
Create/Update an InfoSource (Active-Framework)
Define source relations (Active-Framework)
Remove Source Relations (Active-Framework)
Export All Source Tags (Active-Framework)
Export All Addon Tags (Active-Framework)
Model Sheet Features
Create Nodes
Define isIn relations
Active API
btibRestNetwork
BtibRestNetwork palette
ArtifactDefinition
Authentications
CustomCredentials
BasicAuth
ClientCredentials
EnlightedAuthentication
HMACAuthentication
JWTAuth
PasswordCredentials
Conditions
HttpCodeBetween
HttpCodeEquals
HttpCodeNotBetween
HttpCodeNotEquals
Conversions
Status Conversions
BooleanToStatus
NumericToStatus
StringToStatus
Flows
SplitGroup
SplitSeries
Value Conversions
BitMaskToNumeric
NumericToBoolean
StringBytesToNumeric
StringEncoding
StringSlice
StringToBoolean
StringToFloatNumeric
StringToNumeric
StringTrim
XmlToJson
V64ToJson
Pulse 4 Decoder
Histories
RestHistoryImport
JsonKeySelectorTester
Points
EnumPoint/EnumWritable
RestPointProxyExt
Writable Folder
WritableRestPointProxyExt
RequestSender
RestCallbackQuery
RestCallbackV1Servlet
RestNetwork
RestStatistics
RestQuery
RestScheduleDeviceExt
RestQueryFolder
RestSocketIoQuery
RestSSEQuery
Schedules
RestScheduleCreateExt
RestScheduleDeleteExt
RestScheduleImportExt
RestScheduleImportToReference
Specific
WattSense
WattSenseRestScheduleExportExt
WattSenseRestScheduleImportExt
Configurations
Artifact Selector
Http Config
JSON Key Selector
ScheduleConfig
SocketIoConfig
Writable Http Config
Examples
EcoWatt
Enedis
Synchronizing Microsoft Office 365 Outlook and Niagara schedules
Importing recurring events from Microsoft Outlook
HTTP and Web API
Tips & Tricks
btibAuth
Getting Started With JWT Authentication
btibAuth Palette
JwtAuthenticationScheme
btibAPI
Active API Documentation
ActiveFramework API v1
Connectors
btibConnector
Realtime Connectors
Communication mode
Outbound Data
[COM] Devices
[COM] Points
[COM] Status
[COM] Tags
[COM] Values
[COM] Histories
[COM] References
[COM] Control Schedule
[COM] AlarmRecipients
Inbound Data
Alarm Commands
Point Commands
Point Action
Send History
Control Schedule Commands
Add a recurring event to a schedule
Update a recurring event
Delete a recurring event
Add a special event to a schedule
Update a special eventĀ
Delete a special event
Multiple Commands
Real-time connectors concepts
Architecture
Data Types
Resource identification
Outbound data point value
Inbound commands
Alarm management
Request for historical values
Personalize Messages Payload
Data retention
Palette of generic components
RealTimeConnector
DeviceExt
PointExt
ReferenceExt
ScheduleExt
PointTestExt
AlarmRecipient
StatisticsExt
ExtensionCounter
MessageCounter
Timeseries Connectors
Timeseries Connector
Authentication Schemes
Asymmetric Keys Authentication
ClientCertificateAuthentication
btibIoTHub
Azure IoTHub connector specifics
Get Started with IoTHub
Step 1 Set up IoTHub on Azure
Step 2 Set up IoTHub connector for devices, points and references
Step 3 Send messages to IoTHub from Niagara
Step 4 Send alarms to IoTHub
Step 5 Send commands from IoTHub to Niagara
Step 6 Consume Data from IoTHub in Azure
Performance tips
IoTHub Palette Documentation
IoTHubConnector
IoTHubDeviceDatabaseMaintenance
IoTHubPointDatabaseMaintenance
IoTHubDeviceExt
IoTHubPointExt
IoTHubReferenceExt
IoTHubScheduleExt
IoTHubPointTestExt
Setup the azure cloud function for testing
IoTHubAlarmRecipient
btibAWS
AWS IoTCore Connector Specifics
Get Started with AWS IoT
Step 1 Set up AWS IoT
Step 2 Set up AWS connector for devices points and references
Step 3 Send messages to AWS from Niagara
Step 4 Send alarms to AWS
Step 5 Send commands from AWS to Niagara
AWS Palette Documentation
AwsIoTConnector
AwsIoTDeviceDatabaseMaintenance
AwsIoTDeviceExt
AwsIoTPointExt
AwsIoTReferenceExt
AwsIoTScheduleExt
AwsPointTestExt
AwsIoTAlarmRecipient
btibMqttConnector
MQTT connector specifics
Get started with MQTT and Niagara
MQTT Realtime Connectors
Step 1 Set up a broker and a client app
Step 2 Set up the MQTT connector for devices, points and references
Step 3 Send messages to MQTT broker from Niagara
Step 4 Send alarms to MQTT broker
Step 5 Send commands from mqtt to Niagara
MQTT Timeseries Connectors
Step 1 Setup an MQTT server
Step 2 Setup the mqtt timeseries connector
Step 3 Export data to MQTT server
MQTT Palette Documentation
MQTT Realtime Connectors Palette
MqttConnector
MqttDeviceExt
MqttPointExt
MqttReferenceExt
MqttScheduleExt
MqttPointTestExt
MqttAlarmRecipient
MqttHistoryTester
MQTT Timeseries Connector Palette
MqttTSConnector
MqttExportBlock
btibMongoDb
Mongo Db connector specifics
Get Started with MongoDb and Niagara
MongoDb Realtime Connectors
Step 1 Set up a MongoDb database
Step 2 Set up the MongoDb connector for devices, points and references
Step 3 Send messages to MongoDB from Niagara
Step 4 Send alarms to Mongo Database
Step 5 Send commands from MongoDb to Niagara
MongoDb Timeseries Connectors
Step 1 Setup MongoDB
Step 2 Setup the mongo timeseries connector
Step 3 Export data to MongoDB
Authentication
Username + Password authentication
X.509 Authentication
MongoDb Palette Documentation
MongoDb Realtime Connector
MongoDbRTConnector
MongoDeviceDatabaseMaintenance
MongoPointDatabaseMaintenance
MongoDeviceExt
MongoPointExt
MongoReferenceExt
MongoScheduleExt
MongoPointTestExt
MongoAlarmRecipient
MongoDb Timeseries Connector
MongoDbTSConnector
MongoDbExportBlock
BMongoHistoryExport
BExportChecker
btibElasticsearch
Get Started with Elasticsearch and Niagara
Step 1 Setup Elasticsearch
Step 2 Setup the elasticsearch timeseries connector
Step 3 Export data to Elasticsearch
Elasticsearch Palette Documentation
ElasticsearchTSConnector
ElasticsearchExportBlock
btibSQL
Get Started with SQL
Step 1 Setup an MySQL server
Step 2 Setup the SQL Timeseries Connector
Step 3 Export data to MySQL
SQL Palette Documentation
SqlExportBlock
SqlTSConnector
btibAzure
BtibAzure FlexView Cards
OneDrive Explorer
OneDrive Connector
OneDriveFileImporter
OneDriveSharedLibraryImportParams
OneDriveFolderImportParams
OneDriveFileImportParams
SharePointRecipient
btibIFC
IFCModelImporter
Update
IFCSitePredicateImportParams
IFCModelPredicateImportParams
Import
IFCSiteImportParams
IFCModelImportParams
ImportOnCondition
SFormat IFC Functions
rut
RutSmsController
Modem Configuration
Rut Service
RutSmsAlarmAcknowledger
RutSmsRecipient
Sending and Acknowledging Alarms via SMS
Breadcrumbs
Home
Active API
btibAPI
Active API Documentation
On this Page
ActiveFramework API v1
Open API Spec
