Flowhook

A flowhook is a defined entrypoint for sending (Flowhook Publish) data events from external sources (e.g. Excel Addin, REST clients, etc.) and retrieve data from a flow (Flowhook Receive).

Create Flowhook

The first thing to do is to create a FlowHook Configuration, this global configuration is used to link the Flowhook Publish to an Flowhook Receive and get a named data entrypoint.

The flowhook endpoints can either be called with the FlowHook Configuration Name or Id.

Thereafter a Flowhook Publish and Flowhook Receive can be dropped into a flow and linked to other nodes in this flow.

Attention

It is important that the Flowhook Publish node and the Flowhook Receive node have the same FlowHook Configuration otherwise the Flowhook Receive node will never capture any data events from the Flowhook Publish node.

Sending & Receiving Data

Microsoft Excel Addin

Excel Addin 32bit	`Enexsa.Excel.Grid.DataProcessing-Addin-packed.xll`
Excel Addin 64bit	`Enexsa.Excel.Grid.DataProcessing-Addin64-packed.xll`

Linkarea

Linkarea Parameter
Profile Elements + Begin & End
Profile Meta Variables
Profile Variables (spec, result)
Profiles

Linkarea Parameter

ModelName

Flowhook Name (e.g. Test FlowHook) or Flowhook Id (c96a4786-269a-8e86-acc6-b41feedf5b4e)

Timeline

0 = No Timeline

1 = Timeline (not implemented yet)

Timezone

The timezone for values of the MetaVariable @Timestamp.
If there is no timezone specified or the field is empty UTC will be used.
See: Microsoft Default Time Zones
e.g. UTC or W. Europe Standard Time

ExpiresIn

See: Microsoft Standard TimeSpan format

Default format: [d'.']hh':'mm':'ss['.'fffffff]

d	The optional number of days, with no leading zeros.
hh	The number of hours, which ranges from `00` to `23`
mm	The number of minutes, which ranges from `00` to `59`
ss	The number of seconds, which ranges from `0` to `59`
fffffff	The optional fractional portion of a second. Its value can range from `0000001` (one tick, or one ten-millionth of a second) to `9999999` (9,999,999 ten-millionths of a second, or one second less one tick).

Examples:
00:20 = 20 seconds
30:10 = 30 minutes and 10 seconds
00:15 = 1 hour and 15 seconds

Profile Elements

Type: spec = Input Variable

result = Result Variables
Name: Variable Input or Output name.

e.g. InputVariable1, OutputVariable1
Description: An optional variable description (will not be transmitted).
Unit: Unit of Measurement

e.g. °C, bar, %, mol, etc.
First Element: The First Element indicates where the profile area starts.

As convention the First Element row/column should be empty.
Last Element: The Last Element indicates where the profile area ends.

As convention the Last Element row/column should be empty.
Profiles (no explicit naming): These are the rows/columns for the data to send to the flowhook publish nodes, and receive from the flowhook receive node.

Profile Meta Variables

Profile MetaVariables variables that are prefixed with an @ symbol.

Note

@ is a reserved prefix, do not define custom variables with an prefixed @ symbol.

Input Meta Variables

@CalculationId: UUID that is used to identify flowhook calculations.
@Timestamp: The data Timestamp for the calculation. The timestamp will be interpreted as the timezone specified in Linkarea Timezone Parameter.

This is either an OLE Automation Date (double value) or Date string as specified in Microsoft Standard date and time format strings

e.g. 12 11 2021 17:00:00, 2021-11-12T17:00:00, 11/12/2021 17:00:00.00

Output Meta Variables

@Status: Current processing status of the calculation (identified by the @CalculationId). The status can be retrieved with Get Status and Get Results. | Possible values: Processing and Completed
@Outcome: Outcome of the calculation (identified by the @CalculationId). The outcome can be retrieved with Get Status and Get Results.

Possible values: Success and Failed
@Details: For failed calculations, there may be textual details about the cause of the error.

REST API (Swagger)

See: https://your.cluster.com/dataprocessing/swagger/v1/swagger.json

User Interface

Flowhook calculation can be viewed on the web interface.

Input and Result details can be viewed by clicking a calculation id in the overview.