Data Grid Export Service

From QPR ProcessAnalyzer Wiki
Jump to: navigation, search

Data Grid Export Service is a separately installed add-on for QPR UI that enables to export Data Grids contents as Microsoft Excel, Microsoft Word and PDF documents. This page describes how the Data Grid Export Service is installed. In addition, when using QPR UI Data Grids, export buttons need to be enabled in the data grid settings, or when using PAPO the EnableTableExporting, variable needs to be set.

Prerequisites

The following prerequisites are needed for installing the data grid export web service:

  • .NET Framework 4.6.1 or later.
  • Microsoft Internet Information Services.

Additionally, installation via Web Deploy has the following prerequisites:

Installing

Installation Using Web Deploy

  1. Download the installation package.
  2. Unzip the installation package to a temporary folder.
  3. Open Configuration.ps1 into text editor and modify the values according to your system and desired installation type. With the $customAppPoolCredentials setting you can define whether the application pool will be run as a user defined in $appPoolUser setting (password for the account will be requested during the installation).
  4. Launch Microsoft PowerShell as an Administrator and navigate to the folder containing the deployment files.
  5. Run .\DeployGridExportService.ps1 and input the application pool user password when requested (if you chose to use custom credentials).

Manual Installation

  1. Create folder C:\inetpub\wwwroot\SyncfusionGridExport.
  2. Download the installation package.
  3. Unzip the installation package to a temporary folder.
  4. The unzipped install package contains the QprGridExportAddon.zip file. Unzip the contents of that file to another temporary folder.
  5. From this other temporary folder, copy the contents of the Content\website\ folder to the C:\inetpub\wwwroot\SyncfusionGridExport folder. After this the C:\inetpub\wwwroot\SyncfusionGridExport folder should contain the following:
    • Folder named bin.
    • Files named Global.asx and Web.config.
  6. Open Internet Information Service (IIS) Manager.
  7. Select Application Pools > Add Application Pool..., and give the application pool a name.
  8. Under Sites, right-click Default Web Site and select Add Application...
    1. Type in SyncfusionGridExport as the Alias.
    2. Select the new created application pool from the Application Pool list.
    3. Define the Physical path as C:\inetpub\wwwroot\SyncfusionGridExport.

After the installation, the export servers are available in the following URLs:

  • Excel: http(s)://<HOSTNAME>/SyncfusionGridExport/excelExport
  • Word: http(s)://<HOSTNAME>/SyncfusionGridExport/wordExport
  • PDF: http(s)://<HOSTNAME>/SyncfusionGridExport/pdfExport

where <HOSTNAME> is the QPR UI server name.