CONNECT Streams Reader module
- Last UpdatedJun 26, 2026
- 3 minute read
This module reads CONNECT Streams Data Store (SDS) stream information on demand. When the module starts, it reads the configured list of stream IDs, fetches each stream's metadata and properties, and returns the last value for each stream.
Prerequisites
The following prerequisites are required for this module:
-
An existing Streams Data Store (SDS) in your CONNECT environment.
-
Creation of 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, an environment.
-
Guidelines
-
Stream IDs must be supplied to the module using either the Select Streams field on the Wizard page of the Module Settings dialog, a resource file, or both. See the Examples section at the end of this topic for more details.
-
All incoming messages trigger the module to read from the streams store and output results based on the configured module settings. The incoming messages are not used for any other purpose other than scheduling when a read occurs.
Configuration: Wizard page (Module Settings dialog)
Required configuration settings for the module are listed in the following table. These are set in CONNECT flows on the Wizard/Settings page of the Module Settings dialog.
|
Name |
Requirements |
Purpose |
Default |
|---|---|---|---|
|
Credential |
Valid CONNECT flows credential |
This is the Connect OAuth Client Credential Grant type in CONNECT flows. 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 streams from. |
N/A |
|
Select Streams |
N/A |
Allows the user to select stream IDs from the selected Streams Store instance in an interactive menu. |
N/A |
Configuration: Settings page
|
Name |
Requirements |
Purpose |
Default |
|---|---|---|---|
|
Credential |
Valid CONNECT flows credential |
Automatically populated from the Wizard/Settings page. DO NOT CHANGE. |
N/A |
|
Data Store Instance ID |
Valid ID of a Data Store instance in CONNECT for the selected account |
Automatically populated from the Wizard/Settings page. DO NOT CHANGE. |
N/A |
|
Stream IDs |
IDs are a valid list of strings; stream IDs must exist in the selected CONNECT Data Store instance |
Automatically populated from the Select Streams field and can be added to. |
N/A |
|
Stream IDs Resource File |
The JSON file must follow the accepted pattern shown in the resource file example at the end of this topic. |
A file with an array of Stream IDs to retrieve. Provides the user an alternative option for supplying stream IDs to the module. |
N/A |
|
Target Property |
Length: 1-64 characters |
The property to write the results into. |
data |
|
Keep Properties |
Selected for enabled or deselected for disabled. |
When selected, keeps all input message properties in the output message; otherwise, it creates a new message. |
Disabled |
StreamDataOutput details (per stream)
The module outputs an array of stream results (one for each Stream ID) that contain stream identity, data type, properties, metadata, and the last retrieved value. Each stream result includes the data listed in the following table.
|
Name |
Type |
Description |
|---|---|---|
|
StreamId |
string |
ID of the stream. |
|
StreamName |
string | null |
Name of the stream. |
|
DataType |
string | null |
Type of the stream. |
|
Properties |
IDictionary<string, StreamProperty> |
Set of properties received as a response from SDS. |
|
Metadata |
List<StreamMetadata> |
Stream metadata represented as key-value pairs. |
StreamProperty details
The following table defines stream property details.
|
Name |
Type |
Description |
|
DataType |
string | null |
Data type of the property value. |
|
Value |
object | null |
Property value (may be a primitive or object). |
StreamMetadata details
The following table defines stream metadata details.
|
Name |
Type |
Description |
|---|---|---|
|
Key |
string |
The metadata key. |
|
Value |
string | null |
The metadata value. |
Code examples: Resource file and output results
The following examples show the format for the resource file, and an example of module output results.
Example: Resource file
The resource file must be a JSON file and use the following format:
[
{
"id": "StreamId1"
},
{
"id": "StreamId2"
}
]
Example: Module output results
{
"data": [
{
"DataType": "TimeIndexed.Double",
"Metadata": [],
"Properties": {
"Timestamp": {
"DataType": "DateTime",
"Value": "2026-02-18T21:26:52.013+00:00"
},
"Value": {
"DataType": "Double",
"Value": -74.21715445079566
}
},
"StreamId": "StreamId1",
"StreamName": "StreamId1 Name"
},
{
"DataType": "TimeIndexed.Double",
"Metadata": [],
"Properties": {
"Timestamp": {
"DataType": "DateTime",
"Value": "2026-02-18T21:26:52.013+00:00"
},
"Value": {
"DataType": "Double",
"Value": -74.21715445079566
}
},
"StreamId": "StreamId2",
"StreamName": "StreamId2 Name"
}
]
}