外观
附录索引（appendix）（第 3 部分）
原文: https://finproducts.atlassian.net/wiki/spaces/JIDD3/pages/34793619478/FIN+5.3.1+appendix+part+3 中文整理基于 FIN 5.3.1
导读： 本页为附录索引 / 参考列表（函数、标签等）。
以下为 API 参考，保留英文以便对照源码；目录已列出（英文标题便于检索）；概述已尽量中译。
目录（导读）
- （本页无二级以上标题）
API 正文（英文）
| tariffRanges | The fee ranges for a usage-based charge | | list | Ordered list of zero or more values | | 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 | | attachments | List of attachments as URIs in the virtual file tree | | children | List of prototypes contained by this entity | | childrenFlatten | List of aspects to flatten into children prototypes | | depends | List of this library's dependencies | | fileAccess | List of directory Uris that a non-su user has read-write access to | | fileAccessReadOnly | List of directory Uris that a non-su user has read-only access to | | linter | Fantom qname of Linter class | | meterPoints | This point, configured on the uiMeta record, defines the meter points that will be available in the energy app | | mlInputVarRefs | List of independent variables, also known as model inputs or features, associated with a machine learning model | | notifications | The set of notifications a user is subscribed to | | obsScheduleTimes | Schedule events for given times of the day | | prefUnit | Defines a preferred unit to be used with a quantity | | spanModes | Restrict Span input modes | | tariffChargeRefs | The charges that a percentage charge applies to | | userAllow | List of function names to allow on this user | | weatherSyncIds | Applied to a weatherStation to indicate which weather points to sync for that station | | scalar | Scalar is an atomic value kind | | bool | Boolean value true or false | | mqttCleanSession | Whether to set the clean session flag on the connect request to the broker | | mqttRetain | Set the retention flag on a published message | | coord | Geographic coordinate in latitude/longitude in decimal degrees | | geoCoord | Geographic coordinate as C(latitude,longitude) | | curVal | Current value of a point | | date | ISO 8601 date as year, month, day | | dueDate | Date expected for completion of the workflow task | | expires | Expiration date | | dateTime | ISO 8601 timestamp followed by timezone identifier | | acked | Time that the alarm was acknowledged | | cloneMod | Modified timestamp of the clone's progenitor | | created | The timestamp when entity was created | | finMailSentDate | The email Sent date | | hisEnd | Timestamp of newest item in history | | hisStart | Timestamp of oldest item in history | | mod | Last modified time of record - see docSkySpark | | nextTime | Next time stamp when the schedule transition | | occurred | Date/Time that the alarm actually occurred | | statsResetTs | Set the start time used to calculate the statistics | | ts | Timestamp | | na | Not available used to indicate invalid or missing data | | nextVal | Next value the schedule will transition to | | number | Integer or floating point numbers annotated with an optional unit | | area | Area of a shape or floor space | | bacnetAlarmPid | It specifies the connector will only handle alarms associated with that process identifier | | bacnetCovResubscribeTimeout | Applied to ConnTuning specifies when the COV re-subscribe should be performed for points that failed to be subscribed | | bacnetCovTimeout | Applied to ConnTuning to specify the lifetime for a COV subscription sent to the device | | bacnetInstance | Applied to bacnetDevice it specifies what device instance number is used when the connector is in COV mode, the default instance number randomly picked between 50000 and 200000 | | bacnetServerCovIncrement | Numeric tag that sets the delta threshold for when a COV notification should be send | | bacnetServerInstance | Applied to a bacnetDevice to export it as an BACnet device | | bacnetServerMacAddress | Applied to a bacnetServerDevice assigns an unique mac address to this device | | bacnetServerNetwork | Applied to a bacnetServer ext record assigns an unique BACnet network number to the current project the extension is enabled in | | bacnetServerRefreshInterval | Numeric tag that says how often the BACnet server will rescan equipments on the current project | | bacnetWriteLevel | Number between 1 and 17 used with bacnetWriteLevel to determine which priority level of the remote system is written to | | chartHeight | Fixes the height of a chart plot | | chartMax | Define explicit max value for series axis | | chartMin | Define explicit min value for series axis | | coolingCapacity | Measurement of a chiller ability to remove heat measured | | curCalibration | Calibration value to apply to adjust the value read from the connector before updating curVal | | duration | Number with a unit of time | | actorTimeout | Timeout for messages send to the connector's actor thread | | arcbeamMinEventTime | Applied to arcbeamConn to tune how fast the server should send current value updates | | bacnetInitInterval | Applied to ConnTuning to tune the duration between driver re-initialization | | bacnetScheduleReadFreq | This tag denotes the frequency duration at which schedule read sync will occur | | connLinger | Linger timeout used to keep a connector open | | connOpenRetryFreq | Duration used for connector open retries | | connPingFreq | Duration used to configure the auto-ping feature on a given connector | | dur | Total duration of the spark periods measured in hours | | haystackPollFreq | Applied to haystackConn to tune the duration between watch polls | | hisAppendNA | Specifies the amount of time after a history point's hisEnd that the hisRead() function should append an NA | | hisCollectCovRateLimit | Rate limits the frequency for hisCollectCov | | hisCollectInterval | Enables interval history collection of the curVal | | hisCollectWriteFreq | This tag configures how long to buffer collected history items in memory before flushing them to the historian | | hisInterval | The interval at which sampled or consumption data is collected | | hisRollupAutoMinInterval | Forces hisRollupAuto() to do a rollup using this interval when none is specified and the range of the source history grid is less than 2 days | | hisRollupInterval | Indicates the roll-up interval in his grid column meta-data | | hisTsPrecision | Controls the precision used to store timetamps in the historian | | modbusReadTimeout | How long to wait before timing out on a modbus read | | modbusWriteTimeout | How long to wait before timing out on a modbus write | | mqttRetryInterval | How long to wait between retries for messages that require acknowlegment | | obixPollFreq | Duration between obixConn watch polls | | obsScheduleFreq | Schedule events with given frequency | | pollTime | Frequency between polls of curVal | | ruleFreq | Execution frequency of a curRule | | staleTime | Time before a point's curStatus marked from "ok" to "stale" See Connector Tuning | | steadyState | The delay before transitioning to the steady state | | timeout | Maximum elapsed time to allow an operation to continue | | writeMaxTime | Maximum time between writes used to send periodic writes | | writeMinTime | Minimum time between writes used to throttle the speed of writes | | finBoolStatsFreq | Tune how often the FinWatcher computes boolean runStarts and runTime | | finMailMaxMsgCount | Set the maximum numbers of email records this connector can store | | finMailNewMessages | Shows the number of unread email | | finMailPollFreq | Applied to finMailConn to tune the duration between email checks | | finMailTotalMessages | Shows the number of email on the inbox folder | | finWatcherFreq | Tune how often the FinWatcher looks for changes | | geoElevation | Elevation above sea-level of the location | | hisCollectCov | Enables COV history collection of the curVal | | hisTotalizedRollover | Defines the rollover value for a totalized history - see totalized | | int | Unitless integer number | | arcbeamWriteLevel | Number between 1 and 16 used with arcbeamWrite to determine which priority level of the remote system is written to | | floorNum | Unitless integer indicating the floor's distance from ground level | | haystackWriteLevel | Number between 1 and 16 used with haystackWrite to determine which priority level of the remote system is written to | | hisSize | Approximate number of timestamp/value pairs stored in history | | modbusBlockGap | Applied to modbusConn to allow for gaps in block reads | | modbusBlockMax | Applied to modbusConn to limit the maximum number of registers to read in a block read | | modbusSlave | Applied to modbusConn to identify the slave address on this modbus network | | mqttMaxRetry | How many times to retry sending messages that require acknowlegment | | obixWritable | Server export of a writable point as an obix:Writable:Point | | obixWriteLevel | Number between 1 and 16 used with obixWrite to determine which priority level of the remote system is written to | | schedulable | Binds a schedule to a writable point | | stage | Stage number of staged equipment operation such as coil or pump | | writeLevel | Current priority level for writeVal as number between 1 and 17 | | yearBuilt | Original year of construction as four digit year such as 1980 | | knxWatchdogFreq | KNX watchdog polling interval | | maxVal | Inclusive maximum for a numeric value | | minVal | Inclusive minimum for a numeric value | | mqttQos | MQTT Quality of Service (QoS) - 0 - At most once (fire-and-forget) - 1 - At least once - 2 - Exactly once | | opacity | Alpha transparency for colors as number between 0.0 (transparent) to 1.0 (completely opaque) | | order | Used to order definitions | | percentage | A percentage specified as as <percent> * 100 | | strokeWidth | Stroke width for rendering lines | | tariffContractMin | The minimum contractual demand necessary for this charge to apply | | tariffFee | A fixed numeric fee for the charge | | tariffRatchetPercentage | The peak demand identified during the ratchet period will be multiplied by this percentage to obtain the minimum peak demand | | userFailedLogins | How many failed login attempts the user has made since last successful login | | ref | Reference to an entity | | airRef | Air flows from the referent to this entity | | arcOn | Subject of the document | | arcbeamConnRef | Used on a proxy point to reference its parent arcbeamConn | | assignedTo | Person who is currently responsible for the workflow task | | bacnetConnRef | Used on a proxy object to reference its parent bacnetConn | | bacnetDeviceRef | Applied to a bacnetConn or ext to reference a BACnet device object | | bacnetServerDeviceRef | Applied to an equip to bind the equip to a bacnetServerDevice | | blowdownWaterRef | Blowdown water flows from the referent to this entity | | by | Author of a document or part | | calendarRef | Used to chain a calendar to a schedule or another calendar | | chilledWaterRef | Chilled water flows from the referent to this entity | | cloneSetRef | Clone set which manages the clone | | condensateRef | Condensate flows from the referent to this entity | | condenserWaterRef | Condenser water flows from the referent to this entity | | connTuningRef | Reference to a tuning configuration defined by a connTuning rec | | deviceRef | Device which controls a monitors this entity | | domesticWaterRef | Domestic water flows from the referent to this entity | | ecobeeConnRef | Used on a proxy point to reference its parent ecobeeConn | | elecRef | Electricity flows from the referent to this entity | | energyStarConnRef | Used on a proxy object to reference its parent energyStarConn | | equipRef | Reference to equip which contains this entity | | finMailConnRef | Used on a proxy object to reference its parent finMailConn | | finPreviewImageRef | This is a ref to an image that will be previewed for what this is | | finWatcherChangedRef | Reference to the record that is detected as changed | | finpFileRef | This tag is a ref to the finp file | | floorRef | A legacy deprecated floor reference | | fuelOilRef | Fuel oil flows from the referent to this entity | | gasolineRef | Gasoline flows from the referent to this entity | | ghgEmissionSourceRef | Ref to the emission source where this emission factor will apply | | ghgFactorHisRef | References a ghgFactorHis point record that the Greenhouse Gas Emission Engine uses to calculate emissions | | ghgSourceRef | Ref to the emission source used to calculate Greenhouse Gas Emissions | | haystackConnRef | Used on a proxy point to reference its parent haystackConn | | hotWaterRef | Hot water flows from the referent to this entity | | id | Defines the unique identifier of an entity in system using a ref value type | | knxConnRef | Assocation with knxConn | | knxProjFileRef | A reference to the *knxproj file attached to a given KnxConn | | makeupWaterRef | Makeup water flows from the referent to this entity | | mlOutputVarRef | Dependent variable, also known as the model output or target, associated, with a machine learning model | | mlVarPoint | Reference to a point associated with a machine learning variable, known as a machine learning variable point | | mlVarRef | Reference to a machine learning variable | | modbusConnRef | Used on a proxy point to reference its parent modbusConn | | mqttConnRef | Used on a proxy point to reference its parent mqttConn | | naturalGasRef | Natural gas flows from the referent to this entity | | nestConnRef | Used on a proxy point to reference its parent nestConn | | networkRef | Associates a device which communicates on specific a network | | nodeRef | Reference to a node in the cluster database | | obixConnRef | Used on a proxy point to reference its parent obixConn | | obsMqttConnRef | Subscribe to the topic on this MQTT connector | | opcConnRef | Used on a proxy object to reference its parent opcConn | | pointRef | See Synthetics chapter | | programRef | Reference to associated program rec | | refrigRef | Refrigerant flows from the referent to this entity | | ruleRef | Reference to rule which contains this entity | | ruleTuningTargetRef | Reference to a specific rule target or target parent | | scheduleRef | Associates a schedulable with its schedule | | sedonaConnRef | Used on a proxy point to reference its parent sedonaConn | | siteRef | Reference to site which contains the entity | | snmpConnRef | Used on a proxy object to reference its parent snmpConn | | sourceRef | Reference to the source of the alarm | | spaceRef | Reference to space which contains this entity | | sqlConnRef | Used on a proxy point to reference its parent sqlConn | | steamRef | Steam flows from the referent to this entity | | submeterOf | Reference to parent meter which is immediately upstream of this meter | | syntheticModelRef | See Synthetics chapter | | systemRef | Reference to system | | targetRef | Reference to the target record of a rule result or associated record | | tariffChargeRef | Reference to an entity | | tariffFeeHisRef | The ref to the history point that contains the historical fee data | | tariffHisRef | If multiple meters share the same tariff history, then you can use this tag to reference the "master" point containing the tariff history | | tariffRef | The tariff a charge belongs to | | tplTrendConnRef | Used on a proxy point to reference its parent tplTrendConn | | userProtoRef | User prototype to apply to a user | | userRef | Reference to user entity | | weatherStationRef | Reference to weather station for to use this entity | | remove | Singleton for remove operation | | str | Unicode string of characters | | ackErr | This tag is set when there is an error acknowledging alarm and contains the reason for the error | | ackMessage | Message or reason for acknowledgement | | ackedBy | Who acknowledged the alarm | | addTags | A comma separated list of tags and their values to apply to records | | alarmAckAccessFilter | String filter applied to a user record which defines which alarms a user may acknowldege | | alarmRoute | Alarm route | | alarmRule | Alarm rule | | allowFilter | A string that can be parsed into a filter that determines what records the tag bunlde can be applied to | | alsoSee | Legacy tag definitions | | appAccess | Restricts the set of accessible apps | | appFormOn | Application Form Selector Tag | | appName | View containing app name | | arcPriority | Priority level of the document | | arcState | Defines work flow state of an arc document | | ticketState | Workflow state for a ticket | | workorderState | Workflow state for a workorder | | arcWriteAccess | Defines write permissions for arc documents | | arcbeamCur | Used on a arcbeam proxy point to store the id of the entity in the remote system used to read and watch curVal | | arcbeamHis | Used on a arcbeam proxy point object to store the id of the historized point in the remote system used to sync history data | | arcbeamWrite | Used on a arcbeam proxy point to store the id of the entity in the remote system used to write writeVal | | bacnetCur | Used on a BACnet proxy point to subscribe for current value | | bacnetDeviceName | Tag for current device name | | bacnetHis | Used on a BACnet proxy point to store BACnet trend log id | | bacnetRoute | bacnetRoute string tag if connecting through VPN and if network number is 0 | | bacnetScheduleRead | bacnetScheduleRead tag enables the reading of BACnet schedule properties, required for schedule read sync | | bacnetScheduleWrite | bacnetScheduleWrite tag enables the writing of BACnet schedule properties | | bacnetServerDis | Apply the bacnetServerDis tag of String type to any point or equip to set custom description for the BACnet server | | bacnetServerLocalAddress | Applied to a bacnetServer ext record configures the interface the server listens to request | | bacnetVersion | Tag for current connection protocol version | | bacnetWrite | Reference for BACnet object id to be written | | bindStatus | Current status of a component cell binding | | builderSettings | Function returns settings for builder | | certificatePem | PEM encoding of the User Certificate | | chartAreaMode | Enumeration for how to renders an area fill for a line plot series Note | | chartGroup | Group name used to explicitly group series into one chart | | chartLegend | Provides option to control legend on charts | | chartOn | Chart Record Selector Tag | | chartType | Enumerated chart type such as "line" or "bar" | | cloneProj | Project name for clone set data | | cloneSetStatus | Current status of a cloneSet | | color | Color encoded as #RRGGBB, #RGB, or a CSS color keyword | | connErr | Error message associated when connStatus indicates an error condition | | connState | Current connection state of a connector as one of the predefined strings | | connStatus | Current status of a connector as one of the predefined strings See Connectors | | construct | Defines a constructor for the function | | curErr | Error description when curStatus indicates error condition | | curStatus | Status of point's current value reading | | dbToolCategory | Used to group forms together without affecting their folder path | | defName | Specifies definition symbol name to use | | defView | The name of the view that should be the default for a user or project | | dis | Display name for an entity | | disKey | Localized string key formatted as pod::key | | disMacro | Display name using macro syntax | | doc | Documentation in simplified flavor of markdown | | dockerState | Current status of a Docker container | | dockerStatus | Additional human-readable status of the container | | ecobeeCur | Ecobee address to use to get the current value | | ecobeeHis | Ecobee address to use to sync point history | | ecobeeWrite | Ecobee address to use to write a point value | | elecLine | Single-phase line measurement of an electric quantity in a multi-phase AC electric power system | | lineCurrent | Single-phase line current measured in an AC electric power system | | phaseEnergy | Single-phase energy measured line-to-neutral in an AC electric power system | | phasePf | Single-phase power factor measured line-to-neutral in an AC electric power system | | phasePower | Single-phase power measured line-to-neutral in an AC electric power system | | elecLineToLine | Single-phase electric quantity measured line-to-line in a multi-phase AC electric power system | | lineEnergy | Single-phase energy measured line-to-line in an AC electric power system | | linePf | Single-phase power factor measured line-to-line in an AC electric power system | | linePower | Single-phase power measured line-to-line in an AC electric power system | | lineVolt | Single-phase voltage measured line-to-line in an AC electric power system | | phaseCurrent | Single-phase current measured line-to-line in an AC electric power system | | elecLineToNeutral | Single-phase electric quantity measured line-to-neutral in a multi-phase AC electric power system | | phaseVolt | Single-phase voltage measured line-to-neutral in an AC electric power system | | email | An email address | | energyStarCustomerIds | Comma separated list of customer account ids used for the connection | | energyStarMeter | Tag applied to a point record which marks the point as mapped to a meter in Portfolio Manager | | energyStarMeterType | String enum for EnergyStar meter type applied to energyStarMeter points | | energyStarSite | Tag applied to a site record which marks a site as mapped into Portfolio Manager | | enumExpr | Axon expression to dynamically compute an enum | | errTrace | Exception stack trace | | evseCableType | Physical type of evse-cable | | evseStatus | Status of one or more evse-port reported by an EVSE | | example | Defines an example for the function | | excludes | | | expr | Axon expression string | | taskExpr | Task messaging handling Axon expression | | fileExt | Filename extension such as "csv" | | filterStr | Haystack filter string | | arcAccessFilter | Restricts access to arc document records | | cloneFilter | Filter string for clone set data | | ghgConsumptionOn | An axon filter used by the Greenhouse Gas Emission Engine to identify the usage data to calculate emissions | | mlVarFilter | Filter used for querying points by tags, providing more flexibility than mlVarPoint, although it is not mandatory | | navAuxFilter | Apply extra filter string to a navigation tree | | obsFilter | Filter string to define the record data set observed | | obsRuleFilter | Filter string for rule records to observe | | obsTargetFilter | Filter string for target records to observe | | projAccessFilter | Applied to users to defines access to projects | | projIncludeFilter | Selects other projects to include in UI navigation | | ruleOn | Target filter for a rule or rule ready func | | ruleTuningTargetFilter | Filter string to match rule target records | | siteAccessFilter | Restricts access to sites | | tariffUsageOn | An axon filter used by the tariff engine to identify the charge's historical usage data | | userAccessFilter | Restricts which users are visible | | finMailContent | The first 1024 characters of the email content (body) | | finMailFrom | Comma separated list of From addresses | | finMailReplyTo | Comma separated list of Reply To addresses | | finMailSubject | The email Subject | | finMailTo | Comma separated list of To addresses | | finWatcherCallbackOn | Axon expression tag placed on a finWatcherCallback callback | | finWatcherChanges | A serialized Zinc grid that encodes which tags where added/changed/removed on a finWatcherChangedRef record | | flags | Flags string | | foldOn | Registers a function as folding a given value type | | fontWeight | Font weight setting | | formOn | Form Record Selector Tag | | format | Pattern used to format a value via format() | | fromState | State of the entity prior to alarm transition | | funcName | Name of function associated with route | | geoAddr | Free form street address | | geoCity | Geographic city or locality name | | geoCountry | Geographic country as ISO 3166-1 two letter code | | geoCounty | Geographic subdivision of US state | | geoPostalCode | Geographic postal code | | geoState | State or province name | | geoStreet | Geographic street address and name | | ghgHeatContentDis | Describes source of location specific heat content values | | ghgHeatContentSyncId | Used internally for syncing location specific heat content values | | ghgSourceSyncId | Identifies the emission source used for automatically creating emission factors | | ghgSyncId | Identifies the individual Greenhouse Gas Emission to sync | | halign | Horizontal layout alignment | | haystackCur | Used on a haystack proxy point to store the id of the entity in the remote system used to read and watch curVal | | haystackHis | Used on a haystack proxy point object to store the id of the historized point in the remote system used to sync history data | | haystackWrite | Used on a haystack proxy point to store the id of the entity in the remote system used to write writeVal | | help | End user documentation | | helpDoc | Path to help documentation | | hisErr | Error description when hisStatus indicates error condition | | hisFunc | Axon expression used to create a computed history | | hisInterpolateMode | Explicitly configures the interpolation mode to use for this point | | hisMode | Indicates the way that history data is collected for a point | | hisOnWrite | Axon expression to trap and map history data before writing to the historian database | | hisRollupFunc | Function name to use for hisRollupAuto() | | hisStatus | Status of point's history collection or synchronization | | hotKey | One or more key combinations separated by a comma | | icon | Icon logical name - see Icons | | imageSize | Image size in pixels | | jobExpr | Axon expression to execute for job | | jobSchedule | Specifies when a job is scheduled using a string format | | jobStatus | Current status of a job | | kind | Kind name used to identity a value data type | | knxAddr | The KNX Group Address used on a particular KnxConn | | knxIndividualAddr | The KNX individual address of a physical device record (e.g | | ldapUserProtoAttrVal | The value of this tag is used to help the LDAP mod determine which user prototypes an LDAP user maps to | | libStatus | Current status of an extension or sys module library | | licStatus | License status | | logLevel | Severity level | | message | Message describing the alarm or reason for the alarm | | mime | Mime type formatted as type/subtype | | modbusCur | Modbus address to use for current value subscriptions | | modbusWrite | Used on a modbus proxy point to store the id of the entity in the remote system used to write writeVal | | mqttCertAlias | Used on an mqttConn to indicate which certificate and key pair to use for client authentication to the broker | | mqttClientId | The client identifier to use when connecting to the broker | | mqttVersion | MQTT protocol version | | name | Name key | | navName | Navigation name commonly used with disMacro to create computed display strings | | navTarget | Apply to a def to specify a default navigation target | | navTree | Navigation tree name to use for ref tag | | nestCur | Nest address to use to get the current value | | nestProjectId | The project identifier from your Google Device Access project | | nestWrite | Nest address to use to write a point value | | noData | Message string when no data available | | nodeId | Node id as string without the n: prefix | | nodeStatus | Current status of a cluster node | | nodeType | Is node haxall or skyspark | | notifyTopicProj | The value is a project name | | obsMqttTopic | Receive published messages that match this filter | | obsScheduleDaysOfMonth | Schedule events for given days of the month | | obsScheduleDaysOfWeek | Schedule events for given days of the week | | opcCertAlias | Used on an opcConn to indicate which certificate and key pair to use for asymmetric message security | | opcCur | OPC UA encoded address to use for current value subscriptions | | opcHis | OPC UA encoded address to use for a historized proxy point | | opcSecurity | Defines a security policy and security mode pair to use for OPC UA messages | | opcType | The NodeId of the point's OPC type | | opcUserAuthMode | How the client should authenticate with the OPC-UA server | | opcWrite | OPC UA encoded address to use for writing a point | | optsTemplate | TODO | | pageSize | Printed page size formatted as "width,height" with an explicit unit of "pt", "in", "mm", or "cm" | | password | Manages password which is hashed/stored to the password store | | ecobeeClientId | Your Ecobee API Key | | ecobeeRefreshToken | The refresh token you obtained for your API key | | nestClientId | The OAuth client_id for your application | | nestClientSecret | The OAuth client_secret for your application | | nestRefreshToken | The OAuth refresh_token for your application | | periods | Timeline of on/off periods encoded as Base64 via discretePeriods() | | phase | Phase measurement in a three-phase electrical system | | placeholder | Hint displayed in a text field input | | podName | Fantom pod name | | pointConvert | Point value conversion used to normalize data to/from a remote system | | curConvert | Conversion to apply when reading curVal from connector | | hisConvert | Conversion to apply when reading history data from connector | | writeConvert | Conversion to apply when writing writeVal to the connector | | pointOverrideAccess | Defines levels which may be overridden by the user for writable points | | primaryFunction | Primary function of building as US Energy Star key | | program | Identifies and defines a control program | | programOn | String filter which defines the targets for a control program | | programVars | Zinc encoded table of variable definitions | | pubKey | Public key as encoded string | | queryString | | | reader | Fantom type qname for reader class | | routeOn | Filter that will select alarms to route | | routeStatus | Project cluster route status | | readRouteStatus | Project cluster route status for reads | | ruleCost | Specifies formula used to apply a cost tag to sparks | | ruleFunc | Specifies the function to run for a rule | | ruleStatus | Current status of a rule | | samlSsoUserProtoAttrVal | The value of this tag is used to help the SAML SSO auth mod determine which user prototypes a SAML SSO user matches | | scheduleVal | The string name/encoding of a schedule value | | sedonaCur | Sedona address to use for current value subscritions | | sedonaWrite | Sedona address to use for writing | | snmpAuthProtocol | If the snmpSecurityLevel indicates that authentication is required, then this is the digest algorithm to use | | snmpCommunity | If the snmpVersion is 2c, then this is the name of the SNMP community to use when messaging with the remote agent | | snmpCur | SNMP address to use for current-value subscription | | snmpDesc | For learned points, this is the description of the point as found in its MIB OBJECT-TYPE definition | | snmpMibType | For learned points, this is the human-readable qualified name (qname) of the point | | snmpPrivProtocol | If the snmpSecurityLevel indicates that message privacy is required, then this is the encryption algorithm to use | | snmpProtocol | Applied to snmpConn to indicate the network protocol to use for communicating with a remote agent | | snmpSecurityLevel | If the snmpVersion is 3, then this is the security level to use for messaging with the remote agent | | snmpVersion | Applied to snmpConn to indicate the SNMP protocol version to use for messaging with the remote agent | | snmpWrite | SNMP address to use for writing a point | | sqlHis | Arbitrary key used by the SQL connector to synchronized history data | | sqlSyncHisExpr | This is a tag which must be configured on each sqlConn record used by the connSyncHis() function | | src | Source code | | state | State of the alarm | | strokeDasharray | Comma separated lengths of dashs and gaps for rendering lines such as "6,4" | | subtitle | Defines subtitle string for visualizations | | targetFilter | Filter which matches points to be commanded by this route | | tariffChargeFunc | The name of the function that tariff engine should call to compute the cost | | tariffFeeFreq | The frequency that the charge applies per bill period | | tariffRangeStrategy | When a charge has multiple ranges this tag indicates to the tariff engine how to interpret and calculate costs based on those ranges | | tariffRatchetPeriod | A value representing how far back to go when calculating the minimum peak demand for a billing period | | taskStatus | Current status of a task | | templateName | Template by name - legacy support | | title | Defines title string for visualizations | | toState | State of the entity when going into alarm | | topicsEmailDigest | Classic legacy support | | topicsEmailImmediate | Classic legacy support | | tplTrendCur | TplTrend address to use for reading the current value | | tplTrendHis | TplTrend address to use for reading historical data | | typeName | Fantom type qname | | uiInput | Fantom type qname for Input to use for a definition | | tz | Timezone identifier from standard timezone database | | uiFormOn | uiForm Record Selector Tag | | unit | Unit identifier from standard unit database | | currency | The currency unit related to the entity | | usedWith | Legacy tag definitions | | userProtoName | User prototype name | | userRole | Indicates what permissions and access rights the user has | | username | Username for an authentication account | | validate | Axon expression to validate def | | version | Version string formatted as decimal integers separated by a dot | | viewerSettings | Function returns settings for viewer | | writeErr | Error description when writeStatus indicates error condition | | writeStatus | Current status of a writable point output | | writer | Fantom type qname for writer class | | symbol | Symbol to a def | | def | Create a new definition bound to the given symbol | | defx | Extends the given definition with additional meta tags | | of | Expected value type of a collection, reference, or choice | | reciprocalOf | Specifies the inverse of an association or relationships | | relationship | Ref tags used to model entity-to-entity relationships | | containedBy | The entity is logically contained by the referent | | contains | Entities logically contained by this entity | | inputs | The entity inputs a substance from the referent | | outputs | The entity outputs a substance to the referent | | time | ISO 8601 time as hour, minute, seconds | | uri | Universal resource identifier | | baseUri | Base URI for normalizing relative URIs | | defUri | Host relative URI to redirect the user upon login | | knxCur | Uri to use for current value subscriptions | | knxWrite | Stores the Uri to be used when writing to the datapoint | | modbusRegMapUri | Applied to modbusConn to define the register map CSV file | | obixCur | Used on a oBIX proxy point to store the URI of the entity in the remote system used to read and watch curVal | | obixHis | URI of the obix:History to synchronized history data | | obixLobby | The lobby URI is used to address an obixConn API endpoint | | obixWrite | URI of the obix:WritablePoint to write writeVal | | snmpMibsUri | Applied to snmpConn to define the collection of MIB files to load | | wikipedia | Hyperlink to the subject's page on Wikipedia | | value | Value to write to the selected points | | writeVal | Current desired value to write to output | | xstr | Extended string - type name and string value encoding | | finMailBody | Present if the email body is bigger than 1024 chars, it stores to body as Bin | | span | Time span as modeled encoded as XStr | | mlIdentificationPeriod | Training period description, known as the identification period or baseline, utilized during the model training process | | obsScheduleSpan | Schedule events only during the configured span of time |
All views listed alphabetically
| alerts | Display system alerts such as licensing errors |
| apiSettings | Settings for the API system module |
| apps | App builder used to edit application view groupings |
| arcDoc | Read and edit a single arc document |
| arcSettings | Settings for the arc extension |
| arcSummary | Browse and filter arc documents across the cluster |
| arcTypes | View documentation for the installed arc types |
| arcbeamNodes | Project database of arcbeam connector nodes |
| backups | Execute and manage project database backups |
| blank | Placeholder with no content |
| card | Display each row of a grid as a formatted card |
| certAuthConfig | Upload user certificates to configure certificate authentication |
| certAuthSettings | Settings for the Client Certificate Authentication module |
| chart | Display grid data as a chart |
| cloneDebugClient | Debug client side cloning |
| cloneDebugServer | Debug server side cloning |
| cloneOrphans | View and delete cloning orphans |
| cloneSets | Manage clone sets |
| cloneSettings | Settings for the clone extension |
| clusterAuthSettings | Settings for the cluster authentication system module |
| clusterNodes | Manage the local database of cluster nodes |
| clusterSettings | Settings for the cluster system module |
| codeEditor | Editor for Axon functions |
| connTrace | View debug connector tracing |
| connTuning | Manage connector tuning records in the local project database |
| conns | Manage connectors in the local project database |
| crypto | Manage cryto trust store |
| debugCluster | Debug cluster Arcbeam protocol |
| debugExts | Debug the installed extensions |
| debugFolio | Debug the Folio database and the JIT indexing |
| debugHost | Debug of host level system modules |
| debugProj | Debug the project actor pools |
| debugSupport | Gather support diagnostics |
| diag | Diagnostics dashboard with real-time graphs |
| doc | Documentation viewer |
| dockerContainers | Manage Docker containers |
| dockerImages | Mange Docker images |
| dockerSettings | Settings for the Docker extension |
| emailSettings | Settings for the email system module |
| energyOperation | Analyze energy usage at the site level against equipment runtime |
| energyProfile | Analyze energy usage profiles at the site level |
| energyStarMeters | Manage Energy Star meters |
| energyStarProperties | Manage Energy Star sites |
| energySwivel | Analyze energy usage at the portfolio level using graphical pivot tables |
| energyUsage | Analyze energy usage at the portfolio level across sites |
| extSettings | Enable and disable project extensions |
| fandoc | Display fandoc markup as stylized content |
| favs | Manage saved favorite views |
| files | Browse the virtual file system |
| form | Display a dict for editing using a form layout |
| ghgDirectSources | Manage Direct Greenhouse Gas ghgSource and emission records |
| ghgEmissions | View Greenhouse Gas Emissions for selected sites |
| ghgEquivalentEmissions | View Equivalent Greenhouse Gas Emissions for selected sites |
| ghgIndirectSources | Manage Indirect Greenhouse Gas ghgSource and emission records |
| ghgManageSourceRefs | Manage ghgSourceRefs for Equip Records |
| hisChart | Visualize historical point data as a graphical chart |
| hisCompare | Visualize historical point data from two different spans |
| hisCorrelate | Chart a linear correlation of historical point data |
| hisEquip | Visualize historical point data of a single equipment |
| hisImport | Import point history data into the local project database |
| hisTable | Visualize historical point data as a table |
| hostSettings | Settings for the host system module |
| httpSettings | Settings for the HTTP system module |
| iframe | Display a URI as an embedded HTML iframe |
| jobs | Manage records used to run background jobs |
| kpiChart | Visualize historized KPI analytical results using charts |
| kpiSwivel | Visualize KPI analytical results using graphical pivot tables |
| kpiTable | Visualize KPI analytical results in tabular format |
| ldapSettings | Settings for the LDAP system module |
| lics | Manage software license files |
| lint | View lint errors to validate your database |
| log | System log browser |
| logSettings | Settings for the logging system module |
| map | Display data with a geoCoord on a map |
| mapKpis | View KPIs for each site on the map |
| mapSites | Browse sites on the map |
| modbusRegMap | Manage Modbus register map files |
| monitorEquips | Monitor the current value of points for selected equipment |
| monitorPoints | Monitor the current value of selected points |
| notifyTopics | Fresco UI view |
| page | Display subviews as a linear page-oriented report |
| pageBreak | Use in a page view to force a page break during PDF generation |
| pods | Debug all installed pod modules |
| projAdmin | Admin tools for the current project |
| projSettings | Settings for the project configured on projMeta |
| projs | View and manage the projects visible to the current node |
| prov | Cluster provisioning tool |
| provManifests | Manage provisioning manifests |
| replicas | Fresco UI view |
| ruleCluster | View all rule records configured across the cluster |
| ruleDebug | Debug the rule engine |
| ruleLocal | Manage rules configured in the local project database |
| ruleSettings | Settings for the rule extension |
| ruleTuning | Manage rule tuning records in the local project database |
| samlSsoSettings | Settings for the SAML system module |
| schedule | Fresco UI view |
| sedonaManifests | Manage the local database of Sedona manifest files |
| sessionSettings | Settings for the session system module |
| sessions | Debug user sessions |
| shell | Axon interactive shell to evaluate and visualize expressions |
| sites | Site builder used to edit the site/space/equip/point model |
| sparkEquip | Visualize spark analytical results for a single equipment |
| sparkSwivel | Visualize spark analytical results using graphical pivot tables |
| sparkTable | Visualize spark analytical results in tabular format |
| sysModSettings | Enable and disable system modules |
| table | Display grid data as a two dimensional table |
| tags | Tag builder used to edit project tag definitions |
| tariffBillPeriods | Manage tariff billing periods |
| tariffCost | Analyze tariff costs against energy usage |
| tariffs | Tariff builder used to edit tariff and charge records |
| taskDebug | Task diagnostics and debugging tools |
| taskSettings | Settings for the task extension |
| taskSubscriptions | Debug observable subscriptions |
| tasks | Configure task records |
| text | Display grid data as preformatted plain text |
| threads | Debug thread traces and deadlocks |
| tile | Display subviews using a preconfigured tile layout |
| trash | View and restore records which have been moved to the trash |
| uiSettings | Settings for the user interfactor configured on uiMeta |
| userBackups | Execute and manage backups of the local user database |
| userPrefs | Manage preferences for the current user |
| userProtos | Manage user prototypes in the local user database |
| userSettings | Settings for the user system module |
| users | Manage the local user database |
| usingSettings | Manage Xeto libraries |
| views | View builder used to edit customized views in the local project |
| weatherDegreeDay | Chart degree day calculations for historical weather data |
| weatherForecast | Chart forecasted weather data |
| weatherHistory | Chart historical weather data |
| weatherStations | Managed the configured weather stations in the project database |
| xquerySettings | Settings for the XQuery system module |