Configuration
This section explains each of the properties in the configuration blade.
General
| Property | Description |
|---|---|
Collection | This associates the Agent to a specific Collection (default to that of the current Data Stream). |
Refer to Collections and Stream Hosts to understand more about Collections.
Server
| Property | Description |
|---|---|
Use Connection Variables | Tick to select saved variables; or enter the text manually for the authentication properties. |
Url | The Url of the App Designer server where events are sent. |
Key | The Integration Key of the App Designer server. Please contact your administrator to get this value. |
Output on first occurrence only? | Tick to output an event when an input record creates a new Recommendation Alert. If unticked, events are also generated when input records match existing Recommendation Alerts. |
Entity
| Property | Description |
|---|---|
Entity ID | The column or attribute of the input payload that uniquely identifies the entity, which may be the asset or a combination of the asset and other information, for the recommendation to trigger an alert. |
Asset ID | An optional column or attribute of the input payload that identifies the related asset. |
Process ID | An optional column or attribute of the input payload that identifies the related process. |
KPI ID | An optional column or attribute of the input payload that identifies the related key process indicator. |
Columns To Return
| Property | Description |
|---|---|
Columns to return | The columns or attributes of the input payload included in the output payload. Leave blank to include all. |
Before configuring the Recommendation, please ensure that its input endpoint is connected to a parent Agent which will be sending data to it.
Endpoints
| Property | Description |
|---|---|
Input | This endpoint is used to receive data from the parent Agent, against which the Recommendation rules are run. |
Output | The identifying and descriptive properties of any created Recommendations, controlled by the Columns To Return setting, are made available to this endpoint. |
Error | Errors encountered during the execution of this Agent will be published on this endpoint. |
Last updated
