lib-finstack 库参考

原文: https://finproducts.atlassian.net/wiki/spaces/JIDD3/pages/34793979980/FIN+5.3.1+lib-finstack 中文整理基于 FIN 5.3.1

导读： 本页为 lib-finstack 的 API / 标签 / 函数参考文档。

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

---

目录（导读）

• lib
• meta
• tags
• funcs
• def
• supertypes
• arcs(src, dates: null)
• createFirstLevelOptional(level)
  • src
• createOptionalLevel(level, position: "")
• finActionsRewrite(filter, oldExprDict, newExprDict)
• finAssetUsedBy(assets)
• finBacnetCurToWrite(recs, from: "bacnetCur", to: "bacnetWrite")
• finBacnetWriteToCur(recs)
• finBeginDiscovery(connectorName, discoveryConfiguration: "")
• finCapsNeeded(capCount, mult: Number.<ctor>(1), params: null)
• finConnExts()
• finCopyBoundPoints(sourceExpr, targetExpr)
• finCreateHaystackDb(conns, startLearn: "sep:/", hisEnable: false, doImport: true, parent: null, rootLearn: "")
• finCreateTemplatePackage(finTemplates, meta)
• finCreateTemplatePackage2(finTemplates, meta)
• finCurrentDayInfo(time: SysLib.now(), tz: TimeZone.cur())
• finDiscoveryAdd(recordIds)
• finDiscoverySessionCleanup(discoveryId)
• finDiscoverySessionEnd(discoveryId, error: null)
• finDiscoveryStatusCheck(discoveryId)
• finElementOn(target, elementTag, queryRelated: false)
• finElementsOn(targets, elementTag, queryRelated: false)
• finEnergyAnnualMonthlyDayRollup(pRef, foldFc: null)
• finEnergyAnnualMonthlyRollup(pRef, foldFc: null)
• finEnergyAnnualWkDayRollup(pRef, foldFc: null)
• finEquipPointTagClone(fromEquipRef, fromPointRefs, tags, toEquipFilter, copy: false)
• finFileAndAssetDelete(projects)
• finFiles()
• finFindRecordByChild(targetFilter, childFilter)
• finFindRecordByChildDeep(targetFilter, childFilter)
• finFixOldBinTags()
• finFoldGrid(grd, foldFc: null, ops: {})
• finFreqFilters()
• finFuncs()
• finGetCaps()
• finGetConnectorTagSpecs(extName)
• finGetCurrentUser()
• finGetDiscoveryConfiguration(connectorName)
• finGetHelp(appNames, targetRefs: null)
• finHaystackDrillDown(conns, startLearn: "sep:/", hisEnable: false, rootLearn: "")
• finHaystackExcludedTags()
• finHaystackLearn(conn, learnPath: null, opts: [:])
• finHttpProxy(url, method: "GET", headers: null, params: null)
• finNavDrillDown(start, navTree: "equip", includeConns: false)
• finNavDuplicate(treeName, src, opts)
• finNavLevels(treeName, base: null, opts: null)
• finNavMain(targets, dates: null)
• finNavMerge(sourceRef, targetRef, treeName: "equip", moveTarget: true)
• finNavMeta(level, position: "")
• finNavMetaTagList(target, ops: {})
• finNavNavlets(target, dates: null)
• finNavRollup(grid)
• finNavletsOn(target)
• finNoteSummary(notes)
• finPaginate(target, pageNumber: Number.<ctor>(1), itemsPerPage: Number.<ctor>(25))
• finParseFilter(filter)
• finPointSummary(target, equipExpr: null, pointExpr: null)
• finPointSummary2(equip, normalizeNames: false)
• finPublishTemplatePackage(pod, username, password, live: false)
• finRebuildDocs()
• finRebuildNavTree(navLevel, parentId: Ref.nullRef, navTreeName: "equip")
• finRecordTagClone(fromRef, toFilter, tags)
• finRemoveCategory(category)
• finRewriteHisTz(id: null, tz: null)
• finRewriteHisTzCommit(points)
• finScheduleCopyDays(schedRefs, srcDay, dstDay)
• finShowPointsInWatch(watchId)
• finShowWatches()
• finStackBootStrap()
• finSub(expr)
• finSubEnd()
• finSubStart(graphicName, watchId: null)
• finSyncTags(source, tags, createIfNotExist: false, treeName: "equip")
• finTemplateCopy(source, basePath, targets, returnCloneIds: false)
• finUniqueActions(filter: null, includeRefs: false)
• finUniqueTags(filter: Literal.<ctor>("equip"))
• finUriToDict(uri)
• finhaystackDeviceDiscovery(ref, config)
• finhaystackDeviceDiscoveryConfig()
• finsedonaDeviceDiscovery(ref, config)
• finsedonaDeviceDiscoveryConfig()
• modifyNavMetaOptional(level, position: "")

---

概述（中译）

FINStack 服务

---

API 正文（英文）

tags

advanced
alarmEmailToggle	Having to do with the alarm email toggle
appFormOn	Application Form Selector Tag
axonTemplate	This is a sample axon query that can be used like a template
baSuExec	BA Super User (Defined here because the BA connector does not support 5.0)
baseChart	Basic charting functions
batchRecords	Indicates that the function will process multiple records
chart	Functions related to charting
chartOn	Chart Record Selector Tag
chartOnDownload
chartTest
childData
connDebug	Connector debugging functions
connTrees	Related to dbAddEdit
construct	Defines a constructor for the function
contextSensitive	This is docs or video that are context Sensitive
dbAddEdit	Marks a function that holds add/edit logic for DB Builder forms
dbToolCategory	Used to group forms together without affecting their folder path
deleteTop
digTime	Related to digest time functions
editSum
example	Defines an example for the function
excludes
finActionCat	Indicates that the function will process fin actions
finAsset	Marks resources published from FIN Builder as asset files
finBestPractice	This is either docs or videos that are best practices, typically videos
finBucket	This tag means that the resource is a FIN Bucket resource
finBuilder	This tag is used for content that is used in FIN Builder
finBuilderAction	This resource belongs to a FIN Builder Action
finBuilderComponent	This tag means that the resource is associated with a component
finBuilderCustom	This tag means that the finp file is a custom graphic, IE.
finBuilderMenu	Identifies functions that have elements for right-click menus in Graphics Builder
finCommonQuery	Identifies functions that return common queries to be used with folio
finDocs	Tag that has a link to docs.finproducts.com
finDocsPath	This is the path where you find the docs in docs.finproducts.com
finExample	This tag is for an something that is an example, either for a video, or docs typically
finFile	Marker for Fin Builder published file resource, the actual file stored on disk
finFileUpload	Marker for Fin Builder uploaded files
finForm	Form Record Selector Tag
finIcon	Marker for Fin Builder published project icon file
finKeyWords	A Comma Seperated string that we can add keywords too, so the user can search on this tag
finMime	Marker for Fin Builder published file resource mime type
finModel	This asset is a FIN Model that can be opened in FIN BUilder
finModelFunc	Defines functions that returns FIN Models
finNavTree	Indentifies a function as containing a root node for a DB Builder tree
finPreviewImageRef	This is a ref to an image that will be previewed for what this is
finProject	Marks resources published from FIN Builder as project files
finRemoteAsset	Defines functions that returns graphics remote assets
finRemoteResource
finResource	Marks resources published from FIN Builder
finRuntime	Marks resources published from FIN Builder as runtime files (i.e
finSavedChart
finScreenshot	Marker for Fin Builder published project screen shot file
finStack	This tag means the asset can be used in FIN
finStackMobileMenu
finString	Having to do with fin string related functions
finTemplateFunc	Defines functions that returns FIN Templates
finThumb	Marker for Fin Builder published project thumb file
finTipsAndTricks	This is a resource for FIN Tips and Tricks
finUpdateRecords
finUri	Marker for Fin Builder published resource Uri
finVideo	This tag means it's a video
finVideoPath	This is the path that goes to youTube for the video
finpFile	The asset is a finp file, that can be downloaded and opened in FIN Builder
finpFileRef	This tag is a ref to the finp file
floorRef	A legacy deprecated floor reference
folderPath	Folder Path Tag
foo	Useless
formOn	Form Record Selector Tag
globalCont	Defines usage in Global Control
helpDoc	Path to help documentation
hideFromMobileDB	Hide from database builder
hideMobile	Used to hide forms in mobile
noDoc	Documentation Ignore Tag
obsolete	Marks a function as obsolete and that it needs to be reviewed before removal
polyStats
poo	Useless
private	Marks the function as private
queryString
relationshipFunc	Indentifies functions that hold pre-configured relationships
relationshipTree	Related to dbAddEdit
savedQueryFilterTree	Related to dbAddEdit
summs
tagBundleFunc	Indentifies functions that hold pre-configured tag bundles
tagBundleTree	Related to dbAddEdit
templateTree	Related to dbAddEdit
timez	Definition of a timezone function
topics
uiFormOn	uiForm Record Selector Tag
update

---

funcs

arcs	Given a grid of source data, return the arcs and the arc summaries which are available for the source data
createFirstLevelOptional	Axon function
createOptionalLevel	Axon function
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
finAssetUsedBy	Given an asset or list of asset records or refs return a grid with fin project records that use those assets
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
finBeginDiscovery	Begins a Discovery session Returns the id of this discovery session
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
finConnExts
finCopyBoundPoints
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
finCreateTemplatePackage	Creates a template package to be published to StackHub Accepts as parameters
finCreateTemplatePackage2
finCurrentDayInfo	Returns a grid with the columns daysLeftMonth daysLeftYear hoursLeftDay hoursPastDay daysPastMonth daysPastYear
finDiscoveryAdd	Add discovered item to system
finDiscoverySessionCleanup	Destroy Discovery Session
finDiscoverySessionEnd	Close Discovery Session
finDiscoveryStatusCheck	Get Discovery Status
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
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
finEquipPointTagClone
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
finFiles	Return a list of fin files together with their respective screen shots, thumbs and icons
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
finFixOldBinTags
finFoldGrid
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
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
finGetHelp
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
finHaystackLearn	Improves haystackLearn so that it fetches all the tags defined for a learn path
finHttpProxy
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
finNavMain
finNavMerge
finNavMeta	Adding a Level
finNavMetaTagList	Given an record that is part of the equipPath Posible ops are {"drillDown":false, "values":true, "getRef":true} If drillDown is present
finNavNavlets
finNavRollup
finNavletsOn
finNoteSummary
finPaginate	FIN
finParseFilter	Decode a filter expression into a grid of operands
finPointSummary	Generate a point summary by equip
finPointSummary2	Function to read points that have pointSummaryRef pointing to the specified equipment
finPublishTemplatePackage	Upload a template package to Stack Hub Accepts as parameters
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
finRemoveCategory	Removes a category or a list of categories from all actions and user records Users should call this like
finRewriteHisTz	Axon function
finRewriteHisTzCommit	Axon function
finScheduleCopyDays	Change a weekly schedule (or list of weekly schedules) by copying parts of it to other week days Examples
finShowPointsInWatch	List all records registered for a watch id
finShowWatches	List all watches open for this project
finStackBootStrap
finSub	Evaluate the given expression
finSubEnd	Last call of an evalAll for subscription
finSubStart	Open a new watch as part of an evalAll
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
finTemplateCopy
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
finUniqueTags	finUniqueTags - returns a grid with all markers that are shared by records matching the filter and their match count
finUriToDict
finhaystackDeviceDiscovery
finhaystackDeviceDiscoveryConfig
finsedonaDeviceDiscovery
finsedonaDeviceDiscoveryConfig
modifyNavMetaOptional	Axon function

---

---

def

advanced

---

meta

def	advanced
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

alarmEmailToggle

Having to do with the alarm email toggle

---

meta

def	alarmEmailToggle
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

appFormOn

Application Form Selector Tag

---

meta

def	appFormOn
is	str
lib	lib:finstack

---

supertypes

val	Data value type
scalar	Scalar is an atomic value kind
str	Unicode string of characters

---

---

def

axonTemplate

This is a sample axon query that can be used like a template

---

meta

def	axonTemplate
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

baSuExec

BA Super User (Defined here because the BA connector does not support 5.0)

---

meta

def	baSuExec
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

baseChart

Basic charting functions

---

meta

def	baseChart
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

batchRecords

Indicates that the function will process multiple records

---

meta

def	batchRecords
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

chart

Functions related to charting

---

meta

def	chart
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

chartOn

Chart Record Selector Tag

---

meta

def	chartOn
is	str
lib	lib:finstack

---

supertypes

val	Data value type
scalar	Scalar is an atomic value kind
str	Unicode string of characters

---

---

def

chartOnDownload

---

meta

def	chartOnDownload
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

chartTest

---

meta

def	chartTest
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

childData

---

meta

def	childData
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

connDebug

Connector debugging functions

---

meta

def	connDebug
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

connTrees

Related to dbAddEdit; specifies that the add/edit logic belongs to connector trees.

---

meta

def	connTrees
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

construct

Defines a constructor for the function

---

meta

def	construct
is	str
lib	lib:finstack

---

supertypes

val	Data value type
scalar	Scalar is an atomic value kind
str	Unicode string of characters

---

---

def

contextSensitive

This is docs or video that are context Sensitive

---

meta

def	contextSensitive
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

dbAddEdit

Marks a function that holds add/edit logic for DB Builder forms.

---

meta

def	dbAddEdit
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

dbToolCategory

Used to group forms together without affecting their folder path

---

meta

def	dbToolCategory
is	str
lib	lib:finstack

---

supertypes

val	Data value type
scalar	Scalar is an atomic value kind
str	Unicode string of characters

---

---

def

deleteTop

---

meta

def	deleteTop
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

digTime

Related to digest time functions

---

meta

def	digTime
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

editSum

---

meta

def	editSum
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

example

Defines an example for the function

---

meta

def	example
is	str
lib	lib:finstack

---

supertypes

val	Data value type
scalar	Scalar is an atomic value kind
str	Unicode string of characters

---

---

def

excludes

---

meta

def	excludes
is	str
lib	lib:finstack

---

supertypes

val	Data value type
scalar	Scalar is an atomic value kind
str	Unicode string of characters

---

---

def

finActionCat

Indicates that the function will process fin actions

---

meta

def	finActionCat
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

finAsset

Marks resources published from FIN Builder as asset files

---

meta

def	finAsset
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

finBestPractice

This is either docs or videos that are best practices, typically videos

---

meta

def	finBestPractice
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

finBucket

This tag means that the resource is a FIN Bucket resource

---

meta

def	finBucket
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

finBuilder

This tag is used for content that is used in FIN Builder

---

meta

def	finBuilder
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

finBuilderAction

This resource belongs to a FIN Builder Action

---

meta

def	finBuilderAction
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

finBuilderComponent

This tag means that the resource is associated with a component

---

meta

def	finBuilderComponent
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

finBuilderCustom

This tag means that the finp file is a custom graphic, IE.. It's not built with standard components in FIN Builder

---

meta

def	finBuilderCustom
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

finBuilderMenu

Identifies functions that have elements for right-click menus in Graphics Builder.

---

meta

def	finBuilderMenu
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

finCommonQuery

Identifies functions that return common queries to be used with folio.

---

meta

def	finCommonQuery
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

finDocs

Tag that has a link to docs.finproducts.com

---

meta

def	finDocs
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

finDocsPath

This is the path where you find the docs in docs.finproducts.com

---

meta

def	finDocsPath
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

finExample

This tag is for an something that is an example, either for a video, or docs typically

---

meta

def	finExample
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

finFile

Marker for Fin Builder published file resource, the actual file stored on disk

---

meta

def	finFile
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

finFileUpload

Marker for Fin Builder uploaded files.

---

meta

def	finFileUpload
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

finForm

Form Record Selector Tag

---

meta

def	finForm
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

finIcon

Marker for Fin Builder published project icon file

---

meta

def	finIcon
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

finKeyWords

A Comma Seperated string that we can add keywords too, so the user can search on this tag

---

meta

def	finKeyWords
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

finMime

Marker for Fin Builder published file resource mime type

---

meta

def	finMime
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

finModel

This asset is a FIN Model that can be opened in FIN BUilder

---

meta

def	finModel
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

finModelFunc

Defines functions that returns FIN Models

---

meta

def	finModelFunc
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

finNavTree

Indentifies a function as containing a root node for a DB Builder tree.

---

meta

def	finNavTree
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

finPreviewImageRef

This is a ref to an image that will be previewed for what this is. IE.. A ThumbNail or etc...

---

meta

def	finPreviewImageRef
is	ref
lib	lib:finstack

---

supertypes

val	Data value type
scalar	Scalar is an atomic value kind
ref	Reference to an entity

---

---

def

finProject

Marks resources published from FIN Builder as project files

---

meta

def	finProject
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

finRemoteAsset

Defines functions that returns graphics remote assets

---

meta

def	finRemoteAsset
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

finRemoteResource

---

meta

def	finRemoteResource
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

finResource

Marks resources published from FIN Builder

---

meta

def	finResource
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

finRuntime

Marks resources published from FIN Builder as runtime files (i.e. .flb, .swf)

---

meta

def	finRuntime
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

finSavedChart

---

meta

def	finSavedChart
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

finScreenshot

Marker for Fin Builder published project screen shot file

---

meta

def	finScreenshot
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

finStack

This tag means the asset can be used in FIN|Framework

---

meta

def	finStack
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

finStackMobileMenu

---

meta

def	finStackMobileMenu
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

finString

Having to do with fin string related functions

---

meta

def	finString
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

finTemplateFunc

Defines functions that returns FIN Templates

---

meta

def	finTemplateFunc
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

finThumb

Marker for Fin Builder published project thumb file

---

meta

def	finThumb
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

finTipsAndTricks

This is a resource for FIN Tips and Tricks

---

meta

def	finTipsAndTricks
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

finUpdateRecords

---

meta

def	finUpdateRecords
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

finUri

Marker for Fin Builder published resource Uri. This is computed at publishing time and constructs name spaces for each resource type.

---

meta

def	finUri
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

finVideo

This tag means it's a video

---

meta

def	finVideo
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

finVideoPath

This is the path that goes to youTube for the video

---

meta

def	finVideoPath
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

finpFile

The asset is a finp file, that can be downloaded and opened in FIN Builder

---

meta

def	finpFile
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

finpFileRef

This tag is a ref to the finp file

---

meta

def	finpFileRef
is	ref
lib	lib:finstack

---

supertypes

val	Data value type
scalar	Scalar is an atomic value kind
ref	Reference to an entity

---

---

def

floorRef

A legacy deprecated floor reference. Prefer to use spaceRef.

---

meta

containedBy	floor
def	floorRef
is	ref
lib	lib:finstack
of	floor
tagOn	floor

---

supertypes

val	Data value type
scalar	Scalar is an atomic value kind
ref	Reference to an entity

---

---

def

folderPath

Folder Path Tag

---

meta

def	folderPath
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

foo

Useless

---

meta

def	foo
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

formOn

Form Record Selector Tag

---

meta

def	formOn
is	str
lib	lib:finstack

---

supertypes

val	Data value type
scalar	Scalar is an atomic value kind
str	Unicode string of characters

---

---

def

func:arcs

arcs(src, dates: null)

Given a grid of source data, return the arcs and the arc summaries which are available for the source data.

Examples:

readAll(site).arcs        // using project default date span
readAll(site).arcs(today) // with explicit data span

---

meta

def	func:arcs
is	func
lib	lib:finstack
name	arcs

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:createFirstLevelOptional

createFirstLevelOptional(level)

Axon function

---

meta

def	func:createFirstLevelOptional
is	func
lib	lib:finstack
name	createFirstLevelOptional

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

src

(level) => do
  levels: read(navMeta).toRec->equipPath
  levels = levels.split("/")
  levels = levels.remove(0)
  childLevel: levels[levels.index(level) + 1]

  if(childLevel.startsWith("[") and childLevel.endsWith("]")) do
  childLevel = childLevel[1..-2]
  end

  if(level.startsWith("[") and level.endsWith("]")) do
  level = level[1..-2]
  end

  childLevelRef: childLevel + "Ref"
  levelName: "New " + level.capitalize
  levelRef: level + "Ref"
  d: {id: refGen(), "dis": levelName}
  d = d.set(level, marker())

  diff(null, d, {add}).commit

  e: {}
  e = e.set(levelRef, d->id)

  readAll(childLevelRef.parseFilter or childLevel.parseFilter).toRecList.map(r => diff(r, e)).commit
end

---

---

def

func:createOptionalLevel

createOptionalLevel(level, position: "")

Axon function

---

meta

def	func:createOptionalLevel
is	func
lib	lib:finstack
name	createOptionalLevel

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

src

(level, position: "") => do
  levelMarker: level
  if(level.startsWith("[") and level.endsWith("]")) do
  levelMarker = level[1..-2]
  end
  levelName: "New " + levelMarker.capitalize
  navMetaValue: modifyNavMetaOptional(level, position)

  if(navMetaValue == "yesLevel") do
  return level + " level exists"
  end
  else if(navMetaValue == "noPosition") do
  return position + " is invalid"
  end
  else do
  read(navMeta).toRecList.map(r => diff(r, {equipPath: navMetaValue})).commit

  if(position != "") do
    levels: navMetaValue.split("/")
    levels = levels.remove(0)
    parentLevels: []
    refs: {}

    levels[0..(levels.index(level) - 1)].each str => do
    if(str.startsWith("[") and str.endsWith("]")) do
      str = str[1..-2]
    end
    parentLevels = parentLevels.insert(0, str)
    end

    parentLevels.each str => do
    readAll(str.parseFilter).toRecList.each r => do
      if(refs.missing(r->id.toStr())) do
      refs = refs.set(r->id.toStr(), true)
      d: {id: refGen(),dis: levelName}
      d = d.set(levelMarker, marker())
      d = d.set(str + "Ref", r->id)

      parentLevels[parentLevels.index(str) + 1..-1].each str1 => do
        if(r.has(str1 + "Ref")) do
        refs = refs.set(r.get(str1 + "Ref").toStr(), true)
        d = d.set(str1 + "Ref", r.get(str1 + "Ref"))
        end
      end
      fltr : str + "Ref == @" + r->id
      readAll(fltr.parseFilter).toRecList.each r1 => do
        d1 : {}
        d1 = d1.set(levelMarker + "Ref", d->id)
        diff(r1, d1).commit
      end
      diff(null, d, {add}).commit
      end
    end
    end
  end
  else do
    createFirstLevelOptional(level)
  end

  return levelMarker + " was created successfully"
  end
end

---

---

def

func:finActionsRewrite

finActionsRewrite(filter, oldExprDict, newExprDict)

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:

// all actions that have the dis and expr equal with the oldExprDict will get a new tag someTag finActionsRewrite(actions, {dis:"Manual Auto", expr: "pointAuto($self)"}, {someTag}) // all actions that have the dis and expr equal with the oldExprDict will get the tag someTag removed finActionsRewrite(actions, {dis:"Manual Auto", expr: "pointAuto($self)"}, {-someTag})

---

meta

construct	finActionsRewrite(actions, {dis:"Some dis", expr:"Some e...
def	func:finActionsRewrite
example	finActionsRewrite(actions, {dis:"Manual Auto", expr: "po...
is	func
lib	lib:finstack
name	finActionsRewrite

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finAssetUsedBy

finAssetUsedBy(assets)

Given an asset or list of asset records or refs return a grid with fin project records that use those assets

---

meta

def	func:finAssetUsedBy
is	func
lib	lib:finstack
name	finAssetUsedBy

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finBacnetCurToWrite

finBacnetCurToWrite(recs, from: "bacnetCur", to: "bacnetWrite")

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

---

meta

def	func:finBacnetCurToWrite
dis	Bacnet Cur To Write
is	func
lib	lib:finstack
name	finBacnetCurToWrite

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

src

(recs, from : "bacnetCur", to : "bacnetWrite") => do
  recs = recs.toRecList()

  out : []
  tmp : null
  obj : {}

  recs.each r => do
    tmp = {id: r->id}
    if(r[from] == null) do
      tmp = tmp.set(from, from + " isn't set")

      if(r[to] ==  null) tmp = tmp.set(to, to + " isn't set")
      else tmp = tmp.set(to, r[to])
    end
    else do
      tmp = tmp.set(from, r[from])

      if(r[to] ==  null) tmp = tmp.set(to, to + " isn't set")
      else do
        tmp = tmp.set(to + "BeforeSet", r[to])
        obj = obj.set(to, r[from])
        r.diff(obj).commit
        tmp = tmp.set(to, r[from])
      end
    end
    out = out.add(tmp)
  end
  out
end

---

---

def

func:finBacnetWriteToCur

finBacnetWriteToCur(recs)

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

---

meta

def	func:finBacnetWriteToCur
dis	Bacnet Write To Cur
is	func
lib	lib:finstack
name	finBacnetWriteToCur

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

src

(recs) => do
  finBacnetCurToWrite(recs, "bacnetWrite", "bacnetCur")
end

---

---

def

func:finBeginDiscovery

finBeginDiscovery(connectorName, discoveryConfiguration: "")

Begins a Discovery session Returns the id of this discovery session. You can use this id to check real time results using the function finDiscoveryStatusCheck()

Example:

finBeginDiscovery("bacnet", "ver:\"2.0\" \n serialPort,baudRate,broadcastAddress,localAddress,instanceLow,instanceHi,networkNo,discoveryTimeout \n \"\",76800,\"255.255.255.255\",\"0.0.0.0\",0,4194303,65535,8")
finBeginDiscovery("bacnetMstp", "ver:\"2.0\" \n serialPort,baudRate,broadcastAddress,localAddress,instanceLow,instanceHi,networkNo,discoveryTimeout \n \"com1\",76800,\"FF\",\"00\",0,4194303,65535,8")

---

meta

def	func:finBeginDiscovery
is	func
lib	lib:finstack
name	finBeginDiscovery

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finCapsNeeded

finCapsNeeded(capCount, mult: Number.<ctor>(1), params: null)

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.

Has 3 parameters:

• capCount: number of required CAPS
• mult: multiplier number (optional)
• params: a dictionary of parameters (optional)

---

meta

def	func:finCapsNeeded
is	func
lib	lib:finstack
name	finCapsNeeded

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finConnExts

finConnExts()

---

meta

def	func:finConnExts
is	func
lib	lib:finstack
name	finConnExts

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finCopyBoundPoints

finCopyBoundPoints(sourceExpr, targetExpr)

---

meta

def	func:finCopyBoundPoints
is	func
lib	lib:finstack
name	finCopyBoundPoints

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finCreateHaystackDb

finCreateHaystackDb(conns, startLearn: "sep:/", hisEnable: false, doImport: true, parent: null, rootLearn: "")

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

---

meta

def	func:finCreateHaystackDb
is	func
lib	lib:finstack
name	finCreateHaystackDb

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finCreateTemplatePackage

finCreateTemplatePackage(finTemplates, meta)

Creates a template package to be published to StackHub

Accepts as parameters:

• finTemplates:
  • An Urifor a folder in the `io/` folder under current project. for example: `io/templates/vendorName` To create an resource extension, one will need to create a file called podNameFuncs.trio (see the name tag in the meta Dict). Any trio file that's named fstTemplateNameTags.trio will be included in the templates section of this package and the tags added to the template record. If bacnetProperties.trio file is present, then it will be added to the package also.
  • A list of Refs ids to file records or Records of file tags pointing to FinStack Template files uploaded using the file upload method in the curent project
• meta: a dictionary with properties that will identify the resulting packaged template Contains fields that are exported to the Pods meta.props file, like:
  • name
  • version
  • summary

Returns:

• a Grid containing the id to the resulting template package

Examples:

finCreateTemplatePackage(`io/templates/acmeinc`, {name: "acmeTemplates", version: "1.0"})
finCreateTemplatePackage([@fst1, @fst2], {name: "ACME templates", version: "1.0"})
finCreateTemplatePackage(readAll(file and fst), {name: "acmeTemplates", version: "1.0"})

---

meta

def	func:finCreateTemplatePackage
is	func
lib	lib:finstack
name	finCreateTemplatePackage

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finCreateTemplatePackage2

finCreateTemplatePackage2(finTemplates, meta)

---

meta

def	func:finCreateTemplatePackage2
is	func
lib	lib:finstack
name	finCreateTemplatePackage2

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finCurrentDayInfo

finCurrentDayInfo(time: SysLib.now(), tz: TimeZone.cur())

Returns a grid with the columns

daysLeftMonth daysLeftYear hoursLeftDay hoursPastDay daysPastMonth daysPastYear

---

meta

construct	finCurrentDayInfo()
def	func:finCurrentDayInfo
example	finCurrentDayInfo(now() + 7, tz("New_York"))
is	func
lib	lib:finstack
name	finCurrentDayInfo

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finDiscoveryAdd

finDiscoveryAdd(recordIds)

Add discovered item to system

---

meta

def	func:finDiscoveryAdd
is	func
lib	lib:finstack
name	finDiscoveryAdd

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finDiscoverySessionCleanup

finDiscoverySessionCleanup(discoveryId)

Destroy Discovery Session

---

meta

def	func:finDiscoverySessionCleanup
is	func
lib	lib:finstack
name	finDiscoverySessionCleanup

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finDiscoverySessionEnd

finDiscoverySessionEnd(discoveryId, error: null)

Close Discovery Session

---

meta

def	func:finDiscoverySessionEnd
is	func
lib	lib:finstack
name	finDiscoverySessionEnd

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finDiscoveryStatusCheck

finDiscoveryStatusCheck(discoveryId)

Get Discovery Status. Provide the discovery session id to get real time discovery results.

---

meta

def	func:finDiscoveryStatusCheck
is	func
lib	lib:finstack
name	finDiscoveryStatusCheck

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finElementOn

finElementOn(target, elementTag, queryRelated: false)

FIN Element On This method will find records compatible with the target element based off of the elementTag.

Example: read(equip).finElementOn("form")

This example will find all of the forms that are compatible with the equipment found in the "read()" function.

finElementOn(@target, "graphic", true) - This will find all of the graphics whose graphicsOn tag contains a filter that matches the target.

• target This is the target element that will be used as a test to find compatible elements.
• elementTag This is the element type tag. if "form" is passed, it will search for the filter to be in "formOn" on the form records
• queryRelated If this is true, it will also match elements whose filter evaluates to true for any record referenced by the target.

---

meta

def	func:finElementOn
is	func
lib	lib:finstack
name	finElementOn

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finElementsOn

finElementsOn(targets, elementTag, queryRelated: false)

FIN Elements On This method will find records compatible with all of the target elements based off of the elementTag.

Example: read(equip).finElementOn("form")

This example will find all of the forms that are compatible with the equipment found in the "read()" function.

finElementOn(@target, "graphic", true) - This will find all of the graphics whose graphicsOn tag contains a filter that matches the target.

• grid This is a list of the target elements that will be used as a test to find compatible elements.
• elementTag This is the element type tag. if "form" is passed, it will search for the filter to be in "formOn" on the form records
• queryRelated If this is true, it will also match elements whose filter evaluates to true for any record referenced by the target.

---

meta

def	func:finElementsOn
is	func
lib	lib:finstack
name	finElementsOn

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finEnergyAnnualMonthlyDayRollup

finEnergyAnnualMonthlyDayRollup(pRef, foldFc: null)

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. The columns will be Day 1, Day 2, Day 3, etc... The rows will be Jan, Feb, March, APril, May, June, etc....

It returns that exact formation please. If no folding function is specified, "sum" is used as default.

Has 2 parameters:

• pRef: point reference
• foldFc: a folding function (optional), default is "sum"

---

meta

def	func:finEnergyAnnualMonthlyDayRollup
is	func
lib	lib:finstack
name	finEnergyAnnualMonthlyDayRollup

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finEnergyAnnualMonthlyRollup

finEnergyAnnualMonthlyRollup(pRef, foldFc: null)

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. The columns will be point, jan, feb, mar, etc... The rows will be the points. Has 2 parameters: - pRef: point or list of point - foldFc: a folding function (optional), default is "avg"

---

meta

def	func:finEnergyAnnualMonthlyRollup
is	func
lib	lib:finstack
name	finEnergyAnnualMonthlyRollup

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finEnergyAnnualWkDayRollup

finEnergyAnnualWkDayRollup(pRef, foldFc: null)

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. The columns will be Day 1, Day 2, Day 3, etc... The rows will be Jan, Feb, March, APril, May, June, etc.... It returns that exact formation please. If no folding function is specified, "sum" is used as default. Has 2 parameters: - pRef: point reference - foldFc: a folding function (optional), default is "sum"

---

meta

def	func:finEnergyAnnualWkDayRollup
is	func
lib	lib:finstack
name	finEnergyAnnualWkDayRollup

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finEquipPointTagClone

finEquipPointTagClone(fromEquipRef, fromPointRefs, tags, toEquipFilter, copy: false)

---

meta

def	func:finEquipPointTagClone
is	func
lib	lib:finstack
name	finEquipPointTagClone

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finFileAndAssetDelete

finFileAndAssetDelete(projects)

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. Returns a grid with all records that where deleted

---

meta

def	func:finFileAndAssetDelete
is	func
lib	lib:finstack
name	finFileAndAssetDelete

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finFiles

finFiles()

Return a list of fin files together with their respective screen shots, thumbs and icons.

---

meta

def	func:finFiles
is	func
lib	lib:finstack
name	finFiles

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

src

() => do

p: readProjStatus()

readAll(finThumb).map r => do
  name:  r->name
  return {
    dis: r.toDis,
    finFileUri: p->siteUri + ("/api/" + p->projName + "/rec/" + name + "/finFile"),
    iconUri: p->siteUri + ("/api/" + p->projName + "/rec/" + name[0..-5] + "_fin/finIcon"),
    thumbUri: p->siteUri + ("/api/" + p->projName + "/rec/" + name[0..-5] + "_fin/finThumb"),
    screenUri: p->siteUri + ("/api/" + p->projName + "/rec/" + name[0..-5] + "_fin/finScreenshot"),
  }
 end
end

---

---

def

func:finFindRecordByChild

finFindRecordByChild(targetFilter, childFilter)

This function is just like finFindRecordByChildDeep except this one only searches 1 level deep, and is way more effecient. This function would let you search for let's say all AHUs that have zone temp sensors under them. And it will return the AHUs. parameter-1 is a filter, which is typically a equip , and paramter-2 is a filter for what typically would be a point

---

meta

construct	finFindRecordByChild(ahu and equip, zone and temp and ai...
def	func:finFindRecordByChild
example	finFindRecordByChild(ahu and equip, zone and temp and ai...
is	func
lib	lib:finstack
name	finFindRecordByChild

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finFindRecordByChildDeep

finFindRecordByChildDeep(targetFilter, childFilter)

This function will let you search for children of something. IE... IF you are looking for equipment that have temp sensors under item than this function will return all the equipment that have temp sensors. The normal folio filter does not let you do this. This function finFindRecordByChildDeep is just like finFindRecordByChild, so if you are looking for things and you only want to get the children that are one level deep, than use finFindRecordByChild. finFindRecordByChildDeep is more expensive as it is looking for all the children under what you find. parameter-1 is a filter, which is typically a site or floor, and paramter-2 is a filter for what typically would be a point

---

meta

construct	finFindRecordByChildDeep(site and area, kw or temp)
def	func:finFindRecordByChildDeep
example	finFindRecordByChildDeep(site, (kw or water) and (point)...
is	func
lib	lib:finstack
name	finFindRecordByChildDeep

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finFixOldBinTags

finFixOldBinTags()

---

meta

def	func:finFixOldBinTags
is	func
lib	lib:finstack
name	finFixOldBinTags

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finFoldGrid

finFoldGrid(grd, foldFc: null, ops: {})

---

meta

def	func:finFoldGrid
is	func
lib	lib:finstack
name	finFoldGrid

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finFreqFilters

finFreqFilters()

This function is used for the filter ui that shally made. It is a short cut for filters that people use frequently. The tag call freqFilters will also be able to be extended.

---

meta

def	func:finFreqFilters
is	func
lib	lib:finstack
name	finFreqFilters

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

src

() => do
[
{dis:"Find all Points",filter:"point",finFreqFilters},
{dis:"Find all Equips",filter:"equip",finFreqFilters},
{dis:"Find all Sites",filter:"site",finFreqFilters},
{dis:"Find all History Points",filter:"his and hisEndVal>1",finFreqFilters},
{dis:"Find all Numeric Points",filter:"point and kind==\"Number\"",finFreqFilters},
{dis:"Find all Boolean Points",filter:"point and kind==\"Bool\"",finFreqFilters},
{dis:"Find all Enum Points",filter:"point and kind==\"Str and enum\"",finFreqFilters},
{dis:"Find all Commandable Numeric Points",filter:"point and writable and actions and kind==\"Number\"",finFreqFilters},
{dis:"Find all Commandable Boolean Points",filter:"point and writable and actions and kind==\"Bool\"",finFreqFilters}
]
end

---

---

def

func:finFuncs

finFuncs()

FIN Funcs This method merges the result of the funcs() query with extra data within the finFuncs.trio file to support FIN|Stack's code editor

Example: finFuncs()

---

meta

def	func:finFuncs
is	func
lib	lib:finstack
name	finFuncs

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finGetCaps

finGetCaps()

This function returns a grid with the licensing parts and their prices.

---

meta

def	func:finGetCaps
is	func
lib	lib:finstack
name	finGetCaps

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finGetConnectorTagSpecs

finGetConnectorTagSpecs(extName)

Returns a Grid with the tag specs defined for an enabled connector.

---

meta

def	func:finGetConnectorTagSpecs
is	func
lib	lib:finstack
name	finGetConnectorTagSpecs

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finGetCurrentUser

finGetCurrentUser()

---

meta

def	func:finGetCurrentUser
is	func
lib	lib:finstack
name	finGetCurrentUser

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finGetDiscoveryConfiguration

finGetDiscoveryConfiguration(connectorName)

Get Discovery Configuration

---

meta

def	func:finGetDiscoveryConfiguration
is	func
lib	lib:finstack
name	finGetDiscoveryConfiguration

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finGetHelp

finGetHelp(appNames, targetRefs: null)

---

meta

def	func:finGetHelp
is	func
lib	lib:finstack
name	finGetHelp

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finHaystackDrillDown

finHaystackDrillDown(conns, startLearn: "sep:/", hisEnable: false, rootLearn: "")

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.

---

meta

def	func:finHaystackDrillDown
is	func
lib	lib:finstack
name	finHaystackDrillDown

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finHaystackExcludedTags

finHaystackExcludedTags()

Returns a grid of tags to be excluded when working with records coming from haystack or nhaystack connectors

---

meta

def	func:finHaystackExcludedTags
is	func
lib	lib:finstack
name	finHaystackExcludedTags

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finHaystackLearn

finHaystackLearn(conn, learnPath: null, opts: [:])

Improves haystackLearn so that it fetches all the tags defined for a learn path

---

meta

def	func:finHaystackLearn
is	func
lib	lib:finstack
name	finHaystackLearn

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finHttpProxy

finHttpProxy(url, method: "GET", headers: null, params: null)

---

meta

def	func:finHttpProxy
is	func
lib	lib:finstack
name	finHttpProxy

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finNavDrillDown

finNavDrillDown(start, navTree: "equip", includeConns: false)

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

---

meta

def	func:finNavDrillDown
is	func
lib	lib:finstack
name	finNavDrillDown

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finNavDuplicate

finNavDuplicate(treeName, src, opts)

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. sub-equips

---

meta

def	func:finNavDuplicate
is	func
lib	lib:finstack
name	finNavDuplicate

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finNavLevels

finNavLevels(treeName, base: null, opts: null)

Enhance navLevels

---

meta

def	func:finNavLevels
is	func
lib	lib:finstack
name	finNavLevels

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

src

(treeName, base: null, opts: null) => do

  navs: navLevels(treeName, base, opts).addMeta({"projName": "demo"}) // TODO: Retrieve Project Name

  // This may be able to be done faster by reading all items into memory at once then mapping them over.
  // TODO: Test performance of all possible methods and select the fastest
  navs.map(nav => do
    item: readById(nav->id)
    nav.merge(item)
  end)

end

---

---

def

func:finNavMain

finNavMain(targets, dates: null)

---

meta

def	func:finNavMain
is	func
lib	lib:finstack
name	finNavMain

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finNavMerge

finNavMerge(sourceRef, targetRef, treeName: "equip", moveTarget: true)

---

meta

def	func:finNavMerge
is	func
lib	lib:finstack
name	finNavMerge

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finNavMeta

finNavMeta(level, position: "")

Adding a Level: If you want to add a top level, just enter your parameter level you would like to add. ex: finNavMeta("region") - This will create a region level above the highest level you have.

If you want to add a level between other levels, then you will need two parameters. The first one is what you want to add. The second is under which level you want to add it under. ex: finNavMeta("wing","site") - This will create a wing level under the site level.

Adding an Optional Level: If want an optional level, then you will need two parameters. The first one is what you want to add (in square brackets). The second is under which level you want to add it under. ex: finNavMeta("[branch]","region")

Removing a Level: If you want to remove a level, simply add the "-" before whichever level it is you want to remove. ex: finNavMeta("-[branch]") or finNavMeta("-branch")

---

meta

def	func:finNavMeta
is	func
lib	lib:finstack
name	finNavMeta

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

src

(level, position: "") => do
  if(level != "" and level[0..0] == "-") do

  if(level == "-") do
    level = ""
  end
  else if(level[1..1] != "[") do
    level = level[1..-1]
  end
  else do
    level = level[2..-2]
  end

  navMetaValue: read(navMeta).toRec->equipPath
  navMetaValue1: navMetaValue + "/"

  if((level != "") and (navMetaValue1.contains("/" + level + "/") or navMetaValue1.contains("/[" + level + "]/"))) do
    if(navMetaValue1.contains("/" + level + "/")) do
    navMetaValue = navMetaValue.replace("/" + level, "")
    end
    else do
    navMetaValue = navMetaValue.replace("/[" + level  +"]", "")
    end

    read(navMeta).toRec.diff({equipPath: navMetaValue}).commit

    levelRef: level + "Ref"
    d: {}
    d = d.set(levelRef, removeMarker())
    readAll(level.parseFilter).toRecList.map(r => diff(r, {trash})).commit
    readAll(levelRef.parseFilter).toRecList.map(r => diff(r, d)).commit

    return level + " was successfully removed"
  end
  else do
    return level + " level doesn't exit and can't be removed"
  end
  end
  else do
  createOptionalLevel(level, position)
  end
end

---

---

def

func:finNavMetaTagList

finNavMetaTagList(target, ops: {})

Given an record that is part of the equipPath Posible ops are {"drillDown":false, "values":true, "getRef":true} If drillDown is present: Find all unique tags that are used by the record and all it's nav children. Else finds all unique tags that are used by the record and all it's nav parents. If "drillDown" is not present but "values" is then the resulted grid includes the values for those tags also.

---

meta

def	func:finNavMetaTagList
is	func
lib	lib:finstack
name	finNavMetaTagList

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finNavNavlets

finNavNavlets(target, dates: null)

---

meta

def	func:finNavNavlets
is	func
lib	lib:finstack
name	finNavNavlets

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finNavRollup

finNavRollup(grid)

---

meta

def	func:finNavRollup
is	func
lib	lib:finstack
name	finNavRollup

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finNavletsOn

finNavletsOn(target)

---

meta

def	func:finNavletsOn
is	func
lib	lib:finstack
name	finNavletsOn

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finNoteSummary

finNoteSummary(notes)

---

meta

construct	readAll(note).finNoteSummary
def	func:finNoteSummary
example	readAll(note).finNoteSummary
is	func
lib	lib:finstack
name	finNoteSummary

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finPaginate

finPaginate(target, pageNumber: Number.<ctor>(1), itemsPerPage: Number.<ctor>(25))

FIN|Stack Paginate This method will paginate the data of the grid passed to it.

• target This is the target Grid to be paginated.
• pageNumber This is the page number requested. (Optional, defaults to 1)
• itemsPerPage This is the number of items per page (Optional, defaults to 25)

Example: readAll(point).finPaginate(1, 25)

The resulting grid will contain 5 metadata tags

• paginated is a marker that defines this grid as being a paginated grid
• currentPage is the current page number of the result (requested)
• itemsPerPage is the requested items per page.
• totalItems is the total number of items in the target grid.
• totalPages is the total number of available pages

The resulting grid will also contain the original metadata tags defined by the target.

@return This method returns a paginated grid which is a subset of the target grid.

---

meta

def	func:finPaginate
is	func
lib	lib:finstack
name	finPaginate

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finParseFilter

finParseFilter(filter)

Decode a filter expression into a grid of operands

---

meta

def	func:finParseFilter
is	func
lib	lib:finstack
name	finParseFilter

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finPointSummary

finPointSummary(target, equipExpr: null, pointExpr: null)

Generate a point summary by equip:

• target is id, dict, list of id, list of dicts which determines base to use for <navFilter>. If null, then entire proj is queried.
• equipFilter: filter for equip or null for all equip under target
• pointFilter: filter for points or null for all points under equip

Return a table where ever row represents an equipment, and columns represent key tags on the points. The following cols are used:

• id: equip id and dis
• idX: point id and dis
• curValX: curVal tag of each point
• curDisX: display string for curVal for each point
• curStatusX: curStatus tag of each point

The column's are grouped and use dis tag based on the navName of each point. The grid.meta defined numPoints to determine the number of point columns.

Examples:

finPointSummary(read(site))
finPointSummary(null, ahu)
finPointSummary(null, ahu, discharge and temp)

---

meta

def	func:finPointSummary
is	func
lib	lib:finstack
name	finPointSummary

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finPointSummary2

finPointSummary2(equip, normalizeNames: false)

Function to read points that have pointSummaryRef pointing to the specified equipment. If normalizeNames is set to true then the equipment name would be stripped from the point's dis for points having the equipRef pointing to the equipment.

---

meta

def	func:finPointSummary2
is	func
lib	lib:finstack
name	finPointSummary2

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

src

/**
** Function to read points that have pointSummaryRef pointing to the specified equipment.
** If normalizeNames is set to true then the equipment name would be stripped
** from the point's dis for points having the equipRef pointing to the equipment.
**/
(equip, normalizeNames:false) =>
do
  g:readAll(point and pointSummaryRef == equip->id, false)

  if(g == null)
    return null

  // strip the equipment name from points belonging to the equipment
  if(normalizeNames == true) do
    g = g.map((r)=> do
      if(r->equipRef == equip->id)
        set(r, "dis", r->dis.replace(r->equipRef->dis, ""))
      else
        r
    end)
  end

  return g
end

---

---

def

func:finPublishTemplatePackage

finPublishTemplatePackage(pod, username, password, live: false)

Upload a template package to Stack Hub

Accepts as parameters:

• pod: a String or Dict or Uri to the pod name, like `mytemplate.pod`. The Dict parameter must have an Uri tag called templatePod
• username: the Stack Hub username
• password: the Stack Hub password
• live: publish to live account or the sand-box Stack Hub sites. Default is sand-box.

Examples:

finCreateTemplatePackage(`io/templates/acmeinc`, {name: "acmeTemplates", version: "1.0"}).finPublishTemplatePackage("user", "passwd")
finPublishTemplatePackage(`mytemplate.pod`, "user", "passwd")

---

meta

def	func:finPublishTemplatePackage
is	func
lib	lib:finstack
name	finPublishTemplatePackage

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finRebuildDocs

finRebuildDocs()

Rebuilds the documentation using the FINStack style

---

meta

def	func:finRebuildDocs
is	func
lib	lib:finstack
name	finRebuildDocs

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finRebuildNavTree

finRebuildNavTree(navLevel, parentId: Ref.nullRef, navTreeName: "equip")

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.

---

meta

def	func:finRebuildNavTree
is	func
lib	lib:finstack
name	finRebuildNavTree

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finRecordTagClone

finRecordTagClone(fromRef, toFilter, tags)

---

meta

def	func:finRecordTagClone
is	func
lib	lib:finstack
name	finRecordTagClone

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finRemoveCategory

finRemoveCategory(category)

Removes a category or a list of categories from all actions and user records

Users should call this like: // remove category foo_finCat finRemoveCategory("foo_finCat") // remove a list of categories finRemoveCategory(["foo_finCat", "bar_finCat"])

---

meta

construct	finRemoveCategory()
def	func:finRemoveCategory
example	finRemoveCategory("some_finCat")
is	func
lib	lib:finstack
name	finRemoveCategory

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finRewriteHisTz

finRewriteHisTz(id: null, tz: null)

Axon function

---

meta

def	func:finRewriteHisTz
is	func
lib	lib:finstack
name	finRewriteHisTz

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

src

(id: null, tz: null) => do
  points: [] //{id, tz}

  genFilter: rec => do //generates a filter for all points under this site/floor/equip
    if(rec.has("point")) return "id==@" + rec->id
    filt: "point and " + finNavMetaWhoAmI(rec) + "Ref==@" + rec->id
  end

  //fill points list with all points to fix and what the tz's are
  if(id == null and tz == null) do //each site with site's tz
    readAll(site).each s=> do
      tzval: s["tz"]
      if(tzval == null) tzval = now().tz
      readAll(point and siteRef==s->id).each p=> do
        points = points.add({id: p->id, tz: tzval})
      end
    end
  end else if(id == null) do //each site with specific tz
    readAll(site).each s=> do
      readAll(point and siteRef==s->id).each p=> do
        points = points.add({id: p->id, tz: tz})
      end
    end
  end else if(tz == null) do //site with site's tz
    s: readById(id)
    tzval: s["tz"]
    if(tzval == null) tzval = now().tz
    readAll(parseFilter(genFilter(s))).each p=> do
      points = points.add({id: p->id, tz: tzval})
    end
  end else do //site with specific tz
    s: readById(id)
    readAll(parseFilter(genFilter(s))).each p=> do
      points = points.add({id: p->id, tz: tz})
    end
  end

  eval("jobRun(finRewriteHisTzCommit("+ points.toAxonCode +"))")

  //add stuff to change the timezone of the floors and equips and stuff
end
/*
(null, null)          go through each site and update the stuff based on site's tz
(null, Los_Angeles)   go through each site and update the stuff based on specified tz
(@site, null)         go through site and update the stuff based on site's tz
(@site, Los_Angeles)  go through site and update the stuff based on specified tz
*/

---

---

def

func:finRewriteHisTzCommit

finRewriteHisTzCommit(points)

Axon function

---

meta

def	func:finRewriteHisTzCommit
is	func
lib	lib:finstack
name	finRewriteHisTzCommit

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

src

(points) => do
  percent: 100 / points.size
  jobmsg: " of " + points.size

  nowVal: now()
  hisReadFunc: hp=> hp.hisRead(nowVal)

  points.each() (p, i)=> do
    jobProgress(i * percent, (i + 1) + jobmsg) //update percent
    pt: readById(p->id)

    if(pt.has("his") and not pt.has("hisFunc")) do //fix the his also
      isBroken: try do pt.hisReadFunc; false end catch true //check if the his needs fixing
      continue: true
      if(pt["tz"] != p->tz or isBroken) do //only fix if it's broken
        (1..100).eachWhile q=> do //try to fix the his 100 times max

          try do
            pt.hisRewrite((val, ts)=> [ts.toTimeZone(p->tz), val])
            readById(p->id).diff({tz: p->tz}).commit
            continue = true
          end catch(e) do
            stat: reGroups(r"tz config ([\S]+) != ([\S]+)", e->dis)
            if(stat == null) continue = false //unknown error, stop trying
            else do
              pt.diff({tz: stat[2]}).commit //set it to what the his is
              pt = readById(p->id) //refresh point
              continue = null //keep trying
            end
          end

          if(continue == false or q == 100) logWarn("finRewriteHisTz", "Point "+ pt.dis +" (@"+ p->id +") timezone change failed")
          continue
        end
      end
    end

    else pt.diff({tz: p->tz}).commit //no his, just change tz
  end
end
/*
//rewrite his to york, fail york != regina
//change point to regina
//rewrite his to york, fail regina != berlin
//change point to berlin
//rewrite his to york, success
//change point to york
*/

---

---

def

func:finScheduleCopyDays

finScheduleCopyDays(schedRefs, srcDay, dstDay)

Change a weekly schedule (or list of weekly schedules) by copying parts of it to other week days

Examples:

// copy events from Monday to Tuesday finScheduleCopyDays(@schedRef, "mon", "tue") // copy events from Monday to all work days finScheduleCopyDays(@schedRef, "mon", "workWeek") // copy events from Monday to all week days finScheduleCopyDays(@schedRef, "mon", "everyDay") // using a list of schedule records, for each one, copy events from Monday to all work days finScheduleCopyDays([@schedRef1, @schedRef2], "mon", "workWeek")

---

meta

construct	finScheduleCopyDays(id, srcDay, dstDay)
def	func:finScheduleCopyDays
example	finScheduleCopyDays(id, "mon", "tue")
is	func
lib	lib:finstack
name	finScheduleCopyDays

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finShowPointsInWatch

finShowPointsInWatch(watchId)

List all records registered for a watch id

---

meta

def	func:finShowPointsInWatch
is	func
lib	lib:finstack
name	finShowPointsInWatch

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finShowWatches

finShowWatches()

List all watches open for this project

---

meta

def	func:finShowWatches
is	func
lib	lib:finstack
name	finShowWatches

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finStackBootStrap

finStackBootStrap()

---

meta

def	func:finStackBootStrap
is	func
lib	lib:finstack
name	finStackBootStrap

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finSub

finSub(expr)

Evaluate the given expression. If the expression results in a Dict or a Grid of records with an id tag, then add to them to the watch for the current evalAll. Must call finSubStart() first.

---

meta

def	func:finSub
is	func
lib	lib:finstack
name	finSub

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finSubEnd

finSubEnd()

Last call of an evalAll for subscription. This returns an empty grid with the meta tag finSubWatch which contains the watch id of the current watch subscription.

---

meta

def	func:finSubEnd
is	func
lib	lib:finstack
name	finSubEnd

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finSubStart

finSubStart(graphicName, watchId: null)

Open a new watch as part of an evalAll. The graphicName parameter should be the debug string for the watch. If watchId is null then a new watch is created, otherwise it must reference an existing watch.

---

meta

def	func:finSubStart
is	func
lib	lib:finstack
name	finSubStart

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finSyncTags

finSyncTags(source, tags, createIfNotExist: false, treeName: "equip")

FIN Synchronize Tags This method will recursively synchronize the tag values from the source onto all of the children down the given tree

Example:

finSyncTags(@SiteId, ["tz"])

This example will update the tz tag on all of the children down the tree. It will not create the tz tag if it does not exist on an item

finSyncTags(@SiteId, ["tz"], true) - This will update and/or create the tz tag on every item down the equip tree.

• source This is the Ref to the source where the tag of interest exists. This is also the starting point in the tree that will be traversed.
• tags This is a list of tags that will be copied from the source onto the descendants in the tree.
• createIfNotExist If this is true, it will create the tags of interet on the descendants if they do not exist
• treeName This is the name of the tree that we shall traverse and update

---

meta

construct	finSyncTags(source, ["tag1", "tag2"])
def	func:finSyncTags
example	finSyncTags(source, [])
is	func
lib	lib:finstack
name	finSyncTags

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finTemplateCopy

finTemplateCopy(source, basePath, targets, returnCloneIds: false)

---

meta

def	func:finTemplateCopy
is	func
lib	lib:finstack
name	finTemplateCopy

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finUniqueActions

finUniqueActions(filter: null, includeRefs: false)

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. An optional filter expression can be provided which can narrow the search area that defaults to all actions.

Examples:

// returns all unique actions finUniqueActions() // returns unique actions for sensor finUniqueActions(sensor)

---

meta

construct	finUniqueActions()
def	func:finUniqueActions
example	finUniqueActions(sensor)
is	func
lib	lib:finstack
name	finUniqueActions

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finUniqueTags

finUniqueTags(filter: Literal.<ctor>("equip"))

finUniqueTags

• returns a grid with all markers that are shared by records matching the filter and their match count

---

meta

construct	finUniqueTags()
def	func:finUniqueTags
example	finUniqueTags(equip)
is	func
lib	lib:finstack
name	finUniqueTags

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finUriToDict

finUriToDict(uri)

---

meta

def	func:finUriToDict
is	func
lib	lib:finstack
name	finUriToDict

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finhaystackDeviceDiscovery

finhaystackDeviceDiscovery(ref, config)

---

meta

def	func:finhaystackDeviceDiscovery
is	func
lib	lib:finstack
name	finhaystackDeviceDiscovery

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finhaystackDeviceDiscoveryConfig

finhaystackDeviceDiscoveryConfig()

---

meta

def	func:finhaystackDeviceDiscoveryConfig
is	func
lib	lib:finstack
name	finhaystackDeviceDiscoveryConfig

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finsedonaDeviceDiscovery

finsedonaDeviceDiscovery(ref, config)

---

meta

def	func:finsedonaDeviceDiscovery
is	func
lib	lib:finstack
name	finsedonaDeviceDiscovery

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:finsedonaDeviceDiscoveryConfig

finsedonaDeviceDiscoveryConfig()

---

meta

def	func:finsedonaDeviceDiscoveryConfig
is	func
lib	lib:finstack
name	finsedonaDeviceDiscoveryConfig

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:modifyNavMetaOptional

modifyNavMetaOptional(level, position: "")

Axon function

---

meta

def	func:modifyNavMetaOptional
is	func
lib	lib:finstack
name	modifyNavMetaOptional

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

src

(level, position: "") => do
  level1 : level

  if(position != "" and position.startsWith("[") and position.endsWith("]")) do
  position = position[1..-2]
  end

  if(level1.startsWith("[") and level1.endsWith("]")) do
  level1 = level1[1..-2]
  end

  navMetaValue: read(navMeta).toRec.get("equipPath")
  navMetaValue1: "/" + navMetaValue + "/"

  if(navMetaValue1.contains("/" + level1 + "/") or navMetaValue1.contains("/[" + level1 + "]/")) do
  return "yesLevel"
  end
  else if(not (navMetaValue1.contains("/" + position + "/") or navMetaValue1.contains("/[" + position + "]/"))) do
  return {"noPosition", value: position, navMeta: navMetaValue1}
  end
  else do
  if(position == "") do
    navMetaValue = "/" + level + navMetaValue
      return navMetaValue
    end
  else do
    if(navMetaValue1.contains("/[" + position + "]/")) do
    navMetaValue = navMetaValue.replace("[" + position + "]", "[" + position + "]" + "/" + level)
    return navMetaValue
    end
    else do
    navMetaValue = navMetaValue.replace(position, position + "/" + level)
    return navMetaValue
    end
  end
  end
end

---

---

def

globalCont

Defines usage in Global Control

---

meta

def	globalCont
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

helpDoc

Path to help documentation

---

meta

def	helpDoc
is	str
lib	lib:finstack

---

supertypes

val	Data value type
scalar	Scalar is an atomic value kind
str	Unicode string of characters

---

---

def

hideFromMobileDB

Hide from database builder

---

meta

def	hideFromMobileDB
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

hideMobile

Used to hide forms in mobile

---

meta

def	hideMobile
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

noDoc

Documentation Ignore Tag

---

meta

def	noDoc
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

obsolete

Marks a function as obsolete and that it needs to be reviewed before removal.

---

meta

def	obsolete
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

polyStats

---

meta

def	polyStats
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

poo

Useless

---

meta

def	poo
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

private

Marks the function as private

---

meta

def	private
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

queryString

---

meta

def	queryString
is	str
lib	lib:finstack

---

supertypes

val	Data value type
scalar	Scalar is an atomic value kind
str	Unicode string of characters

---

---

def

relationshipFunc

Indentifies functions that hold pre-configured relationships.

---

meta

def	relationshipFunc
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

relationshipTree

Related to dbAddEdit; specifies that the add/edit logic belongs to the relationship tree.

---

meta

def	relationshipTree
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

savedQueryFilterTree

Related to dbAddEdit; specifies that the add/edit logic belongs to the savedQueryFilter tree.

---

meta

def	savedQueryFilterTree
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

summs

---

meta

def	summs
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

tagBundleFunc

Indentifies functions that hold pre-configured tag bundles.

---

meta

def	tagBundleFunc
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

tagBundleTree

Related to dbAddEdit; specifies that the add/edit logic belongs to the tag bundle tree.

---

meta

def	tagBundleTree
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

templateTree

Related to dbAddEdit; specifies that the add/edit logic belongs to the template tree.

---

meta

def	templateTree
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

timez

Definition of a timezone function

---

meta

def	timez
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

topics

---

meta

def	topics
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information

---

---

def

uiFormOn

uiForm Record Selector Tag

---

meta

def	uiFormOn
is	str
lib	lib:finstack

---

supertypes

val	Data value type
scalar	Scalar is an atomic value kind
str	Unicode string of characters

---

---

def

update

---

meta

def	update
is	marker
lib	lib:finstack

---

supertypes

marker	Marker labels a dict with typing information