外观
附录索引(appendix)
原文: https://finproducts.atlassian.net/wiki/spaces/JIDD3/pages/34793324695/FIN+5.3.1+appendix 中文整理基于 FIN 5.3.1
导读: 所有应用按字母顺序列出
以下为 API 参考,保留英文以便对照源码;目录已列出(英文标题便于检索);概述已尽量中译。
目录(导读)
- quick
- listings
- taxonomies
- core
- misc
- conns
- manuals
- ui
- startHere
- online
- subsystems
API 正文(英文)
taxonomies
| association | Associations model ontological relationships between definitions |
| choice | Choice specifies an exclusive marker selection |
| device | Microprocessor based hardware device |
| equip | Equipment asset |
| feature | Feature namespace of definitions formatted as feature:name |
| marker | Marker labels a dict with typing information |
| observable | Observable subscription - see docs |
| phenomenon | Aspect of scientific interest with measurable quantities |
| point | Data point such as a sensor or actuator |
| process | Industrial or HVAC process |
| protocol | Communication protocol used for devices on a network |
| quantity | Measurable property of a substance or phenomenon |
| relationship | Ref tags used to model entity-to-entity relationships |
| site | Site is a geographic location of the built environment |
| space | Space is a three-dimensional volume in the built environment |
| system | Grouping of related equipment dedicated to a single application |
| val | Data value type |
All apps listed alphabetically
| arc | Views used to browse and edit arc documents |
| builder | Views used to build the database |
| clone | Manage clone replication |
| code | Views used to edit and manage the function library |
| conn | Views used to manage and debug connectors |
| debug | Views used for system diagnostics |
| doc | Views used to browse the documentation |
| docker | Views used to manage Docker images |
| energy | Views used to visualize and analyze energy data |
| energyStar | Views used for Energy Star Portfolio Manager integration |
| favs | Views used to browse and manage your saved favorites |
| ghg | Views used to visualize and analyze Greenhouse Gas Emissions |
| his | Views used to visualize and analyze historical point data |
| home | Home screen showing the available applications |
| host | Views used to manage the system which hosts the software |
| kpi | Views used to visualize KPI rule results |
| map | Visualize data on a geographic map |
| misc | Container for ad hoc views |
| monitor | Views used to visualize real-time point data |
| platform | Platform level configuration and management |
| prov | Views used for provisioning software over the cluster |
| rule | Views used to manage configured analytic rules |
| schedule | Views used to manage schedules |
| settings | Views used to edit SysMod and Ext settings |
| spark | Views used to visualize spark rule results |
| task | Views used to configure and debug tasks |
| tools | Views used for administration including the Axon shell |
| users | Views used to manage user accounts |
| weather | Views to visualize and configure weather stations |
| association | Associations model ontological relationships between definitions |
| is | Defines one or more supertypes of a subtyping relationship |
| quantities | Quantities used to measure this phenomenon |
| quantityOf | Associates quantity as measurement of a phenomenon |
| tagOn | This tag is used on the given entity |
| tags | Tags used with this entity |
quick
| lang | Axon language syntax |
| usage | Examples for using common functions |
| streams | Asynchronous streams |
| comps | Axon component model |
core
| axon | Axon core library |
| hx | Haxall framework definitions |
| skyarc | Skyarc library module |
| io | I/O function library |
| his | Historian core functionality |
| hisKit | Historian analytics function library |
| task | Async task engine |
| xquery | XQuery support module |
misc
| alarm | Alarm Extension |
| alarmConfig | |
| arc | Arc compound document extension |
| bacnetServer | BACnet Server Extension |
| clone | Cloning rec based replication extension |
| conn | Connector framework |
| control | Control Engine Extension |
| docker | Docker management |
| Outbound email via SMTP | |
| energy | Energy analytics |
| event | Event database engine |
| fin5Core | FIN |
| finAmChartsReactExt | |
| finBlockProgramming | FIN Block Programming |
| finDashboard | FIN Dashboard Editor Extension |
| finGraphicResources | Functions and assets required for various FIN Builder items |
| finHtmlReporting | Html Reporting Extension |
| finNHaystackExt | FIN NHaystack |
| finNetwork | FIN Network Extension |
| finServerExt | FIN |
| finStackHubTools | FIN StackHub App |
| finStackMobile | The FIN |
| finSvgGaugesReactExt | |
| finTools | FIN tools |
| finWatcher | FIN Watcher Extension |
| finWindowsDevice | FIN |
| finstack | FINStack Services |
| geo | Geolocation function library |
| ghg | Greenhouse Gas Emission Extension |
| greenButton | Green Button function library |
| html2pdf | Axon extension library to convert webpages to pdf |
| http | HTTP service handling library |
| hvac | HVAC utility and rule functions |
| job | Job management (deprecated) |
| log | Logging engine |
| math | Math function library |
| ml | Machine learning (ML) function library |
| mustache | Mustache Extension |
| nav | Support for UI navigation |
| notification | Notification Extension |
| notify | Notification Extension |
| point | Point historization and writable support |
| proj | Project management module |
| prov | Provisioning management |
| py | Python inter-process communication |
| repl | Support for replication |
| rule | Rule engine to compute sparks, KPIs, and curVals |
| schedule | Scheduling and calendars |
| siemens2dResources | Siemens Components [siemens2D] styles |
| tariff | Utility tariff engine |
| templateWizardExt | |
| ui | Support for Fresco UI |
| user | User management module |
| weather | Weather service and functions |
| xeto | Xeto spec and data function library |
| xml | XML function library |
conns
| arcbeam | Arcbeam connector extension |
| bacnet | BACnet Extension |
| ecobee | Ecobee connector |
| energyStar | EnergyStar Portfolio Manager connector |
| finMail | FIN Email Client Extension |
| finStackCore | FIN host services |
| haystack | Haystack HTTP API connector |
| knx | KNX Connector Extension |
| modbus | Modbus connector |
| mqtt | MQTT connector |
| nest | Google Nest connector |
| obix | oBIX connector |
| opc | OPC-UA connector |
| sedona | Sedona Sox connector |
| snmp | SNMP connector |
| sql | SQL connector |
| trend | Trend Connector |
| choice | Choice specifies an exclusive marker selection |
| ahuZoneDelivery | AHU delivery method of conditioned air to the zone |
| chilledBeamZone | AHU supplies air to chilled beam terminal units |
| directZone | AHU supplies air directly to the zone |
| multiZone | AHU discharge air is split into a duct per zone |
| vavZone | AHU supplies air to VAV terminal units |
| airVolumeAdjustability | Ability of air handling equip to adjust volume of air flow |
| constantAirVolume | Delivers a constant volume of air flow |
| variableAirVolume | Delivers a variable volume of air flow |
| arcType | Document type which determines workflow |
| atesDesign | Design type of the ATES underground system |
| atesClosedLoop | The ATES uses closed piping to transport a water/glycol mixture through the ground |
| atesDoublet | The ATES has one or more pairs of a separate warm and cool well |
| atesDoubletPaired | The ATES is as a doublet, but with specific warm and cool wells linked together |
| atesMono | The ATES has only one physical well |
| atesUnidirectional | Similar to a doublet, but water always flows in the same direction from the extraction to the infiltration well |
| chillerMechanism | Primary mechanism of chiller |
| chiller-absorption | Cooling process using energy from heat source such as hot water |
| chiller-centrifugal | Compression via a continuous flow of fluid through an impeller |
| chiller-reciprocal | Piston compressor driven by a crankshaft |
| chiller-rotaryScrew | Rotary screw compression |
| condenserLoop | Open or closed loop for condenser working fluid |
| condenserClosedLoop | Working fluid is kept separate from fluid used for heat transfer into the atmosphere |
| condenserOpenLoop | Uses working fluid itself for evaporation into the atmosphere |
| coolingProcess | Processed used to cool a substance |
| airCooling | Cooling by dissipating heat into the surrounding air |
| chilledWaterCooling | Cooling using transfer of heat to chilled water |
| condenserCooling | Removal of heat through the process of water condensation |
| dxCooling | Cooling using direct expansion of a refrigerant vapor |
| waterCooling | Cooling using transfer of heat to water which is not explicitly chilled |
| ductConfig | Ductwork configuration |
| dualDuct | Two ducts |
| singleDuct | One single duct |
| tripleDuct | Three ducts |
| ductDeck | Cold, hot, or neutral deck |
| coldDeck | Duct carries air for cooling |
| hotDeck | Duct carries air for heating |
| neutralDeck | Duct carries air which by-passes both heating and cooling coils |
| ductSection | Equipment section of ductwork |
| discharge | Duct for air leaving an equipment |
| economizer | Duct to access fresh outside air only for economizing, not ventilation |
| exhaust | Duct used to expel air back outside |
| flue | Duct for exhausting combustion |
| inlet | Duct with air entering an equipment |
| mixed | Duct where fresh outside air and return air is mixed together |
| outside | Duct to access fresh outside air for both ventilation and economizer |
| return | Duct returning air back to equipment |
| ventilation | Duct to access fresh outside air only for ventilation, not economizing |
| heatingProcess | Processed used to heat a substance |
| biomassHeating | Heating by the combustion of biomass |
| coalHeating | Heating by the combustion of coal |
| dxHeating | Heating using direct expansion of a refrigerant vapor |
| elecHeating | Heating by the conversion of electrical energy |
| fuelOilHeating | Heating by the combustion of fuel oil |
| hotWaterHeating | Heating using energy of hot water |
| naturalGasHeating | Heating by the combustion of natural gas |
| propaneHeating | Heating by the combustion of propane |
| steamHeating | Heating using energy of steam |
| meterScope | Classifies a meter as a main site meter or submeter |
| siteMeter | Main meter for the associated site |
| submeter | Submeters measure usage of a sub-system or equipment within a site |
| observes | Observable subscription - see docs |
| pfScope | Power factor scope |
| pfDisplacement | Displacement power factor, which accounts for the phase angle between voltage and current but excludes effects of nonlinear waveforms ( harmonic distortion) |
| pfDistortion | Distortion power factor, which measures the component of power factor attributable to harmonic distortion in voltage and current waveforms |
| pfTrue | True power factor, which includes effects of harmonic distortion |
| pfStandard | Standard for interpreting power factor's positive or negative sign |
| pfIec | Power factor according to the IEC convention defines a positive or negative sign based on the direction of active power flow |
| pfIeee | Power factor according to the IEEE convention defines a positive or negative sign based on whether the load is capacitive or inductive |
| phaseCount | Number of phases for an AC electrical power system or connected equipment |
| singlePhase | Single-phase AC electricity |
| splitPhase | Split-phase AC electricity |
| threePhase | Three-phase AC electricity |
| twoPhase | Two-phase AC electricity |
| pipeFluid | Type of fluid conveyed by piping |
| pipeSection | Equipment section of piping |
| bypass | Pipe used to bypass an equipment |
| circ | Pipe used to circulate fluid through an equipment or system |
| entering | Pipe conveys fluid into an equipment |
| header | Pipe used as central connection or manifold for other piping runs |
| leaving | Pipe conveys fluid out of an equipment |
| plantLoop | Plant piping loop |
| primaryLoop | Pipework which circulates closest to the energy source |
| secondaryLoop | Pipework which circulates closest to the building or end use |
| tertiaryLoop | Pipework which circulates within the building |
| pointFunction | Classifies the point as a sensor, command, or setpoint |
| cmd | Point is a command, actuator, AO/BO |
| sensor | Point is a sensor, input, AI/BI |
| sp | Point is a setpoint, soft point, internal control variable, schedule |
| synthetic | Synthetic point with computed operational data |
| computed | Computed point |
| ml | Machine learning point |
| sim | Simulation point |
| pointQuantity | Quantity the point senses or controls |
| pointSubject | What the point senses or controls |
| ruleType | Rule type choice |
| curRule | Marker tag for a cur rule type |
| kpiRule | Marker tag for a KPI rule type |
| sparkRule | Marker tag for a spark rule type |
| simScenario | See Synthetics chapter |
| simBaseline | See Synthetics chapter |
| simOperation | See Synthetics chapter |
| simOptimum | See Synthetics chapter |
| tankSubstance | Substance stored by a tank |
| vavAirCircuit | How does the VAV pull in air |
| vav-parallel | VAV pulls air from outside the primary air flow |
| vav-series | VAV pulls air from the primary air flow |
| vavModulation | How does VAV modulate the temp based on duct pressure |
| pressureDependent | VAV damper modulates to control space temp |
| pressureIndependent | VAV damper or a control valve that modulates to maintain desired flow setpoint |
All tag conjuncts listed alphabetically
| ac-elec | Alternating current electricity |
| ac-elec-meter | AC Electricity meter |
| ac-evse-port | An AC EVSE port delivers ac electricity to a single EV charging inlet at a time |
| ac-freq | Frequency of an alternating current waveform |
| active-energy | Active energy in an AC eletrical power system |
| active-power | Active power or real power |
| air-conditioning-system | System for air treatment to control its temperature, humidity, cleanliness, and distribution to meet the requirements of a conditioned space |
| air-exhaust-system | System consisting of one or more fans that remove air from the building |
| air-input | Entity inputs air which flows from another entity |
| air-output | Entity outputs air to other entities |
| air-system | System for moving air to maintain indoor thermal comfort and/or air quality |
| air-temp | Dry bulb temperature |
| air-velocity | Rate of air movement as distance over time |
| air-ventilation-system | System 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-energy | Apparent energy in an AC eletrical power system |
| apparent-power | Apparent power |
| atmospheric-pressure | Barometric pressure exerted by the weight of the atmosphere |
| blowdown-water | Water expelled from a system to remove mineral build up |
| blowdown-water-input | Entity inputs blowdown water which flows from another entity |
| blowdown-water-output | Entity outputs blowdown water to other entities |
| ch2o-concentration | Concentration of formaldehyde (CH₂O) in the air |
| ch4-emission | Greenhouse gas emission of methane (CH₄) into the air |
| chilled-water | Water cooled for use in HVAC and industrial processes |
| chilled-water-input | Entity inputs chilled water which flows from another entity |
| chilled-water-output | Entity outputs chilled water to other entities |
| chilled-water-plant | Plant used to generate chilled water for cooling |
| chilled-water-system | System that circulates water in its liquid state below ambient temperature for cooling a space or process |
| chiller-absorption | Cooling process using energy from heat source such as hot water |
| chiller-centrifugal | Compression via a continuous flow of fluid through an impeller |
| chiller-reciprocal | Piston compressor driven by a crankshaft |
| chiller-rotaryScrew | Rotary screw compression |
| co-concentration | Concentration of carbon monoxide (CO) in the air |
| co2-concentration | Concentration of carbon dioxide (CO₂) in the air |
| co2-emission | Greenhouse gas emission of carbon dioxide (CO₂) into the air |
| cold-water | Water supplied to cold taps |
| computed-point | See Synthetics chapter |
| condensate-input | Entity inputs condensate which flows from another entity |
| condensate-output | Entity outputs condensate to other entities |
| condenser-water | Water used used to remove heat through condensation |
| condenser-water-input | Entity inputs condenser water which flows from another entity |
| condenser-water-output | Entity outputs condenser water to other entities |
| condenser-water-system | System that circulates water in its liquid state for rejecting heat from a space or process |
| controls-panel | Panel housing controllers and networking gear |
| cool-water | Relatively cool water without active chilling |
| cur-point | Point with support to report a "real-time" current value |
| current-angle | AC current phase angle |
| current-imbalance | AC current phase imbalance |
| current-magnitude | Root-mean-square (RMS) magnitude of AC electrical current |
| current-thd | Total harmonic distortion (THD) of AC current |
| damper-actuator | Actuator to regulate the flow of air |
| dc-elec | Direct current electricity |
| dc-elec-meter | DC Electricity meter |
| dc-evse-port | A DC EVSE port delivers dc electricity to a single EV charging inlet at a time |
| domestic-cold-water-system | System that circulates potable cold water in its liquid state for purposes other than space cooling and process requirements |
| domestic-hot-water-system | System that circulates potable hot water in its liquid state for purposes other than space heating and process requirements |
| domestic-water | Tap water for drinking, washing, cooking, and flushing of toilets |
| domestic-water-input | Entity inputs domestic water which flows from another entity |
| domestic-water-output | Entity outputs domestic water to other entities |
| domestic-water-system | System that circulates potable water in its liquid state for purposes other than space conditioning and process requirements |
| elec-current | Electrical current |
| elec-demand | Active power averaged over a regular interval |
| elec-energy | Electrical energy |
| elec-input | Entity inputs electricity which flows from another entity |
| elec-meter | Electricity meter |
| elec-output | Entity outputs electricity to other entities |
| elec-panel | Physical housing for electrical circuits, fuses, and breakers |
| elec-power | Rate of electrical energy transfer |
| elec-system | System that generates, converts, distributes, and/or stores electricity |
| elec-volt | Electrical voltage, potential difference |
| evse-cable | The electrical cable between an evse-port and an EV charging inlet on a vehicle |
| evse-dispenser | Equipment that dispenses electricity to an EV |
| evse-equip | Equipment that supports the delivery of electricity to charging inlets located on EVs |
| evse-port | An EVSE port delivers electricity to a single EV charging inlet at a time |
| evse-powerConverter | A power converter that has a dc electrical output applied to a dc-evse-port |
| evse-system | A system that supplies electricity to EVSE assembly equipment and its auxiliary loads |
| fan-motor | Motor used with a fan to create air flow |
| flow-meter | Meter to measure flow rate and total volume of fluid |
| fuelOil-input | Entity inputs fuel oil which flows from another entity |
| fuelOil-output | Entity outputs fuel oil to other entities |
| gasoline-input | Entity inputs gasoline which flows from another entity |
| gasoline-output | Entity outputs gasoline to other entities |
| ground-floor | Floor at ground level |
| ground-water | Water present under the ground or from a well |
| hfc-emission | Greenhouse gas emission of hydrofluorocarbons into the air |
| his-point | Historized point with a history log of timestamp/value pairs |
| hot-water | Hot water used for HVAC heating or supplied to hot taps |
| hot-water-boiler | Boiler which outputs hot water |
| hot-water-input | Entity inputs hot water which flows from another entity |
| hot-water-output | Entity outputs hot water to other entities |
| hot-water-plant | Plant used to generate hot water for heating |
| hot-water-system | System that circulates water in its liquid state for heating a space or process |
| humidifier-equip | Equipment which adds moisture to air to increase humidity |
| hvac-zone-space | Zone related to conditioning of a space's air temperature and quality |
| light-level | Sensed or controlled dimming level of electrical lighting |
| lighting-system | System designed to provide lighting |
| lighting-zone-space | Zone related to lighting system |
| luminous-flux | Total perceived light in all directions |
| luminous-intensity | Perceived light in a particular direction per unit solid angle |
| makeup-water | Water used used to makeup water loss through leaks, evaporation, or blowdown |
| makeup-water-input | Entity inputs makeup water which flows from another entity |
| makeup-water-output | Entity outputs makeup water to other entities |
| ml-point | See Synthetics chapter |
| mobile-phone | Cellular phone providing telecommunication over radio links |
| n2o-emission | Greenhouse gas emission of nitrous oxide (N₂O) into the air |
| naturalGas-input | Entity inputs natural gas which flows from another entity |
| naturalGas-output | Entity outputs natural gas to other entities |
| networking-device | Microprocessor device used to establish networks |
| networking-router | Networking device used to route data between different networks |
| networking-switch | Networking device used to connect devices on the same network |
| nf3-emission | Greenhouse gas emission of nitrogen trifluoride (NF₃) into the air |
| nh3-concentration | Concentration of ammonia (NH₃) in the air |
| no2-concentration | Concentration of nitrogen dioxide (NO₂) in the air |
| o3-concentration | Concentration of ozone (O₃) in the air |
| pfc-emission | Greenhouse gas emission of perfluorocarbons into the air |
| pm01-concentration | Concentration of particulate matter 0.1 in the air |
| pm10-concentration | Concentration of particulate matter 10 in the air |
| pm25-concentration | Concentration of particulate matter 2.5 in the air |
| pump-motor | Motor used with a pump to move fluid |
| purge-water | Water expelled from a system to remove contaminants |
| reactive-energy | Reactive energy in an AC eletrical power system |
| reactive-power | Reactive power or imaginary power |
| refrig-input | Entity inputs refrigerant which flows from another entity |
| refrig-output | Entity outputs refrigerant to other entities |
| refrig-system | Refrigerant distribution to fulfill all or parts of a refrigeration cycle |
| roof-floor | The roof floor is the topmost level of a building |
| server-computer | General purpose computer used as a server |
| sf6-emission | Greenhouse gas emission of sulphur hexafluoride (SF₆) into the air |
| sim-point | See Synthetics chapter |
| solar-irradiance | Energy received on surface of the earth from the sun |
| steam-boiler | Boiler which outputs steam |
| steam-input | Entity inputs steam which flows from another entity |
| steam-output | Entity outputs steam to other entities |
| steam-plant | Plant used to generate steam for heating |
| steam-system | System that circulates water in its vapor state for heating a space or process |
| subterranean-floor | Floor below ground level |
| synthetic-point | See Synthetics chapter |
| tvoc-concentration | Concentration of total volatile organic compounds (TVOC) in the air |
| valve-actuator | Actuator to regulate the flow of fluid |
| vav-parallel | VAV pulls air from outside the primary air flow |
| vav-series | VAV pulls air from the primary air flow |
| vfd-freq | VFD frequency measured in "Hz" |
| vfd-speed | VFD speed measured in "%" |
| volt-angle | AC voltage phase angle |
| volt-imbalance | AC voltage phase imbalance |
| volt-magnitude | Root-mean-square (RMS) magnitude of AC electrical voltage |
| volt-thd | Total harmonic distortion (THD) of AC voltage |
| vrf-coolingOnly-system | Cooling only VRF system can only cool |
| vrf-equip | Equipment used in VRF systems |
| vrf-heatPump-system | Heat pump VRF system can either heat, or cool, but not at the same time |
| vrf-heatRecovery-system | Heat recovery VRF system can operate cooling and heating by each indoor unit independently, at the same time |
| vrf-indoorUnit | Indoor unit in a VRF system |
| vrf-indoorUnit-fcu | Indoor unit fan coil unit in a VRF system |
| vrf-outdoorUnit | Outdoor unit with one or more compressors in a VRF system |
| vrf-refrig-plant | Group of outdoor units in a VRF system |
| vrf-system | Variable refigerant flow system |
| warm-water | Relatively warm water without active heating |
| water-system | System that supplies or collects potable or non-potable water in any state |
| weather-point | Weather station observation point |
| wind-direction | Compass direction from which wind originates |
| wind-speed | Wind flow speed |
| writable-point | Point with writable output using 16-level priority array |
| zone-space | Space associated with a specific system |
| device | Microprocessor based hardware device |
| computer | General purpose computer |
| laptop | Portable laptop computer |
| server-computer | General purpose computer used as a server |
| controller | Microprocessor based device used in a control system |
| networking-device | Microprocessor device used to establish networks |
| networking-router | Networking device used to route data between different networks |
| networking-switch | Networking device used to connect devices on the same network |
| phone | Telephone used for voice telecommunication |
| mobile-phone | Cellular phone providing telecommunication over radio links |
| tablet | Mobile device with touch screen for user input |
| equip | Equipment asset |
| actuator | Equipment to move or control a mechanism |
| damper-actuator | Actuator to regulate the flow of air |
| valve-actuator | Actuator to regulate the flow of fluid |
| airHandlingEquip | HVAC equipment that conditions and delivers air via one or more fans |
| ahu | Air Handling Unit |
| doas | Dedicated Outside Air System |
| mau | Makeup Air Unit |
| rtu | Roof Top Unit |
| fcu | Fan Coil Unit |
| crac | Computer Room Air Conditioner |
| unitVent | Unit Ventilator |
| vrf-indoorUnit-fcu | Indoor unit fan coil unit in a VRF system |
| airTerminalUnit | Equipment in air distribution systems which terminate at the space |
| cav | Constant air volume terminal unit |
| vav | Variable air volume terminal unit |
| ates | Aquifer Thermal Energy Storage system |
| battery | Equipment used to store electric energy |
| boiler | Equipment to generate hot water or steam for heating |
| hot-water-boiler | Boiler which outputs hot water |
| steam-boiler | Boiler which outputs steam |
| cable | An assembly of one or more insulated conductors |
| chiller | Equipment to remove heat from a liquid |
| circuit | Electrical circuit and its associated components such as breakers |
| conduit | Duct, pipe, or cable to convey a substance or phenomenon |
| duct | Conduit used to convey air for HVAC |
| pipe | Conduit used to convey a fluid |
| wire | Cabling used to convey electricity or data |
| coolingTower | Equipment to transfer waste heat into the atmosphere |
| evse-equip | Equipment that supports the delivery of electricity to charging inlets located on EVs |
| evse-cable | The electrical cable between an evse-port and an EV charging inlet on a vehicle |
| evse-dispenser | Equipment that dispenses electricity to an EV |
| evse-port | An EVSE port delivers electricity to a single EV charging inlet at a time |
| ac-evse-port | An AC EVSE port delivers ac electricity to a single EV charging inlet at a time |
| dc-evse-port | A DC EVSE port delivers dc electricity to a single EV charging inlet at a time |
| evse-powerConverter | A power converter that has a dc electrical output applied to a dc-evse-port |
| flowInverter | System to change direction of substance flow |
| fumeHood | Ventilation equipment to limit exposure to hazardous fumes |
| heatExchanger | Equipment to transfer heat between two working fluids |
| coil | Heat exchanger used to heat or cool air |
| coolingCoil | Coil used to cool air |
| heatingCoil | Coil used to heat air |
| humidifier-equip | Equipment which adds moisture to air to increase humidity |
| luminaire | Light fixture using electricity to provide illumination |
| meter | Equipment to meter a substance or phenomenon |
| elec-meter | Electricity meter |
| ac-elec-meter | AC Electricity meter |
| dc-elec-meter | DC Electricity meter |
| evse-port | An EVSE port delivers electricity to a single EV charging inlet at a time |
| ac-evse-port | An AC EVSE port delivers ac electricity to a single EV charging inlet at a time |
| dc-evse-port | A DC EVSE port delivers dc electricity to a single EV charging inlet at a time |
| flow-meter | Meter to measure flow rate and total volume of fluid |
| motor | Equipment that converts electrical energy into mechanical energy |
| fan-motor | Motor used with a fan to create air flow |
| pump-motor | Motor used with a pump to move fluid |
| panel | Enclosure for electrical and control equipment |
| controls-panel | Panel housing controllers and networking gear |
| elec-panel | Physical housing for electrical circuits, fuses, and breakers |
| plant | Central plant used to generate a substance for a process |
| chilled-water-plant | Plant used to generate chilled water for cooling |
| hot-water-plant | Plant used to generate hot water for heating |
| steam-plant | Plant used to generate steam for heating |
| vrf-refrig-plant | Group of outdoor units in a VRF system |
| rack | Enclosure or chassis used to mount computer and networking gear |
| radiantEquip | HVAC equipment that conditions a space without forced air |
| chilledBeam | Conditions a space using a heat exchanger integrated into the ceiling |
| radiantFloor | Heats a space using pipes or cables embedded beneath floor |
| radiator | Heats a space using exposed pipes or coils |
| tank | Tank used to store a substance for temporary holding |
| thermostat | Senses and controls temperature of space in HVAC system |
| ups | Uninterruptible power supply |
| verticalTransport | Equipment to move humans and materials |
| elevator | Enclosure used to move people between floors |
| escalator | Moving staircase used to move people between floors |
| movingWalkway | Conveyor to move people across a horizontal or inclined plane |
| vrf-equip | Equipment used in VRF systems |
| branchSelector | Branch selector used for heat recovery in a VRF system |
| vrf-indoorUnit | Indoor unit in a VRF system |
| vrf-indoorUnit-fcu | Indoor unit fan coil unit in a VRF system |
| vrf-outdoorUnit | Outdoor unit with one or more compressors in a VRF system |
| well | A well is a source of groundwater and potentially thermal energy |
manuals
| docIntro | Fantom overview and getting started |
| docLang | Fantom language documentation |
| docDomkit | Fantom DomKit HTML5 UI framework documentation |
| docTools | Fantom command line tools |
core
| sys | Fantom system runtime |
| haystack | Haystack model and client API |
| axon | Axon scripting engine |
| folio | Folio database APIs |
| hx | Haxall framework APIs |
| skyarc | SkySpark framework APIs |
| skyarcd | SkySpark framework daemon APIs |
| hxConn | Haxall connector framework |
ui
| graphics | Graphics API |
| dom | Web Browser DOM API |
| domkit | DOM Based UI Framework |
| ui | Fresco user interface framework |
misc
| alarmExt | Alarm Extension |
| asn1 | ASN.1 Data Model |
| bacnetExt | BACnet Extension |
| bacnetServerExt | BACnet Server Extension |
| build | Fantom build utility |
| concurrent | Utilities for concurrent programming |
| controlExt | Control Engine Extension |
| crypto | Cryptography API |
| Email support | |
| fanc | Fan command line compiler |
| fandoc | Fandoc parser and DOM |
| fin | FIN core extension APIs |
| fin5CoreExt | FIN |
| finAmChartsReactExt | |
| finApp | FIN application framework |
| finBacnetExt | Fin BACnet Extension |
| finBuild | FIN Build Utility |
| finBuilderExt | FIN |
| finChartBuilder | FIN chart builder application |
| finConn | FIN core connector extension APIs |
| finDashboardExt | FIN Dashboard Editor Extension |
| finEdge2Cloud | FIN's Edge2Cloud |
| finFolioLiteExt | |
| finHtmlReporting | Html Reporting Extension |
| finMailExt | FIN Email Client Extension |
| finMiniDBExt | |
| finNHaystackExt | FIN NHaystack |
| finNetworkExt | FIN Network Extension |
| finOidc | FIN OpenID Connect SSO |
| finScheduler | FIN scheduler application |
| finServerExt | FIN |
| finSettings | Settings app and definition module for FIN |
| finSmtp | Siemens Desigo Optic SMTP Oauth Library |
| finStackCoreExt | FIN host services |
| finStackExt | FINStack Services |
| finStackHost | FinStack Host |
| finStackHubToolsExt | FIN StackHub App |
| finStackSerial | Serial port provider |
| finSvgGaugesReactExt | |
| finWatcherExt | FIN Watcher Extension |
| finWindowsDevice | FIN |
| html2pdfExt | Axon extension library to convert webpages to pdf. |
| hxComps | Core Components Library |
| hxPy | Python IPC |
| inet | IP networking |
| j2FinToolsExt | FIN tools |
| knx | KNX Library |
| knxExt | KNX Connector Extension |
| markdown | Markdown parsing and rendering |
| math | Math utilities and functions |
| mustacheExt | Mustache Templating System |
| notificationExt | Notification System |
| obs | Observable data stream framework |
| purgeExt | Purge Extension for automated clean-up of alarms, histor... |
| sql | Relational database access |
| stackhub | StackHub library |
| syntax | Syntax styling for programming languages |
| trendExt | Trend Connector |
| util | Utilities |
| web | Standard weblet APIs for processing HTTP requests |
| webmod | Standard library of WebMods |
| wisp | Wisp web Server |
| xeto | Xeto data and spec APIs |
| xml | XML Parser and Document Modeling |
| yaml | YAML parser for Fantom |
| feature | Feature namespace of definitions formatted as feature:name |
| app | UI application grouping of views |
| filetype | File format type definition |
| finDashboard | Feature namespace of definitions formatted as feature:name |
| finDropOverride | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
| lib | Library module of symbolic definitions |
| ext | Extension library |
| sysMod | System module library |
| op | Operation for HTTP API |
| tag | Legacy backward compatible tag definitions |
| view | Fresco UI view |
All filetypes listed alphabetically
| csv | Comma Separated Values - see CSV |
| excel | Excel 2003 XML spreadsheet |
| html | HyperText Markup Language |
| json | Haystack JavaScript Object Notation format - see Json |
| jsonld | JavaScript Object Notation for Linked Data - see RDF |
| Portable Document Format | |
| svg | Scalable Vector Graphics |
| trio | Haystack Tag Record Input Output - see Trio |
| turtle | RDF Turtle - see RDF |
| xml | EXtensible Markup Language |
| zinc | Haystack typed CSV format - see Zinc |
All finDropOverrides listed alphabetically
| finNetworkTree___connTuning | Feature namespace of definitions formatted as feature:name |
| finNetworkTree___connectors | Feature namespace of definitions formatted as feature:name |
| finNetworkTree___equipTree | Feature namespace of definitions formatted as feature:name |
| finNetworkTree___finSettingsTree | Feature namespace of definitions formatted as feature:name |
| finNetworkTree___finSnapshotsTree | Feature namespace of definitions formatted as feature:name |
| finNetworkTree___graphics | Feature namespace of definitions formatted as feature:name |
| finNetworkTree___job | Feature namespace of definitions formatted as feature:name |
| finNetworkTree___programs | Feature namespace of definitions formatted as feature:name |
| finNetworkTree___relationship | Feature namespace of definitions formatted as feature:name |
| finNetworkTree___savedQueryFilter | Feature namespace of definitions formatted as feature:name |
| finNetworkTree___schedules | Feature namespace of definitions formatted as feature:name |
| finNetworkTree___tagBundle | Feature namespace of definitions formatted as feature:name |
| finNetworkTree___template | Feature namespace of definitions formatted as feature:name |
| finNetworkTree___topic | Feature namespace of definitions formatted as feature:name |
All funcs listed alphabetically
| about | Return about dict |
| abs | Return absolute value of a number, if null return null |
| acos | Return the arc cosine |
| actionNormInput | Normalize action input - see Committer.actionNormInput |
| add | Add item to the end of a list and return a new list |
| addAll | Add all the items to the end of a list and return a new list |
| addCol | Add a column to a grid by mapping each row to a new cell value |
| addColMeta | Return a new grid with additional column meta-data |
| addCols | Add grid b as a new set of columns to grid a |
| addMeta | Return new grid with additional grid level meta-data tags |
| addNavURI | |
| addReport | |
| addRow | Add an additional Dict row to the end of a grid |
| addRows | Add an list of rows to the end of a grid |
| addSimilarTypes | Axon function |
| addStateMachineVars | Axon function |
| addVarIds | Axon function |
| ahuCoolAndEcon | Compute periods when AHU is in both cooling and economizing modes |
| ahuCoolAndHeat | Compute periods when AHU is in both cooling and heating modes |
| ahuCoolHeatCycling | Compute periods between cooling and heating which do not meeting a min time |
| ahuCoolPeriods | Compute periods when AHU is in cooling mode or matches given criteria |
| ahuEconPeriods | Compute periods when AHU is in economizing mode when the damper position is over 10% |
| ahuFanFailure | Params |
| ahuFanPeriods | Compute periods when AHU's supply fan is running or matches given criteria |
| ahuHeatAndEcon | Compute periods when AHU is in both cooling and economizing modes |
| ahuHeatPeriods | Compute periods when AHU is in heating mode or matches given criteria |
| ahuOnAndFanOff | Params |
| alarmAck | Given a set of alarms (or alarm ids), acknowledge them and return the updated alarm records |
| alarmActivityPeriods | Example |
| alarmConfigApp | Axon function |
| alarmDigest | Generate an alarm digest grouped by a given parent type |
| alarmHistoryCount | Given an optional target, return the count of alarm history records |
| alarmHistoryQuery | Given a Haystack query string, return the alarm history records as a grid |
| alarmNavCounts | Given a grid of target records with id, enrich it with rolled-up alarm counts per row |
| alarmTargets | Given a root object, return all alarm target records associated with it |
| alarms | Given optional targets and/or a time span, return the current alarm records as a grid |
| alarmsGetById | Given an alarm id, return the corresponding alarm record |
| alarmsRemove | Given a set of alarms (or alarm ids), remove them from the database and return the removed alarm records |
| alarmsV2Menu | Axon function |
| all | Return if all the items in a list, dict, or grid match the given test function |
| any | Return if any the items in a list, dict, or grid match the given test function |
| applyReplace | Axon function |
| arcDigest | Format a grid of arc summary records for a notification |
| arcEdit | Commit a diff to an existing arc rec |
| arcEditPart | Edit an existing part on a record |
| arcMove | Move an arc document to another project database based on arcOn ref Return new arc document as grid |
| arcNew | Create a new arc |
| arcNewPart | Add a new part to an arc record |
| arcRead | Return the encoding of an arc and all its parts as a grid |
| arcReadAllUnder | Read summary grid of arcs with an arcOn contained by the given parent |
| arcRemovePart | Remove an existing part on a record |
| arcbeamCall | Evaluate a platform specific operation on the remote node |
| arcbeamEval | Evaluate a platform specific expression on the remote node |
| arcbeamRead | Read a single record from remote node with filter and return as a dict |
| arcbeamReadAll | Read a grid of records from remote node with a filter |
| arcbeamReadById | Read a record from the remote node by its unique id and return as dict |
| arcbeamReadByIds | Read a list of records from remote node by their identifiers |
| arcs | Given a grid of source data, return the arcs and the arc summaries which are available for the source data |
| as | Set the unit of a number |
| asin | Return the arc sine |
| atan | Return the arc tangent |
| atan2 | Converts rectangular coordinates (x, y) to polar (r, theta) |
| avg | Fold multiple values into their standard average or arithmetic mean |
| bacnetAcknowledgeAlarm | Acknowledges an alarm |
| bacnetAddEnumPropValMapping | The method will save Enum and property value conversion mapping for schedule object e.g |
| bacnetAddRouterEntry | Make a network Table entry manually of router |
| bacnetAddToNotificationClass | Adds the connector to the provided notification class, to enable receiving alarm/event notifications |
| bacnetAny | The method will convert the input data/Dict to given type |
| bacnetApplyNetworkPortPendingChanges | Apply the pending changes in the stack configuration by restarting the stack with new changes Examples |
| bacnetAtomicReadFile | Reads the content of a BACnet File object |
| bacnetAtomicWriteFile | Writes the content of a IOHandle to a BACnet File object |
| bacnetBackupDevice | Takes the backup of the Device |
| bacnetCharString | The method will convert the input Str to Character String |
| bacnetCharacter | The method will convert the input Str to Character Array |
| bacnetClientRestart | Restart the stack Parameters |
| bacnetConfirmedTextMessage | The ConfirmedTextMessage service is used by a client BACnet-user to send a text message to another BACnet device |
| bacnetCreateObject | Create a Bacnet Object Parameters |
| bacnetDbcsString | The method will convert the input Str to dbcs String |
| bacnetDeleteObject | Delete a Bacnet Object Parameters |
| bacnetDeviceCommunicationControl | bacnetDeviceCommunicationControl(@connRef, dccValue, timeRem, password) bacnetDeviceCommunicationControl(read(bacnetConn), 0, 180sec) bacnetDeviceCommunicationControl(read(bacnetConn),"ENABLE", 2min) |
| bacnetDeviceDiscovery | Discover BACnet devices and returns a grid with them |
| bacnetDiscoverObjects | Discover BACnet objects from the BACnet device |
| bacnetDouble | The method will convert the input Number to Double |
| bacnetEmptyList | The method indicates to write an empty list |
| bacnetEnrollmentSummary | The GetEnrollmentSummary service is used to obtain a summary of event-initiating objects Parameters |
| bacnetEnum | The method will convert the input Number to Enumeration |
| bacnetGetAlarmSummary | Retrieves the Alarm Summary from the device and adds them in the Alarm Extension |
| bacnetGetBackupStatus | Gets the device backup information |
| bacnetGetDeviceInstanceNumber | The method will return the bacnet device instance number |
| bacnetGetDeviceObjectName | The 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 |
| bacnetGetHandledAlarms | Returns the handled alarms from this Bacnet connector |
| bacnetGetHandledEvents | |
| bacnetGetLocalBindAddress | The method will get localBindAddress |
| bacnetGetLocalDnetNumber | The method will return the local dnet number |
| bacnetGetMaxDeviceInstance | |
| bacnetGetMaxMacAddress | |
| bacnetGetMaxNetworkNumber | |
| bacnetGetNotificationSubscriptions | Returns all the Notification Classes this current connector receives notifications from |
| bacnetGetPhysicalPortDnetNumber | The method will get physical port dnet Number |
| bacnetGetStackConfigKeys | Method will return all the config keys defined by the system |
| bacnetGetStringTypeSupported | Retrieves the String type supported for the connector |
| bacnetGetUnhandledAlarms | Returns the unhandled alarms from this Bacnet connector This is more for testing purposes, to see we are receiving alarms |
| bacnetGetUnhandledEvents | Returns the unhandled alarm events (type=event) of Bacnet connector This is more for testing purposes, to see we are receiving alarms |
| bacnetIsoString | The method will convert the input Str to Iso8859 String |
| bacnetJisString | The method will convert the input Str to Jisc6226 String |
| bacnetLearn | Returns a grid with the BACnet objects residing on the device the connector points to |
| bacnetLifeSafetyOperation | - conn |
| bacnetListBroadcastIps | List all the available IPv4 broadcast addresses |
| bacnetListLocalIps | List all the available IPv4 local addresses, excluding the loopback |
| bacnetLocalBindAddress | Returns the local address to which the BACnet stack is bind |
| bacnetMigratePoints | This method will migrate point data from FIN 5.1.X release to FIN 5.1.7 release Accumulator and Schedule point will be migrated |
| bacnetMigration | Manually call the migration functions for the current project |
| bacnetNotificationsSubscribeConn | Subscribe to connector, to receive notifications for all the points from it that are bound in DB builder |
| bacnetNotificationsSubscribePoint | Subscribe to connector, to receive notifications only for the provided point |
| bacnetNotificationsUnsubscribeConn | Unsubscribe from connector, from receiving notifications for all the points that are bound in DB builder |
| bacnetNotificationsUnsubscribePoint | Unsubscribe from connector, from receiving notifications only for the provided point |
| bacnetObjectTypeList | List all standard BACnet object types |
| bacnetPing | Asynchronously ping an bacnet connector Examples |
| bacnetPropertyIdentifierList | List all standard properties that a BACnet object can support |
| bacnetReadEnumPropValMapping | The method will fetch all Enum and property value conversion mapping for schedule object Examples |
| bacnetReadHis | Read history log from a BACnet Trend Log object Parameters |
| bacnetReadObject | Read all know properties for this BACnet object Parameters |
| bacnetReadObjectProperty | Read a BACnet property from a BACnet object Parameters |
| bacnetReadPoolSizeFromBbsConfig | Reads the Client_pool_size, Server_pool_size & Pdu_pool_size from the BBS config |
| bacnetReadPropertyFromDB | Reads property value from our own Stack data-base, like properties from Device or Network-port Object Parameters |
| bacnetReadPropertyMultiple | Reads multiple object properties using the BACnet ReadPropertyMultiple service if the remote device supports it |
| bacnetReadStackConfig | The method will return the Config value for inquired Config keys from /etc/bacnetExt/config.props file configKey |
| bacnetReadStructuredView | Reads the properties of BACnet Structured View objects for a given connector |
| bacnetReal | The method will convert the input Number to Real |
| bacnetRegisterBBMDwithNetworkPort | Registers the device as BBMD using network-port object and puts the entry provided in the BBMD-BROADCAST-DISTRIBUTION-TABLE property |
| bacnetRegisterForeignDeviceWithNetworkPort | Registers the device as foreign device by requesting the BBMD of the other subnet it wants to register itself |
| bacnetRemoveFromNotificationClass | Removes the local device corresponding to the connector from the provided notification class, to disable receiving alarm/event notifications |
| bacnetRemoveStackConfig | The method will return delete the provided config entry |
| bacnetRestoreDevice | Restores the device from the already backed up data |
| bacnetScheduleEffectivePeriod | Reads the effective period for a bacnet schedule point Paramaters |
| bacnetScheduleRead | Reads the weekly schedule from a bacnet schedule point Paramaters |
| bacnetScheduleWrite | Writes a weekly schedule to a bacnet schedule point Paramaters |
| bacnetServerDeviceList | List all devices registered across all projects |
| bacnetServerGetObject | Return BACnet object type and instance number for a point record |
| bacnetServerProjects | List all BACnet projects for those BACnetServer is enabled |
| bacnetServerRestart | Restarts the BACnet server |
| bacnetServerSyncDevices | Re-create BACnet devices for the current project |
| bacnetSetDeviceInstanceNumber | Set instance number of our device |
| bacnetSetDeviceObjectName | The method will set object name of default server device |
| bacnetSetLocalBindAddress | The method will set localBindAddress - localBindAddress |
| bacnetSetLocalDnetNumber | The method will set the local dnet number |
| bacnetSetPhysicalPortDnetNumber | The method will set physical port dnet Number |
| bacnetSigned | The method will convert the input Number to Signed |
| bacnetSyncCur | Asynchronously synchronize current values for given list of proxy points |
| bacnetSyncHis | Import the lastest data from an BACnet Trend Log object to the local history database, for each point provided |
| bacnetSyncObjectProperty | Function to sync BACnet object property of BACnet device point to the FIN Note:- Support is currently limited to the units property only |
| bacnetTimeSynchronization | Synchronizes the time of the Device Parameters |
| bacnetUcs2String | The method will convert the input Str to UCS 2 String |
| bacnetUcs4String | The method will convert the input Str to UCS 4 String |
| bacnetUnconfirmedTextMessage | Parameters |
| bacnetUnregisterBBMDwithNetworkPort | bacnetUnregisterBBMDwithNetworkPort() This query will Unregister BBMD from network-port object |
| bacnetUnregisterForeignDeviceWithNetworkPort | bacnetUnregisterForeignDeviceWithNetworkPort() This query will delete Foreign device details from stack database |
| bacnetUnsigned | The method will convert the input Number to Unsigned |
| bacnetUnsigned16 | The method will convert the input Number to Unsigned16 |
| bacnetUnsigned64 | The method will convert the input Number to Unsigned64 |
| bacnetUpdatePoolSizeInConfig | This query updates the Server-TSML-pool, Client-TSML-pool size & Pdu-pool size in the bbs.conf |
| bacnetUtcTimeSynchronization | Synchronizes the time of the Device with UTC Parameters |
| bacnetWhoHas | Sends a WhoHas request in the network Parameters |
| bacnetWriteGroupService | -nListOfChannelValue |
| bacnetWriteNetworkPortProperty | Update/Write property value in our own Stack data-base for supported properties from Device or Network-port Object Parameters |
| bacnetWriteObjectProperty | Write a BACnet property value Parameters |
| bacnetWritePropertyMultiple | Writes multiple object properties using the BACnet WritePropertyMultiple service if the remote device supports it |
| bacnetWriteStackConfig | The method will write the Config key-value to /etc/bacnetExt/config.props file Dict |
| bitAnd | Bitwise and |
| bitNot | Bitwise not |
| bitOr | Bitwise or |
| bitShiftl | Bitwise left shift |
| bitShiftr | Bitwise right shift |
| bitXor | Bitwise xor |
| blineMenu | Axon function |
| blocks | List the installed control blocks |
| breadcrumbs | Axon function |
| buildIsSiemens | True or false if this is a Siemens build or not |
| call | Reflectively call a function with the given arguments |
| capitalize | Return this string with the first character converted to uppercase |
| ceil | Return the smallest whole number greater than or equal to val |
| chart | Set the grid visualization view to chart |
| childrenCurVal2 | Axon function |
| childrenCurVal3 | childrenCurVal3(equipList) Like childrenCurVal2 but also returns the ids of the children points |
| choiceOf | Given a choice spec, return the most specific choice subtype implemented by the instance |
| clamp | Clamp the number val between the min and max |
| cleanFolderPathName | Axon function |
| clearAlarmHistory | Clear alarm history records in the database based on the given parameters |
| clearAlarmHistoryBefore | Clear alarm history records before the given date in the database |
| cloneReadOrphans | Read orphaned clones from the database as a grid |
| cloneRemoveOrphans | Remove clone recs which no longer have a reference to a valid cloneSet |
| cloneResubscribe | Force a re-subscription of one or more client side clone sets |
| cloneSyncHis | Perform remote sync of history data for given clone points |
| col | Get a column by its name |
| colNames | Get the column names a list of strings |
| colToList | Get a column as a list of the cell values ordered by row |
| collect | Collect stream into a in-memory list or grid |
| cols | Get the columns from a grid as a list |
| colsToLocale | Localize column display names |
| commit | Commit one or more diffs to the folio database |
| commonTagBundles | Axon function |
| compDef | Return component definition |
| comparePointVal | Axon function |
| concat | Concatenate a list of items into a string |
| conjuncts | List conjunct definitions in the context namespace as Def[] |
| connClose | Force the given connector closed and return a future |
| connDetails | Return debug details for a connector or a connector point |
| connLearn | Perform a learn on the given connector and return a future |
| connPing | Perform a ping on the given connector and return a future |
| connPoints | Return the points for a connector as list of dicts |
| connPointsVia | Select a group of points explicitly via specific connector library or connector |
| connSyncCur | Perform a remote sync of current values for the given points |
| connSyncHis | Perform a remote sync of history data for the given points |
| connTrace | Read a connector trace log as a grid |
| connTraceClear | Clear the trace log for the given connector |
| connTraceDisable | Disable tracing on the given connector |
| connTraceDisableAll | Disable tracing on every connector in the database |
| connTraceEnable | Enable tracing on the given connector |
| connTraceIsEnabled | Return true or false if given connector has its tracing enabled |
| connectorPoinBadgeVal | Axon function |
| connectorPointBadgeType | Axon function |
| connectorPointColor | Axon function |
| connectorPointTooltip | Axon function |
| connectorSelectedMenu | Axon function |
| connectorsByTypeMenu | Axon function |
| connectorsDebugInfoMenu | Axon function |
| connectorsMainMenu | Axon function |
| connectorsMenu | Axon function |
| connectorsMenuSettings | Axon function |
| connectorsPointIcons | Axon function |
| connectorsPolicyInfo | Axon function |
| connectorsRightIcon | Axon function |
| connectorsShowPoints | Axon function |
| connectorsTunePolicyMenu | Axon function |
| contains | Return if val contains x |
| context | Get the current context as a Dict with the following tags |
| controlTask | Get the details for the task identified by the given program and target combination |
| controlTaskRawVals | Haystack flattens time units to ms (1min -> 60000) Strip the unit from time values so we get the raw number |
| controlTasks | List the tasks for all the programs currently running |
| coord | Construct a Coord from two Numbers in decimal degrees |
| coordDist | Compute the great-circle distance between two Coords |
| coordLat | Latitude of a Coord as a Number |
| coordLng | Longitude of a Coord as a Number |
| copyModbusFile | |
| cos | Return the cosine of angle in radians |
| cosh | Return the hyperbolic cosine |
| count | Fold multiple values into their total count Return zero if no values |
| covAvg | Folding function for generating a time weighted average on change-of-value histories (where hisInterpolate() is "cov") |
| createFirstLevelOptional | Axon function |
| createGraphicsLibrary | |
| createOptionalLevel | Axon function |
| createTemplateGraphic | |
| curFunc | Get the current top-level function's tags |
| date | If val is a DateTime |
| dateTime | Construct a DateTime from a date, time, and timezone name |
| day | Get day of month as integer between 1 to 31 from date or datetime |
| dayOfYear | Given a DateTime or Date, return the day of the year |
| dbAddEditCommit | Axon function |
| dbBuilderCreateLearnPointsJob | Axon function |
| dbBuilderDiscoverBacnetPoints | Axon function |
| dbBuilderDiscoverConnectors | Axon function |
| dbBuilderDropAction | Axon function |
| dbBuilderSelectAction | Axon function |
| dbDiscoveryAdd | Axon function |
| dbDragActionAddConnector | Axon function |
| dbGraphicPanels | Function returns a list of graphics whose graphicOns evaluate to nodeId |
| dbMakeDataGridPanel | Constructs a basic grid panel to be used with the DB Builder app |
| debugType | Return a string of the given value's type |
| decapitalize | Return this string with the first character converted to lowercase |
| def | Lookup a def by its symbol name (Str or Symbol) |
| defs | List all definitions in the context namespace as Def[] |
| degreeDays | Given a site or weather record compute both the heating and cooling degree-days for the given date range |
| degreeDaysBase | Given a site or weather record, return the default balance point temperature to use for degreeDays() |
| deleteMacro | Axon function |
| deleteVar | Axon function |
| deleteVarById | Axon function |
| deprecatedTags | Return tags which have been deprecated as grid with following columns |
| deviceOverview | Axon function |
| diff | Construct a modification "diff" used by commit() |
| diffTypes | Axon function |
| dis | Get display string for dict or the given tag |
| discreteBoolPeriods | Fold timestamp/bool value pairs into an encoded Str of discrete minutely intervals |
| discreteEnumPeriods | Fold timestamp/enum Str value pairs into an encoded Str of discrete minutely intervals |
| discretePeriods | Fold timestamp/bool value pairs into an encoded Str of discrete minutely intervals |
| dockerDeleteContainer | Kill and remove a container |
| dockerListContainers | |
| dockerListImages | |
| dockerRun | |
| dominantValue | Folding function for determining the value which shows up the most in a period |
| dropActionConnectorTree | Axon function |
| dropActionEquipTree | Determines and takes the appropriate action for when an item is dropped onto an item within the equip tree in the DB Builder app |
| dropActionFolderPaths | Axon function |
| dropActionSavedFiltersTree | Determines and takes the appropriate action for when an item is dropped onto an item within the saved filter tree in the DB Builder app |
| dropActionScheduleTree | Determines and takes the appropriate action for when an item is dropped onto an item within the schedule tree in the DB Builder app |
| dropActionTagBundlesTree | Determines and takes the appropriate action for when an item is dropped onto an item within the tagBundle tree in the DB Builder app |
| dst | Return if a DateTime is in daylight saving time |
| durTrue | Fold function for folding timestamp/bool value pairs into durations when true (runtime) |
| each | Iterate the items of a collection |
| eachDay | Iterate the days of a span |
| eachMonth | Iterate the months of a span |
| eachWhile | Iterate the items of a collection until the given function returns non-null |
| echo | Write the str represenation of x to stdout and return x |
| elecKwToKwhHis | Function to create a computed history for energy kWh electrical consumption from demand "kW" electrical demand |
| emailSend | Send an email synchronously |
| emailSendAsync | |
| end | End value of a DateSpan, Span, or a range |
| endsWith | Return if Str ends with the specified Str |
| energyBaselinePrevMonth | Generate a baseline his grid based on last month's data |
| energyBaselinePrevYear | Generate a baseline his grid based on last year's data |
| energyNormByArea | Given a his grid, normalize the values by area in m² or ft² |
| energyNormByDegreeDay | Given a his grid, normalize the values by heating or cooling degree-day |
| energyStarCustomerList | Read list of customers that you are connected with as grid with following columns |
| energyStarHisPull | Pull energy star usage into the given mapped meter points history |
| energyStarHisPush | Push the daily rollup consumption of mapped meter points to portfolio manager |
| energyStarMeterDelete | Delete the meter identified by the given meter id string from the energy star Portfolio Manager |
| energyStarMeterList | Read meters for given property as grid with following columns |
| energyStarMeterPull | Create or update a local meter point record from a meter in Portfolio Manager |
| energyStarMeterPush | Create or update a meter in Portfolio Manager from a local meter point record |
| energyStarMeterRead | Read the given meter and return as Dict |
| energyStarOnsiteRenewableDetailWrite | Write onsite green power renewable details |
| energyStarPing | Asynchronously ping energy star connector to verify connectivity and account credentials |
| energyStarPropertyAssociationsPush | This function recreates the list of property/meter associations in Energy Star |
| energyStarPropertyDelete | Delete the property identified by the given property id string from the energy star Portfolio Manager |
| energyStarPropertyList | Read properties as grid with following columns |
| energyStarPropertyMetrics | Read a list of metrics for a specific property |
| energyStarPropertyPull | Create or update a local site record from a property in Portfolio Manager |
| energyStarPropertyPush | Create or update a property in Portfolio Manager from a local site record |
| energyStarPropertyRead | Read the given property and return as Dict |
| energyStarUsageDelete | Delete the given usage item from portfolio manager |
| energyStarUsageRead | Read consumption data for given meter |
| energyStarUsageWrite | Write consumption data to portfolio manager for given meter |
| enumDef | Return definition of given enum def defined by enumMeta This call forces a refresh of the definitions |
| enumDefs | Return grid of current enum defs defined by enumMeta |
| equals | Return if two values are equivalent |
| equipToPoints | Given a equip record Dict, return a grid of its points |
| eval | Evaluate an Axon string expression |
| evalToFunc | Evalate an Axon string expression to a function |
| eventCreate | Asynchronously create a new event for the given target and return a future |
| eventDelete | Asynchronously delete a batch of events and return a future |
| eventRead | Read all the events for the given list of targets and span |
| exp | Return e raised to val |
| ext | Return extension record for given extension name |
| extAdd | Enable the given extension name or list of names |
| extRemove | Disable the given extension name or list of names |
| extSettings | Return ext settings form data - see Exts |
| extSettingsCommit | Submit function for extSettings() - see Exts |
| exts | Get the list of exts and their current status |
| favEdit | Edit a favotie record |
| favNew | Create a new fav record action |
| favTrash | Trash a favorite record |
| feed | Convert a stream into a live feed to populate a view |
| filter | Apply a filter expression to a collection of dicts |
| filterTasksVars | Reads all tasks variables that match the filter and return them in a grid |
| filterToFunc | Convert a filter expression to a function which maybe used with findAll() or find() |
| finAMChartsComponentsContextMenuItems | Axon function |
| finAMChartsComponentsModels | Returns models from the FIN |
| finActionAddFilterForm | Axon function |
| finActionAddForm | Axon function |
| finActionAddFun | Axon function |
| finActionAddRepeatForm | Axon function |
| finActionCatFilterForm | Axon function |
| finActionCatForm | Axon function |
| finActionCatFunc | Axon function |
| finActionsOn | Get all Actions which are registered on the given target |
| finActionsRewrite | Rewrite 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 |
| finAddBuilderProps | Axon function |
| finAddChartToGroup | Axon function |
| finAddEditKnxConnCommit | Axon function |
| finAddFloorToEquipCommit | Axon function |
| finAddGraphicThumbnail | Axon function |
| finAddPointInfo | Axon function |
| finAddProjectGlobalVar | Axon function |
| finAddShadowPoints | |
| finAddTagsByColumn | Axon function |
| finAddTagsByName | Axon function |
| finAddTagsByNameApply | Axon function |
| finAddTagsIoCsv | Axon function |
| finAddTzToPoint | Adds a tz to a given point |
| finAlarmSettingsForm | Axon function |
| finApplyEnumOptForm | Axon function |
| finApplyNoteTags | Axon function |
| finApplyTagBundle | Applies the passed tagBundles addTags and removeTags properties to the targetFilter that fits a tagBundle's allowFilter |
| finApplyUpdateConnectors | Axon function |
| finAssetUsedBy | Given an asset or list of asset records or refs return a grid with fin project records that use those assets |
| finBLineSnippets | Axon function |
| finBackupRecord | Export 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 |
| finBackupRecordForm | Axon function |
| finBackupUploadForm | Axon function |
| finBacnetAutoCreate | The commit action used by "Create Bacnet Devices" (finBacnetAutoCreateForm) to create bacnet devices from the desired equips |
| finBacnetAutoCreateForm | The UI form for "Create Bacnet Devices" |
| finBacnetAutoCreateManual | Backend function used for "Create Bacnet Devices" (finBacnetAutoCreateForm) to manually configure bacnet devices |
| finBacnetCheckServerDeviceData | Checks if the server device can be created |
| finBacnetCurToWrite | Finds 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 |
| finBacnetWriteToCur | Finds 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 |
| finBase64Decode | Base64 decoding function Turns a base64 encoded string into a string |
| finBase64Encode | Base64 encoding function Turns a string into a base64 encoded string |
| finBatchAdvancedTagDP | Backend function for finFormBatchAdvancedTagEditor and finFormNHaystackBatchAdvancedTagEditor |
| finBatchCloneScheduleApply | Axon function |
| finBatchDeleteEventsForm | Axon function |
| finBatchDeletePointsForm | Form to delete points based on navName and equipRef |
| finBatchDeleteTagProvider | Axon function |
| finBatchDeleteTagsApply | Axon function |
| finBatchDeleteTagsForm | Axon function |
| finBatchRecordCreator | |
| finBatchRecordList | |
| finBatchRecordsEquipFilter | Axon function |
| finBatchRecordsFilter | |
| finBatchUpdateRecords | Axon function |
| finBatchUpdateRecordsFilter | Axon function |
| finBatchUpdateRecsCommit | Axon function |
| finBeginBacnetDiscovery | Axon function |
| finBeginDiscovery | Begins a Discovery session Returns the id of this discovery session |
| finBlockSuggestion | Axon function |
| finBlockSuggestionHelper | Axon function |
| finBlocks | This function uses the blocks() function to gather all blocks and then adds additional information too each block specific to FIN Stack |
| finBlocksCombineVars | Axon function |
| finBlocksJavaScript | Axon function |
| finBlocksPpcl | Axon function |
| finBreadcrumbs | Axon function |
| finBuilderComponents | |
| finBuilderContextMenu | |
| finBuilderContextMenuItems | Axon function |
| finBuilderEquipTrash | Axon function |
| finBuilderModels | |
| finCapsNeeded | This 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 |
| finCertManagementForm | Axon function |
| finCheckForUpdate | |
| finChildBooleanData | finChildBooleanData(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 |
| finChildNumberData | finChildNumberData(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 |
| finClimbNavTree | Axon function |
| finCloneEquipPointTags | Form to clone the tags from the points of one equip to the corresponding points of other selected equips |
| finCloneEventsApply | Axon function |
| finCloneEventsForm | Axon function |
| finCommandAuto | Axon function |
| finCommit | Axon function |
| finCommitApplyBatchTags | This function applies the comma-separated tags to all records that match the filter |
| finCommitNHaystackApplyBatchTags | Axon function |
| finCommitSites | Axon function |
| finCommonQueries | Axon function |
| finConfigureBacnetServerCommit | Sets the values required by a bacnet server even when bacnetExt is disabled |
| finConfigureBacnetServerForm | The UI form for "Configure Bacnet Server" |
| finConflictingTags | Axon function |
| finConnDebugForm | This form is called from finConnectorDebuggingInfo |
| finConnDebugInfo | Shows the debugging info of selected bacnet or haystack connectors from the builder app |
| finConnExts | |
| finConnectorTemplatePackageAddDevice | Axon function |
| finConnectorTypes | Read connector types |
| finConstructBasicTreeItem | Axon function |
| finContentOn | Get all O&M Manuals which are registered on the given target |
| finContentOnFunc | finContentOn(Ref target |
| finContext | |
| finCopyBoundPoints | |
| finCopyFromGraphicForm | finCopyFormGraphicForm(stage |
| finCopyTableData | Axon function |
| finCopyTag | Backend for finCopyTagForm Usage |
| finCopyTagForm | Form to clone tags from one place to another |
| finCreateAlarmTopicCommit | Used by the "Create Alarm Topic" form to create the alarmTopic record |
| finCreateAlarmTopicForm | Create a new alarm topic and chooses which alarm priority, tags, target tags to apply it to |
| finCreateEditTuningPolicyCommit | Axon function |
| finCreateEmbeddedLink | Axon function |
| finCreateFolder | Axon function |
| finCreateFolderPath | Axon function |
| finCreateFormTemplate | Function to make a beginning form function instantly |
| finCreateFromTemplate | Axon function |
| finCreateHaystackDb | Takes 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 |
| finCreateNoteTopicCommit | Used by the "Create Note Topic" form to create the noteTopic record |
| finCreateNoteTopicForm | Allows 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 |
| finCreatePod | Axon function |
| finCreateProjectForm | Axon function |
| finCreateTemplatePackage | Creates a template package to be published to StackHub Accepts as parameters |
| finCreateTemplatePackage2 | |
| finCsvHisReorderForm | Part of CSV History Report |
| finCurWriteHisEditor | Axon function |
| finCurrentDayInfo | Returns a grid with the columns daysLeftMonth daysLeftYear hoursLeftDay hoursPastDay daysPastMonth daysPastYear |
| finCustomAhuCreate | Axon function |
| finCustomAhuCreatePoints | Axon function |
| finCustomAhuPointProvider | Axon function |
| finCustomAhuSelect | Axon function |
| finCustomAhuSelectPoints | Axon function |
| finDBCreateNewEquipCommit | Axon function |
| finDashboardApp | Axon function |
| finDashboardGenerateBinding | |
| finDashboardWidgets | |
| finDashboards | |
| finDbBuilderMenuItem | Axon function |
| finDbHaystackFindUniqueEquipTypes | Axon function |
| finDbHaystackNodeSelectAction | Axon function |
| finDbHaystackReadAllPoints | Axon function |
| finDbRelationshipAddEdit | Axon function |
| finDbSavedFiltersTreeSelectAction | Creates panels to be displayed on when an item from the savedFilters tree is selected |
| finDbSavedQueryFilterAddEdit | Axon function |
| finDbTagBundleAddEdit | Axon function |
| finDbTemplateAddEdit | Axon function |
| finDbTopicAdd | Axon function |
| finDelEnumOptForm | Axon function |
| finDeleteAlarms | Ack/Delete Alarms within the datespan |
| finDeleteTopicsCommit | Axon function |
| finDeleteTopicsForm | Axon function |
| finDigestTimeCommit | Axon function |
| finDigestTimeSettingsForm | Axon function |
| finDiscoveryAdd | Add discovered item to system |
| finDiscoverySessionCleanup | Destroy Discovery Session |
| finDiscoverySessionEnd | Close Discovery Session |
| finDiscoveryStatusCheck | Get Discovery Status |
| finDistinctConnRefs | Read all the distinct conn ref connectors |
| finDownloadSavedRecordsForm | Axon function |
| finDuplicateRec | Duplicates a record and it's children countTimes |
| finEditDescriptionForm | Form to edit description, takes id |
| finEditEnumOptForm | Axon function |
| finEditNoteTagsCommit | This function is used by the "Edit Note Tags" form |
| finEditNoteTagsForm | This form allows the user to add or remove existing tags from the noteTags list |
| finEditSummaryCommit | Axon function |
| finEditSummaryForm | Axon function |
| finEditSummaryPickForm | Axon function |
| finEditTags | finEditTags(id, tags) Form to edit the tags of a record |
| finEditTopicsForm | A form that allows the user to select an alarm or note topic to edit |
| finEditTopicsFormCommit | Axon function |
| finElementOn | FIN Element On This method will find records compatible with the target element based off of the elementTag |
| finElementsOn | FIN Elements On This method will find records compatible with all of the target elements based off of the elementTag |
| finEmail | supportive function to send email |
| finEnergyAnnualMonthlyDayRollup | Given 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 |
| finEnergyAnnualMonthlyRollup | Given 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 |
| finEnergyAnnualWkDayRollup | Given 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 |
| finEnumOptForm | Axon function |
| finEquipCharts | Function to generate chart for equip with schedules and alarms |
| finEquipPointTagClone | |
| finEquipRefTree | Axon function |
| finExcelRowPaster | Axon function |
| finExcelSite | Axon function |
| finExec | This 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 |
| finExistingConnectors | Axon function |
| finExtSettingsForm | Axon function |
| finExtraCountSystems | Axon function |
| finFavoritesForm | Axon function |
| finFavoritesMenu | Axon function |
| finFileAndAssetDelete | Given 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 | |
| finFileType | Axon function |
| finFiles | Return a list of fin files together with their respective screen shots, thumbs and icons |
| finFilteredFuncEval | Filter all functions that match the provided funcFilter expression |
| finFindAnyText | Axon function |
| finFindBadChartPts | Axon function |
| finFindDuplicateIdsInBackup | Looks inside a file for clashing IDs and returns a list duplicates |
| finFindMarkers | Given a dictionary, finFindMarkers will return a list of all marker tags found |
| finFindNonDbRec | Returns a list of dicts resembling, if not actually, records |
| finFindRecordByChild | This function is just like finFindRecordByChildDeep except this one only searches 1 level deep, and is way more effecient |
| finFindRecordByChildDeep | This function will let you search for children of something |
| finFindRefs | Return a grid with a new column called "val" that contains a JSON object with all the Refs found within that record |
| finFindTargetsForStrTagRename | Axon function |
| finFindToolsOnNavItem | Axon function |
| finFixOldBinTags | |
| finFoldGrid | |
| finFolioDownloadForm | Form to download records with a certain filter, like legacy Folio Download |
| finFolioMenu | Axon function |
| finFolioSettings | Axon function |
| finFolioUploadForm | Form to upload records through file or through text, like legacy Folio Import |
| finFormAddEditHaystackConnector | Axon function |
| finFormAddEditKnxConn | Axon function |
| finFormAddTenantsToEquip | Axon function |
| finFormAdvancedEditor | Axon function |
| finFormAhuAirBalance | This form Runs on AHUs that serve VAV zones |
| finFormAlertOk | Bring up an alert dialog that displays a text message |
| finFormApplyBatchTags | This function takes no parameters, as the parameters get loaded from the form |
| finFormBacnetConnDiscoverSettings | Axon function |
| finFormBatchAdvancedTagEditor | Searches database for points with navNames that start with, end with, or contain the specified keywords and adds specified tags to those |
| finFormBatchDuplicate | This function takes a record ID, and it will copy and paste it X amount of times |
| finFormChangeAddAhuRef | This function will take and ID, and a list of selectedDicts |
| finFormCloneConnector | Axon function |
| finFormCloneSchedule | Axon function |
| finFormCommandAuto | Axon function |
| finFormConfirmChangesAlert | Creates a basic form with "Warning" as the form title, a "Cancel" button, and an "Apply" button |
| finFormConfirmKnxProj | Axon function |
| finFormConflictingTags | Axon function |
| finFormConnTuning | Form to add connTuningRef tags to filter results |
| finFormCopyBoundPoints | Axon function |
| finFormCreateEditGraphic | Axon function |
| finFormCreateNote | This form will create a note on a target |
| finFormCreateSummary | Axon function |
| finFormCreateSummaryApply | Axon function |
| finFormCreateSummaryRefs | Axon function |
| finFormCreateTuningPolicy | Axon function |
| finFormCurWriteHisEditor | Axon function |
| finFormCustomName | Axon function |
| finFormDBAddEdit | A form used to create or edit DB Builder items |
| finFormDBBuilderDelete | Axon function |
| finFormDBCreateNewEquip | Axon function |
| finFormDBSelectEditDelete | Axon function |
| finFormDisplayTagRenames | Axon function |
| finFormDuplicateScheduleDay | This is a form to duplicate one day from a schedule to one or more days on the same schedule |
| finFormEditPropertyManagerForm | Form to allow currently selected user to be changed to a property manager or edit a current property manager |
| finFormEditSchedule | Form to edit schedules |
| finFormEditTenant | Form to edit existing user into a tenant |
| finFormEditUtilityBill | Axon function |
| finFormEliminateOrphans | Axon function |
| finFormEquipAuditLog | This function takes an ID, and will you the audit log for what has been changed in the time period |
| finFormEquipPointTagClone | Axon function |
| finFormEquipPointTagsProvider | Axon function |
| finFormFuncs | Axon function |
| finFormHaystackSyncToNiagara | Applies tags made in FIN |
| finFormHisImport | Form to import history from a CSV file into a point |
| finFormKnxProjError | Axon function |
| finFormManageZincLibrary | Form to manage the records within the io/Records.zinc libraries |
| finFormManualAddEditBacnet | Axon function |
| finFormManualOverrideAuto | Axon function |
| finFormModBus | Axon function |
| finFormNHaystackApplyBatchTags | Axon function |
| finFormNHaystackBatchAdvancedTagEditor | Searches haystack points with navNames that start with, end with, or contain the specified keywords and adds specified tags to those |
| finFormNHaystackMapPointsToEquip | Axon function |
| finFormNavMeta | Axon function |
| finFormNewHaystackPassword | Axon function |
| finFormNewOrEditTuningPolicy | Axon function |
| finFormNoteTags | Axon function |
| finFormPointNotTz | Axon function |
| finFormPointNotUnit | Axon function |
| finFormPointPriorityViewer | Form to view and auto points with priorities |
| finFormRecordTagClone | This function takes an id, then it will pop up a form that let's you select the tags you want to clone |
| finFormReplace | Axon function |
| finFormReplaceKnxProj | Axon function |
| finFormReplaceKnxProjCommit | Axon function |
| finFormRestoreTemplate | Axon function |
| finFormRunToolsOnMulti | Axon function |
| finFormSaveTemplate | Axon function |
| finFormSchedulePointPriority | Axon function |
| finFormSelectBacnetType | Axon function |
| finFormSelectKnxConnEdit | Axon function |
| finFormSelectTenantsForReport | Form for setting up tenant reports |
| finFormSelectTool | Axon function |
| finFormSelectTuningPolicy | Axon function |
| finFormSetConnectorDefWriteLevel | Axon function |
| finFormSetImmediateSubscriptionOffTime | Axon function |
| finFormSetSummaryPointOrder | Axon function |
| finFormStandardName | Axon function |
| finFormStringSearchCommit | finFormStringSearchCommit(data |
| finFormStringSearchTrans | Form interface for these functions |
| finFormStringSearchTransPrev | Axon function |
| finFormStringSearchTransStats | Backend function for finFormStringSearchTrans |
| finFormSyncToColl | Axon function |
| finFormTagDuplicate | Axon function |
| finFormTagSplitAndRename | Axon function |
| finFormTempToReal | Form to move prepared tempPoints into the project hierarchy |
| finFormTempToRealStats | Axon function |
| finFormTextArea | Axon function |
| finFormTextareaOk | Axon function |
| finFormTrendConnDiscoverSettings | |
| finFormUniqueEquipTypes | Axon function |
| finFormUniqueTagsEasy | Axon function |
| finFormUnlockKnxProj | Axon function |
| finFormUnlockKnxProjCommit | Axon function |
| finFormUpdateConnectors | Axon function |
| finFormUploadKnxProj | Axon function |
| finFormUploadKnxProjCommit | Axon function |
| finFormWinRestart | Axon function |
| finFormWriteLevels | Axon function |
| finFreqFilters | This function is used for the filter ui that shally made |
| finFuncs | FIN Funcs This method merges the result of the funcs() query with extra data within the finFuncs.trio file to support FIN |
| finGenScram | |
| finGenerateSampleTagValue | Axon function |
| finGetAllPodDocs | |
| finGetAllPodNames | |
| finGetCaps | This function returns a grid with the licensing parts and their prices |
| finGetConnectorTagSpecs | Returns a Grid with the tag specs defined for an enabled connector |
| finGetCurrentUser | |
| finGetDiscoveryConfiguration | Get Discovery Configuration |
| finGetFinDocsForPodWithName | |
| finGetHelp | |
| finGetMinutesFromCur | Axon function |
| finGetPods | Axon function |
| finGetPointIcon | Returns the name of the appropriate point icon based off the point's type |
| finGetPointRecords | Get records from the PointRecords.zinc file in the finToolsExt pod to display in the batch record creator |
| finGetTileOn | Axon function |
| finGetUriFromRef | Axon function |
| finGlobalControl | This 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 |
| finGlobalControlActions | This function is part of "Global Control" |
| finGlobalControlCheckEnum | This function is part of "Global Control" |
| finGlobalControlCommit | This function is part of "Global Control" |
| finGlobalControlDurForm | This function is part of "Global Control" |
| finGlobalControlFilterCheck | This function is part of "Global Control" |
| finGlobalControlFilterForm | This function is part of "Global Control" |
| finGlobalControlFilterTable | This function is part of "Global Control" |
| finGlobalControlForm | This function is part of "Global Control" |
| finGraphicOn | Get all Fin graphics which are registered on the given target |
| finGraphicRemoteAssets | Axon function |
| finGraphicResourceModels | Returns models from the FIN |
| finGraphicResourceTemplates | Returns Templates from the FIN |
| finGraphicTopLevel | finGraphicTopLevel(new) Form to create or edit the topLevel record |
| finGraphicTopLevelDeleteConfirmForm | Axon function |
| finGraphicsBatchTags | Axon function |
| finGraphicsDeleteRecs | Axon function |
| finGraphicsGenericBindings | Axon function |
| finGraphicsGenericBindingsForm | Axon function |
| finGraphicsGenericBindingsResults | Axon function |
| finGraphicsUpdateThumbs | Form to change the thumbnails on graphics |
| finGridFilter | Filters a grid using a filter expression |
| finHardDelete | A function to delete records permanently |
| finHasSpecialChars | Axon function |
| finHaystackDrillDown | Takes 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 |
| finHaystackExcludedTags | Returns a grid of tags to be excluded when working with records coming from haystack or nhaystack connectors |
| finHaystackHexReplaceForm | Axon function |
| finHaystackLearn | Improves haystackLearn so that it fetches all the tags defined for a learn path |
| finHeaderAddEditMenu | Axon function |
| finHeaderAddEditSubMenu | Axon function |
| finHeaderButtonBadgeForm | Axon function |
| finHeaderButtonIconForm | Axon function |
| finHeaderButtonLinkForm | Axon function |
| finHeaderButtonNameForm | Axon function |
| finHeaderButtonSecurityForm | Axon function |
| finHeaderForm | Axon function |
| finHeaderFuncs | Backend functions for finHeaderForm function |
| finHeaderHomeForm | Axon function |
| finHeaderMenu | Axon function |
| finHeaderReorderFunc | Axon function |
| finHeaderReorderMenu | Axon function |
| finHeaderReorderSubMenu | Axon function |
| finHisImport | Function to import histories from a CSV file |
| finHisRead | |
| finHisReadAddMeta | Axon function |
| finHisReadBaseBuildCharts | Axon function |
| finHisReadBaseGetHis | Axon function |
| finHisReadBaseGetTz | Axon function |
| finHisReadBaseline | Axon function |
| finHisReadBaselineCore | takes the following parameters |
| finHisReadBaselineRollup | Axon function |
| finHisReadBaselineStrPoint | Axon function |
| finHisReadBaselineStrPointF | Fantomized version of the finHisReadBaselineStrPoint function |
| finHisReadBaslineStatus | Axon function |
| finHisReadComplexBa | Axon function |
| finHisRewriteSpan | hisRewriteSpan(hisRecs, startTime, endTime, rewriteFunc |
| finHostChangePassForm | Axon function |
| finHostMainMenu | Axon function |
| finHostUpdateLicenseForm | Axon function |
| finHostUsageForm | Axon function |
| finHtmlReportingMainMenu | Axon function |
| finHtmlTemplate | generate string from a handlebars template using handlebars.java engine @noteTemplate |
| finHttpProxy | |
| finImportGrid | Imports the grid in the local server |
| finInfoMenu | Axon function |
| finInjectableProgramResources | Axon function |
| finInvoke | Axon function |
| finIsTagBlackList | Return whether the given tag is a member of the tag blacklist (see finTagBlackList()) |
| finJSLibraries | Axon function |
| finJobMenu | Axon function |
| finJobSettings | Axon function |
| finMacro | Process macro pattern with given scope of variable name/value pairs |
| finMailPing | Asynchronously ping an finMail connector Examples |
| finManualAddEditBacnetCommit | Axon function |
| finMassEditTags | Axon function |
| finMatchPointsToCharts | Axon function |
| finMigrateFilterIds | |
| finMigrateFinFile | Migrates record tags and the ids inside a fin project file record Returns true if project was migrated |
| finMiscComponentsContextMenuItems | Axon function |
| finMiscComponentsModels | Returns models from the FIN |
| finMobileHardDelete | Axon function |
| finMobilePoints | finMobilePoints |
| finMobilePoll | finMobilePoll |
| finModBusMap | Axon function |
| finMoveTag | Backend for finCopyTagForm Usage |
| finNHaystackAddEquips | finNHaystackAddEquips This method calls the addEquips op on nhaystack |
| finNHaystackAddFloorToEquip | Axon function |
| finNHaystackAddHaystackSlots | finNHaystackAddHaystackSlots This method calls the applyBatchTag op on nhaystack |
| finNHaystackAdvancedApplyBatchTagsCommit | Axon function |
| finNHaystackApplyAddEquips | Axon function |
| finNHaystackApplyBatchTags | finNHaystackApplyBatchTags This method calls the applyBatchTag op on nhaystack |
| finNHaystackApplyFolioFilter | finNHaystackApplyFolioFilter This method runs the given filter against the Folio database, and ships the grid down to nhaystack |
| finNHaystackCopyEquipTags | finNHaystackCopyEquipTags |
| finNHaystackDelete | finNHaystackDelete |
| finNHaystackDeleteHaystackSlot | finNHaystackDeleteHaystackSlot |
| finNHaystackFindDuplicatePoints | finNHaystackFindDuplicatePoints |
| finNHaystackFormAddEquips | Axon function |
| finNHaystackFormAddHaystackSlots | Axon function |
| finNHaystackFormAdvancedApplyBatchTags | Axon function |
| finNHaystackFormApplyBatchTags | Axon function |
| finNHaystackFormCopyEquipTags | Axon function |
| finNHaystackFormDelete | Axon function |
| finNHaystackFormDeleteHaystackSlot | Axon function |
| finNHaystackFormPriorityArray | Axon function |
| finNHaystackFormRebuildCache | Axon function |
| finNHaystackFormSyncEquips | Axon function |
| finNHaystackInvoke | Axon function |
| finNHaystackMapPointsToEquip | finNHaystackMapPointsToEquip This method applies equipRef tags to a list of points, so that those points become children of the given equip |
| finNHaystackMapPointsToEquipApply | Axon function |
| finNHaystackPointWriteArray | finNHaystackPointWriteArray |
| finNHaystackPullPropTags | finNHaystackPullPropTags |
| finNHaystackPullPropsForm | Axon function |
| finNHaystackQuery | Axon function |
| finNHaystackReadSize | finNHaystackReadSize This method calls read with the given filter, and then counts the number of resulting recs |
| finNHaystackReadUnique | finNHaystackReadUnique This method calls read with the given filter, and then finds the unique values of the given column |
| finNHaystackRebuildCache | finNHaystackRebuildCache This method calls rebuildCache in NHaystack |
| finNHaystackRemoveBrokenRefs | Axon function |
| finNHaystackSearchAndReplace | finNHaystackSearchAndReplace This method renames components by replacing searchText with replaceText |
| finNHaystackShowPointsInWatch | finNHaystackShowPointsInWatch |
| finNHaystackShowWatches | finNHaystackShowWatches |
| finNHaystackSyncNiagaraEquipApply | Axon function |
| finNHaystackUniqueEquipTypes | Axon function |
| finNHaystackUniqueTags | finNHaystackUniqueTags |
| finNHaystackViewEquipTypesCommit | Axon function |
| finNHaystackViewEquipTypesForm | Axon function |
| finNavChildren | |
| finNavDrillDown | Gets 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 |
| finNavDuplicate | Duplicates 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 |
| finNavLevels | Enhance navLevels |
| finNavListChildren | Axon function |
| finNavMain | |
| finNavMerge | |
| finNavMeta | Adding a Level |
| finNavMetaCommit | Axon function |
| finNavMetaDeleteFailForm | Axon function |
| finNavMetaGetLevels | Axon function |
| finNavMetaTagList | Given an record that is part of the equipPath Posible ops are {"drillDown":false, "values":true, "getRef":true} If drillDown is present |
| finNavMetaWhoAmI | This function takes a Record, and it will return what the record is based on navMeta |
| finNavNavlets | |
| finNavRollup | |
| finNavTreeDropOverrides | Axon function |
| finNavTreeTypes | Axon function |
| finNavletsOn | |
| finNetworkBasicDragDrop | Exposes the functionality for basic drag and drop, like for programs and schedules and jobs |
| finNetworkConnectorsDragDrop | Exposes the functionality for the connector tree drag and drop system |
| finNetworkDragDrop | |
| finNetworkEquipDragDrop | Exposes the functionality for the equip tree drag and drop system |
| finNetworkSettingsDragDrop | Exposes the functionality for the settings tree drag and drop system |
| finNetworkSnapshotsDragDrop | Exposes the functionality for the snapshots tree drag and drop system |
| finNetworkSyncUsers | Takes a conn or list of conns (in a format used by toRecList) and syncs the users over to the children |
| finNetworkTopicDragDrop | |
| finNetworkTransferRecords | |
| finNetworkTree | |
| finNoteSummary | |
| finOMAddForm | Axon function |
| finOMContentOnForm | Axon function |
| finOMDeleteForm | Axon function |
| finOMMenu | Axon function |
| finOMMenu2 | Axon function |
| finOMMenu3 | Axon function |
| finPaginate | FIN |
| finParseFilter | Decode a filter expression into a grid of operands |
| finParseModBus32 | |
| finPodFiles | |
| finPointActions | Axon function |
| finPointConn | |
| finPointNotTz | Axon function |
| finPointNumbersToEquip | Axon function |
| finPointSummary | Generate a point summary by equip |
| finPointSummary2 | Function to read points that have pointSummaryRef pointing to the specified equipment |
| finPostTrioFuncs | Axon function |
| finPrecision | Usage |
| finPrintPdf | download and convert web pages into 1 pdf |
| finProgramOn | Get all Programs which are registered on the given target |
| finProjectAuditForm | Axon function |
| finProjectCategoryForm | Axon function |
| finProjectEmailForm | Axon function |
| finProjectProjectForm | Axon function |
| finProjectedCalc | Used for projecting the use of something like an electric meter's kWh |
| finPublishTemplatePackage | Upload a template package to Stack Hub Accepts as parameters |
| finQueries | Axon function |
| finReadAlarmTags | Axon function |
| finReadAlarmTagsSearch | Axon function |
| finReadBinTag | FIN 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 |
| finReadBlockProgram | Axon function |
| finReadById | |
| finReadByIdTrash | Axon function |
| finReadByIds | |
| finReadByIdsTrash | Axon function |
| finReadCloneEvents | Axon function |
| finReadCsvWithEmbeddedDelimeter | Axon function |
| finReadGraphicPoints | |
| finReadHeader | finReadHeader() Returns content of finHeader record |
| finReadPoints | |
| finRebuildDocs | Rebuilds the documentation using the FINStack style |
| finRebuildNavTree | Rebuild 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 | |
| finRefDis | Get the dis of a ref |
| finRemoteAsset | |
| finRemoveAnimationEditor | Axon function |
| finRemoveCategory | Removes a category or a list of categories from all actions and user records Users should call this like |
| finRemoveStaleLockedKnxProj | Axon function |
| finRemoveUnits | removeUnits(number) Removes' the unit from a number passed in |
| finRenamePointsForm | Form to change navNames of points if they match the filter |
| finResetBoolStats | Resets runtime statistics for bool points By default this will reset both runStarts and runTime |
| finResetStatsStartTime | Resets the start time from when boolean statistics are collected |
| finRestartFinstack | Axon function |
| finRestoreFile | Restores a FinStack template file |
| finRestorePod | |
| finRestoreRecord | Import equip from a zip backup stored on the record Params |
| finRewriteHisTz | Axon function |
| finRewriteHisTzCommit | Axon function |
| finRunSelectedTool | Axon function |
| finSampleHisReadBase | Axon function |
| finSaveAs | supportive function to save text content to a file at path(uri) |
| finSaveEquipRecordsForm | Axon function |
| finSaveFloorRecordsForm | Axon function |
| finSavePointRecordsForm | Axon function |
| finSaveRecords | Axon function |
| finSaveRecordsForm | Axon function |
| finSaveRecordsSeparate | Axon function |
| finSaveSiteRecordsForm | Axon function |
| finSavedCharts | finSavedCharts(Rec id) Finds all the saved charts related to the record that is passed in |
| finScheduleCopyDays | Change a weekly schedule (or list of weekly schedules) by copying parts of it to other week days Examples |
| finSelectedConnectorTypes | Axon function |
| finSelectedPoints | Axon function |
| finSetImmediateSubOffTimeCommit | Axon function |
| finSetSuperUserPassword | |
| finSettingsMenu | Axon function |
| finSettingsMenuLegacy | Axon function |
| finShadowPointToPoint | |
| finShowEquipSummary | Axon function |
| finShowEquipSummaryRecur | Axon function |
| finShowPointsInWatch | List all records registered for a watch id |
| finShowWatches | List all watches open for this project |
| finSkySparkApps | Returns all SkySpark Apps |
| finSkySparkViewsForApp | Returns all Views for a SkySpark app name |
| finSoftDelete | A function to send records to the trash |
| finSplitBacnetUri | Axon function |
| finStackBootStrap | |
| finStackMenuAll | Axon function |
| finStackMenuAppList | Axon function |
| finStackMenuApplySettings | Axon function |
| finStackMenuBackButton | Axon function |
| finStackMenuFolderPath | Axon function |
| finStackMenuInsertVar | Axon function |
| finStackMenuOkForm | Axon function |
| finStackMenuOpenNew | Axon function |
| finStackMobileMenu | Axon function |
| finStrGet | function |
| finStringSearchDicts | Function to search through a list of dicts and return only those that meet the defined criteria |
| finStringSplitDicts | Function to go through a list of dicts and split the specified column by the split character and put it together in a flexible way |
| finSub | Evaluate the given expression |
| finSubEnd | Last call of an evalAll for subscription |
| finSubEquipFilter | Filter out recursively the equip and sub-equip of the base target Ref |
| finSubStart | Open a new watch as part of an evalAll |
| finSummaryDeleteForm | Axon function |
| finSummaryJson | returns a JSON object |
| finSummaryMenu | Axon function |
| finSummaryOn | Get all Summaries which are registered on the given target |
| finSuperTagger | finSuperTagger |
| finSuperTaggerForm | Axon function |
| finSyncHisForm | Axon function |
| finSyncPoints | ToDo |
| finSyncPointsInLib | |
| finSyncTags | FIN Synchronize Tags This method will recursively synchronize the tag values from the source onto all of the children down the given tree Example |
| finSyncToColl | Axon function |
| finTagBlackList | Return a grid of all those tags which should not be removed by the user |
| finTasks | |
| finTemplateCopy | |
| finTemplates | Returns records with templateOn from pods and the database |
| finThemeUsed | This function will return the theme that the user is using |
| finToAlarm | finToAlarm |
| finToNormal | finToNormal |
| finToNumberList | Function to import a string and output values 3-5 will output 3,4,5 starting-ending 4,5 will output 4,5 number1,number2.. |
| finToggleImmediateSubscriptions | Axon function |
| finTraceSubEquip | Axon function |
| finTuningPolicies | Get all tuning policies which are registered on the given target |
| finTuningPolicyGetStats | Axon function |
| finTuningPolicyStatsForm | Axon function |
| finUnique | |
| finUniqueActions | Find 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 |
| finUniqueConnectors | Find all the unique connectors of the given type, among the recs which match the given filter |
| finUniqueEquipTypes | Find the uniqe types for the equips |
| finUniqueEquipTypes2 | Axon function |
| finUniqueTags | finUniqueTags - returns a grid with all markers that are shared by records matching the filter and their match count |
| finUniversalServiceRestart | Axon function |
| finUpdate | |
| finUpdateLicense | |
| finUpdateRecordsIgnoredTags | Axon function |
| finUpdateRecordsIgnoredTags2 | Axon function |
| finUploadSavedRecordsForm | Axon function |
| finUriToDict | |
| finValidConnectors | Axon function |
| finValidateEmail | Returns true if email is in the form [userName]@[domain].[topLevelDomain] and returns false if not |
| finWatcherCallbackOn | Based on the filter expression, returns a grid with all the changes that match the filter expression |
| finWeatherMenu | Axon function |
| finWinRestartFinstack | finWinRestartFinstack() Restarts the Finstack service |
| finWriteBin | |
| finWriteBinTag | FIN Write Binary Tag This function writes the data described by the handle to the given bin tag on the requested record |
| finWriteLevels | Axon function |
| finZincTagBatchEdit | Given 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 |
| finZincTagBatchList | Given 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 |
| find | Find the first matching item in a list or grid by applying the given filter function |
| findAll | Find all the items in a list, dict, or grid by applying the given filter function |
| findBacnetServerInstanceChildPoint | Axon function |
| findEquipTreeAddOpts | Axon function |
| findPod | |
| findPointNames | Axon function |
| finhaystackDeviceDiscovery | |
| finhaystackDeviceDiscoveryConfig | |
| finsedonaDeviceDiscovery | |
| finsedonaDeviceDiscoveryConfig | |
| first | Get the first item from an ordered collection or return null if the collection is empty |
| firstOfMonth | Get the first day of given date's month |
| firstRun | |
| firstRunComplete | |
| fitLinearRegression | Given a grid of x, y coordinates compute the best fit linear regression equation using the ordinary least squares method |
| fits | Return if the given instance fits the spec via structural typing |
| fitsExplain | Return grid which explains how data fits the given spec |
| fitsMatchAll | Match dict recs against specs to find all the specs that fit |
| flatMap | Map each item in a list or grid to zero or more new items as a flattened result |
| flatten | Flatten a list to a single level |
| floor | Return the largest whole number less than or equal to val |
| fold | Fold a list or stream into a single value using given folding function |
| foldCol | Fold the values of the given column into a single value |
| foldCols | Fold a set of columns in each row into a new folded column and return a new grid |
| foldEnd | The fold end marker value |
| foldStart | The fold start marker value |
| folderPathDelete | Axon function |
| folderPathEdit | Axon function |
| folderPathMove | Axon function |
| folioBackup | Asynchronously kick off a new backup for current project |
| folioBackupCleanup | Delete all backups older than the given duration or date |
| folioBackupDelete | Delete a backup file by its timestamp |
| folioBackups | List all the backups for the current project |
| folioDebugQueryForm | Axon function |
| folioDebugTagForm | Axon function |
| folioDebugWatchesForm | Axon function |
| folioEmptyTrash | Delete all the records marked with trash tag |
| folioFileAddTagForm | Axon function |
| folioFileBatchTrashForm | Axon function |
| folioFileEditForm | Axon function |
| folioFileTrashForm | Axon function |
| folioFileUploadForm | Axon function |
| folioOrphanCleanup | Axon function |
| folioOverwriteFileCommit | Axon function |
| folioOverwriteFileForm | Axon function |
| folioQueryForm | Axon function |
| folioQueryMenu | Axon function |
| folioQueryViewForm | Axon function |
| folioSnapRestoreProgBar | Axon function |
| folioSnapRestoreRestart | Axon function |
| folioSnapUploadForm | Axon function |
| folioTrashDeleteForm | Axon function |
| folioTrashEmptyForm | Axon function |
| folioTrashRestoreForm | Axon function |
| folioTrashViewForm | Axon function |
| format | Format an object using the current locale and specified format pattern |
| fromJSON | |
| fromJavaMillis | Given Number of milliseconds since Unix epoch return a DateTime |
| func | Find a top-level function by name or by reference and return its tags |
| funcDefs | |
| funcs | Find all the top-levels functions in the current project which match the given filter |
| futureCancel | Cancel a future |
| futureGet | Block current thread until a future's result is ready |
| futureIsComplete | Return if a future has completed or is still pending a result |
| futureState | Return current state of a future as one of the following strings |
| futureWaitFor | Block until a future transitions to a completed state (ok, err, or canceled) |
| futureWaitForAll | Block on a list of futures until they all transition to a completed state |
| geoCountryCode | Normalize a country name into its two letter ISO-3166 code |
| geoCountryName | Given a two ISO-3166 country code or country name, return a country name |
| geoTz | Given a dict/row that contains primary geo tags such as geoCountry, geoState, and geoCity return ideal timezone name |
| geoUsStateCode | Normalize a US state name into its standard two letter postal code |
| geoUsStateName | Given a two letter postal code or state name, return a US state name |
| get | Get an item from a collection |
| getAllMacros | Axon function |
| getBacnetServerMaxDeviceInstance | |
| getBacnetServerMaxMacAddress | |
| getEnumAlarmText | Axon function |
| getEventsData | Axon function |
| getFinComponent | |
| getHisTags | Axon function |
| getKioskConfig | |
| getLocalBindAddressStackConfig | |
| getLocalDnetNumberStackConfig | |
| getMacroByName | Axon function |
| getMixinsAndDependencies | |
| getNavURI | |
| getPhyiscalDnetStackConfig | |
| getPodVersion | |
| getSafe | Get an item from a str, list, or grid safely when an index is out of bounds |
| ghgCreateDirectSource | Create a ghgDirectSource record (scope 1 emission source) |
| ghgCreateEmission | Create an emission record |
| ghgCreateFactorHisPoint | Create an ghgFactorHis point record |
| ghgCreateIndirectSource | Create a ghgIndirectSource record (scope 2 emission source) |
| ghgEmissions | Calculate emissions for an equip, site, or ghgSource |
| graphicsBuilderNew | Axon function |
| graphicsMenu | Axon function |
| graphicsMenuSettings | Axon function |
| graphicsMobileMenu | Axon function |
| graphicsSelectedMenu | Axon function |
| graphicsVirtPtIcon | Axon function |
| graphicsVirtPtIconColor | Axon function |
| greenButtonReadUsage | Parse a Green Button XML file into a grid of usage data from any IO handle |
| gridColKinds | Given a grid return the types used in each column as a grid with the following |
| gridColsToDict | Convert grid columns into a dict of name/val pairs |
| gridReplace | Replace every grid cell with the given from value with the to value |
| gridRowsToDict | Convert grid rows into a dict of name/val pairs |
| gridToZinc | |
| has | If val is a Grid return if it has the given column name |
| haystackCall | Perform Haystack HTTP API call to given Str op name and with given request grid (can be anything acceptable toGrid()) |
| haystackEval | Evaluate an Axon expression in a remote server over a haystack connector |
| haystackHisRead | Perform Haystack REST API "hisRead" call to read history data for the record identified by the id (must be Ref) |
| haystackInvokeAction | Invoke a remote action on the given Haystack connector and remote entity |
| haystackLearn | Deprecated - use connLearn() |
| haystackPing | Deprecated - use connPing() |
| haystackRead | Perform Haystack REST API call to read single entity with filter |
| haystackReadAll | Perform Haystack REST API call to read all entities with filter |
| haystackReadById | Perform Haystack HTTP API call to read a record by its unique identifier |
| haystackReadByIds | Perform Haystack HTTP API call to read a list of records by their identifiers |
| haystackSyncCur | Deprecated - use connSyncCur() |
| haystackSyncHis | Deprecated - use connSyncHis() |
| hideRef | Axon function |
| hisClear | Clear the history items in the given range |
| hisClip | Remove the rows with leading/trailing timestamps from the actual query range |
| hisCollectWriteAll | Write all hisCollect items buffered in memory to the historian |
| hisCompare | Compare a history query against an alternate set of dates |
| hisCuSum | Calculate a simplified cumulative sum (CuSum) for the given history grid |
| hisDailyProfile | Perform a rollup by time slice to produce a single 24-hour profile of the data |
| hisDurProfile | Compute a "load duration" curve |
| hisFindAll | Perform a filter transformation on a history grid |
| hisFindInPeriods | Perform filter transformation on a history grid by finding all rows which have a timestamp within the given periods |
| hisFindPeaks | Filter a history grid so that only numeric samples that represent a peak are returned |
| hisFindPeriods | Find all the periods of time when fn returns true for a history grid |
| hisFindSlicePeriods | Given a source history grid and a grid of windows, compute the periods of all the slices matched by given function |
| hisFindTroughs | Filter a history grid so that only numeric samples that represent a trough are returned |
| hisFlatten | Perform a transformation on the history to flatten out ts/val pairs into new rows |
| hisFoldCols | Given a history grid, fold all the value columns (every column* except "ts") into a single "v0" column |
| hisInWindows | Return true or false if the given timestamp is inside at least one of the given windows |
| hisInterpolate | Interpolate all the null value cells for each timestamp |
| hisJoin | Given a list of history grids, join them by the ts timestamp column |
| hisMap | Perform a map transformation on the history value cells |
| hisMapSlices | Given a source history grid and a grid of windows, compute the mapping of each slice |
| hisPeriodIntersection | Find the intersection of two or more historical periods |
| hisPeriodMatrix | Get a grid which defines the "matrix" of unique combinations of all the periods merged together |
| hisPeriodNormalize | Given a grid of historical periods, merge any overlapping periods to result in a "normalized" his period grid |
| hisPeriodShift | Given of a grid of historical periods, shift the starting and ending timestamps by an offset |
| hisPeriodUnion | Find the union of two or more historical periods |
| hisRead | Query history for an arbitrary range |
| hisRemove | Remove items from a history using a timestamp or timestamp range |
| hisRewrite | Rewrite every item of a history using the given transformation function |
| hisRollup | Roll up a history grid over discrete intervals of time with the given fold function |
| hisRollupAuto | Automatically chooses the best rollup interval and the best rollup fold function for each history |
| hisRollups | Perform a series of rollups over discrete intervals |
| hisSlice | Slice a source history grid by a single time window |
| hisSlidingWindows | Compute of grid of timestamp/duration windows |
| hisSync | Block until any pending history writes/clears are completed |
| hisTransitionWindows | Compute a grid of timestamp/duration windows based on transitions of a history grid |
| hisWrite | Asynchronously write the specified timestamp/value pairs to the history |
| hostMeta | Read host metadata dict |
| hostVars | Read host variables dict |
| hour | Get hour of day as integer between 0 to 23 from time or datetime |
| hoursInDay | Given a DateTime in a specific timezone, return the number of hours in the day |
| httpSiteUri | Primary HTTP or HTTPS Uri - see HxHttpService.siteUri |
| iconUri | Create a virtual file URI to an icon |
| ignoredConnTags | Axon function |
| importModbus | |
| index | Return the first match of x in val searching forward, starting at the specified offset index |
| indexr | Return the last match of x in val searching backward, starting at the specified offset index |
| infoInfoForm | Axon function |
| infoLintForm | Axon function |
| infoReportForm | Axon function |
| infoThreadsForm | Axon function |
| infoViewerLibsForm | Axon function |
| insert | Insert an item into a list at the given index and return a new list |
| insertAll | Insert a list of items at the given index and return a new list |
| instance | Load or lookup a instance from a Xeto library by its string or ref qname as a Dict |
| instances | Lookup instances from Xeto libs as a list of dicts |
| instantiate | Create the default instance for a given spec |
| invokeBlockTaskVariables | Get the current Task Variables when the top function was called by the Invoke block |
| ioAppend | Convert a handle to append mode |
| ioCharset | Configure an I/O handle to use the specified charset |
| ioCopy | Copy a file or directory to the new specified location |
| ioCopyFile | |
| ioCrc | Generate a cycle reduancy check code as a Number |
| ioCreate | Create a directory or empty file with the given I/O handle |
| ioCreateDir | |
| ioDelete | Delete a file or a directory as mapped by the given I/O handle |
| ioDigest | Generate a one-way hash of the given I/O handle |
| ioDir | Read a directory listing, return a grid with cols |
| ioEachCsv | Iterate the rows of a CSV file (comma separated values) and callback the given function with two parameters |
| ioEachLine | For each line of the given source stream call the given function with two parameters |
| ioExists | |
| ioExport | Export a view to the given file handle - see Export |
| ioFromBase64 | Return an I/O handle to decode from a base64 string |
| ioGzip | Wrap an I/O handle to GZIP compress/uncompress |
| ioHmac | Generate an HMAC message authentication as specified by RFC 2104 |
| ioInfo | Get information about a file handle and return a Dict with the same tags as ioDir() |
| ioMove | Move or rename a file or directory |
| ioPbk | Generate a password based cryptographic key |
| ioRandom | Generate randomized series of bytes which can be used as an input I/O handle |
| ioReadCsv | Read a CSV (comma separated values) file into memory as a Grid |
| ioReadFileStr | |
| ioReadJson | Read a JSON file into memory |
| ioReadJsonGrid | Read a JSON file formatted as a standardized Haystack grid into memory |
| ioReadLines | Read an I/O handle into memory as a list of string lines |
| ioReadStr | Read an I/O handle into memory as a string |
| ioReadTrio | Read a Trio file into memory as a list of Dicts |
| ioReadXeto | Read a Xeto data file into memory as a Haystack data type |
| ioReadZinc | Read a Zinc file into memory as a Haystack data type |
| ioSkip | Apply a skipping operation to an input I/O handle |
| ioStreamCsv | Read a stream of dicts from a comma separated value file |
| ioStreamLines | Read a stream of lines |
| ioToBase64 | Encode an I/O handle into a base64 string |
| ioToHex | Encode an I/O handle into hexidecimal string |
| ioUnzipPod | |
| ioWriteCsv | Write a grid to a CSV (comma separated values) file |
| ioWriteExcel | Write an Excel XLS file, where val may be |
| ioWriteFile | |
| ioWriteHtml | Write an Axon data structure to HTML |
| ioWriteJson | Write an Axon data structure to JSON |
| ioWriteJsonLd | Write an Axon data structure to RDF JSON-LD format |
| ioWriteLines | Write a list of string lines separated with "\n" character |
| ioWritePdf | Render data to a PDF file |
| ioWriteStr | Write a string to an I/O handle |
| ioWriteSvg | Render data to an SVG file |
| ioWriteTrio | Write dicts to a Trio file |
| ioWriteTurtle | Write an Axon data structure to RDF Turtle format |
| ioWriteXeto | Write value to a Xeto text format file |
| ioWriteXml | Write a grid to an XML file |
| ioWriteZinc | Write a Grid to the Zinc format |
| ioZipDir | Read a zip file's entry listing, return a grid with cols |
| ioZipEntry | Return a I/O handle which may be used to read from a zip entry within a zip file |
| is | Return if the given instance inherits from the spec via nominal typing |
| isAlpha | Is number an ASCII alpha char |
| isAlphaNum | Is number an ASCII alpha-numeric char |
| isBool | Return if an object is a boolean type |
| isDate | Return if an object is a Date type |
| isDateTime | Return if an object is a DateTime type |
| isDict | Return if an object is a dict type |
| isDigit | Is number a digit in the specified radix |
| isDuration | Return if an object is a number type with a time unit |
| isEmpty | Return if a collection is empty |
| isEven | Return if an integer is an even number |
| isFunc | Return if an object is a function type |
| isGrid | Return if an object is a grid type |
| isHisGrid | Return if an object is a grid that conforms to the history grid shape |
| isKeyword | Return if given string is an Axon keyword |
| isLeapYear | Return if a year is a leap year |
| isList | Return if an object is a list type |
| isLower | Is number an ASCII lowercase alphabetic char |
| isMetric | Given an optional value return true if the SI metric system should be used |
| isNaN | Return if val is the Number representation of not-a-number |
| isNonNull | Return if an object is not null |
| isNull | Return if an object is null |
| isNumber | Return if an object is a number type |
| isOdd | Return if an integer is an odd number |
| isRef | Return if an object is a ref type |
| isSpace | Is number is whitespace char |
| isSpan | Return if an object is a span |
| isSteadyState | Return HxRuntime.isSteadyState |
| isStr | Return if an object is a str type |
| isTagName | Return if the given string is legal tag name - see Etc.isTagName |
| isTime | Return if an object is a Time type |
| isUpper | Is number an ASCII uppercase alphabetic char |
| isUri | Return if an object is a Uri type |
| isWatched | Return if given record is under at least one watch |
| isWeekday | Does the given Date or DateTime fall on Mon, Tue, Wed, Thu, or Fri |
| isWeekend | Does the given Date or DateTime fall on Sat or Sun |
| jaccardIndex | Axon function |
| jobAppConfig | Axon function |
| jobCancel | Send the cancel message to the job identified by given handle |
| jobCreateForm | Axon function |
| jobCurRec | If running in the context of a scheduled job then return the job record Dict |
| jobDebugForm | Axon function |
| jobEditForm | Axon function |
| jobFinBackup | Axon function |
| jobFolioBackup | Run the folioBackup() function as a background job |
| jobFolioCompact | This is a no-op |
| jobFolioSnapshot | Deprecated |
| jobIsRunning | Is the current context contained by a running job |
| jobLog | Return the LogRecs logged by the job identified by handle |
| jobParseTime | Axon function |
| jobProgress | Update the current job's progress with percent complete and display message for current activity |
| jobRefreshUser | Refresh the user account used for jobs |
| jobRun | Run the given expression in the context of a background job |
| jobRunForm | Axon function |
| jobSleep | Sleep for the given duration |
| jobStatus | Return the status for a single job identified by handle |
| jobStatusAll | Return the status for all the known jobs |
| jobTrashForm | Axon function |
| join | Join two grids by column name |
| joinAll | Join a list of grids into a single grid |
| keepCols | Return a new grid with keeps the given columns, but removes all the others |
| kioskImageImport | |
| knxDeleteProjectFiles | |
| knxDeviceStatus | NOTE |
| knxDevices | Return a grid of all KNX devices found in the ETS project file for the given connector |
| knxDpEditForm | Launches the data point edit form |
| knxEnableCustomEncoding | Method to configure encoding if KNX project import fail Parameters - enable |
| knxFindProjectFiles | |
| knxFormAddEditCustomUnit | Axon function |
| knxFormAddEditExistingUnit | Axon function |
| knxFormAddEditUnit | Axon function |
| knxFormDeleteUnit | Axon function |
| knxFormImportExportCustomUnitFile | Axon function |
| knxFormNote | Axon function |
| knxGetDataTypes | Retrieve the possible data types for the data point edit form's data type selectors |
| knxGetQuantities | |
| knxImportUnits | |
| knxLearn | Perform a synchronous learn read on the given connector |
| knxPing | Perform an async ping on the given connector |
| knxProjectIsLocked | |
| knxReadUnits | |
| knxReplaceProjectFile | |
| knxSyncCur | Asynchronously synchronize current values for given list of proxy points |
| knxUpdateDataPoints | Receives the updated values from the data point edit form |
| knxUpdateIndividualAddress | Method to configure KNX individual address Parameters - conn |
| knxUploadProject | |
| knxWatchdogDisable | Disable the KNX watchdog for the given connector |
| knxWatchdogEnable | Enable or configure the KNX watchdog for the given connector |
| knxWatchdogStatus | Return a grid showing the cached watchdog connectivity status for all KNX devices |
| knxWriteUnits | Write units |
| last | Get the last item from an ordered collection or return null if the collection is empty |
| lastMonth | DateSpan for month previous to this month 1..28-31 |
| lastOfMonth | Get the last day of the date's month |
| lastQuarter | DateSpan for 3 month quarter previous to this quarter |
| lastWeek | DateSpan for week previous to this week sun..sat (uses locale start of week) |
| lastYear | DateSpan for year previous to this year Jan-1..Dec-31 |
| libAdd | Enable a library by name in the runtime |
| libRemove | Disable a library by name in the runtime |
| libStatus | Return grid of enabled libs and their current status |
| libs | List the lib definitions in the context namespace as Def[] |
| licStatus | Return current licensing status as Dict with following tags |
| limit | Truncate stream after given limit is reached |
| lint | Run the lint report on the given recs |
| listFile | |
| listOfEquipIds | Axon function |
| loadPodGraphic | |
| localeUse | Evaluate an expression within a specific locale |
| log | Submit a log record to the logging subsystem |
| log10 | Return base 10 logarithm of val |
| logDebug | Log at the "debug" level - see log() |
| logE | Return natural logarithm to the base e of val |
| logErr | Log at the "err" level - see log() |
| logInfo | Log at the "info" level - see log() |
| logRead | Read log records for given span |
| logWarn | Log at the "warn" level - see log() |
| longCycling | Compute periods when an bool point's on period exceeds maxOnTime Params |
| lower | Convert a char number or str to ASCII lower case |
| manualOverrideArrayMenu | Axon function |
| manualOverrideMenu | Axon function |
| manualOverridesMainMenu | Axon function |
| map | Map list, dict, or grid by applying the given mapping function |
| marker | Get the marker value singleton Marker.val |
| markerOnly | Axon function |
| matchPointVal | Return if a point value matches a given critera |
| matrixAdd | Add two matrices together and return new matrix |
| matrixDeterminant | Return the determinant as a unitless Number for the given matrix which is any value accepted by toMatrix() |
| matrixFitLinearRegression | Given 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 |
| matrixInverse | Return the inverse of the given matrix which is any value accepted by toMatrix() |
| matrixMult | Multiply two matrices and return new matrix |
| matrixSub | Subtract two matrices and return new matrix |
| matrixTranspose | Transpose the given matrix which is any value accepted by toMatrix() |
| max | Compare two numbers and return the larger one |
| mean | Fold a sample of numbers into their standard average or arithmetic mean |
| meanBiasErr | Fold a sample of numbers into their MBE (mean bias error) |
| median | Fold a sample of numbers into their median value which is the middle value of the sorted samples |
| menuForButton | Axon function |
| menuForLabel | Axon function |
| menuForProgram | Axon function |
| menuForSuperman | Axon function |
| menuForVirtualPoint | Axon function |
| merge | Merge two Dicts together and return a new Dict |
| meta | Get the meta-data from a grid or col as a dict |
| migrateGetFileUrl | Allows 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 |
| migrateRef | Allows 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 |
| min | Compare two numbers and return the smaller one |
| minute | Get minutes of the time as integer between 0 to 59 from time or datetime |
| missing | If val is a Grid return if it does not have given column name |
| mlAddMeta | Add metadata to the given trained model |
| mlGridSearchCv | Configure a cross-validation grid-search |
| mlLinearKernel | Create a Linear kernel |
| mlLoadModel | Load a trained model from the given I/O handle |
| mlMeta | Get the model metadata |
| mlOls | Create a training model for doing ordinary least-squares regression (OLS) |
| mlParamSweep | Do a "parameter sweep" by invoking the given func for all combinations of parameters in the parameter grid |
| mlPolyKernel | Create a Polynomial kernel |
| mlPredict | Make predictions against a trained model |
| mlRbfKernel | Create a RBF (RBF) kernel |
| mlSaveModel | Save a trained model to the given I/O handle |
| mlScaleMinMax | Perform Min-Max feature scaling |
| mlScaleZ | Perform Z-score normalization on the features |
| mlStats | Get the model statistics |
| mlSvm | Create a Support Vector Machine (SVM) for classification |
| mlSvr | Create a Support Vector Machine for Regression (SVR) |
| mlToGrid | Convert a matrix to a Grid |
| mlToMatrix | Convert the given obj to an optimized matrix type for machine learning |
| mlTrain | Train a machine learning model with the given training data |
| mobileViewRecordAdd | Axon function |
| mobileViewRecordEdit | Axon function |
| mobileViewRecordInfo | Menu to view tags of a record |
| mobileViewRecordString | Axon function |
| modbusLearn | Deprecated - use connLearn() |
| modbusPing | Deprecated - use connPing() |
| modbusRead | Read a point value for given register name on connector instance |
| modbusRegMap | Return given register map contents |
| modbusRegMaps | List installed register maps including source |
| modbusSyncCur | Deprecated - use connSyncCur() |
| modbusWrite | Write a value to given register name on connecter instance |
| modifyNavMetaOptional | Axon function |
| month | Get month as integer between 1 to 12 from date or datetime |
| moveTo | Find the given item in a list, and move it to the given index |
| mqttPublish | Publish an MQTT message to the given topic on the broker |
| nHaystackQueryApply | Axon function |
| na | Get NA not-available singleton NA.val |
| name | If val is a Col, get the column name |
| names | Get the list of names used by a given dict |
| nan | Return the Number representation of not-a-number |
| navDuplicate2 | This function calls navDuplicate using the parameters to duplicates records and then adjusts the names |
| navProjNames | Return a list of string project names which are currently navigable based on current uiMeta flag |
| navRef | Return a navigation Ref for given target name and record |
| navResolve | Resolve a list of navigation Refs to a list of Dict records |
| negInf | Return the Number representation negative infinity |
| nextActionProgramBlockTree | Axon function |
| nextActionProgramBlockTree2 | Axon function |
| nextActionProgramTree | Axon function |
| nextActionProgramTree2 | Axon function |
| notify | Send an email to all users subscribed to the given topic |
| notifyTarget | |
| notifyTopicSubscribers | Return a list of user rec's for users that are subscribed to the given topic |
| now | Return current DateTime according to context's time zone |
| nowTicks | Return current time as nanosecond ticks since 1 Jan 2000 UTC |
| nowUtc | Return current DateTime in UTC |
| numDays | Number of whole days in a span |
| numDaysInMonth | Get the number of days in a given month |
| obixInvoke | Invoke an obix:op operation as identified by given uri |
| obixPing | Deprecated - use connPing() |
| obixReadHis | Synchronously query a obix::History for its timestamp/value pairs |
| obixReadObj | Read one Uri from an obixConn |
| obixSyncCur | Deprecated - use connSyncCur() |
| obixSyncHis | Deprecated - use connSyncHis() |
| obixWriteObj | Write an object as identified by given uri |
| occurred | Return if a timestamp is contained within a Date range |
| opcGenCert | Generate a client certificate to use for an OPC connector |
| opcPing | Deprecated - use connPing() |
| opcSyncCur | Deprecated - use connSyncCur() |
| opcSyncHis | Deprecated - use connSyncHis() |
| padZero | Axon function |
| padl | Pad string to the left |
| padr | Pad string to the right |
| parseAst | Parse Axon source code into an abstract syntax tree modeled as a tree of dicts |
| parseBool | Parse a Str into a Bool, legal formats are "true" or "false |
| parseDate | Parse a Str into a Date |
| parseDateTime | Parse a Str into a DateTime |
| parseDiscreteBoolPeriods | Parse a Base64 encoded timeline of discrete Bool periods as encoded by discreteBoolPeriods() |
| parseDiscreteEnumPeriods | Parse a base64 encoded string timeline of discrete enum periods as encoded by discreteEnumPeriods() |
| parseDiscretePeriods | Parse a base64 encoded string timeline of discrete periods as encoded by discretePeriods() |
| parseFilter | Parse a filter string into a Filter instance |
| parseFloat | Parse a Str into a Float |
| parseInt | Parse a Str into a integer number using the specified radix |
| parseNumber | Parse a Str into a number with an option unit |
| parseRef | Parse a Str into a Ref |
| parseSearch | Parse a search string into a Filter instance |
| parseSymbol | Parse a Str into a Symbol |
| parseTime | Parse a Str into a Time |
| parseUnit | Parse a Str into a standardized unit name |
| parseUri | Parse a string into a Uri instance |
| passwordSet | Store a password key/val pair into current project's password store |
| pastMonth | DateSpan for last 30days today-30days..today |
| pastWeek | DateSpan for last 7 days as today-7days..today |
| pastYear | DateSpan for this past today-365days..today |
| pi | Return constant for pi |
| pivot | Transform a grid to a pivot table - see Axon Usage |
| pods | Return list of installed Fantom pods |
| pointAuto | User level-8 manual auto (override release) of writable point |
| pointConvert | Evaluate a point conversion |
| pointDetails | Get debug string for point including writables and his collection |
| pointEmergencyAuto | User level-1 manual auto (override release) of writable point |
| pointEmergencyOverride | User level-1 manual override of writable point |
| pointOverride | User level-8 manual override of writable point |
| pointOverrideCommand | Issue a point override command based on current user's access control permissions |
| pointSetDef | Set the relinquish default value (level-17) of writable point |
| pointThermistorTables | Return grid of thermistor table names as grid with one name column |
| pointWrite | Set a writable point's priority array value at the given level |
| pointWriteArray | Return the current priority array state of a writable point |
| posInf | Return the Number representation positive infinity |
| pow | Return val raised to the specified power |
| priorityBadgeVal | Axon function |
| programRead | Given 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 |
| programTargets | Given a program rec or id, return the a grid with the targets matched by the program's programOn filter |
| programVarLocs | Given a program id, return a table of all the variables and their line number locations in the program definition |
| projRebuild | Rebuild the current project in-place |
| projSync | Block until all folio/project message queues are fully processed |
| provDownloadBuild | Download a SkySpark build from skyfoundry.com and create or update a provBuild manifest for it |
| provDownloadPatches | Download all the current patches for a SkySpark build from skyfoundry.com and create or update a provPatch manifest for it |
| provNewImage | Create a provImage from an ordered list of manifest recs |
| provSkySparkImage | Create a provImage for the given SkySpark build number |
| publishPod | Axon function |
| py | Create a new PySession instance |
| pyDefine | Define a variable to be available to python code running in the session |
| pyEval | Evalue the given python statement in the session, and return the result |
| pyExec | Execute the given python code in the session and return the python session |
| pyInit | Initialize the python session by calling the given func to do any one-time setup of the python session |
| pyTimeout | Set the timeout for pyEval() |
| quantile | Computes the p*th* quantile of a list of numbers, according to the specified interpolation method |
| query | Evaluate a relationship query and return record dict |
| queryAll | Evaluate a relationship query and return grid of results |
| queryNamed | Evaluate a relationship query and return the named constraints as a dict |
| random | Return random integer within given inclusive range |
| reFind | Find the first match of regular expression in s or return null if no matches |
| reFindAll | Find all matches of the regular expression in s |
| reGroups | Return a list of the substrings captured by matching the given regular operation against s |
| reMatches | Return if regular expression matches entire region of s |
| read | Read from database the first record which matches filter |
| readAlarmHistory | Given optional targets and/or a time span, query the alarm history as a grid |
| readAll | Reall all records from the database which match the filter |
| readAllStream | Reall all records which match filter as stream of Dict records |
| readAllTagNames | Return the intersection of all tag names used by all the records matching the given filter |
| readAllTagVals | Return the range of all the values mapped to a given tag name used by all the records matching the given filter |
| readById | Read a record from database by id |
| readByIdPersistentTags | Given record id, read only the persistent tags from Folio |
| readByIdTransientTags | Given record id, read only the transient tags from Folio |
| readByIds | Read a list of record ids into a grid |
| readByIdsStream | Read a list of ids as a stream of Dict records |
| readCount | Return the number of records which match the given filter expression |
| readFileTrio | |
| readFinFile | |
| readFinFileResources | |
| readFinToolsCsv | Read a csv from the pod |
| readLink | Read a record Dict by its id for hyperlinking in a UI |
| recDelete | Record delete action |
| recDisable | Record disable action |
| recDup | Record duplicate action |
| recEdit | Record edit action |
| recEnable | Record enable action |
| recForm | Return a data grid for a form view to edit the specified record |
| recFormCommit | Commit a rec based form to Folio |
| recNew | Record create action |
| recTrash | Record trash action |
| reduce | Reduce a collection to a single value with the given reducer function |
| refDis | Given a ref return Ref.dis |
| refGen | Generate a new unique Ref identifier |
| refProjName | Given an absolute ref, return its project name |
| refreshFinComponents | |
| relDis | Get a relative display name |
| remainder | Return the remainder or modulo of division |
| remove | Remove an item from a collection and return a new collection |
| removeCol | Return a new grid with the given column removed |
| removeCols | Return a new grid with all the given columns removed |
| removeMarker | Get the remove value singleton Remove.val |
| renameCol | Return a new grid with the given column renamed |
| renameCols | Return a new grid with multiple columns renamed |
| renameTags | Rename a set of tags on a list of records or across the entire project database |
| renameVar | Axon function |
| renameVarById | Axon function |
| reorderCols | Return a new grid with the columns reordered |
| replace | String replace of all occurrences of from with to |
| replicaBackup | Asynchronously kick off a new local backup for given replica |
| replicaBackupCleanup | Delete all local replica backups older than the given duration or date |
| replicaBackupDelete | Delete a local replica backup file by its timestamp |
| replicaBackups | List the local replica backups on this machine |
| reportData | Axon function |
| retrieveGraphicDependencies | |
| rootMeanSquareErr | Fold a sample of numbers into their RMSE (root mean square error) |
| round | Returns the nearest whole number to val |
| rowToList | Get a grid row as a list of cells |
| ruleDebug | Return a debug grid from the rule engine |
| ruleDelete | Delete works just like ruleRecompute() except it also deletes the sparks/KPIs from the cache |
| ruleErrs | Return grid of all the rule+targets which have errors |
| ruleKpis | Query local KPIs along three dimensions of target x dates x rules |
| ruleKpisDigest | Return grid of KPIs to use for a notification |
| ruleOrphans | Search the database for all previously cached sparks and KPIs which no longer have a valid rule record |
| ruleRecompute | Recompute local sparks or KPIs for the given targets/dates/rules |
| ruleReobserve | Clear today's observed flag to re-observe sparks |
| ruleRosterRefresh | Force roster refresh |
| ruleSparkExplain | Return explanation information for a spark |
| ruleSparkHis | Turn a grid of sparks as returned by ruleSparks() into a history grid of the spark periods |
| ruleSparks | Query local sparks along three dimensions of target x dates x rules |
| ruleSparksCount | Return number of sparks as queried by ruleSparks() |
| ruleSparksDigest | Return grid of sparks to use for a notification |
| ruleTargetsUnder | Get a grid of all the rule targets which are contained by the given parent |
| ruleTest | Perform test run of rule |
| ruleToTargets | Get all the target records the rule is registered on by the ruleOn tag |
| ruleTuning | Return the effective tuning Dict for the given target/rule pair |
| ruleTunings | Read grid of tuning records sorted from lowest to highest priority |
| rulesToTargets | Get all the target records the list of rules is registered on by the ruleOn tag |
| runJob | |
| runRoutine | Asynchronously run the routine identified by given program, target, and routine name |
| sampleAddTags | Axon function |
| saveMacro | Axon function |
| scheduleBadgeTip | Axon function |
| scheduleBadgeType | Axon function |
| scheduleBadgeVal | Axon function |
| scheduleCreateNewCommit | Axon function |
| scheduleCreateNewDefVal | Axon function |
| scheduleCreateNewForm | Axon function |
| scheduleDisplay | Axon function |
| scheduleFindPoints | Axon function |
| scheduleFindPointsCommit | Axon function |
| scheduleGetRefs | Axon function |
| scheduleHis | Compute a historical or future timeline of a schedule record |
| scheduleIconTip | Axon function |
| scheduleMenu | Axon function |
| scheduleMenuSettings | Axon function |
| scheduleMoveSchedulable | Axon function |
| scheduleSync | Block until any schedule changes are refreshed |
| scheduleToolTreeForm | Axon function |
| scheduleToolTreeFormCommit | Axon function |
| scheduleValAt | Return the scheduled value at the given timestamp |
| second | Get seconds of the time as integer between 0 to 59 from time or datetime |
| sedonaPing | Deprecated - use connPing() |
| sedonaReadComp | Synchronously read the current state of the component identified by the given component identifier |
| sedonaSyncCur | Deprecated - use connSyncCur() |
| sedonaWrite | Synchronously write a property |
| selectActionDiscover | Axon function |
| selectActionEquipTree | Creates panels to be displayed on when an item from the equip tree is selected |
| selectActionGraphicsTree | Axon function |
| selectActionJobTree | Axon function |
| selectActionProgramCatTree | Axon function |
| selectActionProgramCatTree2 | Axon function |
| selectActionProgramTasksTree | Axon function |
| selectActionProgramTree | Axon function |
| selectActionProgramVarBindingsTree | Axon function |
| selectActionScheduleTree | Axon function |
| selectActionScheduleTree2 | Axon function |
| selectActionTagBundlesTree | Axon function |
| sensorFailure | Compute periods when a point doesn't change by more than a tolerance |
| services | Grid of installed services |
| set | Set a collection item and return a new collection |
| setColMeta | Return a new grid with column meta-data replaced by given meta dict |
| setMeta | Return new grid with grid level meta-data replaced by given meta Dict |
| shortCycling | Compute periods when an bool point's on/off periods are not meeting min on/off times |
| siemens2dResources | Axon function |
| sin | Return sine of angle in radians |
| sinh | Return hyperbolic sine |
| size | Return number of items in str, list, or grid |
| skip | Skip the given number of items in a stream |
| snmpGet | Synchronously read the current value of the object-type specified by arg |
| snmpPing | Deprecated - use connPing() |
| snmpReadTable | Synchronously read an SNMP table and return it as a Grid |
| snmpSyncCur | Deprecated - use connSyncCur() |
| sort | Sort a list or grid |
| sortDis | Sort a grid by row display name - see Grid.sortDis Examples |
| sortr | Reverse sort a list or grid |
| spec | Load or lookup a Xeto spec by its string or ref qname |
| specBase | Base spec from which the given spec directly inherits |
| specFits | Return if spec a fits spec b based on structural typing |
| specFitsExplain | Return a grid explaining why spec a does not fit b |
| specIs | Return if spec a inherits from spec b based on nominal typing |
| specLib | Load or lookup a Xeto library by its string or ref name |
| specLibs | List Xeto libraries as a list of their dict representation |
| specMeta | Get the spec's effective declared meta-data as dict |
| specMetaOwn | Get the spec's own declared meta-data as dict |
| specName | Return simple name of spec |
| specOf | Return the Xeto spec of the given value |
| specParent | Parent spec which contains given spec and scopes its name |
| specQName | Return fully qualified name of the spec |
| specSlots | Get the effective children slots as a dict of Specs |
| specSlotsOwn | Get the spec's declared children slots as dict of Specs |
| specType | Data type of the spec |
| specs | List Xeto specs as a list of their dict representation |
| split | Split a string by the given separator and trim whitespace |
| spread | Fold multiple values to compute the difference between the max and min value |
| sqlDebugDrivers | Return plain text report on JDBC drivers installed |
| sqlExecute | Execute a SQL statement and if applicable return a result |
| sqlInsert | Insert a record or grid of records into the given table |
| sqlPing | Deprecated - use connPing() |
| sqlQuery | Execute a SQL query and return the result as a grid |
| sqlSyncHis | Deprecated - use connSyncHis() |
| sqlTables | Query the tables defined for the database |
| sqrt | Return square root of val |
| stackhubMobile | Axon function |
| standardDeviation | Fold a series of numbers into the standard deviation of a sample |
| standardFinWatcher | standardFinWatcher 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 |
| start | Start value of a DateSpan, Span or a range |
| startOfWeek | Return current locale's start of weekday |
| startsWith | Return if Str starts with the specified Str |
| stream | Create new stream from given collection |
| streamCol | Create a new stream for the cell values of the given column |
| stripUncommittable | Strip any tags which cannot be persistently committed to Folio |
| subscribeToGraphic | Subscribe 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 |
| sum | Fold multiple values into their numeric sum |
| swizzleRefs | Given a grid of records, assign new ids and swizzle all internal ref tags |
| sysModAdd | Enable the given system module name such as "ldap" |
| sysModRemove | Disable the given system module name |
| sysMods | List the installed system mods |
| sysReload | Force a system reload |
| table | Set the grid visualization view to table |
| tags | List tag definitions in the context namespace as Def[] |
| tan | Return tangent of angle in radians |
| tanh | Return hyperbolic tangent |
| targetToRules | Get all the rule records which are registered on given target |
| targetsToRules | Get all the rule records which are registered on given list of targets |
| tariffBillPeriod | For the given meter, get the date span of the bill period containing the given date |
| tariffConsumptionCharge | Create a consumption charge |
| tariffCost | Calculate the cost of energy for a meter |
| tariffCostToHis | Function to create a computed history for the tariff cost associated with that meter |
| tariffCreate | Create a new tariff |
| tariffCreateBillHis | Create the billing period history point |
| tariffDemandCharge | Create a demand charge |
| tariffFixedCharge | Create a fixed charge |
| tariffPercentageCharge | Create a percentage charge |
| task | Lookup a task by id which is any value supported by toRecId() |
| taskBundle | Read the current state of a bundle variable |
| taskCancel | Set cancel flag for the given task |
| taskCur | Return current task if running within the context of an asynchronous task |
| taskDiagram | Given task or target rec, return the diagram for all the entity relationships to visualize data sharing |
| taskGetVarsFor | Given a rec or rec id, find all the variables which are set on that record |
| taskIsRunning | Is the current context running asynchrounsly inside a task |
| taskLocalGet | Get a task local variable by name or def if not defined |
| taskLocalRemove | Remove a task local variable by name |
| taskLocalSet | Set a task local variable |
| taskMonitorPoll | Poll the var monitor table for the task identified by the given program and target |
| taskProgress | Update the current running task's progress data with given dict |
| taskRefreshUser | Refresh the user account used for tasks |
| taskRestart | Restart a task |
| taskRun | Run the given expression asynchronously in an ephemeral task |
| taskSend | Asynchronously send a message to the given task for processing |
| taskSendAction | Axon function |
| taskSendLater | Schedule a message for delivery after the specified period of duration has elapsed |
| taskSendWhenComplete | Schedule a message for delivery after the given future has completed |
| taskSetMonitorMode | Set or clear the monitor mode for a set of variables in the task identified by the given program and target |
| taskSetUnlinkMode | Set or clear the unlink mode for a set of variables in the task identified by the given program and target |
| taskSetVars | Manually set the given task variables identified by the given program and target |
| taskSleep | Sleep for the given duration |
| taskVarTree | Return a grid which defines a tree of potential variables to create for a target rec |
| taskVarsBoundTo | Given a rec or rec id, find all the task variables which are bound to that rec |
| taskVarsLinkedTo | Given a task identified by the given program and target and a variable name, return all the other tasks where that variable has shared usage |
| tasks | List the current tasks as a grid |
| templateWizardApp | Axon function |
| templatize | |
| terms | List term definitions (tags and conjuncts) in the context namespace as Def[] |
| thisMonth | DateSpan for this month as 1st..28-31 |
| thisQuarter | DateSpan for this 3 month quarter |
| thisWeek | DateSpan for this week as sun..sat (uses locale start of week) |
| thisYear | DateSpan for this year Jan-1..Dec-31 |
| time | If val is a DateTime |
| times | Call the specified function the given number of times passing the counter |
| to | Convert a number to the given unit |
| toAhuCool | Given an ahu rec, get its cool cmd point rec |
| toAhuDischargeFan | Given an ahu rec, query its discharge fan cmd point rec |
| toAhuDischargePressure | Given an ahu rec, get its discharge pressure sensor point rec |
| toAhuDischargeTemp | Given an ahu rec, get its discharge temp sensor point rec |
| toAhuHeat | Given an ahu rec, get its heat cmd point rec |
| toAhuMixedTemp | Given an ahu rec, get its mixed temp sensor point rec |
| toAhuOutsideDamper | Given an ahu rec, get its outside damper cmd point |
| toAhuOutsideTemp | Given an ahu rec, get its outside temp sensor point rec |
| toAhuReturnTemp | Given an ahu rec, get its return temp sensor point rec |
| toAhuZoneTemp | Given an ahu rec, get its zone temp sensor point rec or throw an exception |
| toAlarm | Given a target and either a legacy namespace or a new-style alarm state, transition the given namespace/target to the alarm state |
| toAxonCode | Convert a scalar, list, or dict value to its Axon code representation |
| toChar | Convert a unicode char number into a single char string Examples |
| toDateSpan | Convert the following objects into a DateSpan |
| toDegrees | Convert angle in radians to an angle in degrees |
| toDevices | Map a set of recs to to a grid of devices |
| toEquips | Map a set of recs to to a grid of equips |
| toGrid | Given an arbitrary object, translate it to a Grid via Etc.toGrid |
| toHex | Convert a number to a hexadecimal string |
| toJSON | |
| toJavaMillis | Given a DateTime return Number of milliseconds since Unix epoch |
| toList | If val is a list return it, otherwise return [val] |
| toLocale | Get the localized string for the given tag name or qualified name |
| toMatrix | Convert a general grid to an optimized matrix grid |
| toNormal | Given targets, transition alarms back to normal state using either the legacy API (namespace-based) or the new API (message/occurred/meta) |
| toOccupied | Given a site, space, equip, or point rec, get its occupied point |
| toPoints | Map a set of recs to to a grid of points |
| toRadians | Convert angle in degrees to an angle in radians |
| toRadix | Convert a number to its string representation in the given radix (base) |
| toRec | Coerce a value to a record Dict |
| toRecId | Coerce a value to a Ref identifier |
| toRecIdList | Coerce a value to a list of Ref identifiers |
| toRecList | Coerce a value to a list of record Dicts |
| toSites | Map a set of recs to to a grid of sites |
| toSpaces | Map a set of recs to to a grid of spaces |
| toSpan | Convert the following objects into a Span |
| toStr | Convert an obj to its string representation |
| toTagName | Given arbitrary string, convert to a safe tag name - see Etc.toTagName |
| toTimeZone | Convert a DateTime or Span to another timezone |
| toWeather | Attempt to get the weather station record from |
| today | Return today's Date according to context's time zone |
| transpose | Perform a matrix transpose on the grid |
| trap | Function for the -> operator |
| trendDiscover | |
| trendLearn | Learn - discover points on a device |
| trendPing | Ping |
| trendSyncHis | |
| trim | Trim whitespace from the beginning and end of the string |
| trimEnd | Trim whitespace only from the end of the string |
| trimStart | Trim whitespace only from the beginning of the string |
| tz | Get timezone as city name string in tzinfo database from datetime |
| tzdb | Return the installed timezone database as Grid with following columns |
| uiLink | Host relative URI to hyperlink to a Fresco view - see Export |
| uiLinkAbs | Convenience for httpSiteUri() + uiLink() to generate an absolute URI hyperlink |
| unique | Return the unique items in a collection |
| unit | Given a number return its unit string or null |
| unitdb | Return the installed unit database as Grid with following columns |
| unitsEq | Return if the two numbers have the same unit |
| upper | Convert a char number or str to ASCII upper case |
| uriBasename | Get the basename (last name in path without extension) of a Uri as a string |
| uriDecode | Parse an ASCII percent encoded string into a Uri according to RFC 3986 |
| uriEncode | Return the percent encoded string for this Uri according to RFC 3986 |
| uriExt | Get the URI extension of a Uri as a string or null |
| uriFrag | Return if the fragment identifier portion of the a URI after hash symbol |
| uriHost | Get the host Uri as a string or null |
| uriIsDir | Return if the URI path ends in a slash |
| uriName | Get the name Str of a Uri (last item in path) |
| uriPath | Get the path segments of a Uri as a list of Strs |
| uriPathStr | Get the path a Uri as a string |
| uriPlusSlash | Adding trailing slash to the URI |
| uriPort | Get the port of a Uri as a Number or null |
| uriQueryStr | Return if the query portion of the a URI after question mark |
| uriScheme | Get the scheme of a Uri as a string or null |
| userBackup | Asynchronously kick off a new backup for user database |
| userBackupCleanup | Delete all user database backups older than the given duration or date |
| userBackupDelete | Delete a user database backup file by its timestamp |
| userBackups | List all the user database backups |
| userCommit | Commit one or more diffs to the user database |
| userCur | Read user rec Dict for current session user |
| userDeleteConfirm | Axon function |
| userFormSetPassword | Axon function |
| userIsProjAccessible | Return if the given user has access to the project as configured by projAccessFilter |
| userLastLogin | Get information about the last successful login for the user with the given username |
| userMfaStatus | Check if MFA is required and if user is enrolled |
| userMfaTotpReset | Clear the stored Totp MFA enrollment configuration |
| userRead | Read a rec Dict from the user db by filter |
| userReadAll | Read a Grid of recs from the user db by filter |
| userReadById | Read a rec Dict from the user db by id |
| userSetPassword | Update password of the given user |
| usersAccessFilterWizard | Axon function |
| usersEditUsernameForm | Axon function |
| usersFormAppPermissions | Axon function |
| usersFormAppPermissionsCommit | Axon function |
| usersFormClone | Axon function |
| usersFormCloneCommit | Axon function |
| usersFormCreateNew | Axon function |
| usersFormCreateNewCommit | Axon function |
| usersFormCreateNewOptions | Axon function |
| usersFormEdit | Axon function |
| usersFormEditCommit | Axon function |
| usersFormSelectEdit | Axon function |
| usersFormSubscriptions | Axon function |
| usersFormSubscriptionsCommit | Axon function |
| usersInputValidator | Axon function |
| usersMainMenuSettings | Axon function |
| usersRunTool | Axon function |
| usersToolSettings | Axon function |
| usersType | Axon function |
| validateFilter | Raise an exception if string is not valid filter |
| validateNotBlank | Raise an exception if string is blank |
| validateTagName | Raise an exception if string is not a validate tag name |
| validateUsername | Raise an excpetion if string is not a validate username |
| vals | Get the list of values used by a given dict |
| vizAutoRange | Return the automatic axis range of a min, max number |
| vizInterpolateRgb | Interpolate a heatmap color using the RGB color model |
| watchAdd | Add a grid of recs to an existing watch and return the grid passed in |
| watchClose | Close an open watch by id |
| watchOpen | Open a new watch on a grid of records |
| watchPoll | Poll an open watch and return all the records which have changed since the last poll |
| watchRemove | Remove a grid of recs from an existing watch and return grid passed in |
| watchSubOp | |
| weatherForm | Axon function |
| weatherReadLocs | Search for matching weather stations given a city name |
| weatherSunriseTime | Get sunrise for date and location |
| weatherSunsetTime | Get sunset for date and location |
| weatherSyncHis | Import the latest historical data from the weather web service to the local history database |
| weekOfYear | Given a DateTime or Date, return the week number of the year |
| weekday | Get weekday as integer from 0 to 6 of Date or DateTime |
| wrappedDiffRemove | Axon function |
| wrappedIoReadJson | Axon function |
| wrappedIoReadStr | Axon function |
| writeFinFile | |
| writeLocalBindAddressStackConfig | |
| writeLocalDnetNumberStackConfig | |
| writePhyiscalDnetStackConfig | |
| xetoReload | Reload all the Xeto libraries |
| xmlAttr | Get an attribute from an element by its non-qualified local name |
| xmlAttrs | Get list of all an elements attributes |
| xmlElem | Find an element by its non-qualified local name |
| xmlElems | Get the children elements |
| xmlName | Get the unqualified local name of an element or attribute |
| xmlNs | Get the namespace URI of an element or attribute |
| xmlPrefix | Get the namespace prefix of an element or attribute |
| xmlQname | Get the qualified local name of an element or attribute which includes both its prefix and unqualified name |
| xmlRead | Parse an XML document from an I/O handle and return root element |
| xmlVal | If node is an attribute, then return its value string |
| xq | Construct new XQuery instance |
| xqDefine | Define a variable available to subsequent Axon expressions |
| xqEval | Evaluate an Axon expr in each project - see XQuery.eval |
| xqExecute | Execute the XQuery and return results |
| xqFindAll | Filter the previous step using an Axon expr - see XQuery.findAll |
| xqFlatMap | Map the previous step to zero or more Dicts using an Axon expr - see XQuery.flatMap |
| xqHisRead | Read point history data - see XQuery.hisRead |
| xqHisRollup | Rollup history data - see XQuery.hisRollup |
| xqHisRollupAuto | Rollup history data - see XQuery.hisRollupAuto |
| xqMap | Map the previous step using an Axon expr - see XQuery.map |
| xqPivot | Transform previous step into pivot table - see XQuery.pivot Note |
| xqProjs | Restrict query to given project name(s) - see XQuery.projs |
| xqReadAll | Read recs by filter - see XQuery.readAll |
| xqReadAllList | Read recs by filter - see XQuery.readAllList |
| xqReadByIds | Read recs by ids - see XQuery.readByIds |
| xqReadByIdsList | Read recs by ids - see XQuery.readByIds |
| xqTimeout | Set timeout for network calls to remote nodes - see XQuery.timeout |
| xqTrace | Execute the XQuery and return debug tracing |
| xqUseReplicas | Route to replicas instead of master - see XQuery.useReplicas |
| xstr | Construct decoded XStr instance |
| year | Get year as integer such as 2010 from date or datetime |
| yesterday | Return yesterday's Date according to context's time zone |
startHere
| setup | Get SkySpark installed and run the demo |
| deployment | Step-by-step guide to deploying SkySpark on a project |
| architecture | Overview of the SkySpark architecture |
online
| docTraining | Training videos |
| docAppNotes | Application notes |
| docSkyDive | SkyDive tech talk videos |
| training | Training resources |
| calendar | Calendar for training, demo, and event dates |
subsystems
| folio | Folio database |
| axon | Axon scripting language |
| fresco | Fresco browser user interface |
| arcbeam | Arcbeam clustering technology |
All libs listed alphabetically
| alarm | Alarm Extension |
| alarmConfig | |
| amcharts | The amcharts v3 charting library |
| arc | Arc compound document extension |
| arcKit | Standard document workflows |
| arcbeam | Arcbeam connector extension |
| axon | Axon core library |
| bacnet | BACnet Extension |
| bacnetServer | BACnet Server Extension |
| certAuth | TLS Client Certificate Authentication Module |
| chartbuilder | Chart builder application |
| clone | Cloning rec based replication extension |
| cluster | Arcbeam cluster management |
| clusterAuth | Cluster Authentication System Module |
| conn | Connector framework |
| control | Control Engine Extension |
| docker | Docker management |
| ecobee | Ecobee connector |
| Outbound email via SMTP | |
| energy | Energy analytics |
| energyStar | EnergyStar Portfolio Manager connector |
| event | Event database engine |
| fin5Core | FIN |
| finAlarms | FIN Alarms Web Components |
| finAmChartsReactExt | |
| finBlockProgramming | FIN Block Programming |
| finBuilder | FIN |
| finDashboard | FIN Dashboard Editor Extension |
| finDbBuilderFormsExt | |
| finDocGen | Pod to generate documentation for J2 pods |
| finGraphicResources | Functions and assets required for various FIN Builder items |
| finHtmlReporting | Html Reporting Extension |
| finMail | FIN Email Client Extension |
| finNHaystackExt | FIN NHaystack |
| finNetwork | FIN Network Extension |
| finServerExt | FIN |
| finStackCore | FIN host services |
| finStackHubTools | FIN StackHub App |
| finStackMobile | The FIN |
| finSvgGaugesReactExt | |
| finTools | FIN tools |
| finWatcher | FIN Watcher Extension |
| finWebUI | Collection of UI elements/components that can be used with ractive instance |
| finWindowsDevice | FIN |
| finstack | FINStack Services |
| geo | Geolocation function library |
| ghg | Greenhouse Gas Emission Extension |
| greenButton | Green Button function library |
| haystack | Haystack HTTP API connector |
| his | Historian core functionality |
| hisKit | Historian analytics function library |
| html2pdf | Axon extension library to convert webpages to pdf |
| http | HTTP service handling library |
| hvac | HVAC utility and rule functions |
| hx | Haxall framework definitions |
| io | I/O function library |
| job | Job management (deprecated) |
| knx | KNX Connector Extension |
| ldap | LDAP authentication system module |
| log | Logging engine |
| map | Map extension |
| math | Math function library |
| ml | Machine learning (ML) function library |
| modbus | Modbus connector |
| mqtt | MQTT connector |
| mustache | Mustache Extension |
| nav | Support for UI navigation |
| nest | Google Nest connector |
| notification | Notification Extension |
| notify | Notification Extension |
| obix | oBIX connector |
| obs | Observable data stream framework |
| opc | OPC-UA connector |
| ph | Project Haystack core definitions |
| phIct | Project Haystack definitions for Information and Communications Technology |
| phIoT | Project Haystack definitions for Internet of Things |
| phScience | Project Haystack scientific definitions |
| point | Point historization and writable support |
| proj | Project management module |
| prov | Provisioning management |
| purge | Purge Extension for automated clean-up of alarms, history, etc |
| py | Python inter-process communication |
| repl | Support for replication |
| rule | Rule engine to compute sparks, KPIs, and curVals |
| samlSso | SAML SSO Authentication System Module |
| schedule | Scheduling and calendars |
| scheduler | Scheduler application |
| sedona | Sedona Sox connector |
| siemens2dResources | Siemens Components [siemens2D] styles |
| skyarc | Skyarc library module |
| snmp | SNMP connector |
| sql | SQL connector |
| tariff | Utility tariff engine |
| task | Async task engine |
| templateWizardExt | |
| trend | Trend Connector |
| ui | Support for Fresco UI |
| user | User management module |
| weather | Weather service and functions |
| xeto | Xeto spec and data function library |
| xml | XML function library |
| xquery | XQuery support module |