Sample: Detect solution dependencies

This topic applies to Dynamics 365 Customer Engagement (on-premises). For the Power Apps version of this topic, see: Sample: Detect solution dependencies.

This sample shows how to detect dependencies before you delete a solution component. You can download the sample from here.

Note

This sample applies to both Dynamics 365 Customer Engagement (on-premises) and Common Data Service.

How to run this sample

To obtain a local copy of all samples and build them, do the following:

  1. Download or clone the Samples repo so that you have a local copy.
  2. (Optional) Edit the cds/App.config file to define a connection string specifying the instance/organization you want to connect to.
  3. Open the sample solution in Visual Studio and press F5 to run the sample. After you specify a connection string in cds/App.config, any sample you run will use that connection information.

If you do not specify a connection string in cds/App.config file, a dialog will open each time you run the sample and you will need to enter information about which instance/org you want to connect to and which credentials you want to use. This dialog will cache previous connections so that you can choose a previously used connection.

What this sample does

The RetrieveDependentComponentsRequest, RetrieveDependenciesForDeleteRequest messages are intended to be used in a scenario where it contains data to detect solution dependencies.

How this sample works

In order to simulate the scenario described in What this sample does, the sample will do the following:

Setup

  1. Checks for the current version of the org.
  2. The Publisher method creates the sample publisher that will own the two solutions.
  3. The Solution method creates the primary solution.
  4. The OptionSetMetadata creates the global option set and associates it to the solution.
  5. The ExportSolutionRequest exports the solution as managed so that we can later import it.
  6. The DeleteOptionSetRequest deletes the option set previously created, so it can be imported under the managed solution.
  7. The ImportSolutionRequest re-imports the solution as managed.

Demonstrate

  1. The QueryByAttribute queries all solution components for a solution.
  2. The RetrieveDependentComponentsRequest retrieves all the dependencies for the component. If there are no dependencies we can ignore this component. If there are dependencies upon this solution component, and the solution itself is managed, then you will be unable to delete the solution.

Clean up

Display an option to delete the solutions created in Setup. The deletion is optional in case you want to examine the entities and data created by the sample. You can manually delete the records to achieve the same result.