Dynamics 365 New Releases and Upgrading Versions
In most cases, updating InRule for Dynamics is a relatively straight forward process. You will effectively follow the same order of operations of the initial installation steps outlined in this project.
The components that will need to be upgraded are:
- irAuthor with irX for Dynamics 365
- Rule Execution and Catalog Services
- InRule for Dynamics Solution
All 3 of these components must be upgraded in all upgrade scenarios.
Beyond that, this appendix discusses some special cases and considerations to be aware of when upgrading.
Release History
| Version | Status | Release date | Description |
|---|---|---|---|
| v5.9.0 | RELEASED | Nov 2025 | Upgraded Dynamics execution service to .NET 8.0 WebAPI including authentication options – Primary/Secondary API Key and OAuth. Re-themed the InRule Dynamics Solution pages and added API Key/OAuth configuration to support the new Dynamics Execution API. |
| v5.8.1 | RELEASED | May 2024 | Polymorphic Lookup support, upgrade to DataverseServiceClient v1.1.16, enhanced plugin trace logging, entity deletion capability, RuleHelper fixes, new Rest Execution Service .NET 6 Web API (preview only) |
| v5.8.0 | RELEASED | Nov 2022 | Maintenance Release |
| v5.7.3 | RELEASED | Apr 2022 | RuleHelper query and caching enhancements, 'Rule Executor' role added to Dynamics solution, upgrade to Xrm 9.1.0.79 |
| v5.7.2 | RELEASED | Jul 2021 | Configuration UIs added to InRule SaaS Portal |
| v5.7.1 | RELEASED | Mar 2021 | Maintenance Release |
| v5.7.0 | RELEASED | Feb 2021 | Expanded Execution Options for Rule Sets, Decisions, Parameters, and Version Labels |
| v5.6.0 | RELEASED | Jun 2020 | Power Platform Integration Enhancements, irX OAuth 2.0 Advanced Login, "Test Connectivity" button in Dynamics Solution, Upgrade to XRM 9.1.0.42 |
| v5.5.1 | RELEASED | Feb 2020 | PowerApp Readiness, Data Loading Performance Improvements, Full N:N Relationship Support |
| v5.5.0 | RELEASED | Dec 2019 | Endpoint Overrides in App Settings, Run Rules from Views across batch entities |
| v5.4.3 | RELEASED | Oct 2019 | Maintenance Release |
| v5.4.2 | RELEASED | Sep 2019 | AppInsights Logging, Enhanced Query Caching |
| v5.4.1 | RELEASED | Jun 2019 | Maintenance Release |
| v5.4.0 | RELEASED | May 2019 | UCI compatibility, 8.2 On-Premises Support |
| v5.3.0 | RELEASED | Feb 2019 | Microsoft AppSource Listing, Run Rules button–Rule Set configuration to select from Rule Set list, Configuration for step registration (eliminate dependency on Plugin Registration Tool), Rule Execution Workflow Activity, Config to return Rule execution log to trace log |
| v5.2.0 | RELEASED | Oct 2018 | Rule Execution WebJob App Service replaces Cloud Service Worker Role, Azure ARM Templates, XRM upgrade to v9, S2S connection support |
| v5.1.1 | RELEASED | Aug 2018 | Formalize On-premises Deployment Options |
Version Compatibility Considerations
The below list of items for upgrade consideration includes specific fixes or changes that may require migration or configuration action. Issue number and title are included here, but you can refer to the release notes section of the support site for further information: Decision Platform Release Notes – InRule Technology. This page includes release notes for all InRule products with Dynamics-specific release notes grouped accordingly.
Again, when upgrading to a new version, irAuthor, the InRule for Dynamics Solution, and the Azure Rule Execution Service should always be upgraded together
| Issue Number | Version | Description |
|---|---|---|
| PLAT-1005 | 5.9.0 | Changes in the way Dynamics handles role permission assignment required disabling of the Package Deployer code that dynamically updated the permissions for the 'InRule Integration Administrator' role included in the solution. If this role is assigned to the service account used by the Rule Execution Service we suggest creating a new custom role with the minimum permissions to connect to Dynamics and read the entities required for rule execution. |
| PLAT-569 | 5.9.0 | Upgraded Dynamics execution service to .NET 8.0 WebApi including authentication options – Primary/Secondary API key and OAuth. The new Dynamics Execution API is functionally identical to the AzureRelay/Webjob integration, which should make for a seamless transition, but the new authentication configuration will need to be updated. Change to App settings Notation The Environment Variable App settings for the InRule-provided Azure ARM templates will default to a double underscore ( __) notation vs the previous colon (:) notation, for example:
|
| DYN-778 | 5.8.1 | Removed deployment of app insights resource and all associated conditional logic from ARM templates. Instead, users can provide an Application Insights connection string from an existing resource. |
| DYN-673 | 5.7.3 | Added ruleAppLabel parameter to execution service arm template. By default this label is empty. No ruleAppLabel will result in the most recent version of a rule app being used. Customers relying on a label to denote the production ready version of a rule app, such as LIVE, will want to add the production label to the arm template prior to upgrade deployment. |
| DYN-469 | 5.7.3 | Removed legacy S2S authentication settings |
| DYN-558 | 5.7.2 | Added a new page to the InRule solution and sitemap to aid configuration for SaaS setups. This page allows you to grant the required consent to the InRule Azure AD application, and creates the associated Application User for you |
| DYN-502 | 5.7.0 | Rule configurations have been updated to use Rule Set configuration entities rather than a single rule set list field. The new Rule Set configuration allows for setting Display Names, Sort value, Description, and Parameters. This should not affect existing rule configurations; an upgrade for rule configurations to this new model will automatically occur when upgrading to v5.7.0 |
| DYN-40 | 5.7.0 | Deprecate custom S2S authentication with built-in connection string support |
| DYN-445 | 5.7.0 | Deprecate usage of Xrm.Page. As a result, formContext will need to be passed as the first parameter to inRule.executeRules, if calling the function from custom JavaScript |
| DYN-447 | 5.7.0 | Remove solution support for Dynamics 8.2 |
| DYN-442 | 5.6.0 | Added support for advanced authentication to irX, including MFA |
SaaS Upgrades
For SaaS customers, the upgrade process will be communicated to you by InRule via email. Keep an eye out for these communications, as they will be the primary source of guidance around what to do in upgrade scenarios. Relevant information from these communications includes when an update will be occurring, the new features coming with the update, the maintenance times required to apply the update, and mandatory steps you'll need to take immediately following the update.
Upgrading the InRule Dynamics Solution
For upgrading the InRule Dynamics Solution, it is recommended to update via the Power Platform Admin. All configuration managed in the InRule Solution should be automatically preserved during an ordinary upgrade. In the event there are changes to settings that require manual intervention, this will be detailed in the Version Compatibility Section. For additional peace of mind when upgrading, it may still be a good idea to capture pre-upgrade configuration settings via screenshot or other to refer back to in the case of troubleshooting scenarios.
Execution Service App Settings
When running an ARM template deployment to upgrade an existing app service, the new deployment will remove all app settings that currently exist and replace them with the settings during the new deployment. Because of this, it is important to save your parameters file when you do a deployment. If you do not have your previous parameters file you can find it in the deployments section of the Azure Portal. This also means that any settings that were changed or added manually, such as logging level or endpoint overrides, will be removed.
Alternatively, current app setting values can be manually set in the ARM template parameter file prior to deployment to have the template deploy using those values. Should you go this route, be thorough during the transfer process, it is common for values to have been manually changed over time. For a thorough breakdown of the relevant parameters, reference Rule Execution App Service for Dynamics 365
Lastly, redeploying or upgrading via the ARM template will remove your InRule license from the resulting app service. The license file will need to be manually added back; for a walkthrough on how to do this, reference License Management.
WS-Trust/Office365 Auth Deprecation
As of April 2022, Microsoft has deprecated WS-Trust/Office365 Authentication. If you are intending to leverage S2S authentication, it is strongly recommended you familiarize yourself with Microsoft's announcement and understand the transition to OAuth based connection strings, as any connection strings used will need to be OAuth. You can find Microsoft's documentation on the topic here.
Early versions of irX (<5.6) and the integration framework (<5.2) can only leverage WS-Trust authentication and will not be compatible with this change. For full functional coverage, customers will need to be running these versions or newer to ensure compatibility with this transition.
S2S Legacy Settings Removal
In previous versions of the Rule Execution Service, S2S connection information was provided in individual app settings. Configuring the connection information this way was deprecated in 5.7.0, and support for it has been removed entirely in 5.7.3. The legacy app settings that have been removed are:
- orgUrl
- appId
- appSecret
S2S connection information should now be provided as a connection string in the crmConnectionString app setting. See link for configuring connection string information: https://docs.microsoft.com/en-us/powerapps/developer/common-data-service/xrm-tooling/use-connection-strings-xrm-tooling-connect
Solution Customizations
If you have used the Plugin Registration tool to change the 'Run in User's Context' setting on the 'InRule Custom Action Step', you will need to set this back when updating. Additionally, in the unlikely event you have made any other customizations to resources included in the solution, such as the JavaScript web resources, you will need to re-apply these customizations after updating the solution.
Upgrading from Cloud Service-Based Versions
Earlier versions of InRule for Dynamics used Azure's legacy Cloud Service platform for the rule execution service. The last version to support this was 5.1.1. Versions from 5.2.0 and on now use Azure App Service for the same purpose. When upgrading from one of these versions, simply follow the steps for creating, deploying, and configuring the new Azure resources. Both the App Service and Cloud Service versions use Azure Relay for communication with Dynamics, but in most cases, it is simpler to let the provided ARM template provision a new Relay for use with the App Service. Continue following the rest of the steps in the Deployment Guide to deploy the new version of the Dynamics package and configure it to point to the new Relay and execution service. Once you have verified the new setup is working, you can delete the old Cloud Service resources.
Switching from Dynamics On-Prem to Online
While there are no universal steps for transitioning from an on-prem to online version of Dynamics, there are a few conceptual differences in the way InRule for Dynamics works in each that you should be aware of. In on-prem installations, communication with the rule execution service is typically handled directly via HTTP. In Dynamics Online, communication is handled via an Azure Relay resource that manages the WCF Relay. Depending on the specifics of how your migration takes place, you may need to re-install the Dynamics package entirely, or it may still be installed on the migrated instance, along with associated config records. Either way you will need to follow all the steps in Performing the Installation: In Azure for deploying to Azure, and ensuring that the required Relay information is updated in Dynamics. Once you complete all these steps, you will need to update any existing InRule Configuration records to replace the URI that was in the 'Service Endpoint Id (or Uri)' field with the appropriate value (d2e50ca1-ef4c-e611-80e9-6c3be5a82b30).
Using the New Entity-Based Configuration
From version 5.0.28 and on, step registrations can be configured from within Dynamics. This new system uses Rules Configuration records and associates them to step registrations created in the Rules Configuration UI. Before you can use this new configuration, you will need to delete any custom registrations (registrations other than 'InRule Custom Action Step') under the OnlinePlugin:
Once you've deleted these registrations, you can create new ones from Dynamics using the steps in Rules Configuration and Settings
Default Rule App Label Change
As of v5.7.3, the default Rule App Label configured on the execution service has been changed from "LIVE" to not being set with a value. If a default label is not configured on the execution service, it will now default to using the most recent version of the rule app being run. This has the potential to create an issue during upgrade scenarios where users are relying on the LIVE label to denote their production-ready rule. If using the most recent version of the given rule app is not the desired outcome, the default label on the execution service will need to be set back to LIVE (or whatever the appropriate production label for your existing rule apps may be). This can be done in the ARM template prior to upgrade deployment.