Run Recommendation

The Run Recommendation Agent is a vital part of the App Designer Recommendation functionality. It is used to run Recommendation rules against events in your Data Stream, thus Alerts are raised in App Designer for events that match one or more rules.

The Recommendation configuration includes the selection of a Data Stream where it is applied to events. Including this Agent causes the Data Stream to be available for selection in the Recommendation configuration.

Details for an example and its configuration can be found in the How to Use section.

Pre-requisites

The following is required to use this Agent:

• An App Designer server accessible using the same Subscription Manager credentials as this Data Stream Designer instance

• The minimum XMPro App Designer version required for the classification support (introduced with v3.00) is v4.4.7

• The minimum XMPro Stream Host version required for v3.00 is v4.4.2, however v3.03 is backward compatible to Stream Host v4.3.7+.

Current Version

• Download the Run Recommendation v4.0 (Last Update: 14 Apr 2026)

Please contact XMPro if you're looking for an older version of this Agent.

Release Notes

Version	Date	Description
4.00	14 Apr 2026	Repackaged to translate missed dropdown properties. Support Event-Level Streaming (when using XMPro Platform v4.6+) for reduced memory usage and earlier downstream processing Support downstream processing after all rules are assessed with a new Status output endpoint to publish Recommendation details and a per-rule execution summary, regardless of whether alerts were generated.
3.06	03 Nov 2025	Improved thread safety to resolve an "enumeration operation may not execute" exception when the Recommendation rule is edited while the Agent executes.
3.05	28 Jul 2025	Added error handling to prevent the Stream Host from crashing when the Agent is not configured or unable to authenticate with the credentials provided.
3.04	20 Jan 2025	Repackaged to translate the Agent's properties. Replaced deprecated System.Data.SqlClient library with Microsoft.Data.SqlClient, to mitigate the risk of security vulnerabilities.
3.03	30 Jul 2024	Added Rule Id to the output payload.
3.00	4 Jul 2024	Added classification support, i.e. asset, process, and/or KPIs. Note the updated pre-requisites.
2.64	12 Apr 2024	Fixed a rare concurrent access exception when fetching updated rules.
2.63	21 Jun 2023	Fixed auto-resolve recommendations causing a high load on the database.
2.60	5 May 2023	Added a warning message to the Entity Identifier property, reminding the user that an unsuitable identifier may result in an excessive number of recommendation alerts.
2.59	12 Sep 2022	Repackaged to include the Agent's Category
2.58	4 Jun 2021	Fixed variables (that reference another variable twice or more) being flagged as recursive and throwing an error.
2.57	3 Jun 2021	Variable parsing detects and throws an exception if a variable references itself, instead of crashing the stream host.
2.56	28 May 2021	Rules are only fetched on error once per event batch.
2.55	27 May 2021	Agent responds to new Response Code API response property by updating rule cache if necessary.