Difference between revisions of "Data Grid Export Service"

From Mea Wiki
Jump to navigation Jump to search
(307203)
 
(26 intermediate revisions by 2 users not shown)
Line 1: Line 1:
WiP
+
'''Data Grid Export Service''' is a separately installed add-on for QPR UI that enables to export [[Data_Grid_Properties|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_Grid_Properties#Common_Settings|Data Grids]], export buttons need to be enabled in the data grid settings.
[[Data_Grid_Properties|Data Grid]] contents can be exported to Microsoft Excel, Microsoft Word, or a PDF document. The exporting is done by a separate export server.
 
  
 
== Prerequisites ==
 
== Prerequisites ==
The following prerequisites are needed for installing the data grid export server:
+
The following prerequisites are needed for installing the data grid export web service:
 
* .NET Framework 4.6.1 or later.
 
* .NET Framework 4.6.1 or later.
 
* Microsoft Internet Information Services.
 
* Microsoft Internet Information Services.
 +
 +
Additionally, installation via Web Deploy has the following prerequisites:
 +
* Microsoft Web Deploy 3.0 or later installed on the system - http://www.iis.net/downloads/microsoft/web-deploy
 +
* Microsoft PowerShell 2.0 or later running as an Administrator
  
 
== Installing ==
 
== Installing ==
# Download the installation package.
+
<div class="downloadButton" style="width:270px;float:right;margin:30px 20px 0px 30px;">[[QPR_Product_Downloads#QPR_UI_Data_Grid_Export_Service|Download Data Grid<br />Export Service for QPR UI]]</div>
 +
=== Installation Using Web Deploy ===
 +
# Download the latest installation package (link on the right).
 +
# Unzip the installation package to a temporary folder.
 +
# 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).
 +
# Launch Microsoft PowerShell as an Administrator and navigate to the folder containing the deployment files.
 +
# Run '''.\DeployGridExportService.ps1''' and input the application pool user password when requested (if you chose to use custom credentials).
 +
 
 +
=== Manual Installation ===
 +
# Create folder '''C:\inetpub\wwwroot\SyncfusionGridExport'''.
 +
# Download the latest installation package (link on the right).
 
# Unzip the installation package to a temporary folder.
 
# Unzip the installation package to a temporary folder.
# Create the folder '''C:/inetpub/wwwroot/GridExport'''.
+
# The unzipped install package contains the '''QprGridExportAddon.zip''' file. Unzip the contents of that file to another temporary folder.
# Copy the installation package contents from the temporary folder to the C:/inetpub/wwwroot/GridExport folder.
+
# 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:
# Open Internet Information Service(IIS) manager.
+
#* Folder named '''bin'''.
 +
#* Files named '''Global.asx''' and '''Web.config'''.
 +
# Open '''Internet Information Service (IIS) Manager'''.
 
# Select '''Application Pools''' > '''Add Application Pool...''', and give the application pool a name.
 
# Select '''Application Pools''' > '''Add Application Pool...''', and give the application pool a name.
 
# Under '''Sites''', right-click '''Default Web Site''' and select '''Add Application...'''
 
# Under '''Sites''', right-click '''Default Web Site''' and select '''Add Application...'''
 +
## Type in '''SyncfusionGridExport''' as the '''Alias'''.
 
## Select the new created application pool from the Application Pool list.
 
## Select the new created application pool from the Application Pool list.
## Select the physical path where install package is unzipped to.
+
## Define the '''Physical path''' as '''C:\inetpub\wwwroot\SyncfusionGridExport'''.
 
 
  
[[Category: QPR UI]]
+
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.
 +
[[Category: QPR ProcessAnalyzer]]

Latest revision as of 12:14, 12 October 2020

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.

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 latest installation package (link on the right).
  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 latest installation package (link on the right).
  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.