Skip to content

lib-skyarc 库参考 ​

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

导读: Skyarc 图书馆模块

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


目录(导读) ​

  • lib
  • meta
  • tags
  • ops
  • filetypes
  • apps
  • funcs
  • views
  • def
  • supertypes
  • enum
  • tags
  • actionNormInput(arg, type)
  • chart(val)
  • deprecatedTags()
  • ext(name, checked: true)
  • extAdd(name)
  • extRemove(name)
  • extSettings(extName, opts: {})
  • extSettingsCommit(arg)
  • exts()
  • feed(stream)
  • hostMeta()
  • hostVars()
  • licStatus()
  • lint(recs, opts: null)
  • pivot(input, shape)
  • projSync(timeout: null)
  • recDelete(refs)
  • recDisable(refs)
  • recDup(refs)
  • recEdit(dict)
  • recEnable(refs)
  • recForm(rec, templateName, opts: null)
  • recFormCommit(dict)
  • recNew(dict)
  • recTrash(refs)
  • renameTags(recs, renames, opts: null)
  • sysModAdd(name, opts: null)
  • sysModRemove(name, opts: null)
  • sysMods()
  • sysReload(podNames: null)
  • table(val)
  • validateFilter(s)
  • validateNotBlank(s)
  • validateTagName(s)
  • validateUsername(s)

概述(中译) ​

Skyarc 图书馆模块


API 正文(英文) ​

tags ​

addOnFeature which may be enabled or disabled at runtime
alsoSeeLegacy tag definitions
appUI application grouping of views
appNameView containing app name
auditCommitLog each time a diff is committed to the folio database
betaIndicates a beta quality definition
colorColor encoded as #RRGGBB, #RGB, or a CSS color keyword
confirmUsed on actions to prompt for confirmation
curRuleMarker tag for a cur rule type
currencyThe currency unit related to the entity
defNameSpecifies definition symbol name to use
defValDefault value
emailAn email address
enumExprAxon expression to dynamically compute an enum
enumxExtened enum tag definitions
expiresExpiration date
extExtension library
favFavorite saved view link
fontWeightFont weight setting
halignHorizontal layout alignment
haystackApiFunction which is a published Hasytack REST API op
helpEnd user documentation
hiddenHide a column in a table or a field on a form
hisFuncReadyIndicates a function designed to be used directly as a computed history
hisSrcLegacy 2.1 support for function picker in History App
hotKeyOne or more key combinations separated by a comma
iconIcon logical name - see Icons
imageSizeImage size in pixels
kpiRuleMarker tag for a KPI rule type
libStatusCurrent status of an extension or sys module library
licStatusLicense status
logLevelSeverity level
multiIndicates multiple selection
navAuxFilterApply extra filter string to a navigation tree
navClusterSelect from all the nodes in the cluster
navHiddenHide an entity in the navigation selection pickers
navNameNavigation name commonly used with disMacro to create computed display strings
navSelAnySelect any level of a navigation tree which might include groupings
navSelAnyRecSelect any level of a navigation tree which maps to Folio record
navTargetApply to a def to specify a default navigation target
navTreeNavigation tree name to use for ref tag
optionalNot required
optsTemplateTODO
orderUsed to order definitions
pageSizePrinted page size formatted as "width,height" with an explicit unit of "pt", "in", "mm", or "cm"
percentageA percentage specified as as <percent> * 100
placeholderHint displayed in a text field input
podNameFantom pod name
projIncludeFilterSelects other projects to include in UI navigation
readonlyIndicates a value which may be read, but not written
refreshIndicates an operation which requires a page refresh
restartIndicates a setting which requires restart when modified
ruleOnTarget filter for a rule or rule ready func
ruleTypeRule type choice
selectUsed on an action to use current selection
showDisShow display names in UI instead of programmatic names
spanModesRestrict Span input modes
sparkRuleMarker tag for a spark rule type
sysModSystem module library
tagLegacy backward compatible tag definitions
templateNameTemplate by name - legacy support
timeoutMaximum elapsed time to allow an operation to continue
tsTimestamp
unitlessHide the unit picker for a number field
usedWithLegacy tag definitions
validateAxon expression to validate def
viewFresco UI view
viewLinkView name and state for linking to a saved view

ops ​

exportExport a view to a file
extExt specific HTTP servicing
recGet a record by id

filetypes ​

htmlHyperText Markup Language
pdfPortable Document Format
svgScalable Vector Graphics

apps ​

builderViews used to build the database
codeViews used to edit and manage the function library
connViews used to manage and debug connectors
debugViews used for system diagnostics
docViews used to browse the documentation
favsViews used to browse and manage your saved favorites
homeHome screen showing the available applications
hostViews used to manage the system which hosts the software
miscContainer for ad hoc views
monitorViews used to visualize real-time point data
platformPlatform level configuration and management
settingsViews used to edit SysMod and Ext settings
toolsViews used for administration including the Axon shell
usersViews used to manage user accounts

funcs ​

actionNormInputNormalize action input - see Committer.actionNormInput
chartSet the grid visualization view to chart
deprecatedTagsReturn tags which have been deprecated as grid with following columns
extReturn extension record for given extension name
extAddEnable the given extension name or list of names
extRemoveDisable the given extension name or list of names
extSettingsReturn ext settings form data - see Exts
extSettingsCommitSubmit function for extSettings() - see Exts
extsGet the list of exts and their current status
feedConvert a stream into a live feed to populate a view
hostMetaRead host metadata dict
hostVarsRead host variables dict
licStatusReturn current licensing status as Dict with following tags
lintRun the lint report on the given recs
pivotTransform a grid to a pivot table - see Axon Usage
projSyncBlock until all folio/project message queues are fully processed
recDeleteRecord delete action
recDisableRecord disable action
recDupRecord duplicate action
recEditRecord edit action
recEnableRecord enable action
recFormReturn a data grid for a form view to edit the specified record
recFormCommitCommit a rec based form to Folio
recNewRecord create action
recTrashRecord trash action
renameTagsRename a set of tags on a list of records or across the entire project database
sysModAddEnable the given system module name such as "ldap"
sysModRemoveDisable the given system module name
sysModsList the installed system mods
sysReloadForce a system reload
tableSet the grid visualization view to table
validateFilterRaise an exception if string is not valid filter
validateNotBlankRaise an exception if string is blank
validateTagNameRaise an exception if string is not a validate tag name
validateUsernameRaise an excpetion if string is not a validate username

views ​

alertsDisplay system alerts such as licensing errors
apiSettingsSettings for the API system module
blankPlaceholder with no content
cardDisplay each row of a grid as a formatted card
chartDisplay grid data as a chart
cryptoManage cryto trust store
debugHostDebug of host level system modules
debugSupportGather support diagnostics
diagDiagnostics dashboard with real-time graphs
docDocumentation viewer
emailSettingsSettings for the email system module
fandocDisplay fandoc markup as stylized content
formDisplay a dict for editing using a form layout
hostSettingsSettings for the host system module
httpSettingsSettings for the HTTP system module
iframeDisplay a URI as an embedded HTML iframe
licsManage software license files
logSystem log browser
logSettingsSettings for the logging system module
pageDisplay subviews as a linear page-oriented report
pageBreakUse in a page view to force a page break during PDF generation
podsDebug all installed pod modules
sessionSettingsSettings for the session system module
sessionsDebug user sessions
sysModSettingsEnable and disable system modules
tableDisplay grid data as a two dimensional table
textDisplay grid data as preformatted plain text
threadsDebug thread traces and deadlocks
tileDisplay subviews using a preconfigured tile layout


def ​

addOn ​

Feature which may be enabled or disabled at runtime


meta ​

defaddOn
ismarker
liblib:skyarc

supertypes ​

markerMarker labels a dict with typing information


def ​

alsoSee ​

Legacy tag definitions


meta ​

defalsoSee
isstr
liblib:skyarc

supertypes ​

valData value type
scalarScalar is an atomic value kind
strUnicode string of characters


def ​

app ​

UI application grouping of views. See Apps


meta ​

defapp
iconapp
isfeature
liblib:skyarc

supertypes ​

featureFeature namespace of definitions formatted as feature:name


def ​

appName ​

View containing app name


meta ​

defappName
isstr
liblib:skyarc
uiInputui::AppNameInput

supertypes ​

valData value type
scalarScalar is an atomic value kind
strUnicode string of characters


def ​

app:builder ​

Views used to build the database


meta ​

defapp:builder
disKeyui::builder
iconcompassDraft
isapp
liblib:skyarc

supertypes ​

featureFeature namespace of definitions formatted as feature:name
appUI application grouping of views


def ​

app:code ​

Views used to edit and manage the function library


meta ​

defapp:code
disKeyui::code
iconide
isapp
liblib:skyarc

supertypes ​

featureFeature namespace of definitions formatted as feature:name
appUI application grouping of views


def ​

app:conn ​

Views used to manage and debug connectors


meta ​

defapp:conn
disKeyui::connector
iconconn
isapp
liblib:skyarc

supertypes ​

featureFeature namespace of definitions formatted as feature:name
appUI application grouping of views


def ​

app:debug ​

Views used for system diagnostics


meta ​

defapp:debug
disKeyui::debug
icondebug
isapp
liblib:skyarc

supertypes ​

featureFeature namespace of definitions formatted as feature:name
appUI application grouping of views


def ​

app:doc ​

Views used to browse the documentation


meta ​

defapp:doc
disKeyui::doc
iconhelp
isapp
liblib:skyarc

supertypes ​

featureFeature namespace of definitions formatted as feature:name
appUI application grouping of views


def ​

app:favs ​

Views used to browse and manage your saved favorites


meta ​

defapp:favs
disKeyui::favorites
iconstar
isapp
liblib:skyarc

supertypes ​

featureFeature namespace of definitions formatted as feature:name
appUI application grouping of views


def ​

app:home ​

Home screen showing the available applications


meta ​

defapp:home
disKeyui::home
iconhome
isapp
liblib:skyarc

supertypes ​

featureFeature namespace of definitions formatted as feature:name
appUI application grouping of views


def ​

app:host ​

Views used to manage the system which hosts the software


meta ​

defapp:host
disKeyui::host
iconhost
isapp
liblib:skyarc

supertypes ​

featureFeature namespace of definitions formatted as feature:name
appUI application grouping of views


def ​

app:misc ​

Container for ad hoc views


meta ​

defapp:misc
disKeyui::misc
iconfolder
isapp
liblib:skyarc

supertypes ​

featureFeature namespace of definitions formatted as feature:name
appUI application grouping of views


def ​

app:monitor ​

Views used to visualize real-time point data


meta ​

defapp:monitor
disKeyui::monitor
icongauge
isapp
liblib:skyarc

supertypes ​

featureFeature namespace of definitions formatted as feature:name
appUI application grouping of views


def ​

app:platform ​

Platform level configuration and management


meta ​

defapp:platform
disKeyui::platform
iconcpu
isapp
liblib:skyarc

supertypes ​

featureFeature namespace of definitions formatted as feature:name
appUI application grouping of views


def ​

app:settings ​

Views used to edit SysMod and Ext settings


meta ​

defapp:settings
disKeyui::settings
iconsettings
isapp
liblib:skyarc

supertypes ​

featureFeature namespace of definitions formatted as feature:name
appUI application grouping of views


def ​

app:tools ​

Views used for administration including the Axon shell


meta ​

defapp:tools
disKeyui::tools
icontoolbox
isapp
liblib:skyarc

supertypes ​

featureFeature namespace of definitions formatted as feature:name
appUI application grouping of views


def ​

app:users ​

Views used to manage user accounts


meta ​

defapp:users
disKeyui::user
iconuser
isapp
liblib:skyarc

supertypes ​

featureFeature namespace of definitions formatted as feature:name
appUI application grouping of views


def ​

auditCommit ​

Log each time a diff is committed to the folio database. See Security.


meta ​

defauditCommit
ismarker
liblib:skyarc

supertypes ​

markerMarker labels a dict with typing information


def ​

beta ​

Indicates a beta quality definition. Beta features might not should be used with caution as they might not provide production quality or might change over time.


meta ​

defbeta
ismarker
liblib:skyarc

supertypes ​

markerMarker labels a dict with typing information


def ​

color ​

Color encoded as #RRGGBB, #RGB, or a CSS color keyword


meta ​

defcolor
isstr
liblib:skyarc
tagOnrule
uiInputui::ColorInput

supertypes ​

valData value type
scalarScalar is an atomic value kind
strUnicode string of characters


def ​

confirm ​

Used on actions to prompt for confirmation. Value is dict with following tags:

  • icon: logical icon name (typically "warn")
  • dis/disKey: display title for the confirmation dialog
  • details/detailsKey: additional details

meta ​

defconfirm
isdict
liblib:skyarc

supertypes ​

valData value type
dictMap of name/value tag pairs


def ​

curRule ​

Marker tag for a cur rule type. See rule.


meta ​

defcurRule
isruleType
liblib:skyarc
uiInputui::ChoiceInput

supertypes ​

markerMarker labels a dict with typing information
choiceChoice specifies an exclusive marker selection
ruleTypeRule type choice


def ​

currency ​

The currency unit related to the entity


meta ​

defcurrency
enumSee below
isunit
liblib:skyarc
tagOntariff
uiInputui::UnitInput

enum ​

%percent (dimensionless)
%RHpercent_relative_humidity (dimensionless)
pxpixel (dimensionless)
dbdecibel (dimensionless)
pfpower_factor (dimensionless)
pHph (dimensionless)
gH₂O/kgAirgrams_of_water_per_kilogram_dry_air (dimensionless)
V/Kvolts_per_degree_kelvin (dimensionless)
°daysCdegree_days_celsius (dimensionless)
°daysFdegree_days_fahrenheit (dimensionless)
%obsc/ftpercent_obscuration_per_foot (dimensionless)
%obsc/mpercent_obscuration_per_meter (dimensionless)
psi/°Fpsi_per_degree_fahrenheit (dimensionless)
m²/Nsquare_meters_per_newton (dimensionless)
W/m²Kwatts_per_square_meter_degree_kelvin (dimensionless)
dBmVdb_millivolt (dimensionless)
dBµVdb_microvolt (dimensionless)
ppuparts_per_unit (dimensionless)
ppmparts_per_million (dimensionless)
ppbparts_per_billion (dimensionless)
g/kggrams_per_kilogram (dimensionless)
radradian (dimensionless)
degdegrees_angular (dimensionless)
degPhdegrees_phase (dimensionless)
srsteradian (dimensionless)
ntunephelometric_turbidity_units (dimensionless)
fnuformazin_nephelometric_unit (dimensionless)
PUEpower_usage_effectiveness (dimensionless)
DCIEdata_center_infrastructure_efficiency (dimensionless)
Afafghani (currency)
DZDalgerian_dinar (currency)
ARSargentine_peso (currency)
Դarmenian_dram (currency)
ƒaruban_guilder_florin (currency)
AUDaustralian_dollar (currency)
манazerbaijanian_manat (currency)
BSDbahamian_dollar (currency)
BHDbahraini_dinar (currency)
฿baht (currency)
PABbalboa (currency)
BBDbarbados_dollar (currency)
Brbelarussian_ruble (currency)
BZDbelize_dollar (currency)
BMDbermudian_dollar (currency)
VEFbolivar_fuerte (currency)
BOBboliviano (currency)
R$brazilian_real (currency)
BNDbrunei_dollar (currency)
лвbulgarian_lev (currency)
BIFburundi_franc (currency)
CADcanadian_dollar (currency)
CVEcape_verde_escudo (currency)
KYDcayman_islands_dollar (currency)
₵cedi (currency)
XAFcfa_franc_bceao (currency)
XPFcfp_franc (currency)
CLPchilean_peso (currency)
元chinese_yuan (currency)
CDFcongolese_franc (currency)
C$cordoba_oro (currency)
₡costa_rican_colon (currency)
Kncroatian_kuna (currency)
CUPcuban_peso (currency)
Kčczech_koruna (currency)
GMDdalasi (currency)
krdanish_krone (currency)
денdenar (currency)
DJFdjibouti_franc (currency)
Dbdobra (currency)
DOPdominican_peso (currency)
₫dong (currency)
XCDeast_caribbean_dollar (currency)
EGPegyptian_pound (currency)
ETBethiopian_birr (currency)
€euro (currency)
FKPfalkland_islands_pound (currency)
FJDfiji_dollar (currency)
HUFforint (currency)
GIPgibraltar_pound (currency)
HTGgourde (currency)
₲guarani (currency)
GNFguinea_franc (currency)
GYDguyana_dollar (currency)
HKDhong_kong_dollar (currency)
₴hryvnia (currency)
Kriceland_krona (currency)
₹indian_rupee (currency)
IRRiranian_rial (currency)
IQDiraqi_dinar (currency)
JMDjamaican_dollar (currency)
JODjordanian_dinar (currency)
Shkenyan_shilling (currency)
PGKkina (currency)
₭kip (currency)
КМkonvertibilna_marka (currency)
KWDkuwaiti_dinar (currency)
MKkwacha (currency)
Kzkwanza (currency)
MMKkyat (currency)
ლlari (currency)
LBPlebanese_pound (currency)
ALLlek (currency)
HNLlempira (currency)
Leleone (currency)
RONleu (currency)
LRDliberian_dollar (currency)
LYDlibyan_dinar (currency)
SZLlilangeni (currency)
LSLloti (currency)
MGAmalagasy_ariary (currency)
RMmalaysian_ringgit (currency)
TMTmanat (currency)
MURmauritius_rupee (currency)
MTnmetical (currency)
MXNmexican_peso (currency)
MDLmoldavian_leu (currency)
MADmoroccan_dirham (currency)
₦naira (currency)
Nfknakfa (currency)
NADnamibia_dollar (currency)
NPRnepalese_rupee (currency)
₪new_israeli_shekel (currency)
NZDnew_zealand_dollar (currency)
BTNngultrum (currency)
KPWnorth_korean_won (currency)
NOKnorwegian_krone (currency)
PENnuevo_sol (currency)
UMouguiya (currency)
₨pakistan_rupee (currency)
MOPpataca (currency)
UYUpeso_uruguayo (currency)
₱philippine_peso (currency)
£pound_sterling (currency)
BWPpula (currency)
złpzloty (currency)
QARqatari_rial (currency)
GTQquetzal (currency)
ZARrand (currency)
OMRrial_omani (currency)
KHRriel (currency)
MVRrufiyaa (currency)
Rprupiah (currency)
RUBrussian_ruble (currency)
RWFrwanda_franc (currency)
SHPsaint_helena_pound (currency)
SARsaudi_riyal (currency)
dinserbian_dinar (currency)
SCRseychelles_rupee (currency)
SGDsingapore_dollar (currency)
SBDsolomon_islands_dollar (currency)
KGSsom (currency)
SOSsomali_shilling (currency)
ЅМsomoni (currency)
₩south_korean_won (currency)
Rssri_lanka_rupee (currency)
SDGsudanese_pound (currency)
SRDsuriname_dollar (currency)
SEKswedish_krona (currency)
SFrswiss_franc (currency)
SYPsyrian_pound (currency)
TWDtaiwan_dollar (currency)
৳taka (currency)
WSTtala (currency)
TZStanzanian_shilling (currency)
〒tenge (currency)
TTDtrinidad_and_tobago_dollar (currency)
₮tugrik (currency)
TNDtunisian_dinar (currency)
₤turkish_lira (currency)
AEDuae_dirham (currency)
UGXuganda_shilling (currency)
$us_dollar (currency)
UZSuzbekistan_sum (currency)
Vtvatu (currency)
YERyemeni_rial (currency)
¥yen (currency)
ZKzambian_kwacha (currency)
ZWLzimbabwe_dollar (currency)
m/s²meters_per_second_squared (acceleration)
rad/s²radians_per_second_squared (angular acceleration)
Jsjoule_second (angular momentum)
rad/sradians_per_second (angular velocity)
rpmrevolutions_per_minute (angular velocity)
m²square_meter (area)
mm²square_millimeter (area)
cm²square_centimeter (area)
km²square_kilometer (area)
in²square_inch (area)
ft²square_foot (area)
yd²square_yard (area)
mile²square_mile (area)
acreacre (area)
Ffarad (capacitance)
COPcoefficient_of_performance (cooling efficiency)
EERenergy_efficiency_ratio (cooling efficiency)
kW/tonkilowatt_per_ton (cooling efficiency)
kg/m³kilograms_per_cubic_meter (density)
g/m³grams_per_cubic_meter (density)
mg/m³milligrams_per_cubic_meter (density)
µg/m³micrograms_per_cubic_meter (density)
kg/Lkilograms_per_liter (density)
mg/Lmilligrams_per_liter (density)
Ccoulomb (electric charge)
Ahampere_hour (electric charge)
Ssiemens (electric conductance)
Aampere (electric current)
mAmilliampere (electric current)
Am²ampere_square_meter (electromagnetic moment)
A/m²amperes_per_square_meter (electric current density)
V/mvolts_per_meter (electric field strength)
Vvolt (electric potential)
mVmillivolt (electric potential)
kVkilovolt (electric potential)
MVmegavolt (electric potential)
Ωohm (electric resistance)
kΩkilohm (electric resistance)
MΩmegohm (electric resistance)
mΩmilliohm (electric resistance)
S/msiemens_per_meter (electrical conductivity)
Ωmohm_meter (electrical resistivity)
Jjoule (energy)
kJkilojoule (energy)
Whwatt_hour (energy)
kWhkilowatt_hour (energy)
MWhmegawatt_hour (energy)
GWhgigawatt_hour (energy)
BTUbtu (energy)
kBTUkilobtu (energy)
MMBTUmegabtu (energy)
hphhorsepower_hour (energy)
calcalorie (energy)
thermtherm (energy)
tonrefhtons_refrigeration_hour (energy)
MJmegajoule (energy)
GJgigajoule (energy)
Nmnewton_meter (energy)
m³_gascubic_meters_natural_gas (energy)
ft³_gascubic_feet_natural_gas (energy)
Hcf_natural_gashundred_cubic_feet_natural_gas (energy)
Ccf_natural_gascentum_cubic_feet_natural_gas (energy)
Mcf_natural_gasthousand_cubic_feet_natural_gas (energy)
MMcf_natural_gasmillion_cubic_feet_natural_gas (energy)
VAhvolt_ampere_hour (apparent energy)
kVAhkilovolt_ampere_hour (apparent energy)
MVAhmegavolt_ampere_hour (apparent energy)
VARhvolt_ampere_reactive_hour (reactive energy)
kVARhkilovolt_ampere_reactive_hour (reactive energy)
MVARhmegavolt_ampere_reactive_hour (reactive energy)
J/m²joules_per_square_meter (energy by area)
Wh/m²watt_hours_per_square_meter (energy by area)
Wh/ft²watt_hours_per_square_foot (energy by area)
kWh/m²kilowatt_hours_per_square_meter (energy by area)
kWh/ft²kilowatt_hours_per_square_foot (energy by area)
MWh/m²megawatt_hours_per_square_meter (energy by area)
MWh/ft²megawatt_hours_per_square_foot (energy by area)
MJ/m²megajoules_per_square_meter (energy by area)
MJ/ft²megajoules_per_square_foot (energy by area)
BTU/ft²btu_per_square_foot (energy by area)
kBTU/ft²kilobtu_per_square_foot (energy by area)
MBTU/ft²megabtu_per_square_foot (energy by area)
J/m³joules_per_cubic_meter (energy by volume)
GJ/m³gigajoules_per_cubic_meter (energy by volume)
kWh/m³kilowatt_hours_per_cubic_meter (energy by volume)
J/gjoules_per_gram (enthalpy)
J/kgjoules_per_kilogram (enthalpy)
J/kg_dryjoules_per_kilogram_dry_air (enthalpy)
BTU/lbbtu_per_pound (enthalpy)
btu/lb_drybtus_per_pound_dry_air (enthalpy)
kJ/kgkilojoules_per_kilogram (enthalpy)
kJ/kg_drykilojoules_per_kilogram_dry_air (enthalpy)
MJ/kg_drymegajoules_per_kilogram_dry_air (enthalpy)
cal/gcalorie_per_gram (enthalpy)
J/°Kjoules_per_degree_kelvin (entropy)
kJ/°Kkilojoules_per_degree_kelvin (entropy)
MJ/°Kmegajoules_per_degree_kelvin (entropy)
Nnewton (force)
lbfpound_force (force)
Hzhertz (frequency)
kHzkilohertz (frequency)
cphcycles_per_hour (frequency)
cpmcycles_per_minute (frequency)
MHzmegahertz (frequency)
/minper_minute (frequency)
/sper_second (frequency)
/hper_hour (frequency)
%/spercent_per_second (frequency)
ACHair_changes_per_hour (frequency)
kg/m²kilograms_per_square_meter (grammage)
g/m²grams_per_square_meter (grammage)
K/sdegrees_kelvin_per_second (heating rate)
°C/hdegrees_celsius_per_hour (heating rate)
°C/mindegrees_celsius_per_minute (heating rate)
°F/hdegrees_fahrenheit_per_hour (heating rate)
°F/mindegrees_fahrenheit_per_minute (heating rate)
K/hdegrees_kelvin_per_hour (heating rate)
K/mindegrees_kelvin_per_minute (heating rate)
lxlux (illuminance)
fcfootcandle (illuminance)
photphot (illuminance)
Hhenry (inductance)
W/m²_irrwatts_per_square_meter_irradiance (irradiance)
W/ft²_irrwatts_per_square_foot_irradiance (irradiance)
mmeter (length)
µmmicrometer (length)
mmmillimeter (length)
cmcentimeter (length)
kmkilometer (length)
ininch (length)
ftfoot (length)
ydyard (length)
milemile (length)
cd/m²candelas_per_square_meter (luminance)
cd/ft²candels_per_square_foot (luminance)
lmlumen (luminous flux)
cdcandela (luminous intensity)
A/mamperes_per_meter (magnetic field strength)
Wbweber (magnetic flux)
Ttesla (magnetic flux density)
kgkilogram (mass)
mgmilligram (mass)
ggram (mass)
ozounce (mass)
lbpound (mass)
klbkilopound (mass)
tonmetric_ton (mass)
tshort_ton (mass)
kg/skilograms_per_second (mass flow)
kg/minkilograms_per_minute (mass flow)
kg/hkilograms_per_hour (mass flow)
lb/minpounds_per_minute (mass flow)
lb/hpounds_per_hour (mass flow)
lb/spounds_per_second (mass flow)
klb/hkilopounds_per_hour (mass flow)
g/sgrams_per_second (mass flow)
g/mingrams_per_minute (mass flow)
ton/hmetric_tons_per_hour (mass flow)
Nsnewton_second (momentum)
Wwatt (power)
mWmilliwatt (power)
kWkilowatt (power)
MWmegawatt (power)
GWgigawatt (power)
BTU/hbtus_per_hour (power)
therm/htherms_per_hour (power)
hphorsepower (power)
ftlbs/secfoot_pounds_per_second (power)
tonreftons_refrigeration (power)
kBTU/hkilobtus_per_hour (power)
MMBTU/hmegabtus_per_hour (power)
J/hjoules_per_hour (power)
kJ/hkilojoules_per_hour (power)
MJ/hmegajoules_per_hour (power)
GJ/hgigajoules_per_hour (power)
W/m²watts_per_square_meter (power by area)
W/ft²watts_per_square_foot (power by area)
kW/m²kilowatts_per_square_meter (power by area)
kW/ft²kilowatts_per_square_foot (power by area)
kBTU/h/ft²kilobtus_per_hour_per_square_foot (power by area)
W/m³/swatts_per_cubic_meters_per_second (power by volumetric flow)
W/cfmwatts_per_cubic_feet_per_minute (power by volumetric flow)
kW/kcfmkilowatts_per_kilocubic_feet_per_minute (power by volumetric flow)
kW/gal/minkilowatts_per_gallons_per_minute (power by volumetric flow)
VAvolt_ampere (apparent power)
kVAkilovolt_ampere (apparent power)
mVAmegavolt_ampere (apparent power)
VARvolt_ampere_reactive (reactive power)
kVARkilovolt_ampere_reactive (reactive power)
MVARmegavolt_ampere_reactive (reactive power)
Papascal (pressure)
kPakilopascal (pressure)
barbar (pressure)
atmatmosphere (pressure)
psipounds_per_square_inch (pressure)
cmH₂Ocentimeters_of_water (pressure)
inH₂Oinches_of_water (pressure)
mmHgmillimeters_of_mercury (pressure)
cmHgcentimeters_of_mercury (pressure)
inHginches_of_mercury (pressure)
hPahectopascal (pressure)
mbarmillibar (pressure)
J/kg°Kjoules_per_kilogram_degree_kelvin (specific entropy)
N/mnewtons_per_meter (surface tension)
°Ffahrenheit (temperature)
°Ccelsius (temperature)
Kkelvin (temperature)
Δ°Ffahrenheit_degrees (temperature differential)
Δ°Ccelsius_degrees (temperature differential)
ΔKkelvin_degrees (temperature differential)
W/m°Kwatts_per_meter_degree_kelvin (thermal conductivity)
nsnanosecond (time)
µsmicrosecond (time)
msmillisecond (time)
cshundredths_second (time)
dstenths_second (time)
secsecond (time)
minminute (time)
hrhour (time)
dayday (time)
wkweek (time)
mojulian_month (time)
yryear (time)
m/smeters_per_second (velocity)
km/skilometers_per_second (velocity)
km/hkilometers_per_hour (velocity)
mphmiles_per_hour (velocity)
ft/sfeet_per_second (velocity)
ft/minfeet_per_minute (velocity)
in/hinches_per_hour (velocity)
mm/smillimeters_per_second (velocity)
mm/minmillimeters_per_minute (velocity)
mm/hmillimeters_per_hour (velocity)
m/minmeters_per_minute (velocity)
m/hmeters_per_hour (velocity)
knotknot (velocity)
cfm/ft²cubic_feet_per_minute_per_square_foot (velocity)
m³cubic_meter (volume)
mm³cubic_millimeter (volume)
cm³cubic_centimeter (volume)
mLmilliliter (volume)
hLhectoliter (volume)
Lliter (volume)
kLkiloliter (volume)
in³cubic_inch (volume)
ft³cubic_foot (volume)
yd³cubic_yard (volume)
galgallon (volume)
kgalkilogallon (volume)
qtquart (volume)
ptpint (volume)
fl_ozfluid_ounce (volume)
galUKimperial_gallon (volume)
hft³hecto_cubic_foot (volume)
Hcfhundred_cubic_feet (volume)
Ccfcentum_cubic_feet (volume)
Mcfthousand_cubic_feet (volume)
MMcfmillion_cubic_feet (volume)
m³/scubic_meters_per_second (volumetric flow)
mL/smilliliters_per_second (volumetric flow)
hL/shectoliters_per_second (volumetric flow)
L/sliters_per_second (volumetric flow)
cfscubic_feet_per_second (volumetric flow)
cfmcubic_feet_per_minute (volumetric flow)
cfhcubic_feet_per_hour (volumetric flow)
kcfmkilocubic_feet_per_minute (volumetric flow)
galUK/minimperial_gallons_per_minute (volumetric flow)
L/minliters_per_minute (volumetric flow)
gal/mingallons_per_minute (volumetric flow)
gphgallons_per_hour (volumetric flow)
L/hliters_per_hour (volumetric flow)
m³/mincubic_meters_per_minute (volumetric flow)
m³/hcubic_meters_per_hour (volumetric flow)
bytebyte (bytes)
kBkilobyte (bytes)
MBmegabyte (bytes)
GBgigabyte (bytes)
TBterabyte (bytes)
PBpetabyte (bytes)

supertypes ​

valData value type
scalarScalar is an atomic value kind
strUnicode string of characters
unitUnit identifier from standard unit database


def ​

defName ​

Specifies definition symbol name to use


meta ​

defdefName
isstr
liblib:skyarc

supertypes ​

valData value type
scalarScalar is an atomic value kind
strUnicode string of characters


def ​

defVal ​

Default value


meta ​

defdefVal
isval
liblib:skyarc
tagOnfinSetting

supertypes ​

valData value type


def ​

email ​

An email address


meta ​

defemail
isstr
liblib:skyarc
tagOnuser

supertypes ​

valData value type
scalarScalar is an atomic value kind
strUnicode string of characters


def ​

enumExpr ​

Axon expression to dynamically compute an enum. This tag is used on view inputs to display a dropdown that is populated via a call to the server. The function should return one of the standardized enum value types (typically a list of strings).

Example:

// Axon function that generates an enum from site names
getSiteEnum: () => do
  readAll(site).toRecList.map(s=>s.dis)
end

// Input variable in a view which uses that enum
dynamicEnum: {var input kind:"Str" enumExpr:"getSiteEnum()"}

meta ​

defenumExpr
isstr
liblib:skyarc

supertypes ​

valData value type
scalarScalar is an atomic value kind
strUnicode string of characters


def ​

enumx ​

Extened enum tag definitions


meta ​

defenumx
isdict
liblib:skyarc

supertypes ​

valData value type
dictMap of name/value tag pairs


def ​

expires ​

Expiration date


meta ​

defexpires
isdate
liblib:skyarc
tagOnuser

supertypes ​

valData value type
scalarScalar is an atomic value kind
dateISO 8601 date as year, month, day


def ​

ext ​

Extension library. Exts are enabled on a per project basis. See Exts


meta ​

defext
islib
liblib:skyarc

supertypes ​

featureFeature namespace of definitions formatted as feature:name
libLibrary module of symbolic definitions

tags ​

baseUriBase URI for normalizing relative URIs
connTuningRefReference to a tuning configuration defined by a connTuning rec
dependsList of this library's dependencies
libStatusCurrent status of an extension or sys module library
versionVersion string formatted as decimal integers separated by a dot


def ​

fav ​

Favorite saved view link.


meta ​

deffav
isentity
liblib:skyarc

supertypes ​

markerMarker labels a dict with typing information
entityTop-level dicts with a unique identifier

tags ​

disDisplay name for an entity
docDocumentation in simplified flavor of markdown
idDefines the unique identifier of an entity in system using a ref value type
viewLinkView name and state for linking to a saved view


def ​

filetype:html ​

HyperText Markup Language


meta ​

deffiletype:html
disHTML
fileExthtml
iconhtml
isfiletype
liblib:skyarc
mimetext/html
writerview::HtmlWriter

supertypes ​

featureFeature namespace of definitions formatted as feature:name
filetypeFile format type definition

tags ​

fileExtFilename extension such as "csv"
mimeMime type formatted as type/subtype


def ​

filetype:pdf ​

Portable Document Format


meta ​

deffiletype:pdf
disPDF
fileExtpdf
iconworksheet
isfiletype
liblib:skyarc
mimeapplication/pdf
optsTemplatepdfOpts
writerview::PdfWriter

supertypes ​

featureFeature namespace of definitions formatted as feature:name
filetypeFile format type definition

tags ​

fileExtFilename extension such as "csv"
mimeMime type formatted as type/subtype


def ​

filetype:svg ​

Scalable Vector Graphics


meta ​

deffiletype:svg
disSVG
fileExtsvg
iconpaintBrush
isfiletype
liblib:skyarc
mimeimage/svg+xml
optsTemplatesvgOpts
writerview::SvgWriter

supertypes ​

featureFeature namespace of definitions formatted as feature:name
filetypeFile format type definition

tags ​

fileExtFilename extension such as "csv"
mimeMime type formatted as type/subtype


def ​

fontWeight ​

Font weight setting


meta ​

deffontWeight
isstr
liblib:skyarc
uiInputui::FontWeightInput

supertypes ​

valData value type
scalarScalar is an atomic value kind
strUnicode string of characters


def ​

func:actionNormInput ​

actionNormInput(arg, type) ​

Normalize action input - see Committer.actionNormInput


meta ​

deffunc:actionNormInput
isfunc
liblib:skyarc
nameactionNormInput

supertypes ​

featureFeature namespace of definitions formatted as feature:name
funcAxon function


def ​

func:chart ​

chart(val) ​

Set the grid visualization view to chart.


meta ​

deffunc:chart
isfunc
liblib:skyarc
namechart

supertypes ​

featureFeature namespace of definitions formatted as feature:name
funcAxon function


def ​

func:deprecatedTags ​

deprecatedTags() ​

Return tags which have been deprecated as grid with following columns:

  • old: original name of tag deprecated
  • new: new tag name which should be used or Remove.val
  • version: SkySpark version when tag was tag was deprecated
  • comment: free form comments about the deprecation

This function can be paired with renameTags() to script migration.


meta ​

admin✓
deffunc:deprecatedTags
isfunc
liblib:skyarc
namedeprecatedTags

supertypes ​

featureFeature namespace of definitions formatted as feature:name
funcAxon function


def ​

func:ext ​

ext(name, checked: true) ​

Return extension record for given extension name. If extension is not enabled then raise exception or return null based on checked flag.

Examples:

ext("haystack")          // rec for haystack extensions
ext("haystack", false)   // return null if haystack not enabled

meta ​

admin✓
deffunc:ext
isfunc
liblib:skyarc
nameext

supertypes ​

featureFeature namespace of definitions formatted as feature:name
funcAxon function


def ​

func:extAdd ​

extAdd(name) ​

Enable the given extension name or list of names. All dependencies must be already enabled.

Examples:

extAdd("bacnet")
extAdd(["bacnet", "opc"])

meta ​

admin✓
deffunc:extAdd
isfunc
liblib:skyarc
nameextAdd

supertypes ​

featureFeature namespace of definitions formatted as feature:name
funcAxon function


def ​

func:extRemove ​

extRemove(name) ​

Disable the given extension name or list of names. Raise exception if other extensions currently depend on this one.

Examples:

extRemove("bacnet")
extRemove(["bacnet", "opc"])

meta ​

admin✓
deffunc:extRemove
isfunc
liblib:skyarc
nameextRemove

supertypes ​

featureFeature namespace of definitions formatted as feature:name
funcAxon function


def ​

func:extSettings ​

extSettings(extName, opts: {}) ​

Return ext settings form data - see Exts


meta ​

admin✓
deffunc:extSettings
isfunc
liblib:skyarc
nameextSettings

supertypes ​

featureFeature namespace of definitions formatted as feature:name
funcAxon function


def ​

func:extSettingsCommit ​

extSettingsCommit(arg) ​

Submit function for extSettings() - see Exts


meta ​

admin✓
deffunc:extSettingsCommit
isfunc
liblib:skyarc
nameextSettingsCommit

supertypes ​

featureFeature namespace of definitions formatted as feature:name
funcAxon function


def ​

func:exts ​

exts() ​

Get the list of exts and their current status. Result format is subject to change


meta ​

deffunc:exts
isfunc
liblib:skyarc
nameexts

supertypes ​

featureFeature namespace of definitions formatted as feature:name
funcAxon function


def ​

func:feed ​

feed(stream) ​

Convert a stream into a live feed to populate a view. See Streams


meta ​

deffunc:feed
isfunc
liblib:skyarc
namefeed

supertypes ​

featureFeature namespace of definitions formatted as feature:name
funcAxon function


def ​

func:hostMeta ​

hostMeta() ​

Read host metadata dict


meta ​

deffunc:hostMeta
isfunc
liblib:skyarc
namehostMeta

supertypes ​

featureFeature namespace of definitions formatted as feature:name
funcAxon function


def ​

func:hostVars ​

hostVars() ​

Read host variables dict. This is an arbitary dict of user defined host-level configuration variables which may be configured in the Settings | Host view.


meta ​

deffunc:hostVars
isfunc
liblib:skyarc
namehostVars

supertypes ​

featureFeature namespace of definitions formatted as feature:name
funcAxon function


def ​

func:licStatus ​

licStatus() ​

Return current licensing status as Dict with following tags:

  • dis: summary of licensing status
  • mode: status string
  • usage: current point usage across projects
  • points: licensing capacity
  • level: info, warn, or err
  • devOnly: marker if development only license

meta ​

deffunc:licStatus
isfunc
liblib:skyarc
namelicStatus
su✓

supertypes ​

featureFeature namespace of definitions formatted as feature:name
funcAxon function


def ​

func:lint ​

lint(recs, opts: null) ​

Run the lint report on the given recs. Recs may be any value accepted by toRecList() or if null then lint is run on the entire project. By default lint will only run for 10sec or until it finds 1000 issues. You can adjust these limts via the opts parameter:

  • timeout: max amount of time to run lint (10sec default)
  • limit: max number of issues (1000 default)

Pass {-timeout, -limit} to remove the timeout and limit.

Results are returned as grid with the following columns:

  • id: record id
  • tag: tag name with the lint issue
  • logLevel: either "warn" or "err"
  • msg: issue as string

meta ​

deffunc:lint
isfunc
liblib:skyarc
namelint

supertypes ​

featureFeature namespace of definitions formatted as feature:name
funcAxon function


def ​

func:pivot ​

pivot(input, shape) ​

Transform a grid to a pivot table - see Axon Usage. Note: column names and meta are subject to change.


meta ​

deffunc:pivot
isfunc
liblib:skyarc
namepivot

supertypes ​

featureFeature namespace of definitions formatted as feature:name
funcAxon function


def ​

func:projSync ​

projSync(timeout: null) ​

Block until all folio/project message queues are fully processed.


meta ​

admin✓
deffunc:projSync
isfunc
liblib:skyarc
nameprojSync

supertypes ​

featureFeature namespace of definitions formatted as feature:name
funcAxon function


def ​

func:recDelete ​

recDelete(refs) ​

Record delete action. This function implicitly operates on all contained recs. NOTE: this function should only be used for actions.


meta ​

admin✓
confirm
deffunc:recDelete
disKeyui::delete
isfunc
liblib:skyarc
multi✓
namerecDelete
select✓

supertypes ​

featureFeature namespace of definitions formatted as feature:name
funcAxon function


def ​

func:recDisable ​

recDisable(refs) ​

Record disable action. NOTE: this function should only be used for actions.


meta ​

admin✓
deffunc:recDisable
disKeyui::disable
isfunc
liblib:skyarc
multi✓
namerecDisable
select✓

supertypes ​

featureFeature namespace of definitions formatted as feature:name
funcAxon function


def ​

func:recDup ​

recDup(refs) ​

Record duplicate action. This function implicitly operates on all contained recs. NOTE: this function should only be used for actions.


meta ​

admin✓
confirm
deffunc:recDup
disKeyui::duplicate
isfunc
liblib:skyarc
multi✓
namerecDup
select✓

supertypes ​

featureFeature namespace of definitions formatted as feature:name
funcAxon function


def ​

func:recEdit ​

recEdit(dict) ​

Record edit action. NOTE: this function should only be used for actions.


meta ​

admin✓
deffunc:recEdit
disKeyui::edit
isfunc
liblib:skyarc
multi✓
namerecEdit
select✓

supertypes ​

featureFeature namespace of definitions formatted as feature:name
funcAxon function


def ​

func:recEnable ​

recEnable(refs) ​

Record enable action. NOTE: this function should only be used for actions.


meta ​

admin✓
deffunc:recEnable
disKeyui::enable
isfunc
liblib:skyarc
multi✓
namerecEnable
select✓

supertypes ​

featureFeature namespace of definitions formatted as feature:name
funcAxon function


def ​

func:recForm ​

recForm(rec, templateName, opts: null) ​

Return a data grid for a form view to edit the specified record. If the record is null a new default one is created from the template. See recFormCommit() for the submit action function. TODO: subject to change


meta ​

deffunc:recForm
isfunc
liblib:skyarc
namerecForm

supertypes ​

featureFeature namespace of definitions formatted as feature:name
funcAxon function


def ​

func:recFormCommit ​

recFormCommit(dict) ​

Commit a rec based form to Folio. Also see recForm() TODO: subject to change


meta ​

admin✓
deffunc:recFormCommit
isfunc
liblib:skyarc
namerecFormCommit

supertypes ​

featureFeature namespace of definitions formatted as feature:name
funcAxon function


def ​

func:recNew ​

recNew(dict) ​

Record create action. NOTE: this function should only be used for actions.


meta ​

admin✓
deffunc:recNew
disKeyui::new
isfunc
liblib:skyarc
namerecNew

supertypes ​

featureFeature namespace of definitions formatted as feature:name
funcAxon function


def ​

func:recTrash ​

recTrash(refs) ​

Record trash action. This function implicitly operates on all contained recs. NOTE: this function should only be used for actions.


meta ​

admin✓
confirm
deffunc:recTrash
disKeyui::trash
isfunc
liblib:skyarc
multi✓
namerecTrash
select✓

supertypes ​

featureFeature namespace of definitions formatted as feature:name
funcAxon function


def ​

func:renameTags ​

renameTags(recs, renames, opts: null) ​

Rename a set of tags on a list of records or across the entire project database. This function is easily paired with deprecatedTags() to preview and fix standard tags which are deprecated over time.

The recs parameters specify the recs for the operation. Or pass null to rename every rec in the project database.

The renames parameter may be any of the following shapes:

  • Dict of old to new tag names
  • Grid with old and new columns

If the new value is a string, then the tag is renamed to the given new name. If new value is the Remove value then the tag is simply removed (only if removeOld option passed). If the new value is a conjuct formatted as "foo-bar-baz", then each part is created as a marker tag.

Summary of options:

  • commit: marker to force commit (preview by default)
  • removeOld: remove the old tag (old tag left by default)
  • limit: number of diffs (defaults to 1000)

The default behavior is to preview the changes only and to leave the old tags in place side-by-side with the new tags. To apply the changes pass the commit option. To force removal of the old tags pass the removeOld.

As a saftey measure no more than 1000 diffs are previewed or committed. You can remove the limit by passing -limit in the options. However if removing the limit in a large project, then both thew preview or commit results might be too large to view in the Shell view. In this case, pipe the results to a file using ioWriteZinc().

Examples:

// rename of foo -> bar across all records
// opts: preview, leave old tag, limit 1000
renameTags(null, {foo: "bar"})

// rename of foo -> bar across all records
// opts: commit, remove old tag, no limit
renameTags(null, {foo: "bar"}, {commit, removeOld, -limit})

// remove of foo across all points
// opts: preview, remove old tag, limit 10
readAll(point).renameTags({-foo}, {removeOld, limit:10})

// rename of elecMeter -> elec + meter and steamPlant -> steam + plant
// across all equip records
readAll(equip).renameTags({elecMeter: "elec-meter", steamPlant: "steam-plant"})

// combine with deprecatedTags() to rename all deprecated tags
// and pipe results to a zinc file in the io/ directory
renameTags(null, deprecatedTags()).ioWriteZinc(`io/rename-log.zinc`)

meta ​

admin✓
deffunc:renameTags
isfunc
liblib:skyarc
namerenameTags

supertypes ​

featureFeature namespace of definitions formatted as feature:name
funcAxon function


def ​

func:sysModAdd ​

sysModAdd(name, opts: null) ​

Enable the given system module name such as "ldap". All dependencies must be already enabled.


meta ​

deffunc:sysModAdd
isfunc
liblib:skyarc
namesysModAdd
su✓

supertypes ​

featureFeature namespace of definitions formatted as feature:name
funcAxon function


def ​

func:sysModRemove ​

sysModRemove(name, opts: null) ​

Disable the given system module name. Raise exception if it is a boot module or it is required for dependencies.


meta ​

deffunc:sysModRemove
isfunc
liblib:skyarc
namesysModRemove
su✓

supertypes ​

featureFeature namespace of definitions formatted as feature:name
funcAxon function


def ​

func:sysMods ​

sysMods() ​

List the installed system mods. Result format is subject to change


meta ​

deffunc:sysMods
isfunc
liblib:skyarc
namesysMods

supertypes ​

featureFeature namespace of definitions formatted as feature:name
funcAxon function


def ​

func:sysReload ​

sysReload(podNames: null) ​

Force a system reload. This function takes an optional list of pod names which have been modified to reopen from disk. Only resource pods with no Fantom code can be reloaded. The reload process is:

  1. Reload pods specified by podNames parameter
  2. Reload the full list of pods to see if new pods have been added
  3. Rebuild the def namespace of every project
  4. Delete documentation if generated

We have documented this function to enable hot reloading. However it might change in the future.

Examples:

sysReload()                    // if adding a new pod
sysReload(["myResourceExt"])   // to reload a specific pod

meta ​

deffunc:sysReload
isfunc
liblib:skyarc
namesysReload
su✓

supertypes ​

featureFeature namespace of definitions formatted as feature:name
funcAxon function


def ​

func:table ​

table(val) ​

Set the grid visualization view to table.


meta ​

deffunc:table
isfunc
liblib:skyarc
nametable

supertypes ​

featureFeature namespace of definitions formatted as feature:name
funcAxon function


def ​

func:validateFilter ​

validateFilter(s) ​

Raise an exception if string is not valid filter


meta ​

deffunc:validateFilter
isfunc
liblib:skyarc
namevalidateFilter

supertypes ​

featureFeature namespace of definitions formatted as feature:name
funcAxon function


def ​

func:validateNotBlank ​

validateNotBlank(s) ​

Raise an exception if string is blank


meta ​

deffunc:validateNotBlank
isfunc
liblib:skyarc
namevalidateNotBlank

supertypes ​

featureFeature namespace of definitions formatted as feature:name
funcAxon function


def ​

func:validateTagName ​

validateTagName(s) ​

Raise an exception if string is not a validate tag name


meta ​

deffunc:validateTagName
isfunc
liblib:skyarc
namevalidateTagName

supertypes ​

featureFeature namespace of definitions formatted as feature:name
funcAxon function


def ​

func:validateUsername ​

validateUsername(s) ​

Raise an excpetion if string is not a validate username


meta ​

deffunc:validateUsername
isfunc
liblib:skyarc
namevalidateUsername

supertypes ​

featureFeature namespace of definitions formatted as feature:name
funcAxon function


def ​

halign ​

Horizontal layout alignment


meta ​

defhalign
isstr
liblib:skyarc
uiInputui::HalignInput

supertypes ​

valData value type
scalarScalar is an atomic value kind
strUnicode string of characters


def ​

haystackApi ​

Function which is a published Hasytack REST API op


meta ​

defhaystackApi
ismarker
liblib:skyarc

supertypes ​

markerMarker labels a dict with typing information


def ​

help ​

End user documentation. The string value should be formatted in fandoc. Note that help is targetted for end users versus doc which is reference documentation targetted for developers. For example in a rule, the help tag is displayed directly to users in the UI.


meta ​

defhelp
isstr
liblib:skyarc
multiLine✓
tagOnfunc, rule

supertypes ​

valData value type
scalarScalar is an atomic value kind
strUnicode string of characters


def ​

hidden ​

Hide a column in a table or a field on a form


meta ​

defhidden
ismarker
liblib:skyarc

supertypes ​

markerMarker labels a dict with typing information


def ​

hisFuncReady ​

Indicates a function designed to be used directly as a computed history


meta ​

defhisFuncReady
ismarker
liblib:skyarc

supertypes ​

markerMarker labels a dict with typing information


def ​

hisSrc ​

Legacy 2.1 support for function picker in History App


meta ​

defhisSrc
ismarker
liblib:skyarc

supertypes ​

markerMarker labels a dict with typing information


def ​

hotKey ​

One or more key combinations separated by a comma. Modifiers are prefixed as follows:

  • Window/Linux: Ctrl+, Alt+, Meta+, Shift+
  • Mac: ⌃, ⇧, ⌥, ⌘

meta ​

defhotKey
isstr
liblib:skyarc

supertypes ​

valData value type
scalarScalar is an atomic value kind
strUnicode string of characters


def ​

icon ​

Icon logical name - see Icons


meta ​

deficon
isstr
liblib:skyarc
uiInputui::IconInput

supertypes ​

valData value type
scalarScalar is an atomic value kind
strUnicode string of characters


def ​

imageSize ​

Image size in pixels


meta ​

defimageSize
isstr
liblib:skyarc
tagOnfiletype:svg

supertypes ​

valData value type
scalarScalar is an atomic value kind
strUnicode string of characters


def ​

kpiRule ​

Marker tag for a KPI rule type. See rule.


meta ​

defkpiRule
isruleType
liblib:skyarc
uiInputui::ChoiceInput

supertypes ​

markerMarker labels a dict with typing information
choiceChoice specifies an exclusive marker selection
ruleTypeRule type choice


def ​

libStatus ​

Current status of an extension or sys module library


meta ​

deflibStatus
enumSee below
isstr
liblib:skyarc
tagOnsysMod, ext
transient✓

enum ​

okEnabled and okay
errCould not be loaded
faultConfiguration problem
warnDegraded or inoperable functionality
disabledNot enabled
notLoadedEnabled, but not loaded yet

supertypes ​

valData value type
scalarScalar is an atomic value kind
strUnicode string of characters


def ​

licStatus ​

License status


meta ​

deflicStatus
enumSee below
isstr
liblib:skyarc

enum ​

ok
warn
err

supertypes ​

valData value type
scalarScalar is an atomic value kind
strUnicode string of characters


def ​

logLevel ​

Severity level


meta ​

deflogLevel
enumSee below
isstr
liblib:skyarc

enum ​

infoInformational
warnPotential problem
errFailure problem
debugTracing

supertypes ​

valData value type
scalarScalar is an atomic value kind
strUnicode string of characters


def ​

multi ​

Indicates multiple selection


meta ​

defmulti
ismarker
liblib:skyarc

supertypes ​

markerMarker labels a dict with typing information


def ​

navAuxFilter ​

Apply extra filter string to a navigation tree. See Nav


meta ​

defnavAuxFilter
isfilterStr
liblib:skyarc

supertypes ​

valData value type
scalarScalar is an atomic value kind
strUnicode string of characters
filterStrHaystack filter string


def ​

navCluster ​

Select from all the nodes in the cluster.


meta ​

defnavCluster
ismarker
liblib:skyarc

supertypes ​

markerMarker labels a dict with typing information


def ​

navHidden ​

Hide an entity in the navigation selection pickers. Currently this is only used for project selection.


meta ​

defnavHidden
ismarker
liblib:skyarc

supertypes ​

markerMarker labels a dict with typing information


def ​

navName ​

Navigation name commonly used with disMacro to create computed display strings.


meta ​

defnavName
isstr
liblib:skyarc
tagOnemission, equip, point, space, system

supertypes ​

valData value type
scalarScalar is an atomic value kind
strUnicode string of characters


def ​

navSelAny ​

Select any level of a navigation tree which might include groupings. See Nav


meta ​

defnavSelAny
ismarker
liblib:skyarc

supertypes ​

markerMarker labels a dict with typing information


def ​

navSelAnyRec ​

Select any level of a navigation tree which maps to Folio record. See Nav


meta ​

defnavSelAnyRec
ismarker
liblib:skyarc

supertypes ​

markerMarker labels a dict with typing information


def ​

navTarget ​

Apply to a def to specify a default navigation target. This target is used along with an implicit navAuxFilter when navigating to the def. This navTarget is only used if uiMeta does not contain an explicit definition.


meta ​

defnavTarget
isstr
liblib:skyarc

supertypes ​

valData value type
scalarScalar is an atomic value kind
strUnicode string of characters


def ​

navTree ​

Navigation tree name to use for ref tag


meta ​

defnavTree
isstr
liblib:skyarc

supertypes ​

valData value type
scalarScalar is an atomic value kind
strUnicode string of characters


def ​

optional ​

Not required


meta ​

defoptional
ismarker
liblib:skyarc

supertypes ​

markerMarker labels a dict with typing information


def ​

optsTemplate ​

TODO


meta ​

defoptsTemplate
isstr
liblib:skyarc

supertypes ​

valData value type
scalarScalar is an atomic value kind
strUnicode string of characters


def ​

op:export ​

Export a view to a file; see Export


meta ​

defop:export
isop
liblib:skyarc
noSideEffects✓

supertypes ​

featureFeature namespace of definitions formatted as feature:name
opOperation for HTTP API


def ​

op:ext ​

Ext specific HTTP servicing


meta ​

defop:ext
isop
liblib:skyarc

supertypes ​

featureFeature namespace of definitions formatted as feature:name
opOperation for HTTP API


def ​

op:rec ​

Get a record by id


meta ​

defop:rec
isop
liblib:skyarc

supertypes ​

featureFeature namespace of definitions formatted as feature:name
opOperation for HTTP API


def ​

order ​

Used to order definitions


meta ​

deforder
isnumber
liblib:skyarc
tagOnfinSetting

supertypes ​

valData value type
scalarScalar is an atomic value kind
numberInteger or floating point numbers annotated with an optional unit


def ​

pageSize ​

Printed page size formatted as "width,height" with an explicit unit of "pt", "in", "mm", or "cm". Examples "8.5in,11in" or "612pt,792pt"


meta ​

defpageSize
disKeyui::pageSize
isstr
liblib:skyarc
tagOnfiletype:pdf
uiInputui::PageSizeInput

supertypes ​

valData value type
scalarScalar is an atomic value kind
strUnicode string of characters


def ​

percentage ​

A percentage specified as as <percent> * 100


meta ​

defpercentage
isnumber
liblib:skyarc
tagOntariffPercentageCharge

supertypes ​

valData value type
scalarScalar is an atomic value kind
numberInteger or floating point numbers annotated with an optional unit


def ​

placeholder ​

Hint displayed in a text field input


meta ​

defplaceholder
isstr
liblib:skyarc

supertypes ​

valData value type
scalarScalar is an atomic value kind
strUnicode string of characters


def ​

podName ​

Fantom pod name


meta ​

defpodName
isstr
liblib:skyarc

supertypes ​

valData value type
scalarScalar is an atomic value kind
strUnicode string of characters


def ​

projIncludeFilter ​

Selects other projects to include in UI navigation. See Nav


meta ​

defprojIncludeFilter
isfilterStr
liblib:skyarc

supertypes ​

valData value type
scalarScalar is an atomic value kind
strUnicode string of characters
filterStrHaystack filter string


def ​

readonly ​

Indicates a value which may be read, but not written


meta ​

defreadonly
ismarker
liblib:skyarc

supertypes ​

markerMarker labels a dict with typing information


def ​

refresh ​

Indicates an operation which requires a page refresh


meta ​

defrefresh
ismarker
liblib:skyarc

supertypes ​

markerMarker labels a dict with typing information


def ​

restart ​

Indicates a setting which requires restart when modified


meta ​

defrestart
ismarker
liblib:skyarc

supertypes ​

markerMarker labels a dict with typing information


def ​

ruleOn ​

Target filter for a rule or rule ready func.


meta ​

defruleOn
isfilterStr
liblib:skyarc
tagOnalarmRule, func, rule

supertypes ​

valData value type
scalarScalar is an atomic value kind
strUnicode string of characters
filterStrHaystack filter string


def ​

ruleType ​

Rule type choice


meta ​

defruleType
ischoice
liblib:skyarc
tagOnfunc, rule
uiInputui::ChoiceInput

supertypes ​

markerMarker labels a dict with typing information
choiceChoice specifies an exclusive marker selection

subtypes ​

curRuleMarker tag for a cur rule type
kpiRuleMarker tag for a KPI rule type
sparkRuleMarker tag for a spark rule type


def ​

select ​

Used on an action to use current selection


meta ​

defselect
ismarker
liblib:skyarc

supertypes ​

markerMarker labels a dict with typing information


def ​

showDis ​

Show display names in UI instead of programmatic names


meta ​

defshowDis
ismarker
liblib:skyarc

supertypes ​

markerMarker labels a dict with typing information


def ​

spanModes ​

Restrict Span input modes. Value is string list with the following values: day, week, month, quarter, year, other, recent"


meta ​

defspanModes
islist
liblib:skyarc
ofstr

supertypes ​

valData value type
listOrdered list of zero or more values


def ​

sparkRule ​

Marker tag for a spark rule type. See rule.


meta ​

defsparkRule
isruleType
liblib:skyarc
uiInputui::ChoiceInput

supertypes ​

markerMarker labels a dict with typing information
choiceChoice specifies an exclusive marker selection
ruleTypeRule type choice


def ​

sysMod ​

System module library.


meta ​

defsysMod
islib
liblib:skyarc

supertypes ​

featureFeature namespace of definitions formatted as feature:name
libLibrary module of symbolic definitions

tags ​

baseUriBase URI for normalizing relative URIs
connTuningRefReference to a tuning configuration defined by a connTuning rec
dependsList of this library's dependencies
libStatusCurrent status of an extension or sys module library
versionVersion string formatted as decimal integers separated by a dot


def ​

tag ​

Legacy backward compatible tag definitions


meta ​

deftag
isfeature
liblib:skyarc

supertypes ​

featureFeature namespace of definitions formatted as feature:name


def ​

templateName ​

Template by name - legacy support


meta ​

deftemplateName
isstr
liblib:skyarc

supertypes ​

valData value type
scalarScalar is an atomic value kind
strUnicode string of characters


def ​

timeout ​

Maximum elapsed time to allow an operation to continue


meta ​

deftimeout
isduration
liblib:skyarc

supertypes ​

valData value type
scalarScalar is an atomic value kind
numberInteger or floating point numbers annotated with an optional unit
durationNumber with a unit of time


def ​

ts ​

Timestamp


meta ​

defts
isdateTime
liblib:skyarc

supertypes ​

valData value type
scalarScalar is an atomic value kind
dateTimeISO 8601 timestamp followed by timezone identifier


def ​

unitless ​

Hide the unit picker for a number field


meta ​

defunitless
ismarker
liblib:skyarc

supertypes ​

markerMarker labels a dict with typing information


def ​

usedWith ​

Legacy tag definitions


meta ​

defusedWith
isstr
liblib:skyarc

supertypes ​

valData value type
scalarScalar is an atomic value kind
strUnicode string of characters


def ​

validate ​

Axon expression to validate def


meta ​

defvalidate
isstr
liblib:skyarc

supertypes ​

valData value type
scalarScalar is an atomic value kind
strUnicode string of characters


def ​

view ​

Fresco UI view. See Views


meta ​

defview
iconview
isfeature
liblib:skyarc

supertypes ​

featureFeature namespace of definitions formatted as feature:name

tags ​

adminRequires admin permission
suRequires superuser permission


def ​

viewLink ​

View name and state for linking to a saved view


meta ​

defviewLink
isdict
liblib:skyarc
tagOnarc, fav
uiInputui::ViewLinkInput

supertypes ​

valData value type
dictMap of name/value tag pairs


def ​

view:alerts ​

Display system alerts such as licensing errors


meta ​

appNamedebug
defview:alerts
disKeyui::alerts
iconview
isview
liblib:skyarc

supertypes ​

featureFeature namespace of definitions formatted as feature:name
viewFresco UI view

src ​

view: {inherit:"table"}
silence: {action:"alertSilence"}
data: {expr:"alerts()"}


def ​

view:apiSettings ​

Settings for the API system module


meta ​

appNamesettings
defview:apiSettings
disKeyui::api
iconview
isview
liblib:skyarc
su✓

supertypes ​

featureFeature namespace of definitions formatted as feature:name
viewFresco UI view

src ​

view:   {inherit:"form"}
submit: {action:"hostCommit"}
data:   {expr:"hostSettings(\"api\")"}


def ​

view:blank ​

Placeholder with no content


meta ​

defview:blank
iconview
isview
liblib:skyarc

supertypes ​

featureFeature namespace of definitions formatted as feature:name
viewFresco UI view

src ​

view: { uiType: "ui::BlankView" renderAs:"blank" }


def ​

view:card ​

Display each row of a grid as a formatted card


meta ​

defview:card
disKeyui::card
iconview
isview
liblib:skyarc

supertypes ​

featureFeature namespace of definitions formatted as feature:name
viewFresco UI view

src ​

view: {uiType: "ui::CardView" renderAs:"card"}


def ​

view:chart ​

Display grid data as a chart


meta ​

defview:chart
disKeyui::chart
iconview
isview
liblib:skyarc

supertypes ​

featureFeature namespace of definitions formatted as feature:name
viewFresco UI view

src ​

view: {uiType: "ui::ChartView" renderAs:"chart"}


def ​

view:crypto ​

Manage cryto trust store


meta ​

appNamehost
defview:crypto
disKeyui::crypto
iconview
isview
liblib:skyarc
su✓

supertypes ​

featureFeature namespace of definitions formatted as feature:name
viewFresco UI view

src ​

view:           {inherit:"table"}
type:           {var input kind:"Str" enum:"all,cryptoTrust,cryptoPrivKey" defVal:"all"}
trustUri:       {action:"cryptoTrustUri" templateName:"cryptoTrust" hideAdd hideAdvanced}
cryptoCheckUri: {action:"cryptoCheckAction" templateName:"cryptoCheck" hideAdd hideAdvanced}
delete:         {action:"cryptoEntryDelete" select multi confirm:{icon:"warn" disKey:"ui::cryptoDeleteConfirm" detailsKey: "ui::cryptoDeleteConfirmDetails"}}
rename:         {action:"cryptoEntryRename" templateName:"cryptoRename" select hideAdd hideAdvanced}
addCert:        {action:"uiMisc::CryptoView.onAddCert"}
showPub:        {action:"cryptoShowPub" select}
data:           {expr:"cryptoLocal({{type}})"}


def ​

view:debugHost ​

Debug of host level system modules


meta ​

appNamedebug
defview:debugHost
disKeyui::host
iconview
isview
liblib:skyarc
su✓

supertypes ​

featureFeature namespace of definitions formatted as feature:name
viewFresco UI view

src ​

view: {inherit:"text"}
data: {expr:"debugHost()"}


def ​

view:debugSupport ​

Gather support diagnostics


meta ​

appNamedebug
defview:debugSupport
disKeyui::support
iconview
isview
liblib:skyarc
order900
su✓

supertypes ​

featureFeature namespace of definitions formatted as feature:name
viewFresco UI view

src ​

view: {inherit:"text"}
copy: {disKey: "ui::copy" action:"ui::TextView.copyToClipboard"}
data: {expr:"debugSupport()"}


def ​

view:diag ​

Diagnostics dashboard with real-time graphs


meta ​

appNamedebug
defview:diag
disKeyui::diag
iconview
isview
liblib:skyarc
su✓

supertypes ​

featureFeature namespace of definitions formatted as feature:name
viewFresco UI view

src ​

view: {uiType: "uiMisc::DiagDashboardView"}
uri:  {var input kind:"Uri" defVal:`/`}
data: {expr:"diags({{uri}})"}


def ​

view:doc ​

Documentation viewer


meta ​

appNamedoc
defview:doc
disKeyui::doc
iconview
isview
liblib:skyarc

supertypes ​

featureFeature namespace of definitions formatted as feature:name
viewFresco UI view

src ​

view: {uiType: "uiMisc::DocView"}
uri:  {var defVal:`/index`}


def ​

view:emailSettings ​

Settings for the email system module


meta ​

appNamesettings
defview:emailSettings
disKeyui::email
iconview
isview
liblib:skyarc
su✓

supertypes ​

featureFeature namespace of definitions formatted as feature:name
viewFresco UI view

src ​

view:   {inherit:"form"}
submit: {action:"hostCommit"}
test:   {action:"ui::EmailDialog.test"}
data:   {expr:"hostSettings(\"email\", {password})"}


def ​

view:fandoc ​

Display fandoc markup as stylized content


meta ​

defview:fandoc
disKeyui::fandoc
iconview
isview
liblib:skyarc

supertypes ​

featureFeature namespace of definitions formatted as feature:name
viewFresco UI view

src ​

view: {uiType: "ui::FandocView" renderAs:"fandoc"}


def ​

view:form ​

Display a dict for editing using a form layout


meta ​

defview:form
disKeyui::form
iconview
isview
liblib:skyarc

supertypes ​

featureFeature namespace of definitions formatted as feature:name
viewFresco UI view

src ​

view: {uiType: "ui::FormView"}


def ​

view:hostSettings ​

Settings for the host system module


meta ​

appNamesettings
defview:hostSettings
disKeyui::host
iconview
isview
liblib:skyarc
su✓

supertypes ​

featureFeature namespace of definitions formatted as feature:name
viewFresco UI view

src ​

view:   {inherit:"form"}
submit: {action:"hostCommit"}
data:   {expr:"hostSettings(\"host\")"}


def ​

view:httpSettings ​

Settings for the HTTP system module


meta ​

appNamesettings
defview:httpSettings
disKeyui::http
iconview
isview
liblib:skyarc
su✓

supertypes ​

featureFeature namespace of definitions formatted as feature:name
viewFresco UI view

src ​

view:   {inherit:"form"}
submit: {action:"hostCommit"}
data:   {expr:"hostSettings(\"http\")"}


def ​

view:iframe ​

Display a URI as an embedded HTML iframe


meta ​

defview:iframe
disKeyui::iframe
iconview
isview
liblib:skyarc

supertypes ​

featureFeature namespace of definitions formatted as feature:name
viewFresco UI view

src ​

view: {uiType:"ui::IframeView"}


def ​

view:lics ​

Manage software license files


meta ​

appNamehost
defview:lics
disKeyui::lics
iconview
isview
liblib:skyarc
su✓

supertypes ​

featureFeature namespace of definitions formatted as feature:name
viewFresco UI view

src ​

view:      {uiType: "uiMisc::LicView"}
install:   {disKey: "ui::install" action:"uiMisc::LicView.onInstall"}
update:    {action:"licUpdate"}
uninstall: {action:"licUninstall"}
hostInfo:  {action:"licHostInfo"}
status:    {action:"licStatusInfo"}
show:      {action:"licShow"}
eula:      {action:"eula"}
data:      {expr:"lics()"}


def ​

view:log ​

System log browser


meta ​

appNamedebug
defview:log
disKeyui::log
iconview
isview
liblib:skyarc
su✓

supertypes ​

featureFeature namespace of definitions formatted as feature:name
viewFresco UI view

src ​

view:   {uiType:"uiMisc::LogView"}
span:   {var input kind:"Span" defVal:Span("today")}
filter: {var input kind:"Str" defExpr:"null"}
data:   {expr:"logRead({{span}}, {{filter}}, {feed})"}


def ​

view:logSettings ​

Settings for the logging system module


meta ​

appNamesettings
defview:logSettings
disKeyui::log
iconview
isview
liblib:skyarc
su✓

supertypes ​

featureFeature namespace of definitions formatted as feature:name
viewFresco UI view

src ​

view:   {inherit:"form"}
submit: {action:"hostCommit"}
data:   {expr:"hostSettings(\"log\")"}


def ​

view:page ​

Display subviews as a linear page-oriented report


meta ​

defview:page
disKeyui::page
iconview
isview
liblib:skyarc

supertypes ​

featureFeature namespace of definitions formatted as feature:name
viewFresco UI view

src ​

view: {uiType: "ui::PageView" renderAs:"page"}


def ​

view:pageBreak ​

Use in a page view to force a page break during PDF generation


meta ​

defview:pageBreak
disKeyui::pageBreak
iconview
isview
liblib:skyarc

supertypes ​

featureFeature namespace of definitions formatted as feature:name
viewFresco UI view

src ​

view: {uiType: "ui::PageBreakView" renderAs:"pageBreak"}


def ​

view:pods ​

Debug all installed pod modules


meta ​

appNamedebug
defview:pods
disKeyui::pods
iconview
isview
liblib:skyarc
su✓

supertypes ​

featureFeature namespace of definitions formatted as feature:name
viewFresco UI view

src ​

view: {inherit:"table"}
data: {expr:"pods()"}


def ​

view:sessionSettings ​

Settings for the session system module


meta ​

appNamesettings
defview:sessionSettings
disKeyui::session
iconview
isview
liblib:skyarc
su✓

supertypes ​

featureFeature namespace of definitions formatted as feature:name
viewFresco UI view

src ​

view:   {inherit:"form"}
submit: {action:"hostCommit"}
data:   {expr:"hostSettings(\"session\")"}


def ​

view:sessions ​

Debug user sessions


meta ​

appNamehost
defview:sessions
disKeyui::sessions
iconview
isview
liblib:skyarc
su✓

supertypes ​

featureFeature namespace of definitions formatted as feature:name
viewFresco UI view

src ​

view:    {inherit:"table"}
logout:  {action:"sessionLogout"}
details: {action:"sessionDetails"}
data:    {expr:"sessions()"}


def ​

view:sysModSettings ​

Enable and disable system modules


meta ​

appNamesettings
defview:sysModSettings
disKeyui::sysMods
iconview
isview
liblib:skyarc
order105
su✓

supertypes ​

featureFeature namespace of definitions formatted as feature:name
viewFresco UI view

src ​

view:    {inherit:"table"}
enable:  {disKey:"ui::enable"  select multi action:"uiBuilder::LibActions.enable"}
disable: {disKey:"ui::disable" select multi action:"uiBuilder::LibActions.disable"}
data:    {expr: "sysMods()"}


def ​

view:table ​

Display grid data as a two dimensional table


meta ​

defview:table
disKeyui::table
iconview
isview
liblib:skyarc

supertypes ​

featureFeature namespace of definitions formatted as feature:name
viewFresco UI view

src ​

view:    {uiType: "ui::TableView" renderAs:"table"}
sortCol: {var kind:"Str"}
sortDir: {var kind:"Str"}


def ​

view:text ​

Display grid data as preformatted plain text


meta ​

defview:text
disKeyui::text
iconview
isview
liblib:skyarc

supertypes ​

featureFeature namespace of definitions formatted as feature:name
viewFresco UI view

src ​

view: {uiType: "ui::TextView" renderAs:"text"}


def ​

view:threads ​

Debug thread traces and deadlocks


meta ​

appNamedebug
defview:threads
disKeyui::threads
iconview
isview
liblib:skyarc
su✓

supertypes ​

featureFeature namespace of definitions formatted as feature:name
viewFresco UI view

src ​

view: {inherit:"text"}
data: {expr:"threadDump()"}


def ​

view:tile ​

Display subviews using a preconfigured tile layout


meta ​

defview:tile
disKeyui::tile
iconview
isview
liblib:skyarc

supertypes ​

featureFeature namespace of definitions formatted as feature:name
viewFresco UI view

src ​

view: {uiType: "ui::TileView" renderAs:"tile"}