CONNECT Events Reader module
- Last UpdatedJun 26, 2026
- 3 minute read
This module reads CONNECT Events Data Store events information on demand. When triggered, the module retrieves events from the configured timestamp and filters.
Supported filters include TypeId, Name, and Id. Multiple filters are combined using AND. If no timestamp is configured, the module uses an internal, in-memory timestamp to read only new events since the previous execution. On first execution, this internal timestamp is initialized to the current UTC time.
Prerequisites
The following prerequisites are required for this module:
-
An existing Events Data Store in your CONNECT environment.
-
A new credential type called Connect OAuth Client Credential. This credential type is used to authenticate with CONNECT. Follow these steps in CONNECT flows to create the credential:
-
In the CONNECT portal, create a client and assign it to the Data Viewer role.
-
In CONNECT flows, select Manage, then select Credentials.
-
On the Credentials page, create the following credential type: Connect OAuth Client Credential Grant
-
Provide the account ID, client ID, client secret, and, optionally, the environment. Leave the environment blank if you want to default to the Production environment.
-
Guidelines
-
All incoming messages trigger the module to read the Events Data Store and output results based on the configured module settings. The incoming message is not used for any other purpose other than scheduling when a read occurs.
-
If a Timestamp Property path is configured, the incoming message is inspected to extract the timestamp value from the specified path. If the path is missing or the value cannot be parsed as a valid timestamp, the message is skipped and the module enters an error state. The user must fix the issue and resend the message.
-
If no Timestamp Property is configured, the incoming message is used only to trigger execution and is otherwise not read.
Configuration: Wizard page in the Module Settings dialog
The following table lists the settings for the Wizard page.
|
Name |
Requirements |
Purpose |
Default |
|---|---|---|---|
|
Credential |
Valid CONNECT flows credential |
This is a CONNECT flows credential that belongs to the Connect OAuth Client Credential Grant type. It allows the user to authenticate and communicate with CONNECT. |
N/A |
|
Select Data Store |
Choose a valid data store Instance ID from the populated list |
Determines which instance to retrieve events from. |
N/A |
Configuration: Settings page
|
Name |
Requirements |
Purpose |
Default |
|---|---|---|---|
|
Credential |
Valid CONNECT flows credential |
Automatically populated from the Wizard page in the Module Settings dialog. DO NOT CHANGE. |
N/A |
|
Event Store Instance ID |
Valid ID of a data store instance in CONNECT for the selected account. Length: 1-64 characters. |
Automatically populated from the Wizard page in the Module Settings dialog. DO NOT CHANGE. |
N/A |
|
Timestamp Property |
Optional. A dot-notation path to a property in the incoming message that contains a timestamp string. |
Lower-bound timestamp for event retrieval. When provided, the module reads events generated at or after this timestamp. When not provided, the module uses an internal, in-memory timestamp. |
N/A |
|
Filters |
Optional list of filters. Each filter requires Source, Condition, and Value. Supported Source values: TypeId, Name, Id. Supported Condition values: Equal To, Starts With, Ends With. Note: TypeId and Id only support Equal To. |
Restricts the returned events using backend query syntax. Multiple filters are combined using AND. |
N/A |
|
Target Property |
Length: 1-64 characters |
The property to write the results into. |
data |
|
Keep Properties |
Checked for enabled, or unchecked for disabled |
When checked, keeps all input message properties in the output message; otherwise it creates a new message. |
Disabled |
Module output
The module outputs an array of event results.
Code example: Outgoing message:
[
{
"AcknowledgedDate":"1970-01-01T00:00:00+00:00",
"AdditionalProperties":{
"activePower":{
"ValueKind":"Object"
},
"activePower10minrollingavg":{
"ValueKind":"Object"
},
"averagePrice":46.68149383930529,
"averageWindSpeed":12.25259258743624,
"eventDuration":{
"ValueKind":"Object"
},
"eventDurationEnd":"2025-01-02T01:08:00Z",
"eventDurationStart":"2025-01-02T00:45:00Z",
"expectedPower":{
"ValueKind":"Object"
},
"expectedPower10minrollingavg":{
"ValueKind":"Object"
},
"isRoot":true,
"manufacturer":"Truvale",
"operatingState":"Load Operation",
"powerRated":1500,
"price":46.44929437217419,
"referencedElementPath":"Windtopia\\Big Buffalo Wind Farm\\GE01",
"turbine":"GE01",
"windFarm":"Big Buffalo Wind Farm",
"windSpeed":{
"ValueKind":"Object"
}
},
"AdhocProperties":[
],
"AncestorTypeIds":[
],
"CreatedBy":"e3aacb7d-e4b1-4892-a8e1-bdf989654e19",
"CreatedDate":"2026-03-27T00:45:26.9656889+00:00",
"DataSources":[
],
"Description":"Capture turbine low production events",
"Duration":"00:23:00",
"EndTime":"2026-03-27T01:08:00+00:00",
"Id":"PIWindtopiaAF_45cd7aaa-fb9d-4bdc-9e62-7ba37a63c47c_dab31615-fd00-4da0-bcc9-d47a94ac0358",
"ModifiedBy":"e3aacb7d-e4b1-4892-a8e1-bdf989654e19",
"ModifiedDate":"2026-03-27T01:08:31.1720388+00:00",
"Parent":"PIWindtopiaAF_8b33d5cc-382a-11f0-94d2-001ddcb78302",
"Relationships":[
{
"Id":"Parent",
"Targets":[
{
"Id":"PIWindtopiaAF_8b33d5cc-382a-11f0-94d2-001ddcb78302",
"RelationshipType":"Parent",
"TargetBase":"Entity"
}
]
}
],
"SecurityTags":[
],
"StartTime":"2026-03-27T00:45:00+00:00",
"State":"Closed",
"TypeId":"PIWindtopiaAF_45cd7aaa-fb9d-4bdc-9e62-7ba37a63c47c",
"Version":2
}
]