Skip to content

附录索引(appendix) ​

原文: https://finproducts.atlassian.net/wiki/spaces/JIDD3/pages/34793324695/FIN+5.3.1+appendix 中文整理基于 FIN 5.3.1

导读: 所有应用按字母顺序列出

以下为 API 参考,保留英文以便对照源码;目录已列出(英文标题便于检索);概述已尽量中译。


目录(导读) ​


API 正文(英文) ​

taxonomies ​

associationAssociations model ontological relationships between definitions
choiceChoice specifies an exclusive marker selection
deviceMicroprocessor based hardware device
equipEquipment asset
featureFeature namespace of definitions formatted as feature:name
markerMarker labels a dict with typing information
observableObservable subscription - see docs
phenomenonAspect of scientific interest with measurable quantities
pointData point such as a sensor or actuator
processIndustrial or HVAC process
protocolCommunication protocol used for devices on a network
quantityMeasurable property of a substance or phenomenon
relationshipRef tags used to model entity-to-entity relationships
siteSite is a geographic location of the built environment
spaceSpace is a three-dimensional volume in the built environment
systemGrouping of related equipment dedicated to a single application
valData value type

All apps listed alphabetically

arcViews used to browse and edit arc documents
builderViews used to build the database
cloneManage clone replication
codeViews used to edit and manage the function library
connViews used to manage and debug connectors
debugViews used for system diagnostics
docViews used to browse the documentation
dockerViews used to manage Docker images
energyViews used to visualize and analyze energy data
energyStarViews used for Energy Star Portfolio Manager integration
favsViews used to browse and manage your saved favorites
ghgViews used to visualize and analyze Greenhouse Gas Emissions
hisViews used to visualize and analyze historical point data
homeHome screen showing the available applications
hostViews used to manage the system which hosts the software
kpiViews used to visualize KPI rule results
mapVisualize data on a geographic map
miscContainer for ad hoc views
monitorViews used to visualize real-time point data
platformPlatform level configuration and management
provViews used for provisioning software over the cluster
ruleViews used to manage configured analytic rules
scheduleViews used to manage schedules
settingsViews used to edit SysMod and Ext settings
sparkViews used to visualize spark rule results
taskViews used to configure and debug tasks
toolsViews used for administration including the Axon shell
usersViews used to manage user accounts
weatherViews to visualize and configure weather stations

associationAssociations model ontological relationships between definitions
isDefines one or more supertypes of a subtyping relationship
quantitiesQuantities used to measure this phenomenon
quantityOfAssociates quantity as measurement of a phenomenon
tagOnThis tag is used on the given entity
tagsTags used with this entity


quick ​

langAxon language syntax
usageExamples for using common functions
streamsAsynchronous streams
compsAxon component model

core ​

axonAxon core library
hxHaxall framework definitions
skyarcSkyarc library module
ioI/O function library
hisHistorian core functionality
hisKitHistorian analytics function library
taskAsync task engine
xqueryXQuery support module

misc ​

alarmAlarm Extension
alarmConfig
arcArc compound document extension
bacnetServerBACnet Server Extension
cloneCloning rec based replication extension
connConnector framework
controlControl Engine Extension
dockerDocker management
emailOutbound email via SMTP
energyEnergy analytics
eventEvent database engine
fin5CoreFIN
finAmChartsReactExt
finBlockProgrammingFIN Block Programming
finDashboardFIN Dashboard Editor Extension
finGraphicResourcesFunctions and assets required for various FIN Builder items
finHtmlReportingHtml Reporting Extension
finNHaystackExtFIN NHaystack
finNetworkFIN Network Extension
finServerExtFIN
finStackHubToolsFIN StackHub App
finStackMobileThe FIN
finSvgGaugesReactExt
finToolsFIN tools
finWatcherFIN Watcher Extension
finWindowsDeviceFIN
finstackFINStack Services
geoGeolocation function library
ghgGreenhouse Gas Emission Extension
greenButtonGreen Button function library
html2pdfAxon extension library to convert webpages to pdf
httpHTTP service handling library
hvacHVAC utility and rule functions
jobJob management (deprecated)
logLogging engine
mathMath function library
mlMachine learning (ML) function library
mustacheMustache Extension
navSupport for UI navigation
notificationNotification Extension
notifyNotification Extension
pointPoint historization and writable support
projProject management module
provProvisioning management
pyPython inter-process communication
replSupport for replication
ruleRule engine to compute sparks, KPIs, and curVals
scheduleScheduling and calendars
siemens2dResourcesSiemens Components [siemens2D] styles
tariffUtility tariff engine
templateWizardExt
uiSupport for Fresco UI
userUser management module
weatherWeather service and functions
xetoXeto spec and data function library
xmlXML function library

conns ​

arcbeamArcbeam connector extension
bacnetBACnet Extension
ecobeeEcobee connector
energyStarEnergyStar Portfolio Manager connector
finMailFIN Email Client Extension
finStackCoreFIN host services
haystackHaystack HTTP API connector
knxKNX Connector Extension
modbusModbus connector
mqttMQTT connector
nestGoogle Nest connector
obixoBIX connector
opcOPC-UA connector
sedonaSedona Sox connector
snmpSNMP connector
sqlSQL connector
trendTrend Connector

choiceChoice specifies an exclusive marker selection
ahuZoneDeliveryAHU delivery method of conditioned air to the zone
chilledBeamZoneAHU supplies air to chilled beam terminal units
directZoneAHU supplies air directly to the zone
multiZoneAHU discharge air is split into a duct per zone
vavZoneAHU supplies air to VAV terminal units
airVolumeAdjustabilityAbility of air handling equip to adjust volume of air flow
constantAirVolumeDelivers a constant volume of air flow
variableAirVolumeDelivers a variable volume of air flow
arcTypeDocument type which determines workflow
atesDesignDesign type of the ATES underground system
atesClosedLoopThe ATES uses closed piping to transport a water/glycol mixture through the ground
atesDoubletThe ATES has one or more pairs of a separate warm and cool well
atesDoubletPairedThe ATES is as a doublet, but with specific warm and cool wells linked together
atesMonoThe ATES has only one physical well
atesUnidirectionalSimilar to a doublet, but water always flows in the same direction from the extraction to the infiltration well
chillerMechanismPrimary mechanism of chiller
chiller-absorptionCooling process using energy from heat source such as hot water
chiller-centrifugalCompression via a continuous flow of fluid through an impeller
chiller-reciprocalPiston compressor driven by a crankshaft
chiller-rotaryScrewRotary screw compression
condenserLoopOpen or closed loop for condenser working fluid
condenserClosedLoopWorking fluid is kept separate from fluid used for heat transfer into the atmosphere
condenserOpenLoopUses working fluid itself for evaporation into the atmosphere
coolingProcessProcessed used to cool a substance
airCoolingCooling by dissipating heat into the surrounding air
chilledWaterCoolingCooling using transfer of heat to chilled water
condenserCoolingRemoval of heat through the process of water condensation
dxCoolingCooling using direct expansion of a refrigerant vapor
waterCoolingCooling using transfer of heat to water which is not explicitly chilled
ductConfigDuctwork configuration
dualDuctTwo ducts
singleDuctOne single duct
tripleDuctThree ducts
ductDeckCold, hot, or neutral deck
coldDeckDuct carries air for cooling
hotDeckDuct carries air for heating
neutralDeckDuct carries air which by-passes both heating and cooling coils
ductSectionEquipment section of ductwork
dischargeDuct for air leaving an equipment
economizerDuct to access fresh outside air only for economizing, not ventilation
exhaustDuct used to expel air back outside
flueDuct for exhausting combustion
inletDuct with air entering an equipment
mixedDuct where fresh outside air and return air is mixed together
outsideDuct to access fresh outside air for both ventilation and economizer
returnDuct returning air back to equipment
ventilationDuct to access fresh outside air only for ventilation, not economizing
heatingProcessProcessed used to heat a substance
biomassHeatingHeating by the combustion of biomass
coalHeatingHeating by the combustion of coal
dxHeatingHeating using direct expansion of a refrigerant vapor
elecHeatingHeating by the conversion of electrical energy
fuelOilHeatingHeating by the combustion of fuel oil
hotWaterHeatingHeating using energy of hot water
naturalGasHeatingHeating by the combustion of natural gas
propaneHeatingHeating by the combustion of propane
steamHeatingHeating using energy of steam
meterScopeClassifies a meter as a main site meter or submeter
siteMeterMain meter for the associated site
submeterSubmeters measure usage of a sub-system or equipment within a site
observesObservable subscription - see docs
pfScopePower factor scope
pfDisplacementDisplacement power factor, which accounts for the phase angle between voltage and current but excludes effects of nonlinear waveforms ( harmonic distortion)
pfDistortionDistortion power factor, which measures the component of power factor attributable to harmonic distortion in voltage and current waveforms
pfTrueTrue power factor, which includes effects of harmonic distortion
pfStandardStandard for interpreting power factor's positive or negative sign
pfIecPower factor according to the IEC convention defines a positive or negative sign based on the direction of active power flow
pfIeeePower factor according to the IEEE convention defines a positive or negative sign based on whether the load is capacitive or inductive
phaseCountNumber of phases for an AC electrical power system or connected equipment
singlePhaseSingle-phase AC electricity
splitPhaseSplit-phase AC electricity
threePhaseThree-phase AC electricity
twoPhaseTwo-phase AC electricity
pipeFluidType of fluid conveyed by piping
pipeSectionEquipment section of piping
bypassPipe used to bypass an equipment
circPipe used to circulate fluid through an equipment or system
enteringPipe conveys fluid into an equipment
headerPipe used as central connection or manifold for other piping runs
leavingPipe conveys fluid out of an equipment
plantLoopPlant piping loop
primaryLoopPipework which circulates closest to the energy source
secondaryLoopPipework which circulates closest to the building or end use
tertiaryLoopPipework which circulates within the building
pointFunctionClassifies the point as a sensor, command, or setpoint
cmdPoint is a command, actuator, AO/BO
sensorPoint is a sensor, input, AI/BI
spPoint is a setpoint, soft point, internal control variable, schedule
syntheticSynthetic point with computed operational data
computedComputed point
mlMachine learning point
simSimulation point
pointQuantityQuantity the point senses or controls
pointSubjectWhat the point senses or controls
ruleTypeRule type choice
curRuleMarker tag for a cur rule type
kpiRuleMarker tag for a KPI rule type
sparkRuleMarker tag for a spark rule type
simScenarioSee Synthetics chapter
simBaselineSee Synthetics chapter
simOperationSee Synthetics chapter
simOptimumSee Synthetics chapter
tankSubstanceSubstance stored by a tank
vavAirCircuitHow does the VAV pull in air
vav-parallelVAV pulls air from outside the primary air flow
vav-seriesVAV pulls air from the primary air flow
vavModulationHow does VAV modulate the temp based on duct pressure
pressureDependentVAV damper modulates to control space temp
pressureIndependentVAV damper or a control valve that modulates to maintain desired flow setpoint

All tag conjuncts listed alphabetically

ac-elecAlternating current electricity
ac-elec-meterAC Electricity meter
ac-evse-portAn AC EVSE port delivers ac electricity to a single EV charging inlet at a time
ac-freqFrequency of an alternating current waveform
active-energyActive energy in an AC eletrical power system
active-powerActive power or real power
air-conditioning-systemSystem for air treatment to control its temperature, humidity, cleanliness, and distribution to meet the requirements of a conditioned space
air-exhaust-systemSystem consisting of one or more fans that remove air from the building
air-inputEntity inputs air which flows from another entity
air-outputEntity outputs air to other entities
air-systemSystem for moving air to maintain indoor thermal comfort and/or air quality
air-tempDry bulb temperature
air-velocityRate of air movement as distance over time
air-ventilation-systemSystem that supplies or removes air by natural or mechanical means to or from any space in order to provide outdoor air to the space
apparent-energyApparent energy in an AC eletrical power system
apparent-powerApparent power
atmospheric-pressureBarometric pressure exerted by the weight of the atmosphere
blowdown-waterWater expelled from a system to remove mineral build up
blowdown-water-inputEntity inputs blowdown water which flows from another entity
blowdown-water-outputEntity outputs blowdown water to other entities
ch2o-concentrationConcentration of formaldehyde (CH₂O) in the air
ch4-emissionGreenhouse gas emission of methane (CH₄) into the air
chilled-waterWater cooled for use in HVAC and industrial processes
chilled-water-inputEntity inputs chilled water which flows from another entity
chilled-water-outputEntity outputs chilled water to other entities
chilled-water-plantPlant used to generate chilled water for cooling
chilled-water-systemSystem that circulates water in its liquid state below ambient temperature for cooling a space or process
chiller-absorptionCooling process using energy from heat source such as hot water
chiller-centrifugalCompression via a continuous flow of fluid through an impeller
chiller-reciprocalPiston compressor driven by a crankshaft
chiller-rotaryScrewRotary screw compression
co-concentrationConcentration of carbon monoxide (CO) in the air
co2-concentrationConcentration of carbon dioxide (CO₂) in the air
co2-emissionGreenhouse gas emission of carbon dioxide (CO₂) into the air
cold-waterWater supplied to cold taps
computed-pointSee Synthetics chapter
condensate-inputEntity inputs condensate which flows from another entity
condensate-outputEntity outputs condensate to other entities
condenser-waterWater used used to remove heat through condensation
condenser-water-inputEntity inputs condenser water which flows from another entity
condenser-water-outputEntity outputs condenser water to other entities
condenser-water-systemSystem that circulates water in its liquid state for rejecting heat from a space or process
controls-panelPanel housing controllers and networking gear
cool-waterRelatively cool water without active chilling
cur-pointPoint with support to report a "real-time" current value
current-angleAC current phase angle
current-imbalanceAC current phase imbalance
current-magnitudeRoot-mean-square (RMS) magnitude of AC electrical current
current-thdTotal harmonic distortion (THD) of AC current
damper-actuatorActuator to regulate the flow of air
dc-elecDirect current electricity
dc-elec-meterDC Electricity meter
dc-evse-portA DC EVSE port delivers dc electricity to a single EV charging inlet at a time
domestic-cold-water-systemSystem that circulates potable cold water in its liquid state for purposes other than space cooling and process requirements
domestic-hot-water-systemSystem that circulates potable hot water in its liquid state for purposes other than space heating and process requirements
domestic-waterTap water for drinking, washing, cooking, and flushing of toilets
domestic-water-inputEntity inputs domestic water which flows from another entity
domestic-water-outputEntity outputs domestic water to other entities
domestic-water-systemSystem that circulates potable water in its liquid state for purposes other than space conditioning and process requirements
elec-currentElectrical current
elec-demandActive power averaged over a regular interval
elec-energyElectrical energy
elec-inputEntity inputs electricity which flows from another entity
elec-meterElectricity meter
elec-outputEntity outputs electricity to other entities
elec-panelPhysical housing for electrical circuits, fuses, and breakers
elec-powerRate of electrical energy transfer
elec-systemSystem that generates, converts, distributes, and/or stores electricity
elec-voltElectrical voltage, potential difference
evse-cableThe electrical cable between an evse-port and an EV charging inlet on a vehicle
evse-dispenserEquipment that dispenses electricity to an EV
evse-equipEquipment that supports the delivery of electricity to charging inlets located on EVs
evse-portAn EVSE port delivers electricity to a single EV charging inlet at a time
evse-powerConverterA power converter that has a dc electrical output applied to a dc-evse-port
evse-systemA system that supplies electricity to EVSE assembly equipment and its auxiliary loads
fan-motorMotor used with a fan to create air flow
flow-meterMeter to measure flow rate and total volume of fluid
fuelOil-inputEntity inputs fuel oil which flows from another entity
fuelOil-outputEntity outputs fuel oil to other entities
gasoline-inputEntity inputs gasoline which flows from another entity
gasoline-outputEntity outputs gasoline to other entities
ground-floorFloor at ground level
ground-waterWater present under the ground or from a well
hfc-emissionGreenhouse gas emission of hydrofluorocarbons into the air
his-pointHistorized point with a history log of timestamp/value pairs
hot-waterHot water used for HVAC heating or supplied to hot taps
hot-water-boilerBoiler which outputs hot water
hot-water-inputEntity inputs hot water which flows from another entity
hot-water-outputEntity outputs hot water to other entities
hot-water-plantPlant used to generate hot water for heating
hot-water-systemSystem that circulates water in its liquid state for heating a space or process
humidifier-equipEquipment which adds moisture to air to increase humidity
hvac-zone-spaceZone related to conditioning of a space's air temperature and quality
light-levelSensed or controlled dimming level of electrical lighting
lighting-systemSystem designed to provide lighting
lighting-zone-spaceZone related to lighting system
luminous-fluxTotal perceived light in all directions
luminous-intensityPerceived light in a particular direction per unit solid angle
makeup-waterWater used used to makeup water loss through leaks, evaporation, or blowdown
makeup-water-inputEntity inputs makeup water which flows from another entity
makeup-water-outputEntity outputs makeup water to other entities
ml-pointSee Synthetics chapter
mobile-phoneCellular phone providing telecommunication over radio links
n2o-emissionGreenhouse gas emission of nitrous oxide (N₂O) into the air
naturalGas-inputEntity inputs natural gas which flows from another entity
naturalGas-outputEntity outputs natural gas to other entities
networking-deviceMicroprocessor device used to establish networks
networking-routerNetworking device used to route data between different networks
networking-switchNetworking device used to connect devices on the same network
nf3-emissionGreenhouse gas emission of nitrogen trifluoride (NF₃) into the air
nh3-concentrationConcentration of ammonia (NH₃) in the air
no2-concentrationConcentration of nitrogen dioxide (NO₂) in the air
o3-concentrationConcentration of ozone (O₃) in the air
pfc-emissionGreenhouse gas emission of perfluorocarbons into the air
pm01-concentrationConcentration of particulate matter 0.1 in the air
pm10-concentrationConcentration of particulate matter 10 in the air
pm25-concentrationConcentration of particulate matter 2.5 in the air
pump-motorMotor used with a pump to move fluid
purge-waterWater expelled from a system to remove contaminants
reactive-energyReactive energy in an AC eletrical power system
reactive-powerReactive power or imaginary power
refrig-inputEntity inputs refrigerant which flows from another entity
refrig-outputEntity outputs refrigerant to other entities
refrig-systemRefrigerant distribution to fulfill all or parts of a refrigeration cycle
roof-floorThe roof floor is the topmost level of a building
server-computerGeneral purpose computer used as a server
sf6-emissionGreenhouse gas emission of sulphur hexafluoride (SF₆) into the air
sim-pointSee Synthetics chapter
solar-irradianceEnergy received on surface of the earth from the sun
steam-boilerBoiler which outputs steam
steam-inputEntity inputs steam which flows from another entity
steam-outputEntity outputs steam to other entities
steam-plantPlant used to generate steam for heating
steam-systemSystem that circulates water in its vapor state for heating a space or process
subterranean-floorFloor below ground level
synthetic-pointSee Synthetics chapter
tvoc-concentrationConcentration of total volatile organic compounds (TVOC) in the air
valve-actuatorActuator to regulate the flow of fluid
vav-parallelVAV pulls air from outside the primary air flow
vav-seriesVAV pulls air from the primary air flow
vfd-freqVFD frequency measured in "Hz"
vfd-speedVFD speed measured in "%"
volt-angleAC voltage phase angle
volt-imbalanceAC voltage phase imbalance
volt-magnitudeRoot-mean-square (RMS) magnitude of AC electrical voltage
volt-thdTotal harmonic distortion (THD) of AC voltage
vrf-coolingOnly-systemCooling only VRF system can only cool
vrf-equipEquipment used in VRF systems
vrf-heatPump-systemHeat pump VRF system can either heat, or cool, but not at the same time
vrf-heatRecovery-systemHeat recovery VRF system can operate cooling and heating by each indoor unit independently, at the same time
vrf-indoorUnitIndoor unit in a VRF system
vrf-indoorUnit-fcuIndoor unit fan coil unit in a VRF system
vrf-outdoorUnitOutdoor unit with one or more compressors in a VRF system
vrf-refrig-plantGroup of outdoor units in a VRF system
vrf-systemVariable refigerant flow system
warm-waterRelatively warm water without active heating
water-systemSystem that supplies or collects potable or non-potable water in any state
weather-pointWeather station observation point
wind-directionCompass direction from which wind originates
wind-speedWind flow speed
writable-pointPoint with writable output using 16-level priority array
zone-spaceSpace associated with a specific system

deviceMicroprocessor based hardware device
computerGeneral purpose computer
laptopPortable laptop computer
server-computerGeneral purpose computer used as a server
controllerMicroprocessor based device used in a control system
networking-deviceMicroprocessor device used to establish networks
networking-routerNetworking device used to route data between different networks
networking-switchNetworking device used to connect devices on the same network
phoneTelephone used for voice telecommunication
mobile-phoneCellular phone providing telecommunication over radio links
tabletMobile device with touch screen for user input

equipEquipment asset
actuatorEquipment to move or control a mechanism
damper-actuatorActuator to regulate the flow of air
valve-actuatorActuator to regulate the flow of fluid
airHandlingEquipHVAC equipment that conditions and delivers air via one or more fans
ahuAir Handling Unit
doasDedicated Outside Air System
mauMakeup Air Unit
rtuRoof Top Unit
fcuFan Coil Unit
cracComputer Room Air Conditioner
unitVentUnit Ventilator
vrf-indoorUnit-fcuIndoor unit fan coil unit in a VRF system
airTerminalUnitEquipment in air distribution systems which terminate at the space
cavConstant air volume terminal unit
vavVariable air volume terminal unit
atesAquifer Thermal Energy Storage system
batteryEquipment used to store electric energy
boilerEquipment to generate hot water or steam for heating
hot-water-boilerBoiler which outputs hot water
steam-boilerBoiler which outputs steam
cableAn assembly of one or more insulated conductors
chillerEquipment to remove heat from a liquid
circuitElectrical circuit and its associated components such as breakers
conduitDuct, pipe, or cable to convey a substance or phenomenon
ductConduit used to convey air for HVAC
pipeConduit used to convey a fluid
wireCabling used to convey electricity or data
coolingTowerEquipment to transfer waste heat into the atmosphere
evse-equipEquipment that supports the delivery of electricity to charging inlets located on EVs
evse-cableThe electrical cable between an evse-port and an EV charging inlet on a vehicle
evse-dispenserEquipment that dispenses electricity to an EV
evse-portAn EVSE port delivers electricity to a single EV charging inlet at a time
ac-evse-portAn AC EVSE port delivers ac electricity to a single EV charging inlet at a time
dc-evse-portA DC EVSE port delivers dc electricity to a single EV charging inlet at a time
evse-powerConverterA power converter that has a dc electrical output applied to a dc-evse-port
flowInverterSystem to change direction of substance flow
fumeHoodVentilation equipment to limit exposure to hazardous fumes
heatExchangerEquipment to transfer heat between two working fluids
coilHeat exchanger used to heat or cool air
coolingCoilCoil used to cool air
heatingCoilCoil used to heat air
humidifier-equipEquipment which adds moisture to air to increase humidity
luminaireLight fixture using electricity to provide illumination
meterEquipment to meter a substance or phenomenon
elec-meterElectricity meter
ac-elec-meterAC Electricity meter
dc-elec-meterDC Electricity meter
evse-portAn EVSE port delivers electricity to a single EV charging inlet at a time
ac-evse-portAn AC EVSE port delivers ac electricity to a single EV charging inlet at a time
dc-evse-portA DC EVSE port delivers dc electricity to a single EV charging inlet at a time
flow-meterMeter to measure flow rate and total volume of fluid
motorEquipment that converts electrical energy into mechanical energy
fan-motorMotor used with a fan to create air flow
pump-motorMotor used with a pump to move fluid
panelEnclosure for electrical and control equipment
controls-panelPanel housing controllers and networking gear
elec-panelPhysical housing for electrical circuits, fuses, and breakers
plantCentral plant used to generate a substance for a process
chilled-water-plantPlant used to generate chilled water for cooling
hot-water-plantPlant used to generate hot water for heating
steam-plantPlant used to generate steam for heating
vrf-refrig-plantGroup of outdoor units in a VRF system
rackEnclosure or chassis used to mount computer and networking gear
radiantEquipHVAC equipment that conditions a space without forced air
chilledBeamConditions a space using a heat exchanger integrated into the ceiling
radiantFloorHeats a space using pipes or cables embedded beneath floor
radiatorHeats a space using exposed pipes or coils
tankTank used to store a substance for temporary holding
thermostatSenses and controls temperature of space in HVAC system
upsUninterruptible power supply
verticalTransportEquipment to move humans and materials
elevatorEnclosure used to move people between floors
escalatorMoving staircase used to move people between floors
movingWalkwayConveyor to move people across a horizontal or inclined plane
vrf-equipEquipment used in VRF systems
branchSelectorBranch selector used for heat recovery in a VRF system
vrf-indoorUnitIndoor unit in a VRF system
vrf-indoorUnit-fcuIndoor unit fan coil unit in a VRF system
vrf-outdoorUnitOutdoor unit with one or more compressors in a VRF system
wellA well is a source of groundwater and potentially thermal energy


manuals ​

docIntroFantom overview and getting started
docLangFantom language documentation
docDomkitFantom DomKit HTML5 UI framework documentation
docToolsFantom command line tools

core ​

sysFantom system runtime
haystackHaystack model and client API
axonAxon scripting engine
folioFolio database APIs
hxHaxall framework APIs
skyarcSkySpark framework APIs
skyarcdSkySpark framework daemon APIs
hxConnHaxall connector framework

ui ​

graphicsGraphics API
domWeb Browser DOM API
domkitDOM Based UI Framework
uiFresco user interface framework

misc ​

alarmExtAlarm Extension
asn1ASN.1 Data Model
bacnetExtBACnet Extension
bacnetServerExtBACnet Server Extension
buildFantom build utility
concurrentUtilities for concurrent programming
controlExtControl Engine Extension
cryptoCryptography API
emailEmail support
fancFan command line compiler
fandocFandoc parser and DOM
finFIN core extension APIs
fin5CoreExtFIN
finAmChartsReactExt
finAppFIN application framework
finBacnetExtFin BACnet Extension
finBuildFIN Build Utility
finBuilderExtFIN
finChartBuilderFIN chart builder application
finConnFIN core connector extension APIs
finDashboardExtFIN Dashboard Editor Extension
finEdge2CloudFIN's Edge2Cloud
finFolioLiteExt
finHtmlReportingHtml Reporting Extension
finMailExtFIN Email Client Extension
finMiniDBExt
finNHaystackExtFIN NHaystack
finNetworkExtFIN Network Extension
finOidcFIN OpenID Connect SSO
finSchedulerFIN scheduler application
finServerExtFIN
finSettingsSettings app and definition module for FIN
finSmtpSiemens Desigo Optic SMTP Oauth Library
finStackCoreExtFIN host services
finStackExtFINStack Services
finStackHostFinStack Host
finStackHubToolsExtFIN StackHub App
finStackSerialSerial port provider
finSvgGaugesReactExt
finWatcherExtFIN Watcher Extension
finWindowsDeviceFIN
html2pdfExtAxon extension library to convert webpages to pdf.
hxCompsCore Components Library
hxPyPython IPC
inetIP networking
j2FinToolsExtFIN tools
knxKNX Library
knxExtKNX Connector Extension
markdownMarkdown parsing and rendering
mathMath utilities and functions
mustacheExtMustache Templating System
notificationExtNotification System
obsObservable data stream framework
purgeExtPurge Extension for automated clean-up of alarms, histor...
sqlRelational database access
stackhubStackHub library
syntaxSyntax styling for programming languages
trendExtTrend Connector
utilUtilities
webStandard weblet APIs for processing HTTP requests
webmodStandard library of WebMods
wispWisp web Server
xetoXeto data and spec APIs
xmlXML Parser and Document Modeling
yamlYAML parser for Fantom

featureFeature namespace of definitions formatted as feature:name
appUI application grouping of views
filetypeFile format type definition
finDashboardFeature namespace of definitions formatted as feature:name
finDropOverrideFeature namespace of definitions formatted as feature:name
funcAxon function
libLibrary module of symbolic definitions
extExtension library
sysModSystem module library
opOperation for HTTP API
tagLegacy backward compatible tag definitions
viewFresco UI view

All filetypes listed alphabetically

csvComma Separated Values - see CSV
excelExcel 2003 XML spreadsheet
htmlHyperText Markup Language
jsonHaystack JavaScript Object Notation format - see Json
jsonldJavaScript Object Notation for Linked Data - see RDF
pdfPortable Document Format
svgScalable Vector Graphics
trioHaystack Tag Record Input Output - see Trio
turtleRDF Turtle - see RDF
xmlEXtensible Markup Language
zincHaystack typed CSV format - see Zinc

All finDropOverrides listed alphabetically

finNetworkTree___connTuningFeature namespace of definitions formatted as feature:name
finNetworkTree___connectorsFeature namespace of definitions formatted as feature:name
finNetworkTree___equipTreeFeature namespace of definitions formatted as feature:name
finNetworkTree___finSettingsTreeFeature namespace of definitions formatted as feature:name
finNetworkTree___finSnapshotsTreeFeature namespace of definitions formatted as feature:name
finNetworkTree___graphicsFeature namespace of definitions formatted as feature:name
finNetworkTree___jobFeature namespace of definitions formatted as feature:name
finNetworkTree___programsFeature namespace of definitions formatted as feature:name
finNetworkTree___relationshipFeature namespace of definitions formatted as feature:name
finNetworkTree___savedQueryFilterFeature namespace of definitions formatted as feature:name
finNetworkTree___schedulesFeature namespace of definitions formatted as feature:name
finNetworkTree___tagBundleFeature namespace of definitions formatted as feature:name
finNetworkTree___templateFeature namespace of definitions formatted as feature:name
finNetworkTree___topicFeature namespace of definitions formatted as feature:name

All funcs listed alphabetically

aboutReturn about dict
absReturn absolute value of a number, if null return null
acosReturn the arc cosine
actionNormInputNormalize action input - see Committer.actionNormInput
addAdd item to the end of a list and return a new list
addAllAdd all the items to the end of a list and return a new list
addColAdd a column to a grid by mapping each row to a new cell value
addColMetaReturn a new grid with additional column meta-data
addColsAdd grid b as a new set of columns to grid a
addMetaReturn new grid with additional grid level meta-data tags
addNavURI
addReport
addRowAdd an additional Dict row to the end of a grid
addRowsAdd an list of rows to the end of a grid
addSimilarTypesAxon function
addStateMachineVarsAxon function
addVarIdsAxon function
ahuCoolAndEconCompute periods when AHU is in both cooling and economizing modes
ahuCoolAndHeatCompute periods when AHU is in both cooling and heating modes
ahuCoolHeatCyclingCompute periods between cooling and heating which do not meeting a min time
ahuCoolPeriodsCompute periods when AHU is in cooling mode or matches given criteria
ahuEconPeriodsCompute periods when AHU is in economizing mode when the damper position is over 10%
ahuFanFailureParams
ahuFanPeriodsCompute periods when AHU's supply fan is running or matches given criteria
ahuHeatAndEconCompute periods when AHU is in both cooling and economizing modes
ahuHeatPeriodsCompute periods when AHU is in heating mode or matches given criteria
ahuOnAndFanOffParams
alarmAckGiven a set of alarms (or alarm ids), acknowledge them and return the updated alarm records
alarmActivityPeriodsExample
alarmConfigAppAxon function
alarmDigestGenerate an alarm digest grouped by a given parent type
alarmHistoryCountGiven an optional target, return the count of alarm history records
alarmHistoryQueryGiven a Haystack query string, return the alarm history records as a grid
alarmNavCountsGiven a grid of target records with id, enrich it with rolled-up alarm counts per row
alarmTargetsGiven a root object, return all alarm target records associated with it
alarmsGiven optional targets and/or a time span, return the current alarm records as a grid
alarmsGetByIdGiven an alarm id, return the corresponding alarm record
alarmsRemoveGiven a set of alarms (or alarm ids), remove them from the database and return the removed alarm records
alarmsV2MenuAxon function
allReturn if all the items in a list, dict, or grid match the given test function
anyReturn if any the items in a list, dict, or grid match the given test function
applyReplaceAxon function
arcDigestFormat a grid of arc summary records for a notification
arcEditCommit a diff to an existing arc rec
arcEditPartEdit an existing part on a record
arcMoveMove an arc document to another project database based on arcOn ref Return new arc document as grid
arcNewCreate a new arc
arcNewPartAdd a new part to an arc record
arcReadReturn the encoding of an arc and all its parts as a grid
arcReadAllUnderRead summary grid of arcs with an arcOn contained by the given parent
arcRemovePartRemove an existing part on a record
arcbeamCallEvaluate a platform specific operation on the remote node
arcbeamEvalEvaluate a platform specific expression on the remote node
arcbeamReadRead a single record from remote node with filter and return as a dict
arcbeamReadAllRead a grid of records from remote node with a filter
arcbeamReadByIdRead a record from the remote node by its unique id and return as dict
arcbeamReadByIdsRead a list of records from remote node by their identifiers
arcsGiven a grid of source data, return the arcs and the arc summaries which are available for the source data
asSet the unit of a number
asinReturn the arc sine
atanReturn the arc tangent
atan2Converts rectangular coordinates (x, y) to polar (r, theta)
avgFold multiple values into their standard average or arithmetic mean
bacnetAcknowledgeAlarmAcknowledges an alarm
bacnetAddEnumPropValMappingThe method will save Enum and property value conversion mapping for schedule object e.g
bacnetAddRouterEntryMake a network Table entry manually of router
bacnetAddToNotificationClassAdds the connector to the provided notification class, to enable receiving alarm/event notifications
bacnetAnyThe method will convert the input data/Dict to given type
bacnetApplyNetworkPortPendingChangesApply the pending changes in the stack configuration by restarting the stack with new changes Examples
bacnetAtomicReadFileReads the content of a BACnet File object
bacnetAtomicWriteFileWrites the content of a IOHandle to a BACnet File object
bacnetBackupDeviceTakes the backup of the Device
bacnetCharStringThe method will convert the input Str to Character String
bacnetCharacterThe method will convert the input Str to Character Array
bacnetClientRestartRestart the stack Parameters
bacnetConfirmedTextMessageThe ConfirmedTextMessage service is used by a client BACnet-user to send a text message to another BACnet device
bacnetCreateObjectCreate a Bacnet Object Parameters
bacnetDbcsStringThe method will convert the input Str to dbcs String
bacnetDeleteObjectDelete a Bacnet Object Parameters
bacnetDeviceCommunicationControlbacnetDeviceCommunicationControl(@connRef, dccValue, timeRem, password) bacnetDeviceCommunicationControl(read(bacnetConn), 0, 180sec) bacnetDeviceCommunicationControl(read(bacnetConn),"ENABLE", 2min)
bacnetDeviceDiscoveryDiscover BACnet devices and returns a grid with them
bacnetDiscoverObjectsDiscover BACnet objects from the BACnet device
bacnetDoubleThe method will convert the input Number to Double
bacnetEmptyListThe method indicates to write an empty list
bacnetEnrollmentSummaryThe GetEnrollmentSummary service is used to obtain a summary of event-initiating objects Parameters
bacnetEnumThe method will convert the input Number to Enumeration
bacnetGetAlarmSummaryRetrieves the Alarm Summary from the device and adds them in the Alarm Extension
bacnetGetBackupStatusGets the device backup information
bacnetGetDeviceInstanceNumberThe method will return the bacnet device instance number
bacnetGetDeviceObjectNameThe method will return the bacnet device object name
bacnetGetEventInformation"active event states" refers to all event-initiating objects that (a) have an Event_State property whose value is not equal to NORMAL, or (b) have an Acked_Transitions property, which has at least one of the bits (TO_OFFNORMAL, TO_FAULT, TO_NORMAL) set to FALSE
bacnetGetHandledAlarmsReturns the handled alarms from this Bacnet connector
bacnetGetHandledEvents
bacnetGetLocalBindAddressThe method will get localBindAddress
bacnetGetLocalDnetNumberThe method will return the local dnet number
bacnetGetMaxDeviceInstance
bacnetGetMaxMacAddress
bacnetGetMaxNetworkNumber
bacnetGetNotificationSubscriptionsReturns all the Notification Classes this current connector receives notifications from
bacnetGetPhysicalPortDnetNumberThe method will get physical port dnet Number
bacnetGetStackConfigKeysMethod will return all the config keys defined by the system
bacnetGetStringTypeSupportedRetrieves the String type supported for the connector
bacnetGetUnhandledAlarmsReturns the unhandled alarms from this Bacnet connector This is more for testing purposes, to see we are receiving alarms
bacnetGetUnhandledEventsReturns the unhandled alarm events (type=event) of Bacnet connector This is more for testing purposes, to see we are receiving alarms
bacnetIsoStringThe method will convert the input Str to Iso8859 String
bacnetJisStringThe method will convert the input Str to Jisc6226 String
bacnetLearnReturns a grid with the BACnet objects residing on the device the connector points to
bacnetLifeSafetyOperation- conn
bacnetListBroadcastIpsList all the available IPv4 broadcast addresses
bacnetListLocalIpsList all the available IPv4 local addresses, excluding the loopback
bacnetLocalBindAddressReturns the local address to which the BACnet stack is bind
bacnetMigratePointsThis method will migrate point data from FIN 5.1.X release to FIN 5.1.7 release Accumulator and Schedule point will be migrated
bacnetMigrationManually call the migration functions for the current project
bacnetNotificationsSubscribeConnSubscribe to connector, to receive notifications for all the points from it that are bound in DB builder
bacnetNotificationsSubscribePointSubscribe to connector, to receive notifications only for the provided point
bacnetNotificationsUnsubscribeConnUnsubscribe from connector, from receiving notifications for all the points that are bound in DB builder
bacnetNotificationsUnsubscribePointUnsubscribe from connector, from receiving notifications only for the provided point
bacnetObjectTypeListList all standard BACnet object types
bacnetPingAsynchronously ping an bacnet connector Examples
bacnetPropertyIdentifierListList all standard properties that a BACnet object can support
bacnetReadEnumPropValMappingThe method will fetch all Enum and property value conversion mapping for schedule object Examples
bacnetReadHisRead history log from a BACnet Trend Log object Parameters
bacnetReadObjectRead all know properties for this BACnet object Parameters
bacnetReadObjectPropertyRead a BACnet property from a BACnet object Parameters
bacnetReadPoolSizeFromBbsConfigReads the Client_pool_size, Server_pool_size & Pdu_pool_size from the BBS config
bacnetReadPropertyFromDBReads property value from our own Stack data-base, like properties from Device or Network-port Object Parameters
bacnetReadPropertyMultipleReads multiple object properties using the BACnet ReadPropertyMultiple service if the remote device supports it
bacnetReadStackConfigThe method will return the Config value for inquired Config keys from /etc/bacnetExt/config.props file configKey
bacnetReadStructuredViewReads the properties of BACnet Structured View objects for a given connector
bacnetRealThe method will convert the input Number to Real
bacnetRegisterBBMDwithNetworkPortRegisters the device as BBMD using network-port object and puts the entry provided in the BBMD-BROADCAST-DISTRIBUTION-TABLE property
bacnetRegisterForeignDeviceWithNetworkPortRegisters the device as foreign device by requesting the BBMD of the other subnet it wants to register itself
bacnetRemoveFromNotificationClassRemoves the local device corresponding to the connector from the provided notification class, to disable receiving alarm/event notifications
bacnetRemoveStackConfigThe method will return delete the provided config entry
bacnetRestoreDeviceRestores the device from the already backed up data
bacnetScheduleEffectivePeriodReads the effective period for a bacnet schedule point Paramaters
bacnetScheduleReadReads the weekly schedule from a bacnet schedule point Paramaters
bacnetScheduleWriteWrites a weekly schedule to a bacnet schedule point Paramaters
bacnetServerDeviceListList all devices registered across all projects
bacnetServerGetObjectReturn BACnet object type and instance number for a point record
bacnetServerProjectsList all BACnet projects for those BACnetServer is enabled
bacnetServerRestartRestarts the BACnet server
bacnetServerSyncDevicesRe-create BACnet devices for the current project
bacnetSetDeviceInstanceNumberSet instance number of our device
bacnetSetDeviceObjectNameThe method will set object name of default server device
bacnetSetLocalBindAddressThe method will set localBindAddress - localBindAddress
bacnetSetLocalDnetNumberThe method will set the local dnet number
bacnetSetPhysicalPortDnetNumberThe method will set physical port dnet Number
bacnetSignedThe method will convert the input Number to Signed
bacnetSyncCurAsynchronously synchronize current values for given list of proxy points
bacnetSyncHisImport the lastest data from an BACnet Trend Log object to the local history database, for each point provided
bacnetSyncObjectPropertyFunction to sync BACnet object property of BACnet device point to the FIN Note:- Support is currently limited to the units property only
bacnetTimeSynchronizationSynchronizes the time of the Device Parameters
bacnetUcs2StringThe method will convert the input Str to UCS 2 String
bacnetUcs4StringThe method will convert the input Str to UCS 4 String
bacnetUnconfirmedTextMessageParameters
bacnetUnregisterBBMDwithNetworkPortbacnetUnregisterBBMDwithNetworkPort() This query will Unregister BBMD from network-port object
bacnetUnregisterForeignDeviceWithNetworkPortbacnetUnregisterForeignDeviceWithNetworkPort() This query will delete Foreign device details from stack database
bacnetUnsignedThe method will convert the input Number to Unsigned
bacnetUnsigned16The method will convert the input Number to Unsigned16
bacnetUnsigned64The method will convert the input Number to Unsigned64
bacnetUpdatePoolSizeInConfigThis query updates the Server-TSML-pool, Client-TSML-pool size & Pdu-pool size in the bbs.conf
bacnetUtcTimeSynchronizationSynchronizes the time of the Device with UTC Parameters
bacnetWhoHasSends a WhoHas request in the network Parameters
bacnetWriteGroupService-nListOfChannelValue
bacnetWriteNetworkPortPropertyUpdate/Write property value in our own Stack data-base for supported properties from Device or Network-port Object Parameters
bacnetWriteObjectPropertyWrite a BACnet property value Parameters
bacnetWritePropertyMultipleWrites multiple object properties using the BACnet WritePropertyMultiple service if the remote device supports it
bacnetWriteStackConfigThe method will write the Config key-value to /etc/bacnetExt/config.props file Dict
bitAndBitwise and
bitNotBitwise not
bitOrBitwise or
bitShiftlBitwise left shift
bitShiftrBitwise right shift
bitXorBitwise xor
blineMenuAxon function
blocksList the installed control blocks
breadcrumbsAxon function
buildIsSiemensTrue or false if this is a Siemens build or not
callReflectively call a function with the given arguments
capitalizeReturn this string with the first character converted to uppercase
ceilReturn the smallest whole number greater than or equal to val
chartSet the grid visualization view to chart
childrenCurVal2Axon function
childrenCurVal3childrenCurVal3(equipList) Like childrenCurVal2 but also returns the ids of the children points
choiceOfGiven a choice spec, return the most specific choice subtype implemented by the instance
clampClamp the number val between the min and max
cleanFolderPathNameAxon function
clearAlarmHistoryClear alarm history records in the database based on the given parameters
clearAlarmHistoryBeforeClear alarm history records before the given date in the database
cloneReadOrphansRead orphaned clones from the database as a grid
cloneRemoveOrphansRemove clone recs which no longer have a reference to a valid cloneSet
cloneResubscribeForce a re-subscription of one or more client side clone sets
cloneSyncHisPerform remote sync of history data for given clone points
colGet a column by its name
colNamesGet the column names a list of strings
colToListGet a column as a list of the cell values ordered by row
collectCollect stream into a in-memory list or grid
colsGet the columns from a grid as a list
colsToLocaleLocalize column display names
commitCommit one or more diffs to the folio database
commonTagBundlesAxon function
compDefReturn component definition
comparePointValAxon function
concatConcatenate a list of items into a string
conjunctsList conjunct definitions in the context namespace as Def[]
connCloseForce the given connector closed and return a future
connDetailsReturn debug details for a connector or a connector point
connLearnPerform a learn on the given connector and return a future
connPingPerform a ping on the given connector and return a future
connPointsReturn the points for a connector as list of dicts
connPointsViaSelect a group of points explicitly via specific connector library or connector
connSyncCurPerform a remote sync of current values for the given points
connSyncHisPerform a remote sync of history data for the given points
connTraceRead a connector trace log as a grid
connTraceClearClear the trace log for the given connector
connTraceDisableDisable tracing on the given connector
connTraceDisableAllDisable tracing on every connector in the database
connTraceEnableEnable tracing on the given connector
connTraceIsEnabledReturn true or false if given connector has its tracing enabled
connectorPoinBadgeValAxon function
connectorPointBadgeTypeAxon function
connectorPointColorAxon function
connectorPointTooltipAxon function
connectorSelectedMenuAxon function
connectorsByTypeMenuAxon function
connectorsDebugInfoMenuAxon function
connectorsMainMenuAxon function
connectorsMenuAxon function
connectorsMenuSettingsAxon function
connectorsPointIconsAxon function
connectorsPolicyInfoAxon function
connectorsRightIconAxon function
connectorsShowPointsAxon function
connectorsTunePolicyMenuAxon function
containsReturn if val contains x
contextGet the current context as a Dict with the following tags
controlTaskGet the details for the task identified by the given program and target combination
controlTaskRawValsHaystack flattens time units to ms (1min -> 60000) Strip the unit from time values so we get the raw number
controlTasksList the tasks for all the programs currently running
coordConstruct a Coord from two Numbers in decimal degrees
coordDistCompute the great-circle distance between two Coords
coordLatLatitude of a Coord as a Number
coordLngLongitude of a Coord as a Number
copyModbusFile
cosReturn the cosine of angle in radians
coshReturn the hyperbolic cosine
countFold multiple values into their total count Return zero if no values
covAvgFolding function for generating a time weighted average on change-of-value histories (where hisInterpolate() is "cov")
createFirstLevelOptionalAxon function
createGraphicsLibrary
createOptionalLevelAxon function
createTemplateGraphic
curFuncGet the current top-level function's tags
dateIf val is a DateTime
dateTimeConstruct a DateTime from a date, time, and timezone name
dayGet day of month as integer between 1 to 31 from date or datetime
dayOfYearGiven a DateTime or Date, return the day of the year
dbAddEditCommitAxon function
dbBuilderCreateLearnPointsJobAxon function
dbBuilderDiscoverBacnetPointsAxon function
dbBuilderDiscoverConnectorsAxon function
dbBuilderDropActionAxon function
dbBuilderSelectActionAxon function
dbDiscoveryAddAxon function
dbDragActionAddConnectorAxon function
dbGraphicPanelsFunction returns a list of graphics whose graphicOns evaluate to nodeId
dbMakeDataGridPanelConstructs a basic grid panel to be used with the DB Builder app
debugTypeReturn a string of the given value's type
decapitalizeReturn this string with the first character converted to lowercase
defLookup a def by its symbol name (Str or Symbol)
defsList all definitions in the context namespace as Def[]
degreeDaysGiven a site or weather record compute both the heating and cooling degree-days for the given date range
degreeDaysBaseGiven a site or weather record, return the default balance point temperature to use for degreeDays()
deleteMacroAxon function
deleteVarAxon function
deleteVarByIdAxon function
deprecatedTagsReturn tags which have been deprecated as grid with following columns
deviceOverviewAxon function
diffConstruct a modification "diff" used by commit()
diffTypesAxon function
disGet display string for dict or the given tag
discreteBoolPeriodsFold timestamp/bool value pairs into an encoded Str of discrete minutely intervals
discreteEnumPeriodsFold timestamp/enum Str value pairs into an encoded Str of discrete minutely intervals
discretePeriodsFold timestamp/bool value pairs into an encoded Str of discrete minutely intervals
dockerDeleteContainerKill and remove a container
dockerListContainers
dockerListImages
dockerRun
dominantValueFolding function for determining the value which shows up the most in a period
dropActionConnectorTreeAxon function
dropActionEquipTreeDetermines and takes the appropriate action for when an item is dropped onto an item within the equip tree in the DB Builder app
dropActionFolderPathsAxon function
dropActionSavedFiltersTreeDetermines and takes the appropriate action for when an item is dropped onto an item within the saved filter tree in the DB Builder app
dropActionScheduleTreeDetermines and takes the appropriate action for when an item is dropped onto an item within the schedule tree in the DB Builder app
dropActionTagBundlesTreeDetermines and takes the appropriate action for when an item is dropped onto an item within the tagBundle tree in the DB Builder app
dstReturn if a DateTime is in daylight saving time
durTrueFold function for folding timestamp/bool value pairs into durations when true (runtime)
eachIterate the items of a collection
eachDayIterate the days of a span
eachMonthIterate the months of a span
eachWhileIterate the items of a collection until the given function returns non-null
echoWrite the str represenation of x to stdout and return x
elecKwToKwhHisFunction to create a computed history for energy kWh electrical consumption from demand "kW" electrical demand
emailSendSend an email synchronously
emailSendAsync
endEnd value of a DateSpan, Span, or a range
endsWithReturn if Str ends with the specified Str
energyBaselinePrevMonthGenerate a baseline his grid based on last month's data
energyBaselinePrevYearGenerate a baseline his grid based on last year's data
energyNormByAreaGiven a his grid, normalize the values by area in m² or ft²
energyNormByDegreeDayGiven a his grid, normalize the values by heating or cooling degree-day
energyStarCustomerListRead list of customers that you are connected with as grid with following columns
energyStarHisPullPull energy star usage into the given mapped meter points history
energyStarHisPushPush the daily rollup consumption of mapped meter points to portfolio manager
energyStarMeterDeleteDelete the meter identified by the given meter id string from the energy star Portfolio Manager
energyStarMeterListRead meters for given property as grid with following columns
energyStarMeterPullCreate or update a local meter point record from a meter in Portfolio Manager
energyStarMeterPushCreate or update a meter in Portfolio Manager from a local meter point record
energyStarMeterReadRead the given meter and return as Dict
energyStarOnsiteRenewableDetailWriteWrite onsite green power renewable details
energyStarPingAsynchronously ping energy star connector to verify connectivity and account credentials
energyStarPropertyAssociationsPushThis function recreates the list of property/meter associations in Energy Star
energyStarPropertyDeleteDelete the property identified by the given property id string from the energy star Portfolio Manager
energyStarPropertyListRead properties as grid with following columns
energyStarPropertyMetricsRead a list of metrics for a specific property
energyStarPropertyPullCreate or update a local site record from a property in Portfolio Manager
energyStarPropertyPushCreate or update a property in Portfolio Manager from a local site record
energyStarPropertyReadRead the given property and return as Dict
energyStarUsageDeleteDelete the given usage item from portfolio manager
energyStarUsageReadRead consumption data for given meter
energyStarUsageWriteWrite consumption data to portfolio manager for given meter
enumDefReturn definition of given enum def defined by enumMeta This call forces a refresh of the definitions
enumDefsReturn grid of current enum defs defined by enumMeta
equalsReturn if two values are equivalent
equipToPointsGiven a equip record Dict, return a grid of its points
evalEvaluate an Axon string expression
evalToFuncEvalate an Axon string expression to a function
eventCreateAsynchronously create a new event for the given target and return a future
eventDeleteAsynchronously delete a batch of events and return a future
eventReadRead all the events for the given list of targets and span
expReturn e raised to val
extReturn extension record for given extension name
extAddEnable the given extension name or list of names
extRemoveDisable the given extension name or list of names
extSettingsReturn ext settings form data - see Exts
extSettingsCommitSubmit function for extSettings() - see Exts
extsGet the list of exts and their current status
favEditEdit a favotie record
favNewCreate a new fav record action
favTrashTrash a favorite record
feedConvert a stream into a live feed to populate a view
filterApply a filter expression to a collection of dicts
filterTasksVarsReads all tasks variables that match the filter and return them in a grid
filterToFuncConvert a filter expression to a function which maybe used with findAll() or find()
finAMChartsComponentsContextMenuItemsAxon function
finAMChartsComponentsModelsReturns models from the FIN
finActionAddFilterFormAxon function
finActionAddFormAxon function
finActionAddFunAxon function
finActionAddRepeatFormAxon function
finActionCatFilterFormAxon function
finActionCatFormAxon function
finActionCatFuncAxon function
finActionsOnGet all Actions which are registered on the given target
finActionsRewriteRewrite actions that match the filter expression and the oldExprDict, dis and expr, fields with the new newExprDict, that contains new tags or overrides existing dis or expr tags, or removes tags Users should call this like
finAddBuilderPropsAxon function
finAddChartToGroupAxon function
finAddEditKnxConnCommitAxon function
finAddFloorToEquipCommitAxon function
finAddGraphicThumbnailAxon function
finAddPointInfoAxon function
finAddProjectGlobalVarAxon function
finAddShadowPoints
finAddTagsByColumnAxon function
finAddTagsByNameAxon function
finAddTagsByNameApplyAxon function
finAddTagsIoCsvAxon function
finAddTzToPointAdds a tz to a given point
finAlarmSettingsFormAxon function
finApplyEnumOptFormAxon function
finApplyNoteTagsAxon function
finApplyTagBundleApplies the passed tagBundles addTags and removeTags properties to the targetFilter that fits a tagBundle's allowFilter
finApplyUpdateConnectorsAxon function
finAssetUsedByGiven an asset or list of asset records or refs return a grid with fin project records that use those assets
finBLineSnippetsAxon function
finBackupRecordExport all the related records referencing the recs parameter The recs can be a single id or a list of ids By default this will be an equip, but users can pass any record and specify the primaryTag that defines the entity for this record
finBackupRecordFormAxon function
finBackupUploadFormAxon function
finBacnetAutoCreateThe commit action used by "Create Bacnet Devices" (finBacnetAutoCreateForm) to create bacnet devices from the desired equips
finBacnetAutoCreateFormThe UI form for "Create Bacnet Devices"
finBacnetAutoCreateManualBackend function used for "Create Bacnet Devices" (finBacnetAutoCreateForm) to manually configure bacnet devices
finBacnetCheckServerDeviceDataChecks if the server device can be created
finBacnetCurToWriteFinds all records from the grid or record list you passed as an argument, writes the value from the cur property to the write property and displays for every record of the argument the actions that took places
finBacnetWriteToCurFinds all records from the grid or record list you passed as an argument, writes the value from the write property to the cur property and displays for every record of the argument the actions that took places
finBase64DecodeBase64 decoding function Turns a base64 encoded string into a string
finBase64EncodeBase64 encoding function Turns a string into a base64 encoded string
finBatchAdvancedTagDPBackend function for finFormBatchAdvancedTagEditor and finFormNHaystackBatchAdvancedTagEditor
finBatchCloneScheduleApplyAxon function
finBatchDeleteEventsFormAxon function
finBatchDeletePointsFormForm to delete points based on navName and equipRef
finBatchDeleteTagProviderAxon function
finBatchDeleteTagsApplyAxon function
finBatchDeleteTagsFormAxon function
finBatchRecordCreator
finBatchRecordList
finBatchRecordsEquipFilterAxon function
finBatchRecordsFilter
finBatchUpdateRecordsAxon function
finBatchUpdateRecordsFilterAxon function
finBatchUpdateRecsCommitAxon function
finBeginBacnetDiscoveryAxon function
finBeginDiscoveryBegins a Discovery session Returns the id of this discovery session
finBlockSuggestionAxon function
finBlockSuggestionHelperAxon function
finBlocksThis function uses the blocks() function to gather all blocks and then adds additional information too each block specific to FIN Stack
finBlocksCombineVarsAxon function
finBlocksJavaScriptAxon function
finBlocksPpclAxon function
finBreadcrumbsAxon function
finBuilderComponents
finBuilderContextMenu
finBuilderContextMenuItemsAxon function
finBuilderEquipTrashAxon function
finBuilderModels
finCapsNeededThis function, given the number of required CAPS, returns a grid with the licensing parts and how many parts are needed alog with the base to reach desired CAPS at the lowest price
finCertManagementFormAxon function
finCheckForUpdate
finChildBooleanDatafinChildBooleanData(parentFilter, childFilter) This function will return a grid where each row lists the parent, the children currently on, the number of children currently off, and the total count of all matching children
finChildNumberDatafinChildNumberData(parentFilter, childFilter) This function will return a grid where each row lists the parent, the average of all children values, maximum value among the children, the smallest value among the children, and the total of all the children values
finClimbNavTreeAxon function
finCloneEquipPointTagsForm to clone the tags from the points of one equip to the corresponding points of other selected equips
finCloneEventsApplyAxon function
finCloneEventsFormAxon function
finCommandAutoAxon function
finCommitAxon function
finCommitApplyBatchTagsThis function applies the comma-separated tags to all records that match the filter
finCommitNHaystackApplyBatchTagsAxon function
finCommitSitesAxon function
finCommonQueriesAxon function
finConfigureBacnetServerCommitSets the values required by a bacnet server even when bacnetExt is disabled
finConfigureBacnetServerFormThe UI form for "Configure Bacnet Server"
finConflictingTagsAxon function
finConnDebugFormThis form is called from finConnectorDebuggingInfo
finConnDebugInfoShows the debugging info of selected bacnet or haystack connectors from the builder app
finConnExts
finConnectorTemplatePackageAddDeviceAxon function
finConnectorTypesRead connector types
finConstructBasicTreeItemAxon function
finContentOnGet all O&M Manuals which are registered on the given target
finContentOnFuncfinContentOn(Ref target
finContext
finCopyBoundPoints
finCopyFromGraphicFormfinCopyFormGraphicForm(stage
finCopyTableDataAxon function
finCopyTagBackend for finCopyTagForm Usage
finCopyTagFormForm to clone tags from one place to another
finCreateAlarmTopicCommitUsed by the "Create Alarm Topic" form to create the alarmTopic record
finCreateAlarmTopicFormCreate a new alarm topic and chooses which alarm priority, tags, target tags to apply it to
finCreateEditTuningPolicyCommitAxon function
finCreateEmbeddedLinkAxon function
finCreateFolderAxon function
finCreateFolderPathAxon function
finCreateFormTemplateFunction to make a beginning form function instantly
finCreateFromTemplateAxon function
finCreateHaystackDbTakes a haystack connector ref or a list of haystack connector refs and using the navTree supplied imports the entities matching the navFiltering to the local server
finCreateNoteTopicCommitUsed by the "Create Note Topic" form to create the noteTopic record
finCreateNoteTopicFormAllows the user to create a new note topic and choose which users, tags, and target tags to apply it to by assigning it to topicOn property
finCreatePodAxon function
finCreateProjectFormAxon function
finCreateTemplatePackageCreates a template package to be published to StackHub Accepts as parameters
finCreateTemplatePackage2
finCsvHisReorderFormPart of CSV History Report
finCurWriteHisEditorAxon function
finCurrentDayInfoReturns a grid with the columns daysLeftMonth daysLeftYear hoursLeftDay hoursPastDay daysPastMonth daysPastYear
finCustomAhuCreateAxon function
finCustomAhuCreatePointsAxon function
finCustomAhuPointProviderAxon function
finCustomAhuSelectAxon function
finCustomAhuSelectPointsAxon function
finDBCreateNewEquipCommitAxon function
finDashboardAppAxon function
finDashboardGenerateBinding
finDashboardWidgets
finDashboards
finDbBuilderMenuItemAxon function
finDbHaystackFindUniqueEquipTypesAxon function
finDbHaystackNodeSelectActionAxon function
finDbHaystackReadAllPointsAxon function
finDbRelationshipAddEditAxon function
finDbSavedFiltersTreeSelectActionCreates panels to be displayed on when an item from the savedFilters tree is selected
finDbSavedQueryFilterAddEditAxon function
finDbTagBundleAddEditAxon function
finDbTemplateAddEditAxon function
finDbTopicAddAxon function
finDelEnumOptFormAxon function
finDeleteAlarmsAck/Delete Alarms within the datespan
finDeleteTopicsCommitAxon function
finDeleteTopicsFormAxon function
finDigestTimeCommitAxon function
finDigestTimeSettingsFormAxon function
finDiscoveryAddAdd discovered item to system
finDiscoverySessionCleanupDestroy Discovery Session
finDiscoverySessionEndClose Discovery Session
finDiscoveryStatusCheckGet Discovery Status
finDistinctConnRefsRead all the distinct conn ref connectors
finDownloadSavedRecordsFormAxon function
finDuplicateRecDuplicates a record and it's children countTimes
finEditDescriptionFormForm to edit description, takes id
finEditEnumOptFormAxon function
finEditNoteTagsCommitThis function is used by the "Edit Note Tags" form
finEditNoteTagsFormThis form allows the user to add or remove existing tags from the noteTags list
finEditSummaryCommitAxon function
finEditSummaryFormAxon function
finEditSummaryPickFormAxon function
finEditTagsfinEditTags(id, tags) Form to edit the tags of a record
finEditTopicsFormA form that allows the user to select an alarm or note topic to edit
finEditTopicsFormCommitAxon function
finElementOnFIN Element On This method will find records compatible with the target element based off of the elementTag
finElementsOnFIN Elements On This method will find records compatible with all of the target elements based off of the elementTag
finEmailsupportive function to send email
finEnergyAnnualMonthlyDayRollupGiven a point ID and a folding function (sum, avg, median, etc....) the result of the query will return a years worth of data, and it will create up to 31 columns of data
finEnergyAnnualMonthlyRollupGiven a point or list of points ID and a folding function (sum, avg, median, etc....), if the points have a history it would return a row for each point, and then have 12 months of columns in it, for the last year, folded using the given function
finEnergyAnnualWkDayRollupGiven a point ID and a folding function (sum, avg, median, etc....) the result of the query will return a years worth of data, and it will create up to 31 columns of data
finEnumOptFormAxon function
finEquipChartsFunction to generate chart for equip with schedules and alarms
finEquipPointTagClone
finEquipRefTreeAxon function
finExcelRowPasterAxon function
finExcelSiteAxon function
finExecThis will parse trio file into records then look for "function" tag in each record, then it will execute the function tag expression on the corresponding record
finExistingConnectorsAxon function
finExtSettingsFormAxon function
finExtraCountSystemsAxon function
finFavoritesFormAxon function
finFavoritesMenuAxon function
finFileAndAssetDeleteGiven a finProject or list of finProject records or refs the function will delete the finProject(s) and assets that are use only by this project
finFileToSnapshot
finFileTypeAxon function
finFilesReturn a list of fin files together with their respective screen shots, thumbs and icons
finFilteredFuncEvalFilter all functions that match the provided funcFilter expression
finFindAnyTextAxon function
finFindBadChartPtsAxon function
finFindDuplicateIdsInBackupLooks inside a file for clashing IDs and returns a list duplicates
finFindMarkersGiven a dictionary, finFindMarkers will return a list of all marker tags found
finFindNonDbRecReturns a list of dicts resembling, if not actually, records
finFindRecordByChildThis function is just like finFindRecordByChildDeep except this one only searches 1 level deep, and is way more effecient
finFindRecordByChildDeepThis function will let you search for children of something
finFindRefsReturn a grid with a new column called "val" that contains a JSON object with all the Refs found within that record
finFindTargetsForStrTagRenameAxon function
finFindToolsOnNavItemAxon function
finFixOldBinTags
finFoldGrid
finFolioDownloadFormForm to download records with a certain filter, like legacy Folio Download
finFolioMenuAxon function
finFolioSettingsAxon function
finFolioUploadFormForm to upload records through file or through text, like legacy Folio Import
finFormAddEditHaystackConnectorAxon function
finFormAddEditKnxConnAxon function
finFormAddTenantsToEquipAxon function
finFormAdvancedEditorAxon function
finFormAhuAirBalanceThis form Runs on AHUs that serve VAV zones
finFormAlertOkBring up an alert dialog that displays a text message
finFormApplyBatchTagsThis function takes no parameters, as the parameters get loaded from the form
finFormBacnetConnDiscoverSettingsAxon function
finFormBatchAdvancedTagEditorSearches database for points with navNames that start with, end with, or contain the specified keywords and adds specified tags to those
finFormBatchDuplicateThis function takes a record ID, and it will copy and paste it X amount of times
finFormChangeAddAhuRefThis function will take and ID, and a list of selectedDicts
finFormCloneConnectorAxon function
finFormCloneScheduleAxon function
finFormCommandAutoAxon function
finFormConfirmChangesAlertCreates a basic form with "Warning" as the form title, a "Cancel" button, and an "Apply" button
finFormConfirmKnxProjAxon function
finFormConflictingTagsAxon function
finFormConnTuningForm to add connTuningRef tags to filter results
finFormCopyBoundPointsAxon function
finFormCreateEditGraphicAxon function
finFormCreateNoteThis form will create a note on a target
finFormCreateSummaryAxon function
finFormCreateSummaryApplyAxon function
finFormCreateSummaryRefsAxon function
finFormCreateTuningPolicyAxon function
finFormCurWriteHisEditorAxon function
finFormCustomNameAxon function
finFormDBAddEditA form used to create or edit DB Builder items
finFormDBBuilderDeleteAxon function
finFormDBCreateNewEquipAxon function
finFormDBSelectEditDeleteAxon function
finFormDisplayTagRenamesAxon function
finFormDuplicateScheduleDayThis is a form to duplicate one day from a schedule to one or more days on the same schedule
finFormEditPropertyManagerFormForm to allow currently selected user to be changed to a property manager or edit a current property manager
finFormEditScheduleForm to edit schedules
finFormEditTenantForm to edit existing user into a tenant
finFormEditUtilityBillAxon function
finFormEliminateOrphansAxon function
finFormEquipAuditLogThis function takes an ID, and will you the audit log for what has been changed in the time period
finFormEquipPointTagCloneAxon function
finFormEquipPointTagsProviderAxon function
finFormFuncsAxon function
finFormHaystackSyncToNiagaraApplies tags made in FIN
finFormHisImportForm to import history from a CSV file into a point
finFormKnxProjErrorAxon function
finFormManageZincLibraryForm to manage the records within the io/Records.zinc libraries
finFormManualAddEditBacnetAxon function
finFormManualOverrideAutoAxon function
finFormModBusAxon function
finFormNHaystackApplyBatchTagsAxon function
finFormNHaystackBatchAdvancedTagEditorSearches haystack points with navNames that start with, end with, or contain the specified keywords and adds specified tags to those
finFormNHaystackMapPointsToEquipAxon function
finFormNavMetaAxon function
finFormNewHaystackPasswordAxon function
finFormNewOrEditTuningPolicyAxon function
finFormNoteTagsAxon function
finFormPointNotTzAxon function
finFormPointNotUnitAxon function
finFormPointPriorityViewerForm to view and auto points with priorities
finFormRecordTagCloneThis function takes an id, then it will pop up a form that let's you select the tags you want to clone
finFormReplaceAxon function
finFormReplaceKnxProjAxon function
finFormReplaceKnxProjCommitAxon function
finFormRestoreTemplateAxon function
finFormRunToolsOnMultiAxon function
finFormSaveTemplateAxon function
finFormSchedulePointPriorityAxon function
finFormSelectBacnetTypeAxon function
finFormSelectKnxConnEditAxon function
finFormSelectTenantsForReportForm for setting up tenant reports
finFormSelectToolAxon function
finFormSelectTuningPolicyAxon function
finFormSetConnectorDefWriteLevelAxon function
finFormSetImmediateSubscriptionOffTimeAxon function
finFormSetSummaryPointOrderAxon function
finFormStandardNameAxon function
finFormStringSearchCommitfinFormStringSearchCommit(data
finFormStringSearchTransForm interface for these functions
finFormStringSearchTransPrevAxon function
finFormStringSearchTransStatsBackend function for finFormStringSearchTrans
finFormSyncToCollAxon function
finFormTagDuplicateAxon function
finFormTagSplitAndRenameAxon function
finFormTempToRealForm to move prepared tempPoints into the project hierarchy
finFormTempToRealStatsAxon function
finFormTextAreaAxon function
finFormTextareaOkAxon function
finFormTrendConnDiscoverSettings
finFormUniqueEquipTypesAxon function
finFormUniqueTagsEasyAxon function
finFormUnlockKnxProjAxon function
finFormUnlockKnxProjCommitAxon function
finFormUpdateConnectorsAxon function
finFormUploadKnxProjAxon function
finFormUploadKnxProjCommitAxon function
finFormWinRestartAxon function
finFormWriteLevelsAxon function
finFreqFiltersThis function is used for the filter ui that shally made
finFuncsFIN Funcs This method merges the result of the funcs() query with extra data within the finFuncs.trio file to support FIN
finGenScram
finGenerateSampleTagValueAxon function
finGetAllPodDocs
finGetAllPodNames
finGetCapsThis function returns a grid with the licensing parts and their prices
finGetConnectorTagSpecsReturns a Grid with the tag specs defined for an enabled connector
finGetCurrentUser
finGetDiscoveryConfigurationGet Discovery Configuration
finGetFinDocsForPodWithName
finGetHelp
finGetMinutesFromCurAxon function
finGetPodsAxon function
finGetPointIconReturns the name of the appropriate point icon based off the point's type
finGetPointRecordsGet records from the PointRecords.zinc file in the finToolsExt pod to display in the batch record creator
finGetTileOnAxon function
finGetUriFromRefAxon function
finGlobalControlThis function opens a form that allows users to select points via a filter, or it takes in selected points, that will then allow the user to invoke command actions to all the selected points
finGlobalControlActionsThis function is part of "Global Control"
finGlobalControlCheckEnumThis function is part of "Global Control"
finGlobalControlCommitThis function is part of "Global Control"
finGlobalControlDurFormThis function is part of "Global Control"
finGlobalControlFilterCheckThis function is part of "Global Control"
finGlobalControlFilterFormThis function is part of "Global Control"
finGlobalControlFilterTableThis function is part of "Global Control"
finGlobalControlFormThis function is part of "Global Control"
finGraphicOnGet all Fin graphics which are registered on the given target
finGraphicRemoteAssetsAxon function
finGraphicResourceModelsReturns models from the FIN
finGraphicResourceTemplatesReturns Templates from the FIN
finGraphicTopLevelfinGraphicTopLevel(new) Form to create or edit the topLevel record
finGraphicTopLevelDeleteConfirmFormAxon function
finGraphicsBatchTagsAxon function
finGraphicsDeleteRecsAxon function
finGraphicsGenericBindingsAxon function
finGraphicsGenericBindingsFormAxon function
finGraphicsGenericBindingsResultsAxon function
finGraphicsUpdateThumbsForm to change the thumbnails on graphics
finGridFilterFilters a grid using a filter expression
finHardDeleteA function to delete records permanently
finHasSpecialCharsAxon function
finHaystackDrillDownTakes a connector ref or a list of haystack connector refs and using the navTree supplied queries all the nav paths on each connector and creates an grid with all the entities that match the path
finHaystackExcludedTagsReturns a grid of tags to be excluded when working with records coming from haystack or nhaystack connectors
finHaystackHexReplaceFormAxon function
finHaystackLearnImproves haystackLearn so that it fetches all the tags defined for a learn path
finHeaderAddEditMenuAxon function
finHeaderAddEditSubMenuAxon function
finHeaderButtonBadgeFormAxon function
finHeaderButtonIconFormAxon function
finHeaderButtonLinkFormAxon function
finHeaderButtonNameFormAxon function
finHeaderButtonSecurityFormAxon function
finHeaderFormAxon function
finHeaderFuncsBackend functions for finHeaderForm function
finHeaderHomeFormAxon function
finHeaderMenuAxon function
finHeaderReorderFuncAxon function
finHeaderReorderMenuAxon function
finHeaderReorderSubMenuAxon function
finHisImportFunction to import histories from a CSV file
finHisRead
finHisReadAddMetaAxon function
finHisReadBaseBuildChartsAxon function
finHisReadBaseGetHisAxon function
finHisReadBaseGetTzAxon function
finHisReadBaselineAxon function
finHisReadBaselineCoretakes the following parameters
finHisReadBaselineRollupAxon function
finHisReadBaselineStrPointAxon function
finHisReadBaselineStrPointFFantomized version of the finHisReadBaselineStrPoint function
finHisReadBaslineStatusAxon function
finHisReadComplexBaAxon function
finHisRewriteSpanhisRewriteSpan(hisRecs, startTime, endTime, rewriteFunc
finHostChangePassFormAxon function
finHostMainMenuAxon function
finHostUpdateLicenseFormAxon function
finHostUsageFormAxon function
finHtmlReportingMainMenuAxon function
finHtmlTemplategenerate string from a handlebars template using handlebars.java engine @noteTemplate
finHttpProxy
finImportGridImports the grid in the local server
finInfoMenuAxon function
finInjectableProgramResourcesAxon function
finInvokeAxon function
finIsTagBlackListReturn whether the given tag is a member of the tag blacklist (see finTagBlackList())
finJSLibrariesAxon function
finJobMenuAxon function
finJobSettingsAxon function
finMacroProcess macro pattern with given scope of variable name/value pairs
finMailPingAsynchronously ping an finMail connector Examples
finManualAddEditBacnetCommitAxon function
finMassEditTagsAxon function
finMatchPointsToChartsAxon function
finMigrateFilterIds
finMigrateFinFileMigrates record tags and the ids inside a fin project file record Returns true if project was migrated
finMiscComponentsContextMenuItemsAxon function
finMiscComponentsModelsReturns models from the FIN
finMobileHardDeleteAxon function
finMobilePointsfinMobilePoints
finMobilePollfinMobilePoll
finModBusMapAxon function
finMoveTagBackend for finCopyTagForm Usage
finNHaystackAddEquipsfinNHaystackAddEquips This method calls the addEquips op on nhaystack
finNHaystackAddFloorToEquipAxon function
finNHaystackAddHaystackSlotsfinNHaystackAddHaystackSlots This method calls the applyBatchTag op on nhaystack
finNHaystackAdvancedApplyBatchTagsCommitAxon function
finNHaystackApplyAddEquipsAxon function
finNHaystackApplyBatchTagsfinNHaystackApplyBatchTags This method calls the applyBatchTag op on nhaystack
finNHaystackApplyFolioFilterfinNHaystackApplyFolioFilter This method runs the given filter against the Folio database, and ships the grid down to nhaystack
finNHaystackCopyEquipTagsfinNHaystackCopyEquipTags
finNHaystackDeletefinNHaystackDelete
finNHaystackDeleteHaystackSlotfinNHaystackDeleteHaystackSlot
finNHaystackFindDuplicatePointsfinNHaystackFindDuplicatePoints
finNHaystackFormAddEquipsAxon function
finNHaystackFormAddHaystackSlotsAxon function
finNHaystackFormAdvancedApplyBatchTagsAxon function
finNHaystackFormApplyBatchTagsAxon function
finNHaystackFormCopyEquipTagsAxon function
finNHaystackFormDeleteAxon function
finNHaystackFormDeleteHaystackSlotAxon function
finNHaystackFormPriorityArrayAxon function
finNHaystackFormRebuildCacheAxon function
finNHaystackFormSyncEquipsAxon function
finNHaystackInvokeAxon function
finNHaystackMapPointsToEquipfinNHaystackMapPointsToEquip This method applies equipRef tags to a list of points, so that those points become children of the given equip
finNHaystackMapPointsToEquipApplyAxon function
finNHaystackPointWriteArrayfinNHaystackPointWriteArray
finNHaystackPullPropTagsfinNHaystackPullPropTags
finNHaystackPullPropsFormAxon function
finNHaystackQueryAxon function
finNHaystackReadSizefinNHaystackReadSize This method calls read with the given filter, and then counts the number of resulting recs
finNHaystackReadUniquefinNHaystackReadUnique This method calls read with the given filter, and then finds the unique values of the given column
finNHaystackRebuildCachefinNHaystackRebuildCache This method calls rebuildCache in NHaystack
finNHaystackRemoveBrokenRefsAxon function
finNHaystackSearchAndReplacefinNHaystackSearchAndReplace This method renames components by replacing searchText with replaceText
finNHaystackShowPointsInWatchfinNHaystackShowPointsInWatch
finNHaystackShowWatchesfinNHaystackShowWatches
finNHaystackSyncNiagaraEquipApplyAxon function
finNHaystackUniqueEquipTypesAxon function
finNHaystackUniqueTagsfinNHaystackUniqueTags
finNHaystackViewEquipTypesCommitAxon function
finNHaystackViewEquipTypesFormAxon function
finNavChildren
finNavDrillDownGets all the children of the parent id or parent id list that matches the supplied navTree start - a ref or list of refs or a rec or list of records
finNavDuplicateDuplicates a record using the nav tree specified by treeName This functions uses the built-in proj::SysLib.navDuplicate function with the important add-on of also duplication the children of the src record that have the same nav level as the source, i.e
finNavLevelsEnhance navLevels
finNavListChildrenAxon function
finNavMain
finNavMerge
finNavMetaAdding a Level
finNavMetaCommitAxon function
finNavMetaDeleteFailFormAxon function
finNavMetaGetLevelsAxon function
finNavMetaTagListGiven an record that is part of the equipPath Posible ops are {"drillDown":false, "values":true, "getRef":true} If drillDown is present
finNavMetaWhoAmIThis function takes a Record, and it will return what the record is based on navMeta
finNavNavlets
finNavRollup
finNavTreeDropOverridesAxon function
finNavTreeTypesAxon function
finNavletsOn
finNetworkBasicDragDropExposes the functionality for basic drag and drop, like for programs and schedules and jobs
finNetworkConnectorsDragDropExposes the functionality for the connector tree drag and drop system
finNetworkDragDrop
finNetworkEquipDragDropExposes the functionality for the equip tree drag and drop system
finNetworkSettingsDragDropExposes the functionality for the settings tree drag and drop system
finNetworkSnapshotsDragDropExposes the functionality for the snapshots tree drag and drop system
finNetworkSyncUsersTakes a conn or list of conns (in a format used by toRecList) and syncs the users over to the children
finNetworkTopicDragDrop
finNetworkTransferRecords
finNetworkTree
finNoteSummary
finOMAddFormAxon function
finOMContentOnFormAxon function
finOMDeleteFormAxon function
finOMMenuAxon function
finOMMenu2Axon function
finOMMenu3Axon function
finPaginateFIN
finParseFilterDecode a filter expression into a grid of operands
finParseModBus32
finPodFiles
finPointActionsAxon function
finPointConn
finPointNotTzAxon function
finPointNumbersToEquipAxon function
finPointSummaryGenerate a point summary by equip
finPointSummary2Function to read points that have pointSummaryRef pointing to the specified equipment
finPostTrioFuncsAxon function
finPrecisionUsage
finPrintPdfdownload and convert web pages into 1 pdf
finProgramOnGet all Programs which are registered on the given target
finProjectAuditFormAxon function
finProjectCategoryFormAxon function
finProjectEmailFormAxon function
finProjectProjectFormAxon function
finProjectedCalcUsed for projecting the use of something like an electric meter's kWh
finPublishTemplatePackageUpload a template package to Stack Hub Accepts as parameters
finQueriesAxon function
finReadAlarmTagsAxon function
finReadAlarmTagsSearchAxon function
finReadBinTagFIN Read Binary Tag This function will read the data in the given tag on the given record this function will return a Str if the tag has text data and will return a handle for all other types
finReadBlockProgramAxon function
finReadById
finReadByIdTrashAxon function
finReadByIds
finReadByIdsTrashAxon function
finReadCloneEventsAxon function
finReadCsvWithEmbeddedDelimeterAxon function
finReadGraphicPoints
finReadHeaderfinReadHeader() Returns content of finHeader record
finReadPoints
finRebuildDocsRebuilds the documentation using the FINStack style
finRebuildNavTreeRebuild a nav tree by ensuring that parent refs to and from the specified navLevel are bound to parents and children respectively An optional parent ref id can be supplied so that the rebuild is limited to the branch starting from that specific parent ref id
finRecordTagClone
finRecordsSources
finRefDisGet the dis of a ref
finRemoteAsset
finRemoveAnimationEditorAxon function
finRemoveCategoryRemoves a category or a list of categories from all actions and user records Users should call this like
finRemoveStaleLockedKnxProjAxon function
finRemoveUnitsremoveUnits(number) Removes' the unit from a number passed in
finRenamePointsFormForm to change navNames of points if they match the filter
finResetBoolStatsResets runtime statistics for bool points By default this will reset both runStarts and runTime
finResetStatsStartTimeResets the start time from when boolean statistics are collected
finRestartFinstackAxon function
finRestoreFileRestores a FinStack template file
finRestorePod
finRestoreRecordImport equip from a zip backup stored on the record Params
finRewriteHisTzAxon function
finRewriteHisTzCommitAxon function
finRunSelectedToolAxon function
finSampleHisReadBaseAxon function
finSaveAssupportive function to save text content to a file at path(uri)
finSaveEquipRecordsFormAxon function
finSaveFloorRecordsFormAxon function
finSavePointRecordsFormAxon function
finSaveRecordsAxon function
finSaveRecordsFormAxon function
finSaveRecordsSeparateAxon function
finSaveSiteRecordsFormAxon function
finSavedChartsfinSavedCharts(Rec id) Finds all the saved charts related to the record that is passed in
finScheduleCopyDaysChange a weekly schedule (or list of weekly schedules) by copying parts of it to other week days Examples
finSelectedConnectorTypesAxon function
finSelectedPointsAxon function
finSetImmediateSubOffTimeCommitAxon function
finSetSuperUserPassword
finSettingsMenuAxon function
finSettingsMenuLegacyAxon function
finShadowPointToPoint
finShowEquipSummaryAxon function
finShowEquipSummaryRecurAxon function
finShowPointsInWatchList all records registered for a watch id
finShowWatchesList all watches open for this project
finSkySparkAppsReturns all SkySpark Apps
finSkySparkViewsForAppReturns all Views for a SkySpark app name
finSoftDeleteA function to send records to the trash
finSplitBacnetUriAxon function
finStackBootStrap
finStackMenuAllAxon function
finStackMenuAppListAxon function
finStackMenuApplySettingsAxon function
finStackMenuBackButtonAxon function
finStackMenuFolderPathAxon function
finStackMenuInsertVarAxon function
finStackMenuOkFormAxon function
finStackMenuOpenNewAxon function
finStackMobileMenuAxon function
finStrGetfunction
finStringSearchDictsFunction to search through a list of dicts and return only those that meet the defined criteria
finStringSplitDictsFunction to go through a list of dicts and split the specified column by the split character and put it together in a flexible way
finSubEvaluate the given expression
finSubEndLast call of an evalAll for subscription
finSubEquipFilterFilter out recursively the equip and sub-equip of the base target Ref
finSubStartOpen a new watch as part of an evalAll
finSummaryDeleteFormAxon function
finSummaryJsonreturns a JSON object
finSummaryMenuAxon function
finSummaryOnGet all Summaries which are registered on the given target
finSuperTaggerfinSuperTagger
finSuperTaggerFormAxon function
finSyncHisFormAxon function
finSyncPointsToDo
finSyncPointsInLib
finSyncTagsFIN Synchronize Tags This method will recursively synchronize the tag values from the source onto all of the children down the given tree Example
finSyncToCollAxon function
finTagBlackListReturn a grid of all those tags which should not be removed by the user
finTasks
finTemplateCopy
finTemplatesReturns records with templateOn from pods and the database
finThemeUsedThis function will return the theme that the user is using
finToAlarmfinToAlarm
finToNormalfinToNormal
finToNumberListFunction to import a string and output values 3-5 will output 3,4,5 starting-ending 4,5 will output 4,5 number1,number2..
finToggleImmediateSubscriptionsAxon function
finTraceSubEquipAxon function
finTuningPoliciesGet all tuning policies which are registered on the given target
finTuningPolicyGetStatsAxon function
finTuningPolicyStatsFormAxon function
finUnique
finUniqueActionsFind all actions that have the same dis and expr tags Returns a grid with dis, expr, count rows to show how many similar actions were found
finUniqueConnectorsFind all the unique connectors of the given type, among the recs which match the given filter
finUniqueEquipTypesFind the uniqe types for the equips
finUniqueEquipTypes2Axon function
finUniqueTagsfinUniqueTags - returns a grid with all markers that are shared by records matching the filter and their match count
finUniversalServiceRestartAxon function
finUpdate
finUpdateLicense
finUpdateRecordsIgnoredTagsAxon function
finUpdateRecordsIgnoredTags2Axon function
finUploadSavedRecordsFormAxon function
finUriToDict
finValidConnectorsAxon function
finValidateEmailReturns true if email is in the form [userName]@[domain].[topLevelDomain] and returns false if not
finWatcherCallbackOnBased on the filter expression, returns a grid with all the changes that match the filter expression
finWeatherMenuAxon function
finWinRestartFinstackfinWinRestartFinstack() Restarts the Finstack service
finWriteBin
finWriteBinTagFIN Write Binary Tag This function writes the data described by the handle to the given bin tag on the requested record
finWriteLevelsAxon function
finZincTagBatchEditGiven a list of recs and a tag name such as "schedule" which stores an Zinc encoded grid, apply a change to the row identified by the given tags
finZincTagBatchListGiven a list of recs and a tag name such as "schedule" which stores an Zinc encoded grid return a list of the unique dicts rows in the zinc tag values
findFind the first matching item in a list or grid by applying the given filter function
findAllFind all the items in a list, dict, or grid by applying the given filter function
findBacnetServerInstanceChildPointAxon function
findEquipTreeAddOptsAxon function
findPod
findPointNamesAxon function
finhaystackDeviceDiscovery
finhaystackDeviceDiscoveryConfig
finsedonaDeviceDiscovery
finsedonaDeviceDiscoveryConfig
firstGet the first item from an ordered collection or return null if the collection is empty
firstOfMonthGet the first day of given date's month
firstRun
firstRunComplete
fitLinearRegressionGiven a grid of x, y coordinates compute the best fit linear regression equation using the ordinary least squares method
fitsReturn if the given instance fits the spec via structural typing
fitsExplainReturn grid which explains how data fits the given spec
fitsMatchAllMatch dict recs against specs to find all the specs that fit
flatMapMap each item in a list or grid to zero or more new items as a flattened result
flattenFlatten a list to a single level
floorReturn the largest whole number less than or equal to val
foldFold a list or stream into a single value using given folding function
foldColFold the values of the given column into a single value
foldColsFold a set of columns in each row into a new folded column and return a new grid
foldEndThe fold end marker value
foldStartThe fold start marker value
folderPathDeleteAxon function
folderPathEditAxon function
folderPathMoveAxon function
folioBackupAsynchronously kick off a new backup for current project
folioBackupCleanupDelete all backups older than the given duration or date
folioBackupDeleteDelete a backup file by its timestamp
folioBackupsList all the backups for the current project
folioDebugQueryFormAxon function
folioDebugTagFormAxon function
folioDebugWatchesFormAxon function
folioEmptyTrashDelete all the records marked with trash tag
folioFileAddTagFormAxon function
folioFileBatchTrashFormAxon function
folioFileEditFormAxon function
folioFileTrashFormAxon function
folioFileUploadFormAxon function
folioOrphanCleanupAxon function
folioOverwriteFileCommitAxon function
folioOverwriteFileFormAxon function
folioQueryFormAxon function
folioQueryMenuAxon function
folioQueryViewFormAxon function
folioSnapRestoreProgBarAxon function
folioSnapRestoreRestartAxon function
folioSnapUploadFormAxon function
folioTrashDeleteFormAxon function
folioTrashEmptyFormAxon function
folioTrashRestoreFormAxon function
folioTrashViewFormAxon function
formatFormat an object using the current locale and specified format pattern
fromJSON
fromJavaMillisGiven Number of milliseconds since Unix epoch return a DateTime
funcFind a top-level function by name or by reference and return its tags
funcDefs
funcsFind all the top-levels functions in the current project which match the given filter
futureCancelCancel a future
futureGetBlock current thread until a future's result is ready
futureIsCompleteReturn if a future has completed or is still pending a result
futureStateReturn current state of a future as one of the following strings
futureWaitForBlock until a future transitions to a completed state (ok, err, or canceled)
futureWaitForAllBlock on a list of futures until they all transition to a completed state
geoCountryCodeNormalize a country name into its two letter ISO-3166 code
geoCountryNameGiven a two ISO-3166 country code or country name, return a country name
geoTzGiven a dict/row that contains primary geo tags such as geoCountry, geoState, and geoCity return ideal timezone name
geoUsStateCodeNormalize a US state name into its standard two letter postal code
geoUsStateNameGiven a two letter postal code or state name, return a US state name
getGet an item from a collection
getAllMacrosAxon function
getBacnetServerMaxDeviceInstance
getBacnetServerMaxMacAddress
getEnumAlarmTextAxon function
getEventsDataAxon function
getFinComponent
getHisTagsAxon function
getKioskConfig
getLocalBindAddressStackConfig
getLocalDnetNumberStackConfig
getMacroByNameAxon function
getMixinsAndDependencies
getNavURI
getPhyiscalDnetStackConfig
getPodVersion
getSafeGet an item from a str, list, or grid safely when an index is out of bounds
ghgCreateDirectSourceCreate a ghgDirectSource record (scope 1 emission source)
ghgCreateEmissionCreate an emission record
ghgCreateFactorHisPointCreate an ghgFactorHis point record
ghgCreateIndirectSourceCreate a ghgIndirectSource record (scope 2 emission source)
ghgEmissionsCalculate emissions for an equip, site, or ghgSource
graphicsBuilderNewAxon function
graphicsMenuAxon function
graphicsMenuSettingsAxon function
graphicsMobileMenuAxon function
graphicsSelectedMenuAxon function
graphicsVirtPtIconAxon function
graphicsVirtPtIconColorAxon function
greenButtonReadUsageParse a Green Button XML file into a grid of usage data from any IO handle
gridColKindsGiven a grid return the types used in each column as a grid with the following
gridColsToDictConvert grid columns into a dict of name/val pairs
gridReplaceReplace every grid cell with the given from value with the to value
gridRowsToDictConvert grid rows into a dict of name/val pairs
gridToZinc
hasIf val is a Grid return if it has the given column name
haystackCallPerform Haystack HTTP API call to given Str op name and with given request grid (can be anything acceptable toGrid())
haystackEvalEvaluate an Axon expression in a remote server over a haystack connector
haystackHisReadPerform Haystack REST API "hisRead" call to read history data for the record identified by the id (must be Ref)
haystackInvokeActionInvoke a remote action on the given Haystack connector and remote entity
haystackLearnDeprecated - use connLearn()
haystackPingDeprecated - use connPing()
haystackReadPerform Haystack REST API call to read single entity with filter
haystackReadAllPerform Haystack REST API call to read all entities with filter
haystackReadByIdPerform Haystack HTTP API call to read a record by its unique identifier
haystackReadByIdsPerform Haystack HTTP API call to read a list of records by their identifiers
haystackSyncCurDeprecated - use connSyncCur()
haystackSyncHisDeprecated - use connSyncHis()
hideRefAxon function
hisClearClear the history items in the given range
hisClipRemove the rows with leading/trailing timestamps from the actual query range
hisCollectWriteAllWrite all hisCollect items buffered in memory to the historian
hisCompareCompare a history query against an alternate set of dates
hisCuSumCalculate a simplified cumulative sum (CuSum) for the given history grid
hisDailyProfilePerform a rollup by time slice to produce a single 24-hour profile of the data
hisDurProfileCompute a "load duration" curve
hisFindAllPerform a filter transformation on a history grid
hisFindInPeriodsPerform filter transformation on a history grid by finding all rows which have a timestamp within the given periods
hisFindPeaksFilter a history grid so that only numeric samples that represent a peak are returned
hisFindPeriodsFind all the periods of time when fn returns true for a history grid
hisFindSlicePeriodsGiven a source history grid and a grid of windows, compute the periods of all the slices matched by given function
hisFindTroughsFilter a history grid so that only numeric samples that represent a trough are returned
hisFlattenPerform a transformation on the history to flatten out ts/val pairs into new rows
hisFoldColsGiven a history grid, fold all the value columns (every column* except "ts") into a single "v0" column
hisInWindowsReturn true or false if the given timestamp is inside at least one of the given windows
hisInterpolateInterpolate all the null value cells for each timestamp
hisJoinGiven a list of history grids, join them by the ts timestamp column
hisMapPerform a map transformation on the history value cells
hisMapSlicesGiven a source history grid and a grid of windows, compute the mapping of each slice
hisPeriodIntersectionFind the intersection of two or more historical periods
hisPeriodMatrixGet a grid which defines the "matrix" of unique combinations of all the periods merged together
hisPeriodNormalizeGiven a grid of historical periods, merge any overlapping periods to result in a "normalized" his period grid
hisPeriodShiftGiven of a grid of historical periods, shift the starting and ending timestamps by an offset
hisPeriodUnionFind the union of two or more historical periods
hisReadQuery history for an arbitrary range
hisRemoveRemove items from a history using a timestamp or timestamp range
hisRewriteRewrite every item of a history using the given transformation function
hisRollupRoll up a history grid over discrete intervals of time with the given fold function
hisRollupAutoAutomatically chooses the best rollup interval and the best rollup fold function for each history
hisRollupsPerform a series of rollups over discrete intervals
hisSliceSlice a source history grid by a single time window
hisSlidingWindowsCompute of grid of timestamp/duration windows
hisSyncBlock until any pending history writes/clears are completed
hisTransitionWindowsCompute a grid of timestamp/duration windows based on transitions of a history grid
hisWriteAsynchronously write the specified timestamp/value pairs to the history
hostMetaRead host metadata dict
hostVarsRead host variables dict
hourGet hour of day as integer between 0 to 23 from time or datetime
hoursInDayGiven a DateTime in a specific timezone, return the number of hours in the day
httpSiteUriPrimary HTTP or HTTPS Uri - see HxHttpService.siteUri
iconUriCreate a virtual file URI to an icon
ignoredConnTagsAxon function
importModbus
indexReturn the first match of x in val searching forward, starting at the specified offset index
indexrReturn the last match of x in val searching backward, starting at the specified offset index
infoInfoFormAxon function
infoLintFormAxon function
infoReportFormAxon function
infoThreadsFormAxon function
infoViewerLibsFormAxon function
insertInsert an item into a list at the given index and return a new list
insertAllInsert a list of items at the given index and return a new list
instanceLoad or lookup a instance from a Xeto library by its string or ref qname as a Dict
instancesLookup instances from Xeto libs as a list of dicts
instantiateCreate the default instance for a given spec
invokeBlockTaskVariablesGet the current Task Variables when the top function was called by the Invoke block
ioAppendConvert a handle to append mode
ioCharsetConfigure an I/O handle to use the specified charset
ioCopyCopy a file or directory to the new specified location
ioCopyFile
ioCrcGenerate a cycle reduancy check code as a Number
ioCreateCreate a directory or empty file with the given I/O handle
ioCreateDir
ioDeleteDelete a file or a directory as mapped by the given I/O handle
ioDigestGenerate a one-way hash of the given I/O handle
ioDirRead a directory listing, return a grid with cols
ioEachCsvIterate the rows of a CSV file (comma separated values) and callback the given function with two parameters
ioEachLineFor each line of the given source stream call the given function with two parameters
ioExists
ioExportExport a view to the given file handle - see Export
ioFromBase64Return an I/O handle to decode from a base64 string
ioGzipWrap an I/O handle to GZIP compress/uncompress
ioHmacGenerate an HMAC message authentication as specified by RFC 2104
ioInfoGet information about a file handle and return a Dict with the same tags as ioDir()
ioMoveMove or rename a file or directory
ioPbkGenerate a password based cryptographic key
ioRandomGenerate randomized series of bytes which can be used as an input I/O handle
ioReadCsvRead a CSV (comma separated values) file into memory as a Grid
ioReadFileStr
ioReadJsonRead a JSON file into memory
ioReadJsonGridRead a JSON file formatted as a standardized Haystack grid into memory
ioReadLinesRead an I/O handle into memory as a list of string lines
ioReadStrRead an I/O handle into memory as a string
ioReadTrioRead a Trio file into memory as a list of Dicts
ioReadXetoRead a Xeto data file into memory as a Haystack data type
ioReadZincRead a Zinc file into memory as a Haystack data type
ioSkipApply a skipping operation to an input I/O handle
ioStreamCsvRead a stream of dicts from a comma separated value file
ioStreamLinesRead a stream of lines
ioToBase64Encode an I/O handle into a base64 string
ioToHexEncode an I/O handle into hexidecimal string
ioUnzipPod
ioWriteCsvWrite a grid to a CSV (comma separated values) file
ioWriteExcelWrite an Excel XLS file, where val may be
ioWriteFile
ioWriteHtmlWrite an Axon data structure to HTML
ioWriteJsonWrite an Axon data structure to JSON
ioWriteJsonLdWrite an Axon data structure to RDF JSON-LD format
ioWriteLinesWrite a list of string lines separated with "\n" character
ioWritePdfRender data to a PDF file
ioWriteStrWrite a string to an I/O handle
ioWriteSvgRender data to an SVG file
ioWriteTrioWrite dicts to a Trio file
ioWriteTurtleWrite an Axon data structure to RDF Turtle format
ioWriteXetoWrite value to a Xeto text format file
ioWriteXmlWrite a grid to an XML file
ioWriteZincWrite a Grid to the Zinc format
ioZipDirRead a zip file's entry listing, return a grid with cols
ioZipEntryReturn a I/O handle which may be used to read from a zip entry within a zip file
isReturn if the given instance inherits from the spec via nominal typing
isAlphaIs number an ASCII alpha char
isAlphaNumIs number an ASCII alpha-numeric char
isBoolReturn if an object is a boolean type
isDateReturn if an object is a Date type
isDateTimeReturn if an object is a DateTime type
isDictReturn if an object is a dict type
isDigitIs number a digit in the specified radix
isDurationReturn if an object is a number type with a time unit
isEmptyReturn if a collection is empty
isEvenReturn if an integer is an even number
isFuncReturn if an object is a function type
isGridReturn if an object is a grid type
isHisGridReturn if an object is a grid that conforms to the history grid shape
isKeywordReturn if given string is an Axon keyword
isLeapYearReturn if a year is a leap year
isListReturn if an object is a list type
isLowerIs number an ASCII lowercase alphabetic char
isMetricGiven an optional value return true if the SI metric system should be used
isNaNReturn if val is the Number representation of not-a-number
isNonNullReturn if an object is not null
isNullReturn if an object is null
isNumberReturn if an object is a number type
isOddReturn if an integer is an odd number
isRefReturn if an object is a ref type
isSpaceIs number is whitespace char
isSpanReturn if an object is a span
isSteadyStateReturn HxRuntime.isSteadyState
isStrReturn if an object is a str type
isTagNameReturn if the given string is legal tag name - see Etc.isTagName
isTimeReturn if an object is a Time type
isUpperIs number an ASCII uppercase alphabetic char
isUriReturn if an object is a Uri type
isWatchedReturn if given record is under at least one watch
isWeekdayDoes the given Date or DateTime fall on Mon, Tue, Wed, Thu, or Fri
isWeekendDoes the given Date or DateTime fall on Sat or Sun
jaccardIndexAxon function
jobAppConfigAxon function
jobCancelSend the cancel message to the job identified by given handle
jobCreateFormAxon function
jobCurRecIf running in the context of a scheduled job then return the job record Dict
jobDebugFormAxon function
jobEditFormAxon function
jobFinBackupAxon function
jobFolioBackupRun the folioBackup() function as a background job
jobFolioCompactThis is a no-op
jobFolioSnapshotDeprecated
jobIsRunningIs the current context contained by a running job
jobLogReturn the LogRecs logged by the job identified by handle
jobParseTimeAxon function
jobProgressUpdate the current job's progress with percent complete and display message for current activity
jobRefreshUserRefresh the user account used for jobs
jobRunRun the given expression in the context of a background job
jobRunFormAxon function
jobSleepSleep for the given duration
jobStatusReturn the status for a single job identified by handle
jobStatusAllReturn the status for all the known jobs
jobTrashFormAxon function
joinJoin two grids by column name
joinAllJoin a list of grids into a single grid
keepColsReturn a new grid with keeps the given columns, but removes all the others
kioskImageImport
knxDeleteProjectFiles
knxDeviceStatusNOTE
knxDevicesReturn a grid of all KNX devices found in the ETS project file for the given connector
knxDpEditFormLaunches the data point edit form
knxEnableCustomEncodingMethod to configure encoding if KNX project import fail Parameters - enable
knxFindProjectFiles
knxFormAddEditCustomUnitAxon function
knxFormAddEditExistingUnitAxon function
knxFormAddEditUnitAxon function
knxFormDeleteUnitAxon function
knxFormImportExportCustomUnitFileAxon function
knxFormNoteAxon function
knxGetDataTypesRetrieve the possible data types for the data point edit form's data type selectors
knxGetQuantities
knxImportUnits
knxLearnPerform a synchronous learn read on the given connector
knxPingPerform an async ping on the given connector
knxProjectIsLocked
knxReadUnits
knxReplaceProjectFile
knxSyncCurAsynchronously synchronize current values for given list of proxy points
knxUpdateDataPointsReceives the updated values from the data point edit form
knxUpdateIndividualAddressMethod to configure KNX individual address Parameters - conn
knxUploadProject
knxWatchdogDisableDisable the KNX watchdog for the given connector
knxWatchdogEnableEnable or configure the KNX watchdog for the given connector
knxWatchdogStatusReturn a grid showing the cached watchdog connectivity status for all KNX devices
knxWriteUnitsWrite units
lastGet the last item from an ordered collection or return null if the collection is empty
lastMonthDateSpan for month previous to this month 1..28-31
lastOfMonthGet the last day of the date's month
lastQuarterDateSpan for 3 month quarter previous to this quarter
lastWeekDateSpan for week previous to this week sun..sat (uses locale start of week)
lastYearDateSpan for year previous to this year Jan-1..Dec-31
libAddEnable a library by name in the runtime
libRemoveDisable a library by name in the runtime
libStatusReturn grid of enabled libs and their current status
libsList the lib definitions in the context namespace as Def[]
licStatusReturn current licensing status as Dict with following tags
limitTruncate stream after given limit is reached
lintRun the lint report on the given recs
listFile
listOfEquipIdsAxon function
loadPodGraphic
localeUseEvaluate an expression within a specific locale
logSubmit a log record to the logging subsystem
log10Return base 10 logarithm of val
logDebugLog at the "debug" level - see log()
logEReturn natural logarithm to the base e of val
logErrLog at the "err" level - see log()
logInfoLog at the "info" level - see log()
logReadRead log records for given span
logWarnLog at the "warn" level - see log()
longCyclingCompute periods when an bool point's on period exceeds maxOnTime Params
lowerConvert a char number or str to ASCII lower case
manualOverrideArrayMenuAxon function
manualOverrideMenuAxon function
manualOverridesMainMenuAxon function
mapMap list, dict, or grid by applying the given mapping function
markerGet the marker value singleton Marker.val
markerOnlyAxon function
matchPointValReturn if a point value matches a given critera
matrixAddAdd two matrices together and return new matrix
matrixDeterminantReturn the determinant as a unitless Number for the given matrix which is any value accepted by toMatrix()
matrixFitLinearRegressionGiven a matrix of y coordinates and a matrix of multiple x coordinates compute the best fit multiple linear regression equation using the ordinary least squares method
matrixInverseReturn the inverse of the given matrix which is any value accepted by toMatrix()
matrixMultMultiply two matrices and return new matrix
matrixSubSubtract two matrices and return new matrix
matrixTransposeTranspose the given matrix which is any value accepted by toMatrix()
maxCompare two numbers and return the larger one
meanFold a sample of numbers into their standard average or arithmetic mean
meanBiasErrFold a sample of numbers into their MBE (mean bias error)
medianFold a sample of numbers into their median value which is the middle value of the sorted samples
menuForButtonAxon function
menuForLabelAxon function
menuForProgramAxon function
menuForSupermanAxon function
menuForVirtualPointAxon function
mergeMerge two Dicts together and return a new Dict
metaGet the meta-data from a grid or col as a dict
migrateGetFileUrlAllows you to change the project name on a getFinFile url /getFinFile/projectA -> /getfinFile/projectB @param original Original getFinFile URL @param projectName New project name to point the url to @return getFinFile URL that queries the project specified by the projectName
migrateRefAllows you to change the project name on an absolute or relative reference @p:projectA:r:1234-5678 -> @p:projectB:r:1234-5678 or @1234-5678 -> @p:projectB:r:1234-5678 @param original Original Reference @param projectName New project name to point the reference to @return reference that points to the project specified by the projectName
minCompare two numbers and return the smaller one
minuteGet minutes of the time as integer between 0 to 59 from time or datetime
missingIf val is a Grid return if it does not have given column name
mlAddMetaAdd metadata to the given trained model
mlGridSearchCvConfigure a cross-validation grid-search
mlLinearKernelCreate a Linear kernel
mlLoadModelLoad a trained model from the given I/O handle
mlMetaGet the model metadata
mlOlsCreate a training model for doing ordinary least-squares regression (OLS)
mlParamSweepDo a "parameter sweep" by invoking the given func for all combinations of parameters in the parameter grid
mlPolyKernelCreate a Polynomial kernel
mlPredictMake predictions against a trained model
mlRbfKernelCreate a RBF (RBF) kernel
mlSaveModelSave a trained model to the given I/O handle
mlScaleMinMaxPerform Min-Max feature scaling
mlScaleZPerform Z-score normalization on the features
mlStatsGet the model statistics
mlSvmCreate a Support Vector Machine (SVM) for classification
mlSvrCreate a Support Vector Machine for Regression (SVR)
mlToGridConvert a matrix to a Grid
mlToMatrixConvert the given obj to an optimized matrix type for machine learning
mlTrainTrain a machine learning model with the given training data
mobileViewRecordAddAxon function
mobileViewRecordEditAxon function
mobileViewRecordInfoMenu to view tags of a record
mobileViewRecordStringAxon function
modbusLearnDeprecated - use connLearn()
modbusPingDeprecated - use connPing()
modbusReadRead a point value for given register name on connector instance
modbusRegMapReturn given register map contents
modbusRegMapsList installed register maps including source
modbusSyncCurDeprecated - use connSyncCur()
modbusWriteWrite a value to given register name on connecter instance
modifyNavMetaOptionalAxon function
monthGet month as integer between 1 to 12 from date or datetime
moveToFind the given item in a list, and move it to the given index
mqttPublishPublish an MQTT message to the given topic on the broker
nHaystackQueryApplyAxon function
naGet NA not-available singleton NA.val
nameIf val is a Col, get the column name
namesGet the list of names used by a given dict
nanReturn the Number representation of not-a-number
navDuplicate2This function calls navDuplicate using the parameters to duplicates records and then adjusts the names
navProjNamesReturn a list of string project names which are currently navigable based on current uiMeta flag
navRefReturn a navigation Ref for given target name and record
navResolveResolve a list of navigation Refs to a list of Dict records
negInfReturn the Number representation negative infinity
nextActionProgramBlockTreeAxon function
nextActionProgramBlockTree2Axon function
nextActionProgramTreeAxon function
nextActionProgramTree2Axon function
notifySend an email to all users subscribed to the given topic
notifyTarget
notifyTopicSubscribersReturn a list of user rec's for users that are subscribed to the given topic
nowReturn current DateTime according to context's time zone
nowTicksReturn current time as nanosecond ticks since 1 Jan 2000 UTC
nowUtcReturn current DateTime in UTC
numDaysNumber of whole days in a span
numDaysInMonthGet the number of days in a given month
obixInvokeInvoke an obix:op operation as identified by given uri
obixPingDeprecated - use connPing()
obixReadHisSynchronously query a obix::History for its timestamp/value pairs
obixReadObjRead one Uri from an obixConn
obixSyncCurDeprecated - use connSyncCur()
obixSyncHisDeprecated - use connSyncHis()
obixWriteObjWrite an object as identified by given uri
occurredReturn if a timestamp is contained within a Date range
opcGenCertGenerate a client certificate to use for an OPC connector
opcPingDeprecated - use connPing()
opcSyncCurDeprecated - use connSyncCur()
opcSyncHisDeprecated - use connSyncHis()
padZeroAxon function
padlPad string to the left
padrPad string to the right
parseAstParse Axon source code into an abstract syntax tree modeled as a tree of dicts
parseBoolParse a Str into a Bool, legal formats are "true" or "false
parseDateParse a Str into a Date
parseDateTimeParse a Str into a DateTime
parseDiscreteBoolPeriodsParse a Base64 encoded timeline of discrete Bool periods as encoded by discreteBoolPeriods()
parseDiscreteEnumPeriodsParse a base64 encoded string timeline of discrete enum periods as encoded by discreteEnumPeriods()
parseDiscretePeriodsParse a base64 encoded string timeline of discrete periods as encoded by discretePeriods()
parseFilterParse a filter string into a Filter instance
parseFloatParse a Str into a Float
parseIntParse a Str into a integer number using the specified radix
parseNumberParse a Str into a number with an option unit
parseRefParse a Str into a Ref
parseSearchParse a search string into a Filter instance
parseSymbolParse a Str into a Symbol
parseTimeParse a Str into a Time
parseUnitParse a Str into a standardized unit name
parseUriParse a string into a Uri instance
passwordSetStore a password key/val pair into current project's password store
pastMonthDateSpan for last 30days today-30days..today
pastWeekDateSpan for last 7 days as today-7days..today
pastYearDateSpan for this past today-365days..today
piReturn constant for pi
pivotTransform a grid to a pivot table - see Axon Usage
podsReturn list of installed Fantom pods
pointAutoUser level-8 manual auto (override release) of writable point
pointConvertEvaluate a point conversion
pointDetailsGet debug string for point including writables and his collection
pointEmergencyAutoUser level-1 manual auto (override release) of writable point
pointEmergencyOverrideUser level-1 manual override of writable point
pointOverrideUser level-8 manual override of writable point
pointOverrideCommandIssue a point override command based on current user's access control permissions
pointSetDefSet the relinquish default value (level-17) of writable point
pointThermistorTablesReturn grid of thermistor table names as grid with one name column
pointWriteSet a writable point's priority array value at the given level
pointWriteArrayReturn the current priority array state of a writable point
posInfReturn the Number representation positive infinity
powReturn val raised to the specified power
priorityBadgeValAxon function
programReadGiven a program id or rec, return a dict of the program with the XML normalized with the addition of line attribute on each block element
programTargetsGiven a program rec or id, return the a grid with the targets matched by the program's programOn filter
programVarLocsGiven a program id, return a table of all the variables and their line number locations in the program definition
projRebuildRebuild the current project in-place
projSyncBlock until all folio/project message queues are fully processed
provDownloadBuildDownload a SkySpark build from skyfoundry.com and create or update a provBuild manifest for it
provDownloadPatchesDownload all the current patches for a SkySpark build from skyfoundry.com and create or update a provPatch manifest for it
provNewImageCreate a provImage from an ordered list of manifest recs
provSkySparkImageCreate a provImage for the given SkySpark build number
publishPodAxon function
pyCreate a new PySession instance
pyDefineDefine a variable to be available to python code running in the session
pyEvalEvalue the given python statement in the session, and return the result
pyExecExecute the given python code in the session and return the python session
pyInitInitialize the python session by calling the given func to do any one-time setup of the python session
pyTimeoutSet the timeout for pyEval()
quantileComputes the p*th* quantile of a list of numbers, according to the specified interpolation method
queryEvaluate a relationship query and return record dict
queryAllEvaluate a relationship query and return grid of results
queryNamedEvaluate a relationship query and return the named constraints as a dict
randomReturn random integer within given inclusive range
reFindFind the first match of regular expression in s or return null if no matches
reFindAllFind all matches of the regular expression in s
reGroupsReturn a list of the substrings captured by matching the given regular operation against s
reMatchesReturn if regular expression matches entire region of s
readRead from database the first record which matches filter
readAlarmHistoryGiven optional targets and/or a time span, query the alarm history as a grid
readAllReall all records from the database which match the filter
readAllStreamReall all records which match filter as stream of Dict records
readAllTagNamesReturn the intersection of all tag names used by all the records matching the given filter
readAllTagValsReturn the range of all the values mapped to a given tag name used by all the records matching the given filter
readByIdRead a record from database by id
readByIdPersistentTagsGiven record id, read only the persistent tags from Folio
readByIdTransientTagsGiven record id, read only the transient tags from Folio
readByIdsRead a list of record ids into a grid
readByIdsStreamRead a list of ids as a stream of Dict records
readCountReturn the number of records which match the given filter expression
readFileTrio
readFinFile
readFinFileResources
readFinToolsCsvRead a csv from the pod
readLinkRead a record Dict by its id for hyperlinking in a UI
recDeleteRecord delete action
recDisableRecord disable action
recDupRecord duplicate action
recEditRecord edit action
recEnableRecord enable action
recFormReturn a data grid for a form view to edit the specified record
recFormCommitCommit a rec based form to Folio
recNewRecord create action
recTrashRecord trash action
reduceReduce a collection to a single value with the given reducer function
refDisGiven a ref return Ref.dis
refGenGenerate a new unique Ref identifier
refProjNameGiven an absolute ref, return its project name
refreshFinComponents
relDisGet a relative display name
remainderReturn the remainder or modulo of division
removeRemove an item from a collection and return a new collection
removeColReturn a new grid with the given column removed
removeColsReturn a new grid with all the given columns removed
removeMarkerGet the remove value singleton Remove.val
renameColReturn a new grid with the given column renamed
renameColsReturn a new grid with multiple columns renamed
renameTagsRename a set of tags on a list of records or across the entire project database
renameVarAxon function
renameVarByIdAxon function
reorderColsReturn a new grid with the columns reordered
replaceString replace of all occurrences of from with to
replicaBackupAsynchronously kick off a new local backup for given replica
replicaBackupCleanupDelete all local replica backups older than the given duration or date
replicaBackupDeleteDelete a local replica backup file by its timestamp
replicaBackupsList the local replica backups on this machine
reportDataAxon function
retrieveGraphicDependencies
rootMeanSquareErrFold a sample of numbers into their RMSE (root mean square error)
roundReturns the nearest whole number to val
rowToListGet a grid row as a list of cells
ruleDebugReturn a debug grid from the rule engine
ruleDeleteDelete works just like ruleRecompute() except it also deletes the sparks/KPIs from the cache
ruleErrsReturn grid of all the rule+targets which have errors
ruleKpisQuery local KPIs along three dimensions of target x dates x rules
ruleKpisDigestReturn grid of KPIs to use for a notification
ruleOrphansSearch the database for all previously cached sparks and KPIs which no longer have a valid rule record
ruleRecomputeRecompute local sparks or KPIs for the given targets/dates/rules
ruleReobserveClear today's observed flag to re-observe sparks
ruleRosterRefreshForce roster refresh
ruleSparkExplainReturn explanation information for a spark
ruleSparkHisTurn a grid of sparks as returned by ruleSparks() into a history grid of the spark periods
ruleSparksQuery local sparks along three dimensions of target x dates x rules
ruleSparksCountReturn number of sparks as queried by ruleSparks()
ruleSparksDigestReturn grid of sparks to use for a notification
ruleTargetsUnderGet a grid of all the rule targets which are contained by the given parent
ruleTestPerform test run of rule
ruleToTargetsGet all the target records the rule is registered on by the ruleOn tag
ruleTuningReturn the effective tuning Dict for the given target/rule pair
ruleTuningsRead grid of tuning records sorted from lowest to highest priority
rulesToTargetsGet all the target records the list of rules is registered on by the ruleOn tag
runJob
runRoutineAsynchronously run the routine identified by given program, target, and routine name
sampleAddTagsAxon function
saveMacroAxon function
scheduleBadgeTipAxon function
scheduleBadgeTypeAxon function
scheduleBadgeValAxon function
scheduleCreateNewCommitAxon function
scheduleCreateNewDefValAxon function
scheduleCreateNewFormAxon function
scheduleDisplayAxon function
scheduleFindPointsAxon function
scheduleFindPointsCommitAxon function
scheduleGetRefsAxon function
scheduleHisCompute a historical or future timeline of a schedule record
scheduleIconTipAxon function
scheduleMenuAxon function
scheduleMenuSettingsAxon function
scheduleMoveSchedulableAxon function
scheduleSyncBlock until any schedule changes are refreshed
scheduleToolTreeFormAxon function
scheduleToolTreeFormCommitAxon function
scheduleValAtReturn the scheduled value at the given timestamp
secondGet seconds of the time as integer between 0 to 59 from time or datetime
sedonaPingDeprecated - use connPing()
sedonaReadCompSynchronously read the current state of the component identified by the given component identifier
sedonaSyncCurDeprecated - use connSyncCur()
sedonaWriteSynchronously write a property
selectActionDiscoverAxon function
selectActionEquipTreeCreates panels to be displayed on when an item from the equip tree is selected
selectActionGraphicsTreeAxon function
selectActionJobTreeAxon function
selectActionProgramCatTreeAxon function
selectActionProgramCatTree2Axon function
selectActionProgramTasksTreeAxon function
selectActionProgramTreeAxon function
selectActionProgramVarBindingsTreeAxon function
selectActionScheduleTreeAxon function
selectActionScheduleTree2Axon function
selectActionTagBundlesTreeAxon function
sensorFailureCompute periods when a point doesn't change by more than a tolerance
servicesGrid of installed services
setSet a collection item and return a new collection
setColMetaReturn a new grid with column meta-data replaced by given meta dict
setMetaReturn new grid with grid level meta-data replaced by given meta Dict
shortCyclingCompute periods when an bool point's on/off periods are not meeting min on/off times
siemens2dResourcesAxon function
sinReturn sine of angle in radians
sinhReturn hyperbolic sine
sizeReturn number of items in str, list, or grid
skipSkip the given number of items in a stream
snmpGetSynchronously read the current value of the object-type specified by arg
snmpPingDeprecated - use connPing()
snmpReadTableSynchronously read an SNMP table and return it as a Grid
snmpSyncCurDeprecated - use connSyncCur()
sortSort a list or grid
sortDisSort a grid by row display name - see Grid.sortDis Examples
sortrReverse sort a list or grid
specLoad or lookup a Xeto spec by its string or ref qname
specBaseBase spec from which the given spec directly inherits
specFitsReturn if spec a fits spec b based on structural typing
specFitsExplainReturn a grid explaining why spec a does not fit b
specIsReturn if spec a inherits from spec b based on nominal typing
specLibLoad or lookup a Xeto library by its string or ref name
specLibsList Xeto libraries as a list of their dict representation
specMetaGet the spec's effective declared meta-data as dict
specMetaOwnGet the spec's own declared meta-data as dict
specNameReturn simple name of spec
specOfReturn the Xeto spec of the given value
specParentParent spec which contains given spec and scopes its name
specQNameReturn fully qualified name of the spec
specSlotsGet the effective children slots as a dict of Specs
specSlotsOwnGet the spec's declared children slots as dict of Specs
specTypeData type of the spec
specsList Xeto specs as a list of their dict representation
splitSplit a string by the given separator and trim whitespace
spreadFold multiple values to compute the difference between the max and min value
sqlDebugDriversReturn plain text report on JDBC drivers installed
sqlExecuteExecute a SQL statement and if applicable return a result
sqlInsertInsert a record or grid of records into the given table
sqlPingDeprecated - use connPing()
sqlQueryExecute a SQL query and return the result as a grid
sqlSyncHisDeprecated - use connSyncHis()
sqlTablesQuery the tables defined for the database
sqrtReturn square root of val
stackhubMobileAxon function
standardDeviationFold a series of numbers into the standard deviation of a sample
standardFinWatcherstandardFinWatcher An example callback function that gets executed by the FinWatcher A callback function is a func marked record that has a valid Axon src tag
startStart value of a DateSpan, Span or a range
startOfWeekReturn current locale's start of weekday
startsWithReturn if Str starts with the specified Str
streamCreate new stream from given collection
streamColCreate a new stream for the cell values of the given column
stripUncommittableStrip any tags which cannot be persistently committed to Folio
subscribeToGraphicSubscribe To Graphic This method takes a graphic reference and a target reference and will find all of the points utilized in the database and instantiate the watch for this graphic/target combination
sumFold multiple values into their numeric sum
swizzleRefsGiven a grid of records, assign new ids and swizzle all internal ref tags
sysModAddEnable the given system module name such as "ldap"
sysModRemoveDisable the given system module name
sysModsList the installed system mods
sysReloadForce a system reload
tableSet the grid visualization view to table
tagsList tag definitions in the context namespace as Def[]
tanReturn tangent of angle in radians
tanhReturn hyperbolic tangent
targetToRulesGet all the rule records which are registered on given target
targetsToRulesGet all the rule records which are registered on given list of targets
tariffBillPeriodFor the given meter, get the date span of the bill period containing the given date
tariffConsumptionChargeCreate a consumption charge
tariffCostCalculate the cost of energy for a meter
tariffCostToHisFunction to create a computed history for the tariff cost associated with that meter
tariffCreateCreate a new tariff
tariffCreateBillHisCreate the billing period history point
tariffDemandChargeCreate a demand charge
tariffFixedChargeCreate a fixed charge
tariffPercentageChargeCreate a percentage charge
taskLookup a task by id which is any value supported by toRecId()
taskBundleRead the current state of a bundle variable
taskCancelSet cancel flag for the given task
taskCurReturn current task if running within the context of an asynchronous task
taskDiagramGiven task or target rec, return the diagram for all the entity relationships to visualize data sharing
taskGetVarsForGiven a rec or rec id, find all the variables which are set on that record
taskIsRunningIs the current context running asynchrounsly inside a task
taskLocalGetGet a task local variable by name or def if not defined
taskLocalRemoveRemove a task local variable by name
taskLocalSetSet a task local variable
taskMonitorPollPoll the var monitor table for the task identified by the given program and target
taskProgressUpdate the current running task's progress data with given dict
taskRefreshUserRefresh the user account used for tasks
taskRestartRestart a task
taskRunRun the given expression asynchronously in an ephemeral task
taskSendAsynchronously send a message to the given task for processing
taskSendActionAxon function
taskSendLaterSchedule a message for delivery after the specified period of duration has elapsed
taskSendWhenCompleteSchedule a message for delivery after the given future has completed
taskSetMonitorModeSet or clear the monitor mode for a set of variables in the task identified by the given program and target
taskSetUnlinkModeSet or clear the unlink mode for a set of variables in the task identified by the given program and target
taskSetVarsManually set the given task variables identified by the given program and target
taskSleepSleep for the given duration
taskVarTreeReturn a grid which defines a tree of potential variables to create for a target rec
taskVarsBoundToGiven a rec or rec id, find all the task variables which are bound to that rec
taskVarsLinkedToGiven a task identified by the given program and target and a variable name, return all the other tasks where that variable has shared usage
tasksList the current tasks as a grid
templateWizardAppAxon function
templatize
termsList term definitions (tags and conjuncts) in the context namespace as Def[]
thisMonthDateSpan for this month as 1st..28-31
thisQuarterDateSpan for this 3 month quarter
thisWeekDateSpan for this week as sun..sat (uses locale start of week)
thisYearDateSpan for this year Jan-1..Dec-31
timeIf val is a DateTime
timesCall the specified function the given number of times passing the counter
toConvert a number to the given unit
toAhuCoolGiven an ahu rec, get its cool cmd point rec
toAhuDischargeFanGiven an ahu rec, query its discharge fan cmd point rec
toAhuDischargePressureGiven an ahu rec, get its discharge pressure sensor point rec
toAhuDischargeTempGiven an ahu rec, get its discharge temp sensor point rec
toAhuHeatGiven an ahu rec, get its heat cmd point rec
toAhuMixedTempGiven an ahu rec, get its mixed temp sensor point rec
toAhuOutsideDamperGiven an ahu rec, get its outside damper cmd point
toAhuOutsideTempGiven an ahu rec, get its outside temp sensor point rec
toAhuReturnTempGiven an ahu rec, get its return temp sensor point rec
toAhuZoneTempGiven an ahu rec, get its zone temp sensor point rec or throw an exception
toAlarmGiven a target and either a legacy namespace or a new-style alarm state, transition the given namespace/target to the alarm state
toAxonCodeConvert a scalar, list, or dict value to its Axon code representation
toCharConvert a unicode char number into a single char string Examples
toDateSpanConvert the following objects into a DateSpan
toDegreesConvert angle in radians to an angle in degrees
toDevicesMap a set of recs to to a grid of devices
toEquipsMap a set of recs to to a grid of equips
toGridGiven an arbitrary object, translate it to a Grid via Etc.toGrid
toHexConvert a number to a hexadecimal string
toJSON
toJavaMillisGiven a DateTime return Number of milliseconds since Unix epoch
toListIf val is a list return it, otherwise return [val]
toLocaleGet the localized string for the given tag name or qualified name
toMatrixConvert a general grid to an optimized matrix grid
toNormalGiven targets, transition alarms back to normal state using either the legacy API (namespace-based) or the new API (message/occurred/meta)
toOccupiedGiven a site, space, equip, or point rec, get its occupied point
toPointsMap a set of recs to to a grid of points
toRadiansConvert angle in degrees to an angle in radians
toRadixConvert a number to its string representation in the given radix (base)
toRecCoerce a value to a record Dict
toRecIdCoerce a value to a Ref identifier
toRecIdListCoerce a value to a list of Ref identifiers
toRecListCoerce a value to a list of record Dicts
toSitesMap a set of recs to to a grid of sites
toSpacesMap a set of recs to to a grid of spaces
toSpanConvert the following objects into a Span
toStrConvert an obj to its string representation
toTagNameGiven arbitrary string, convert to a safe tag name - see Etc.toTagName
toTimeZoneConvert a DateTime or Span to another timezone
toWeatherAttempt to get the weather station record from
todayReturn today's Date according to context's time zone
transposePerform a matrix transpose on the grid
trapFunction for the -> operator
trendDiscover
trendLearnLearn - discover points on a device
trendPingPing
trendSyncHis
trimTrim whitespace from the beginning and end of the string
trimEndTrim whitespace only from the end of the string
trimStartTrim whitespace only from the beginning of the string
tzGet timezone as city name string in tzinfo database from datetime
tzdbReturn the installed timezone database as Grid with following columns
uiLinkHost relative URI to hyperlink to a Fresco view - see Export
uiLinkAbsConvenience for httpSiteUri() + uiLink() to generate an absolute URI hyperlink
uniqueReturn the unique items in a collection
unitGiven a number return its unit string or null
unitdbReturn the installed unit database as Grid with following columns
unitsEqReturn if the two numbers have the same unit
upperConvert a char number or str to ASCII upper case
uriBasenameGet the basename (last name in path without extension) of a Uri as a string
uriDecodeParse an ASCII percent encoded string into a Uri according to RFC 3986
uriEncodeReturn the percent encoded string for this Uri according to RFC 3986
uriExtGet the URI extension of a Uri as a string or null
uriFragReturn if the fragment identifier portion of the a URI after hash symbol
uriHostGet the host Uri as a string or null
uriIsDirReturn if the URI path ends in a slash
uriNameGet the name Str of a Uri (last item in path)
uriPathGet the path segments of a Uri as a list of Strs
uriPathStrGet the path a Uri as a string
uriPlusSlashAdding trailing slash to the URI
uriPortGet the port of a Uri as a Number or null
uriQueryStrReturn if the query portion of the a URI after question mark
uriSchemeGet the scheme of a Uri as a string or null
userBackupAsynchronously kick off a new backup for user database
userBackupCleanupDelete all user database backups older than the given duration or date
userBackupDeleteDelete a user database backup file by its timestamp
userBackupsList all the user database backups
userCommitCommit one or more diffs to the user database
userCurRead user rec Dict for current session user
userDeleteConfirmAxon function
userFormSetPasswordAxon function
userIsProjAccessibleReturn if the given user has access to the project as configured by projAccessFilter
userLastLoginGet information about the last successful login for the user with the given username
userMfaStatusCheck if MFA is required and if user is enrolled
userMfaTotpResetClear the stored Totp MFA enrollment configuration
userReadRead a rec Dict from the user db by filter
userReadAllRead a Grid of recs from the user db by filter
userReadByIdRead a rec Dict from the user db by id
userSetPasswordUpdate password of the given user
usersAccessFilterWizardAxon function
usersEditUsernameFormAxon function
usersFormAppPermissionsAxon function
usersFormAppPermissionsCommitAxon function
usersFormCloneAxon function
usersFormCloneCommitAxon function
usersFormCreateNewAxon function
usersFormCreateNewCommitAxon function
usersFormCreateNewOptionsAxon function
usersFormEditAxon function
usersFormEditCommitAxon function
usersFormSelectEditAxon function
usersFormSubscriptionsAxon function
usersFormSubscriptionsCommitAxon function
usersInputValidatorAxon function
usersMainMenuSettingsAxon function
usersRunToolAxon function
usersToolSettingsAxon function
usersTypeAxon function
validateFilterRaise an exception if string is not valid filter
validateNotBlankRaise an exception if string is blank
validateTagNameRaise an exception if string is not a validate tag name
validateUsernameRaise an excpetion if string is not a validate username
valsGet the list of values used by a given dict
vizAutoRangeReturn the automatic axis range of a min, max number
vizInterpolateRgbInterpolate a heatmap color using the RGB color model
watchAddAdd a grid of recs to an existing watch and return the grid passed in
watchCloseClose an open watch by id
watchOpenOpen a new watch on a grid of records
watchPollPoll an open watch and return all the records which have changed since the last poll
watchRemoveRemove a grid of recs from an existing watch and return grid passed in
watchSubOp
weatherFormAxon function
weatherReadLocsSearch for matching weather stations given a city name
weatherSunriseTimeGet sunrise for date and location
weatherSunsetTimeGet sunset for date and location
weatherSyncHisImport the latest historical data from the weather web service to the local history database
weekOfYearGiven a DateTime or Date, return the week number of the year
weekdayGet weekday as integer from 0 to 6 of Date or DateTime
wrappedDiffRemoveAxon function
wrappedIoReadJsonAxon function
wrappedIoReadStrAxon function
writeFinFile
writeLocalBindAddressStackConfig
writeLocalDnetNumberStackConfig
writePhyiscalDnetStackConfig
xetoReloadReload all the Xeto libraries
xmlAttrGet an attribute from an element by its non-qualified local name
xmlAttrsGet list of all an elements attributes
xmlElemFind an element by its non-qualified local name
xmlElemsGet the children elements
xmlNameGet the unqualified local name of an element or attribute
xmlNsGet the namespace URI of an element or attribute
xmlPrefixGet the namespace prefix of an element or attribute
xmlQnameGet the qualified local name of an element or attribute which includes both its prefix and unqualified name
xmlReadParse an XML document from an I/O handle and return root element
xmlValIf node is an attribute, then return its value string
xqConstruct new XQuery instance
xqDefineDefine a variable available to subsequent Axon expressions
xqEvalEvaluate an Axon expr in each project - see XQuery.eval
xqExecuteExecute the XQuery and return results
xqFindAllFilter the previous step using an Axon expr - see XQuery.findAll
xqFlatMapMap the previous step to zero or more Dicts using an Axon expr - see XQuery.flatMap
xqHisReadRead point history data - see XQuery.hisRead
xqHisRollupRollup history data - see XQuery.hisRollup
xqHisRollupAutoRollup history data - see XQuery.hisRollupAuto
xqMapMap the previous step using an Axon expr - see XQuery.map
xqPivotTransform previous step into pivot table - see XQuery.pivot Note
xqProjsRestrict query to given project name(s) - see XQuery.projs
xqReadAllRead recs by filter - see XQuery.readAll
xqReadAllListRead recs by filter - see XQuery.readAllList
xqReadByIdsRead recs by ids - see XQuery.readByIds
xqReadByIdsListRead recs by ids - see XQuery.readByIds
xqTimeoutSet timeout for network calls to remote nodes - see XQuery.timeout
xqTraceExecute the XQuery and return debug tracing
xqUseReplicasRoute to replicas instead of master - see XQuery.useReplicas
xstrConstruct decoded XStr instance
yearGet year as integer such as 2010 from date or datetime
yesterdayReturn yesterday's Date according to context's time zone


startHere ​

setupGet SkySpark installed and run the demo
deploymentStep-by-step guide to deploying SkySpark on a project
architectureOverview of the SkySpark architecture

online ​

docTrainingTraining videos
docAppNotesApplication notes
docSkyDiveSkyDive tech talk videos
trainingTraining resources
calendarCalendar for training, demo, and event dates

subsystems ​

folioFolio database
axonAxon scripting language
frescoFresco browser user interface
arcbeamArcbeam clustering technology

All libs listed alphabetically

alarmAlarm Extension
alarmConfig
amchartsThe amcharts v3 charting library
arcArc compound document extension
arcKitStandard document workflows
arcbeamArcbeam connector extension
axonAxon core library
bacnetBACnet Extension
bacnetServerBACnet Server Extension
certAuthTLS Client Certificate Authentication Module
chartbuilderChart builder application
cloneCloning rec based replication extension
clusterArcbeam cluster management
clusterAuthCluster Authentication System Module
connConnector framework
controlControl Engine Extension
dockerDocker management
ecobeeEcobee connector
emailOutbound email via SMTP
energyEnergy analytics
energyStarEnergyStar Portfolio Manager connector
eventEvent database engine
fin5CoreFIN
finAlarmsFIN Alarms Web Components
finAmChartsReactExt
finBlockProgrammingFIN Block Programming
finBuilderFIN
finDashboardFIN Dashboard Editor Extension
finDbBuilderFormsExt
finDocGenPod to generate documentation for J2 pods
finGraphicResourcesFunctions and assets required for various FIN Builder items
finHtmlReportingHtml Reporting Extension
finMailFIN Email Client Extension
finNHaystackExtFIN NHaystack
finNetworkFIN Network Extension
finServerExtFIN
finStackCoreFIN host services
finStackHubToolsFIN StackHub App
finStackMobileThe FIN
finSvgGaugesReactExt
finToolsFIN tools
finWatcherFIN Watcher Extension
finWebUICollection of UI elements/components that can be used with ractive instance
finWindowsDeviceFIN
finstackFINStack Services
geoGeolocation function library
ghgGreenhouse Gas Emission Extension
greenButtonGreen Button function library
haystackHaystack HTTP API connector
hisHistorian core functionality
hisKitHistorian analytics function library
html2pdfAxon extension library to convert webpages to pdf
httpHTTP service handling library
hvacHVAC utility and rule functions
hxHaxall framework definitions
ioI/O function library
jobJob management (deprecated)
knxKNX Connector Extension
ldapLDAP authentication system module
logLogging engine
mapMap extension
mathMath function library
mlMachine learning (ML) function library
modbusModbus connector
mqttMQTT connector
mustacheMustache Extension
navSupport for UI navigation
nestGoogle Nest connector
notificationNotification Extension
notifyNotification Extension
obixoBIX connector
obsObservable data stream framework
opcOPC-UA connector
phProject Haystack core definitions
phIctProject Haystack definitions for Information and Communications Technology
phIoTProject Haystack definitions for Internet of Things
phScienceProject Haystack scientific definitions
pointPoint historization and writable support
projProject management module
provProvisioning management
purgePurge Extension for automated clean-up of alarms, history, etc
pyPython inter-process communication
replSupport for replication
ruleRule engine to compute sparks, KPIs, and curVals
samlSsoSAML SSO Authentication System Module
scheduleScheduling and calendars
schedulerScheduler application
sedonaSedona Sox connector
siemens2dResourcesSiemens Components [siemens2D] styles
skyarcSkyarc library module
snmpSNMP connector
sqlSQL connector
tariffUtility tariff engine
taskAsync task engine
templateWizardExt
trendTrend Connector
uiSupport for Fresco UI
userUser management module
weatherWeather service and functions
xetoXeto spec and data function library
xmlXML function library
xqueryXQuery support module