CONNECT Entities Reader module
- Last UpdatedJun 26, 2026
- 3 minute read
This module reads data from a CONNECT 2.0 Entities Store and outputs it to the next module in the flow. The CONNECT Entities Store Reader module is an Output module type.
Prerequisites
The following prerequisites are required for this module.
-
An existing Entities Store instance 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 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; this allows you to authenticate with CONNECT.
-
Provide the account ID, client ID, client secret, and, optionally, an environment. Leave the environment blank to default to the Production environment.
-
Guidelines
-
At least one source of Entity IDs is required — either the Select Entities list in the wizard, a resource file, or both. See below for the accepted resource file format.
-
Every incoming message initiates a read from the Entities Store. The incoming message content itself is not used; it only controls when a read occurs. Entity Data results are output for use by downstream modules.
Configuration: Wizard/Settings page (Module Settings dialog)
Credential and Data Store Instance ID are required configuration settings for the module. These are set on the Wizard/Settings page of the Module Settings dialog in CONNECT flows. These settings are described in the following table.
|
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 entities from. |
N/A |
|
Select Entities |
N/A |
Allows the user to search for and select entity IDs from the selected entities store instance in an interactive menu. |
N/A |
Settings page
The Credential and Data Store Instance ID fields are auto-populated from your wizard selections. We recommend updating these values on the Wizard page in the Module Settings dialog.
Note: Manually changing these values may cause authentication failures or incorrect data retrieval.
|
Name |
Requirements |
Purpose |
Default |
|---|---|---|---|
|
Credential |
Valid CONNECT flows credential |
Auto-populated from the wizard. Do not modify this field directly. |
N/A |
|
Data Store Instance ID |
Valid data store instance ID in your selected CONNECT account |
Auto-populated from the wizard. Do not modify this field directly. |
N/A |
|
Entity IDs |
Valid list of strings; IDs must exist in the selected data store |
Populated from the wizard's Select Entities field. Can be edited manually. |
N/A |
|
Entity IDs Resource File |
JSON file following the format below |
Alternative way to supply entity IDs via a resource file. |
N/A |
|
Target Property |
1–64 characters |
The message property to write results into. |
data |
|
Keep Properties |
Boolean |
If true, the output message retains all original properties. If false, only the target property is included in the output message. |
true |
Entity ID Validation Rules
Entity IDs are validated against the following rules:
-
Cannot be null, empty, or whitespace.
-
Have a maximum length of 250 characters.
-
Cannot contain control characters.
-
Leading and trailing whitespace is automatically trimmed.
Behavior: partial success
If some entity IDs fail to resolve, the module forwards the successfully resolved entities in the output message. Failed entities are reported as a warning and flowMessage.success is set to false on the message.
Code example: Resource file format
The resource file must be a JSON array of objects, with each object having an id field.
[
{
"id": "EntityId1"
},
{
"id": "EntityId2"
},
{
"id": "EntityId3"
}
]
Code example: Module output
The output is an array of resolved entity objects that contain information about each entity's relationships, properties, metadata, and more.
{
"data": {
"Entities": [
{
"Aliases": [],
"ClassId": "Asset",
"ComponentMetadata": [
{
"AncestorTypeIds": [
"BaseAsset"
],
"ComponentTypeId": "Example_Entity_Type",
"ComponentTypeName": "Example Entity Type"
}
],
"CreatedBy": "00000000-0000-0000-0000-000000000000",
"CreatedDate": "2026-03-23T18:50:49.0453242+00:00",
"Description": "",
"Id": "Example_Entity_101",
"ModifiedBy": "00000000-0000-0000-0000-000000000000",
"ModifiedDate": "2026-03-23T18:50:49.1006605+00:00",
"Name": "Example Entity",
"Properties": [
{
"Category": null,
"ComponentTypeId": null,
"EnumerationSetId": null,
"Id": "__ParentName",
"Name": null,
"TypeCode": "String",
"Uom": null,
"Value": "Property1"
}
],
"Relationships": [
{
"ComponentTypeId": null,
"DataSource": null,
"Id": "parentEntity",
"Name": null,
"Targets": [
{
"Id": "ParentEntity101",
"RelationshipType": "Parent",
"TargetBase": "Entity"
}
]
}
],
"SecurityTags": null,
"Version": 2
}
]
},
"flowMessage": {
"success": true
}
}