Sample: Work with solutions

This sample shows how to perform the following actions with solutions:

  • Create a publisher.
  • Retrieve the default publisher.
  • Create a solution.
  • Retrieve a solution.
  • Add an existing solution component.
  • Remove a solution component.
  • Export or package a solution.
  • Install or upgrade a solution.
  • Delete a solution.

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

This sample shows how to work with solutions. This sample covers how to create a publisher, create a solution, export, and import solution and also how to delete the solution.

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 defines a new publisher.
  3. The Solution method creates a new solution.
  4. The OptionSetMetadata method adds a solution component.
  5. The ExportSolutionRequest method exports the created solution in the Setup.
  6. The DeleteSolutionRequest method deletes the solution and the components.

Demonstrate

  1. The querySDKSamplePublisher method checks whether the publisher is already in the system.
  2. The querySampleSolutionResults method checks whether the solution is already in the system.
  3. The ExportSolutionRequest method exports the solution.
  4. The ImportSolutionRequest method imports the solution.

Clean up

Displays an option to delete all the data created in the sample. The deletion is optional in case you want to examine the data created by the sample. You can manually delete the data to achieve same results.