bfitDesigoExt

This function takes the Desigo 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 bfitDesigoLearn function or the Connector hierarchy explorer in the Builder view. Long running function. Run in jobs.

Params

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

Return

A grid of discovered points.

Example

• read(bfitDesigoConn).bfitDesigoExport(null, io/export_output.csv)
• read(bfitDesigoConn).bfitDesigoExport("api/systembrowser/1/9/JMS_Desigo.ManagementView", io/export_output.csv)

Gets the set of objects nested under a given api path. Usually the path is the objects learn parameter.

Get all property values under a given object id.

Params

• connRec: The connector record
• objId: The object ID

Grabs the system nodes and returns them as a grid.

Gets a list of values for a list of object IDs.

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 Desigo WSI where the points are housed
• arg: The learn path as a string obtained from previous calls to bfitDesigoLearn or null to start at the root.

Return

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

Example

• read(bfitDesigoConn).bfitDesigoLearn(null)
• read(bfitDesigoConn).bfitDesigoLearn("api/systembrowser/1/9/JMS_Desigo.ManagementView")

Pings the API address. This is a global ping to ensure that the API is receiving and processing requests.

Params

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

Return

1 on a successful ping, -1 otherwise.

Example

• readAll(bfitDesigoConn).bfitDesigoPing()

Sends a heartbeat to extend the lifespan of a session. Returns the result code of the call.

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

Params

• points: Any number of point records that contain valid bfitDesigoConnRef and BfitDesigoCur tags

Return

None

Example

• read(point and bfitDesigoCur).bfitDesigoSyncCur()

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

Params

• points: Any number of point records that contain valid bfitDesigoConnRef and BfitDesigoHis 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 bfitDesigoHis).bfitDesigoSyncHis(pastWeek())
• readAll(point and bfitDesigoHis).bfitDesigoSyncHis()

Gets the table of objectId to trendseriesId mappings. The systemId variable takes the id number of the system node.

SystemIds can be seen in the Connectors page in Builder as well as by running the following command in folio: read(bfitDesigoConn).bfitDesigoLearn(null)

Params

• connRec: The connector record that points to the Desigo WSI where the points are housed
• systemId: The SystemId value as a number. Most easily found by running: read(bfitDesigoConn).bfitDesigoLearn(null)

Return

A grid of all the objectIds with their associated trendseriesId. The objectId will match the bfitDesigoCur tag.

Example

• read(bfitDesigoConn).bfitDesigoTrendseriesInfo(1)