StackHub Bulletin BoardAdvertise your announcements here!

bfitALCExt

Connector for ALC
bfitALCExtAxon funcs

Registered StackHub users may elect to receive email notifications whenever a new package version is released or a comment is posted on the forum.

There are 4 watchers.

v1.0.4

bfitALCConvertStrToBool
bfitALCConvertStrToBool(connRec)

This function will search for points attached to the connector that have a bool type and a curErr tag and add a conversion string. It assumes that ALL bool types are returned as numeric strings and applies the curConvert tag: "strToNumber() numberToBool()". Do NOT use this function if the system is returning bools as strings with non-numeric types.

Params

  • connRec: The connector record that points to the ALC WSI where the points are housed

Return

Nothing

Example

  • read(bfitALCConn).bfitALCConvertStrToBool()
Fantom signature:
@Axon static Grid? bfitALCConvertStrToBool(Dict connRec)
bfitALCExport
bfitALCExport(connRec, entryPoint, filename)

This function takes the ALC connector and a filename URI and creates a CSV file with information helpful for automatic point creation. Entry point can be null to gather everything. Otherwise, it is a string containing the learn path obtained from either the bfitALCLearn function or the Connector hierarchy explorer in the Builder view. This process is recursive and as a result the progress percentage cannot be calculated. Long running function. Run in jobs.

Params

  • connRec: The connector record that points to the ALC where the points are housed
  • entryPoint: The learn path as a string obtained from calls to bfitALCLearn or null to start at the root.
  • filename: The URI to write the output csv to.

Return

A grid of discovered points.

Example

  • read(bfitALCConn).bfitALCExport(null, \`io/export_output.csv\`)
  • read(bfitALCConn).bfitALCExport("#testnode", \`io/export_output.csv\`)
Fantom signature:
@Axon static Grid? bfitALCExport(Dict connRec, Str? entryPoint, Uri filename)
bfitALCLearn
bfitALCLearn(conn, arg)

Gather the nodes list of the selected point. For system nodes, pass null to arg. Otherwise pass the learn address returned from a previous level.

Params

  • conn: The connector record that points to the ALC WSI where the points are housed
  • arg: The learn path as a string obtained from previous calls to bfitALCLearn or null to start at the root.

Return

A grid of children found below the arg node with associated parameters, if any.

Example

  • read(bfitALCConn).bfitALCLearn(null)
  • read(bfitALCConn).bfitALCLearn("api/systembrowser/1/9/JMS_ALC.ManagementView")
Fantom signature:
@Axon static Grid? bfitALCLearn(Obj conn, Obj? arg)
bfitALCPingEx
bfitALCPingEx(connRec)

Pings the API address. This is a global ping to ensure that the API is receiving and processing requests. This function is designed to function through Axon and as a result may operate slightly differently than the ping operation in the Connectors app.

Params

  • connRec: The connector record that points to the ALC WSI where the points are housed

Return

1 on a successful ping, -1 otherwise.

Example

  • read(bfitALCConn).bfitALCPingEx()
Fantom signature:
@Axon static Number? bfitALCPingEx(Dict connRec)
bfitALCSyncCur
bfitALCSyncCur(points)

Sync the cur value of the points using the bfitALCCur ID.

Params

  • points: Any number of point records that contain valid bfitALCConnRef and bfitALCCur tags

Return

None

Example

  • read(point and bfitALCCur).bfitALCSyncCur()
Fantom signature:
@Axon static Void bfitALCSyncCur(Obj points)
bfitALCSyncHis
bfitALCSyncHis(points, dates: null)

Sync the history data of a point from the trendlog. Requires bfitALCHis ID.

Params

  • points: Any number of point records that contain valid bfitALCConnRef and bfitALCHis tags
  • dates: A DateSpan for the desired period of time to sync. Calling this function without passing a span will sync from the current date to the hisEnd on the point record. If no hisEnd exists, it will sync from the current date to one month previous.

Return

The number of points that were updated. One row for each history in the order that they were passed to the function.

Example

  • readAll(point and bfitALCHis).bfitALCSyncHis(pastWeek())
  • readAll(point and bfitALCHis).bfitALCSyncHis()
Fantom signature:
@Axon static Obj? bfitALCSyncHis(Obj points, Obj? dates := null)
Published by BuildingFit

Products & Services by BuildingFit

Packages by BuildingFit

Commercial packages

Free packages