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).
Polling Interval
A timespan to specify how often should the Agent check for new data/changes or update its cache.
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.
Url
The URL of the App Designer server from which to read recommendations.
Key
The Integration Key of the App Designer server.
Recommendation
Property
Description
Recommendation
One or more recommendations to read.
Rules
An optional filter applied to the recommendations .
Additional Fields to Return
If the selected Rules have Forms attached, their fields can be selected here to include them in the details.
No. of days to query
Filter recommendations based on their created date. If set to 0, no filtering is performed.
Status
Filter recommendations based on their status - Pending (open), Resolved (closed), or All (both).
Include Summary
Tick to make a summary of received events available on the Summary endpoint.
Include Work Instructions
Tick to include work instructions in the recommendation data.
Include Rule Icon
Tick to include the rule's icon in the recommendation data.
Summary Options
Ticking the Include Summary option enables the Summary endpoint, which aggregates various data about the received recommendations. These options control how the records are aggregated and summarized.
Property
Description
Interval Type
The size of the interval: Month, Week, or Day. For instance, selecting Week will organize Recommendations based on how many full 7-day intervals have passed since they were opened.
Columns to Return
The summary data options are:
TotalCount - The total count of recommendations in this group.
AvgCountPerEntity - The average count of recommendations per Entity in this group.
EntityWithMaxRec - The EntityId that has the most recommendations in this group.
EntityWithMaxRec_Count - The number of recommendations against the Entity with the most recommendations.
EntityWithMinRec - The EntityId that has the least recommendations in this group.
EntityWithMinRec_Count - The number of recommendations against the Entity with the least recommendations.
ChangeVsPrevInterval - The difference between this interval and the previous, as a positive number.
ChangeDirection - Whether the above difference was lesser ("Down") or greater ("Up") than the previous interval.
Group Rules Together
Tick to generate a single summary encompassing all configured rules, or each rule will get a summary output.
Endpoints
Name
Description
Output
The recommendation data is made available to this endpoint.
Summary
If Include Summary is ticked, summary data is made available to this endpoint.

Property	Description
Collection	This associates the Agent to a specific Collection (default to that of the current Data Stream).
Polling Interval	A timespan to specify how often should the Agent check for new data/changes or update its cache.

Property	Description
Use Connection Variables	Tick to select saved variables, or enter the text manually.
Url	The URL of the App Designer server from which to read recommendations.
Key	The Integration Key of the App Designer server.

Property	Description
Recommendation	One or more recommendations to read.
Rules	An optional filter applied to the recommendations .
Additional Fields to Return	If the selected Rules have Forms attached, their fields can be selected here to include them in the details.
No. of days to query	Filter recommendations based on their created date. If set to 0, no filtering is performed.
Status	Filter recommendations based on their status - Pending (open), Resolved (closed), or All (both).
Include Summary	Tick to make a summary of received events available on the Summary endpoint.
Include Work Instructions	Tick to include work instructions in the recommendation data.
Include Rule Icon	Tick to include the rule's icon in the recommendation data.

Property	Description
Interval Type	The size of the interval: Month, Week, or Day. For instance, selecting Week will organize Recommendations based on how many full 7-day intervals have passed since they were opened.
Columns to Return	The summary data options are: TotalCount - The total count of recommendations in this group. AvgCountPerEntity - The average count of recommendations per Entity in this group. EntityWithMaxRec - The EntityId that has the most recommendations in this group. EntityWithMaxRec_Count - The number of recommendations against the Entity with the most recommendations. EntityWithMinRec - The EntityId that has the least recommendations in this group. EntityWithMinRec_Count - The number of recommendations against the Entity with the least recommendations. ChangeVsPrevInterval - The difference between this interval and the previous, as a positive number. ChangeDirection - Whether the above difference was lesser ("Down") or greater ("Up") than the previous interval.
Group Rules Together	Tick to generate a single summary encompassing all configured rules, or each rule will get a summary output.

Name	Description
Output	The recommendation data is made available to this endpoint.
Summary	If Include Summary is ticked, summary data is made available to this endpoint.

Last modified 3mo ago