Enhance pac solution import to support routing rulesets lifecycle during upgrades

[jboliveira]

Context

If a routing ruleset is present during an upgrade deployment, Microsoft recommends (required) changing the routing state to draft, performing the solution upgrade, and then reactivating the routing rulesets. More information may be found by clicking here.

It is feasible to accomplish this using PowerShell:

# Deactivate
Set-CrmRecordState -conn $crmConn -EntityLogicalName routingrule -Id $routingruleid -StateCode 0 -StatusCode 1

# Activate
Set-CrmRecordState -conn $crmConn -EntityLogicalName routingrule -Id $routingruleid -StateCode 1 -StatusCode 2

Furthermore, it could be improved by adding a check to the script that checks if any routing rules are activated and, if so, changes their status to draft, but this will necessitate exporting these routing rule Ids in as task output variable to be used in the second script that will be executed immediately after the solution deployment to reactivate the routing rules based on the Ids from the previous task. [Seems complex, but it's not] 🤡

Without further ado, let's get started with the Idea.

Idea

The aim is to have a mechanism that checks whether any routing rule(s) are activated during the solution import, if so, change the status to draft, import the solution (if upgrade), and then re-activate the routing rule(s) [only those that had previously been activated] when the import is complete.

The feature would be added to the existing pac solution import.

Commands

Usage: pac solution import [--path] [--activate-plugins] [--force-overwrite] [--skip-dependency-check] [--import-as-holding] [--publish-changes] [--convert-to-managed] [--async] [--max-async-wait-time] [--settings-file] [--skip-lower-version] [--activate-flows] [--update-canvas-app-ownership] [--manage-routing-rules]

Not all commands are described; just the additional one is.

Read more: Microsoft Power Platform CLI solution command group - Power Platform | Microsoft Learn

command	description
--manage-routing-rules	Optional: Routing rules should be recycled automatically if they exist. (alias: -mr)

Remarks

The only challenge with this topic is the relationship between routedqueueid and routingruleitemid, which is not part of the solution managed package. Currently, I have an additional mechanism in place to handle this problem and deploy the relationship to higher environments using PowerShell script; nevertheless, it would be a topic to be addressed in the pac solution export.