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.
Details
Property
Description
Use Environment Variables
Tick to use the system Environment Variables for Python; or enter the Python home and path manually.
​
​
Python Home
The location of the Python folder (applies if Use Environment Variables is not ticked).
Eg. C:\Python37\Lib\site-packages
Python Path
The location of the Python site packages folder (applies if Use Environment Variables is not ticked).
Eg. C:\Python37\Lib\site-packages
Python Version
The major Python version which installed on the Stream Host machine.
Python File
The Python script file to be executed. 
Input Mapping
Input variables from the Python file are auto-populated when it is loaded. Each input variable is mapped to a column or attribute from the input payload.
Outputs
One or more Python variable names from the Python script file. These are added to the output payload. 
Columns Returned
The output values can either be appended to the incoming payload (Append to Existing), or a new payload is created that consists only of the output values (New).
Globals Grid
Optional. Any global variables defined in the Python file that to be available immediately when next the Data Stream is published. The value is saved to a Pickle file whenever the Data Stream is unpublished. 
This allows you to maintain program state across sessions, e.g. to recall the previous high temperature without waiting on sensor input or a recalculation.
Before configuring the Python Agent, please ensure that its input endpoint is connected to a parent Agent which will be sending data to it.
Endpoints
Name
Description
Input
This endpoint is used to receive data from the parent Agent.
Output
Events received from the parent Agent are made available to this endpoint with the configured Outputs appended.
Error
Errors encountered during the execution of this Agent will be published on this endpoint.

Property	Description
Collection	This associates the Agent to a specific Collection (default to that of the current Data Stream).

Property	Description
Use Environment Variables	Tick to use the system Environment Variables for Python; or enter the Python home and path manually.

Python Home	The location of the Python folder (applies if Use Environment Variables is not ticked). Eg. C:\Python37\Lib\site-packages
Python Path	The location of the Python site packages folder (applies if Use Environment Variables is not ticked). Eg. C:\Python37\Lib\site-packages
Python Version	The major Python version which installed on the Stream Host machine.
Python File	The Python script file to be executed.
Input Mapping	Input variables from the Python file are auto-populated when it is loaded. Each input variable is mapped to a column or attribute from the input payload.
Outputs	One or more Python variable names from the Python script file. These are added to the output payload.
Columns Returned	The output values can either be appended to the incoming payload (Append to Existing), or a new payload is created that consists only of the output values (New).
Globals Grid	Optional. Any global variables defined in the Python file that to be available immediately when next the Data Stream is published. The value is saved to a Pickle file whenever the Data Stream is unpublished. This allows you to maintain program state across sessions, e.g. to recall the previous high temperature without waiting on sensor input or a recalculation.

Name	Description
Input	This endpoint is used to receive data from the parent Agent.
Output	Events received from the parent Agent are made available to this endpoint with the configured Outputs appended.
Error	Errors encountered during the execution of this Agent will be published on this endpoint.

Last modified 9mo ago