A button on the command bar is visible when it should be hidden
Article
Applies to: Power Apps Original KB number: 4552163
Determine why a button is visible
A button will be made visible if all the enable rules and display rules on the command associated with the button evaluate to true. If this is unexpected, it's possible that the command definition has been overridden and is missing enable rules or display rules, or the rule definitions themselves are overridden and causing the button to be visible when you expect it to be hidden.
Do not remove the Mscrm.HideOnModern display rule from a command to force a button to appear in the Unified Interface. Commands that have the Mscrm.HideOnModern display rule are intended for the legacy Web Client interface and are not supported in the Unified Interface, and may not work correctly.
The following example shows two Appointment buttons on the activities grid page, and one is expected to be hidden.
Select the Command Properties tab to display the details of the command for this button. This will display the actions, enable rules, and display rules, along with the result (True, False, Skipped) of each rule evaluation. Review the enable rules and display rules, if you expect a particular rule should be evaluating to false, then it's possible the rule is incorrectly customized or the necessary circumstances to return a false result aren't met. If so, skip to step 9, otherwise it's possible then that the command is missing a rule or rules and we'll view the command solution layers for further analysis.
Select the View command definition solution layers link below the command name to view the solution(s) that installed a definition of the command.
The Solution Layers pane will display the layering of each ribbon component definition a particular solution has installed. The layer at the top of the list is the current definition that is used by the application, the other layers are inactive and aren't used by the application at the moment. If the top solution is uninstalled or an updated version is installed that removes the definition, then the next layer will become the current active definition used by the application. When an unmanaged Active solution layer is present, it will always be the definition the application uses. If there's no Active solution listed, then the solution listed at the top of the list will be the definition used by the application. Any custom-managed solutions that aren't published by Microsoft will also take precedence over Microsoft published solution layers.
The Entity context indicates the object the ribbon customization is on, if "All Entities" is listed, then the layer is from the Application Ribbon client extensions and not entity specific, otherwise the logical name of the entity will be listed.
When there are two or more layers, you can select two rows and select Compare to view a comparison of the definitions brought in by each solution.
Selecting Back will return to the previous Command Checker window.
If there's only one solution layer, skip to step 9, otherwise, select the top two solution layers (If you have a layer in the Active solution, but it isn't listed at the top, select the Active solution layer and then the top row) and select Compare.
The comparison of the current active definition and the previous inactive definition will be displayed showing the differences, if any. The following example shows the unmanaged Active definition to have been customized with the removal of a display rule Mscrm.HideOnModern that is included in the inactive msdynce_ActivitiesPatch Microsoft published solution layer.
The approach needed to fix a button's visibility will depend on the various customizations in your specific scenario. If you determined that a rule is incorrectly evaluating to false, and if the rule definition is incorrectly defined, then you should modify the rule definition and make changes that would permit the rule to evaluate to false under the proper circumstances. If the rule definition is correct, then it's possible that the requirements that would make the rule return false aren't met, such as a field value or security privilege isn't correctly assigned. Depending on your rule definition, the requirements can vary greatly, refer to Define ribbon enable rules, and Define ribbon display rules. Considering our example, the command was customized with the removal of a Mscrm.HideOnModern display rule. This display rule is intended to hide this particular button from being displayed in Unified Interface applications and only be visible in the legacy Web Client interface. We could modify the custom version of the command and add the missing the Mscrm.HideOnModern display rule to the command definition. Since this is a custom override of a Microsoft published definition and there are no other intentional modifications, it's recommended that this custom version of the command be deleted to restore the default functionality.
Repair Options
Select a repair option from one of the tabs below. The first tab is selected by default.
If there's another solution layer that contains a working definition of this command, then you can delete this definition to restore the next inactive working definition.
If this is the only layer and you no longer need the command, then you can remove it from your solution if no other button is referencing the command.
Select one of the following options that matches your particular scenario:
The command is in the unmanaged Active solution
To delete a command in the Active unmanaged solution layer, we'll export an unmanaged solution containing the entity or Application Ribbon and edit the <RibbonDiffXml> node in the customizations.xml file, and then import a new version of this solution where this command has been removed in order to delete the component. See Export, prepare to edit, and import the ribbon.
The command is entity-specific
Based on our example scenario, we identified the entity is activitypointer and the command that needs to be deleted is Mscrm.CreateAppointment and it's declared in the Active unmanaged solution layer from a publisher named DefaultPublisherCITTest.
Open Advanced Settings.
Navigate to Settings -> Solutions.
Select New to create a new solution, set Publisher to the value shown in the Command Checker's solution layers listing for the command and the Active solution layer. (In our example, this is DefaultPublisherCITTest).
Select Entities > Add Existing.
Select the entity your command is defined on (In our example, this is activitypointer) and select OK.
Make sure you uncheck the Include entity metadata and uncheck Add all assets options before selecting Finish.
Select Save.
Select Export Solution and export the unmanaged solution.
Extract the .zip file.
Open the customizations.xml file.
Locate the <Entity> node child of the entity node you wish to edit and locate its child <RibbonDiffXml> node.
Locate the <CommandDefinition> node (In our example, ID of the <CommandDefinition> node is Mscrm.CreateAppointment, so we would locate the following node).
Edit the <RibbonDiffXml> node and remove the specific <CommandDefinition> node that has the ID of the command you wish to delete. Make sure you don't unintentionally delete other <CommandDefinition> nodes that may be present. (Based on our example, we would delete the <CommandDefinition> node in which ID is Mscrm.CreateAppointment.)
Save the customizations.xml file.
Add the modified customizations.xml file back to the solution .zip file.
Import the solution file.
Select Publish All Customizations.
The command is in the Application Ribbon (applies to "All entities")
If the command isn't entity-specific, rather it's applicable to "All Entities" declared in the Application Ribbon, then the steps will be slightly different as follows:
Open Advanced Settings.
Navigate to Settings > Solutions
Select New to create a new solution, set Publisher to the value shown in the Command Checker's solution layers listing for the command and the Active solution layer.
Select Export Solution and export the unmanaged solution.
Extract the .zip file.
Open the customizations.xml file.
Locate the root <RibbonDiffXml> node.
Locate the <CommandDefinition>.
Edit the <RibbonDiffXml> node and remove the <CommandDefinition> node that has the ID of the command you wish to delete. Make sure you don't unintentionally delete other <CommandDefinition> nodes that may be present.
Save the customizations.xml file.
Add the modified customizations.xml file back to the compressed solution .zip file.
Import the solution file.
Select Publish All Customizations.
The command is from a custom-managed solution that my company authored
To delete a command that was installed by a custom-managed solution that you created, follow these steps:
In your separate development organization that has the unmanaged source version of your custom solution, complete the steps listed above for the The command is in the unmanaged Active solution option.
Increment the Version of your custom solution.
Export solution as managed.
In your separate affected organization, import this new version of your custom-managed solution.
The command is from a custom-managed solution that my company did not author (from third-party/ISV)
To delete a command that was installed by a custom-managed solution that was created by a third-party/ISV, you'll need to contact the author of the solution and request a new version of the solution that has removed the specific command definition and then install this new solution into your affected organization.
How to add missing enable/display rules to the command
If there are modifications to the command that you need to retain, but you still want the button to be hidden under the appropriate circumstances, then you can add the missing enable/display rules to the command instead of deleting the custom definition.
Select one of the following options that matches your particular scenario:
The command is in the unmanaged Active solution
If you determined that enable/display rules are missing from your command definition, then you can modify the <CommandDefinition> node and add the rules to achieve the desired behavior. To fix a command in the Active unmanaged solution layer, we'll export an unmanaged solution containing the entity or Application Ribbon and edit the <RibbonDiffXml> node in the customizations.xml file, and then import a new version of this solution containing the fixed command definition. See Export, prepare to edit, and import the ribbon.
The command is entity-specific
Based on our example scenario, we identified the entity is activitypointer and the command that needs to be fixed is Mscrm.CreateAppointment and it's declared in the Active unmanaged solution layer from a publisher named DefaultPublisherCITTest.
Open Advanced Settings.
Navigate to Settings > Solutions.
Select New to create a new solution, set Publisher to the value shown in the Command Checker's solution layers listing for the command and the Active solution layer. (In our example, this is DefaultPublisherCITTest)
Select Entities > Add Existing.
Select the entity your command is defined on (In our example, this is activitypointer) and select OK.
Make sure you uncheck the Include entity metadata and Add all assets options before selecting Finish.
Select Save.
Select Export Solution and export the unmanaged solution.
Extract the .zip file.
Open the customizations.xml file.
Locate the <Entity> node child of the entity node that you want to edit, and locate its child <RibbonDiffXml> node.
Locate the <CommandDefinition> node. In the example, the ID of the <CommandDefinition> node is Mscrm.CreateAppointment. Therefore, you would locate the following node:
Edit the <RibbonDiffXml> node, and make the necessary changes to the <CommandDefinition> node that will enable the command to function correctly under the correct circumstances to fix the command. For more information about how to declare commands, see Define ribbon commands. (Based on our example, we would modify the <CommandDefinition> node by adding the Mscrm.HideOnModern display rule that will correctly hide this button.)
Restore the modified customizations.xml file to the solution .zip file.
Import the solution file.
Select Publish All Customizations.
The command is in the Application Ribbon (applies to "All entities")
If the command isn't entity-specific, rather it's applicable to "All entities" declared in the Application Ribbon, then the steps will be slightly different as follows:
Open Advanced Settings.
Navigate to Settings > Solutions.
Select New to create a new solution, set Publisher to the value shown in the Command Checker's solution layers listing for the command and the Active solution layer.
Select Export Solution and export the unmanaged solution.
Extract the .zip file.
Open the customizations.xml file.
Locate the root <RibbonDiffXml> node.
Locate the <CommandDefinition>.
Edit <RibbonDiffXml> and make the necessary changes to the <CommandDefinition> node that will enable the command to function correctly under the correct circumstances to fix the command. For more information about how to declare commands, see Define ribbon commands.
Add the modified customizations.xml file back to the solution .zip file.
Import the solution file.
Select Publish All Customizations.
The command is from a custom-managed solution that I authored
To fix a command that was installed by a custom-managed solution that you created, follow these steps:
In your separate development organization that has the unmanaged source version of your custom solution, complete the steps listed above for the The command is in the unmanaged Active solution option.
Increment the Version of your custom solution.
Export solution as managed.
In your separate affected organization, import this new version of your custom-managed solution.
The command is from a custom-managed solution that I did not author or my organization does not own (i.e. from a third-party/ISV)
To fix a command that was installed by a custom-managed solution that was created by a third-party/ISV, you'll need to contact the author of the solution and request a new version of the solution that contains the fixed command definition and install this new solution into your affected organization.
The command is in a Microsoft published managed solution
To fix a command that was installed by a Microsoft published managed solution, you may need a newer version of the solution to be installed, which would typically be done during a release update. It's possible that you've identified a bug that still needs to be fixed. Contact customer support for assistance.
How to fix an enable/display rule
Select the View rule definition solution layers link below the rule name to view the solution(s) that installed a definition of the rule.
The Solution Layers pane will display the layering of each ribbon component definition a particular solution has installed. The layer at the top of the list is the current definition that is used by the application, the other layers are inactive and aren't used by the application at the moment. If the top solution is uninstalled or an updated version is installed that removes the definition, then the next layer will become the current active definition used by the application. When an unmanaged Active solution layer is present, it will always be the definition the application uses. If there's no Active solution listed, then the solution listed at the top of the list will be the definition used by the application. Any custom-managed solutions that aren't published by Microsoft will also take precedence over Microsoft published solution layers.
The Entity context indicates the object the ribbon customization is on, if "All Entities" is listed, then the layer is from the Application Ribbon client extensions and not entity specific, otherwise the logical name of the entity will be listed.
When there are two or more layers, you can select two rows and select Compare to view a comparison of the definitions brought in by each solution.
Selecting Back will return to the previous Command Checker window.
The following image shows the solution layers for the enable rule in our example, and indicates that there's one solution layer in this case, and that it's an unmanaged customization as denoted by the solution titled Active. Your actual scenario may differ, you may not an Active solution layer, you may have a managed solution and the name of that solution will be listed here.
Now that we've reviewed the solution layers and identified the solution that installed the customization, we must fix the definition in the appropriate solution.
Select one of the following options that matches your particular scenario:
The enable/display rule is in the unmanaged Active solution
To fix an enable/display rule in the Active unmanaged solution layer, we'll export an unmanaged solution containing the entity or Application Ribbon and edit the <RibbonDiffXml> node in the customizations.xml file, and then import the new version of this solution containing the fixed enable/display rule definition. See Export, prepare to edit, and import the ribbon.
The enable/display rule is entity-specific
Based on our example scenario, we identified the entity is contact and the enable rule that needs to be fixed is new.contact.EnableRule.EntityRule and it's declared in the Active unmanaged solution layer from a publisher named DefaultPublisherCITTest.
Open Advanced Settings.
Navigate to Settings > Solutions.
Select New to create a new solution, set Publisher to the value shown in the Command Checker solution layers listing for the enable rule and the Active solution layer. (In our example, this is DefaultPublisherCITTest)
Select Entities > Add Existing.
Select the entity your enable/display rule is defined on (In our example, this is contact) and select OK.
Make sure you uncheck the Include entity metadata and Add all assets options before selecting Finish.
Select Save.
Select Export Solution and export the unmanaged solution.
Extract the .zip file.
Open the customizations.xml file.
Locate the <Entity> node child of the entity node you wish to edit and locate its child <RibbonDiffXml> node.
Locate the enable/display rule. In the example, the ID of the enable rule is new.contact.EnableRule.EntityRule. Therefore, you would locate the following node:
Edit the <RibbonDiffXml> node, and make the necessary changes to the enable/display rule that will enable the rule to evaluate to True under the correct circumstances to fix the rule. For more information about how to declare rules, see Define ribbon enable rules, and Define ribbon display rules. (Based on our example, we would change the rule definition to the following)
Add the modified customizations.xml file back to the solution .zip file.
Import the solution file.
Select Publish All Customizations.
The enable/display rule is in the Application Ribbon (applies to "All entities")
If the enable/display rule isn't entity-specific, rather it's applicable to "All Entities" declared in the Application Ribbon, then the steps will be slightly different as follows:
Open Advanced Settings.
Navigate to Settings > Solutions.
Select New to create a new solution, set Publisher to the value shown in the Command Checker's solution layers listing for the enable/display rule and the Active solution layer.
Select Export Solution and export the unmanaged solution.
Extract the .zip file.
Open the customizations.xml file.
Locate the root <RibbonDiffXml> node.
Locate the enable/display rule.
Edit the <RibbonDiffXml> node, and make the necessary changes to the enable/display rule that will enable the rule to evaluate to True under the correct circumstances to fix the rule. For more information about how to declare rules, see Define ribbon enable rules, and Define ribbon display rules.
Add the modified customizations.xml file back to the solution .zip file.
Import the solution file.
Select Publish All Customizations.
The enable/display rule is from a custom-managed solution that I authored
To fix an enable/display rule that was installed by a custom-managed solution that you created, follow these steps:
In your separate development organization that has the unmanaged source version of your custom solution, complete the steps listed above for the The enable/display rule is in the unmanaged Active solution option.
Increment the Version of your custom solution.
Export solution as managed.
In your separate affected organization, import this new version of your custom-managed solution.
The enable/display rule is from a custom-managed solution that I did not author or my organization does not own (from a third-party/ISV)
To fix an enable/display rule that was installed by a custom-managed solution that was created by a third-party/ISV, you'll need to contact the author of the solution and request a new version of the solution that contains the fixed enable/display rule definition and install this new solution into your affected organization.
The enable/display rule is in a Microsoft published managed solution
To fix an enable/display rule that was installed by a Microsoft published managed solution, you may need a newer version of the solution to be installed, which would typically be done during a release update. It's possible that you've identified a bug that still needs to be fixed. Contact customer support for assistance.
