Edit

Sample: Download report definition

  • Article

This sample shows how to download a report definition (.rdl) file by using the DownloadReportDefinitionRequest message.

SDK for .NET: Download report definition sample code

How to run this sample

  1. Download or clone the Samples repo so that you have a local copy.
  2. (Optional) Edit the dataverse/App.config file to define a connection string specifying the Microsoft Dataverse instance 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 dataverse/App.config, any sample you run will use that connection information.

If you do not specify a connection string in dataverse/App.config file, a dialog will open each time you run the sample and you will need to enter information about which Dataverse instance 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.

Those samples in this repo that require a connection to a Dataverse instance to run will include a linked reference to the dataverse/App.config file.

What this sample does

The DownloadReportDefinitionRequest message is intended to be used in a scenario where it contains the data that is needed to download a report definition.

How this sample works

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

Setup

Checks for the current version of the org.

Demonstrate

  1. The QueryByAttribute method queries for an existing report.
  2. The DownloadReportDefinitionRequest method downloads the report definition.

Clean up

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