FIN 5.3.1 中文文档

外观

finNHaystackExt 扩展参考 ​

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

导读： @FinExtMeta

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

目录（导读） ​

  • classes
  • Slot Details
    • REMOVE_TAGS
    • finNHaystackAddEquips
    • finNHaystackAddHaystackSlots
    • finNHaystackApplyBatchTags
    • finNHaystackApplyFolioFilter
    • finNHaystackCopyEquipTags
    • finNHaystackDelete
    • finNHaystackDeleteHaystackSlot
    • finNHaystackFindDuplicatePoints
    • finNHaystackMapPointsToEquip
    • finNHaystackPointWriteArray
    • finNHaystackPullPropTags
    • finNHaystackReadSize
    • finNHaystackReadUnique
    • finNHaystackRebuildCache
    • finNHaystackSearchAndReplace
    • finNHaystackShowPointsInWatch
    • finNHaystackShowWatches
    • finNHaystackUniqueTags
    • finToAlarm
    • finToNormal

概述（中译） ​

@ExtMeta { name="finNHaystackExt"; depends=["finstack"] } @FinExtMeta { licFeature="finstack"; licFeatureExclude="enterprise"; pngIcon=fan://finStackExt/res/img/fins_24.png } const class FinNHaystackExt : FinExt, Weblet

FinPublish 扩展

插槽详情

const class FinNHaystackLib : Obj

FIN 堆栈库函数。

字段

方法

插槽详情

const static Str[] REMOVE_TAGS := ...

@Axon

API 正文（英文） ​

static Grid finNHaystackAddEquips(Obj? conn, Str targetFilter, Str siteName, List ids := [,])`

finNHaystackAddEquips This method calls the addEquips op on nhaystack. It uses the targetFilter to find recs, and then adds the equip

finNHaystackAddHaystackSlots ​

@Axon { meta=... } static Grid finNHaystackAddHaystackSlots(Obj? conn, Str targetFilter, List ids := [,])

finNHaystackAddHaystackSlots This method calls the applyBatchTag op on nhaystack. It uses the targetFilter to find recs, and then adds or removes tags on those recs.

finNHaystackApplyBatchTags ​

@Axon { meta=... } static Grid finNHaystackApplyBatchTags(Obj? conn, Str targetFilter, Str tags, List ids := [,], Bool returnResultRows := false)

finNHaystackApplyBatchTags This method calls the applyBatchTag op on nhaystack. It uses the targetFilter to find recs, and then adds or removes tags on those recs.

finNHaystackApplyFolioFilter ​

@Axon { meta=... } static Grid finNHaystackApplyFolioFilter(Obj? conn, Str filter)

finNHaystackApplyFolioFilter

This method runs the given filter against the Folio database, and ships the grid down to nhaystack. NHaystack takes the grid and applies the tags to each component, via the axSlotPath entry.

Tags which should not be written down to nhaystack are automatically stripped out.

finNHaystackCopyEquipTags ​

@Axon { meta=... } static Grid finNHaystackCopyEquipTags(Obj? conn, Ref fromEquip, Str targetFilter, List toEquips := [,])

finNHaystackCopyEquipTags

finNHaystackDelete ​

@Axon { meta=... } static Grid finNHaystackDelete(Obj? conn, List ids)

finNHaystackDelete

finNHaystackDeleteHaystackSlot ​

@Axon { meta=... } static Grid finNHaystackDeleteHaystackSlot(Obj? conn, List ids)

finNHaystackDeleteHaystackSlot

finNHaystackFindDuplicatePoints ​

@Axon { meta=... } static Grid finNHaystackFindDuplicatePoints(Obj? conn)

finNHaystackFindDuplicatePoints

finNHaystackMapPointsToEquip ​

@Axon { meta=... } static Grid finNHaystackMapPointsToEquip(Obj? conn, Str siteNavName, Str equipNavName, List ids)

finNHaystackMapPointsToEquip

This method applies equipRef tags to a list of points, so that those points become children of the given equip. If there is no Equip or Site by those name(s) in niagara, then an Equip and/or Site is created.

The rebuildCache action should be run in Niagara after this method is invoked.

finNHaystackPointWriteArray ​

@Axon { meta=... } static Grid finNHaystackPointWriteArray(Obj? conn, Ref id)

finNHaystackPointWriteArray

finNHaystackPullPropTags ​

@Axon { meta=... } static Grid finNHaystackPullPropTags(Obj? conn, List tags, Str filter, List ids := [,])

finNHaystackPullPropTags

finNHaystackReadSize ​

@Axon { meta=... } static Grid finNHaystackReadSize(Obj? conn, Str filter)

finNHaystackReadSize This method calls read with the given filter, and then counts the number of resulting recs.

finNHaystackReadUnique ​

@Axon { meta=... } static Grid finNHaystackReadUnique(Obj? conn, Str filter, Str column)

finNHaystackReadUnique This method calls read with the given filter, and then finds the unique values of the given column

finNHaystackRebuildCache ​

@Axon { meta=... } static Grid finNHaystackRebuildCache(Obj? conn)

finNHaystackRebuildCache This method calls rebuildCache in NHaystack. This is an expensive operation, so be careful.

finNHaystackSearchAndReplace ​

@Axon { meta=... } static Grid finNHaystackSearchAndReplace(Obj? conn, Str filter, Str searchText, Str replaceText, List ids := [,])

finNHaystackSearchAndReplace This method renames components by replacing searchText with replaceText.

finNHaystackShowPointsInWatch ​

@Axon { meta=... } static Grid finNHaystackShowPointsInWatch(Obj? conn, Ref watchId)

finNHaystackShowPointsInWatch

finNHaystackShowWatches ​

@Axon { meta=... } static Grid finNHaystackShowWatches(Obj? conn)

finNHaystackShowWatches

finNHaystackUniqueTags ​

@Axon { meta=... } static Grid finNHaystackUniqueTags(Obj? conn, Str filter)

finNHaystackUniqueTags

finToAlarm ​

@Axon static Grid finToAlarm(Grid params)

finToAlarm

finToNormal ​

@Axon static Grid finToNormal(Grid params)

finToNormal