report platform - olem shoeolemportal.olemshoe.com/install/reportdesigner.pdf · 2017-04-18 ·...

Syncfusion Report Platform Version - v2.1.0.8 | Release Date - March 22, 2017

Overview ....................................................................................................................................................... 5

Key features .............................................................................................................................................. 5

Create a support incident ......................................................................................................................... 5

System Requirements ................................................................................................................................... 5

Report Server ............................................................................................................................................ 5

Hardware Requirements ....................................................................................................................... 5

Software Requirements ........................................................................................................................ 6

Supported Operating Systems .............................................................................................................. 6

Browser Compatibility .......................................................................................................................... 6

Report Designer ........................................................................................................................................ 6



Supported Operating Systems .............................................................................................................. 6

Report Platform SDK ................................................................................................................................. 7



Browser Compatibility .......................................................................................................................... 7

Report Designer ............................................................................................................................................ 7

Overview ................................................................................................................................................... 7

Key Features .......................................................................................................................................... 7

Installation ................................................................................................................................................ 7

Downloading Report Designer .............................................................................................................. 7

Installing Report Designer ..................................................................................................................... 8

Upgrading Report Designer ................................................................................................................. 13

Uninstalling Report Designer .............................................................................................................. 13

Getting Started ........................................................................................................................................ 14

Start Report Designer .......................................................................................................................... 14

Shared DataSource .............................................................................................................................. 14

Add DataSource .................................................................................................................................. 14

Add a Dataset ...................................................................................................................................... 19

Create Pivot Table ............................................................................................................................... 24

Saving Report ...................................................................................................................................... 33

Report Platform SDK ................................................................................................................................... 37

Overview ................................................................................................................................................. 37

Key features ........................................................................................................................................ 37

Create a support incident ................................................................................................................... 37

Installation and Deployment .................................................................................................................. 37

Installation .......................................................................................................................................... 37

Samples Deployment .......................................................................................................................... 38

ReportViewer .......................................................................................................................................... 38

Getting Started with ASP.NET Application .......................................................................................... 38

Getting Started with ASP.NET MVC Application ................................................................................. 48

Getting Started with JavaScript Application ....................................................................................... 57

Getting Started with LightSwitch HTML Application .......................................................................... 66

Getting Started with WPF Application ................................................................................................ 78

ReportWriter ........................................................................................................................................... 84

Getting Started with ASP.NET MVC Application ................................................................................. 91

Report Server ............................................................................................................................................ 105

REST API ................................................................................................................................................ 105

API Versions ...................................................................................................................................... 106

Installation and Deployment ................................................................................................................ 106

Download Setup ................................................................................................................................ 106

Installation ........................................................................................................................................ 106

Deployment....................................................................................................................................... 112

Host as website in IIS ........................................................................................................................ 113

Host as Application in IIS ................................................................................................................... 114

Azure App Service Deployment ............................................................................................................ 115

Installation and Deployment............................................................................................................. 115

Deploy Using FTP .............................................................................................................................. 123

Deploy Using Visual Studio ............................................................................................................... 125

Application Startup ............................................................................................................................... 133

Storage Options ................................................................................................................................ 133

Storage System ................................................................................................................................. 142

New User - System Administrator..................................................................................................... 143

Administration ...................................................................................................................................... 145

Users ................................................................................................................................................. 145

Groups ............................................................................................................................................... 165

Manage Permissions ......................................................................................................................... 171

Manage Categories ........................................................................................................................... 175

Manage Reports ................................................................................................................................ 181

Manage Data Sources ....................................................................................................................... 223

Share Data sources ........................................................................................................................... 226

Manage Files ..................................................................................................................................... 231

Share Files ......................................................................................................................................... 233

Manage Schedules ............................................................................................................................ 237

Collaboration......................................................................................................................................... 242

Post a new comment ........................................................................................................................ 242

Reply to a comment .......................................................................................................................... 243

Edit a comment ................................................................................................................................. 246

Delete a comment ............................................................................................................................. 249

Show parent comment of a reply ..................................................................................................... 250

Mention Users in the comment ........................................................................................................ 252

Notifications .......................................................................................................................................... 253

Admin notification settings ............................................................................................................... 253

User Notification Settings ................................................................................................................. 254

Localization ........................................................................................................................................... 255

Site Settings........................................................................................................................................... 255

Custom Rebranding ........................................................................................................................... 255

Email Settings .................................................................................................................................... 258

Active Directory ................................................................................................................................ 259

User Profile ........................................................................................................................................... 262

View Profile ....................................................................................................................................... 262

Edit Profile ......................................................................................................................................... 263

Change Password .............................................................................................................................. 263

My Permissions ................................................................................................................................. 263

Utilities .................................................................................................................................................. 264

Database Backup ............................................................................................................................... 264

FAQ ........................................................................................................................................................ 273

What all are the files and folders will be generated in the installed machine? ............................... 273

Overview Key features

Copyright © 2001 - 2017 Syncfusion Inc. 5

Overview The Syncfusion Report Server is a complete solution for enterprise reporting. It shuns proprietary reporting standards and is built on the open Report Definition Language (RDL) specification used by products such as the SQL Server. Reporting Server comes with a designer and a rich deployment environment that provides support for a variety of platforms, out of the box.

Key features Report management --- Reports are efficiently organized under the categories. Permission to view the reports can be given to specific users or groups.

Designer integration --- Seamlessly design and publish reports from within the Syncfusion Report Designer application.

Versioning --- All items stored in the Report Server are versioned, so it is possible to revert to an older version.

User management --- Users can be easily organized into groups to accurately map the structure of the small and large organizations.

Scheduling --- Reports can be generated and emailed according to a schedule. The scheduling functionality is very flexible.

Flexible permissions --- A flexible permission scheme controls the access to read, write, and delete reports.

View reports --- The built-in HTML 5 RDL Report Viewer control lets the user to view reports from within the browser.

Embedded reports --- Reports hosted on the Report Server can easily be embedded in an application by using the HTML 5 Report Viewer control.

Export --- The RDL reports can be exported to Excel, Word, PDF, and HTML file formats.

Custom branding --- The Report Server has built-in customization capabilities such as allowing you to add your organization’s name, logo, welcome note, etc.

Create a support incident If you are still not able to find the information that you are looking for in the self-help resources mentioned above then please contact us by creating a support ticket.

System Requirements This section explains the system requirements to run Syncfusion Report Server, Report Designer and Report Platform SDK.

Report Server

Hardware Requirements The following hardware requirements are necessary to run the Report Server:

• 1 GHZ or faster, 32bit or 64 bit processor • 1 GB RAM for 32 bit or 2 GB RAM for 64 bit • 130 MB Hard Disk space (Installation files)

/report-platform/report-server/administration/manage-users

http://www.syncfusion.com/support/

System Requirements Report Designer


Software Requirements The following software requirements are necessary to run the Report Server:

• Windows Client OS 7+ \| Windows Server OS 2008 R2+ • Microsoft .NET Framework 4.5 • Microsoft SQL Server 2005+ \| Azure SQL Database \| Oracle \| MySQL • Internet Information Services (IIS) 7.0+ \| Microsoft Azure • SMTP Mail Server (Check Email Settings for more details)

Supported Operating Systems

• Windows 7+ • Windows Server 2008 R2

Browser Compatibility

• IE 9+ • Microsoft Edge • Mozilla Firefox 22+ • Chrome 17+ • Opera 12+ • Safari 5+

Report Designer

Hardware Requirements The following minimum hardware requirements are necessary to run the Syncfusion Report Designer:

• 1 GHZ or faster, 32-bit or 64-bit processor • 1 GB RAM for 32-bit or 2 GB RAM for 64-bit • 100 MB Hard Disk space (For installation files)

Software Requirements The following minimum software requirements are necessary to run the Syncfusion Report Designer:

• Operating System - Windows 7, 8+ • Microsoft .NET Framework 4.5

Supported Operating Systems

• Windows Vista SP2 • Windows 7 SP1 • Windows 8+

https://www.microsoft.com/en-in/download/details.aspx?id=30653

https://en.wikipedia.org/wiki/Internet_Information_Services

https://azure.microsoft.com/en-in/documentation/articles/app-service-value-prop-what-is

https://en.wikipedia.org/wiki/Simple_Mail_Transfer_Protocol

https://www.microsoft.com/en-in/download/details.aspx?id=30653

Report Designer Report Platform SDK


Report Platform SDK

Hardware Requirements The following minimum hardware requirements are necessary to run the Syncfusion Report Platform SDK:

• 1 GHZ or faster, 32-bit or 64-bit processor • 1 GB RAM for 32-bit or 2 GB RAM for-64 bit • 130 MB Hard Disk space (For installation files)

Software Requirements The following minimum software requirements are necessary to run the Syncfusion Dashboard Platform SDK:

• Operating System - Windows 7, 8+ • Microsoft Visual Studio 2010 or later • Internet Information Services (IIS) 7.0+

Browser Compatibility

• IE 8+ • Microsoft Edge • Mozilla Firefox 22+ • Chrome 17+ • Opera 12+ • Safari 5+

Report Designer Overview Report Designer integrated with Report Server Service to create and modify RDL Reports from Report Server in RDL 2008/2008R2 specification standard. The Report Designer helps you to design, organize the data from a database and quickly build the reports with both tabular and visualization formats with help of following features.

Key Features The Report Designer supports the following features.

Data sources – Build the Report with advanced datasource like SQL, SQL Azure etc. Wizard Helper – Interactive wizards to build Pivot, Grouping and Visualization elements instead of drag and drop the fields. Report Parameter – Ability to create report with parameters in Query and other Report elements. Expression – Allows to dynamically control the layout of the Report based on data.

Installation This section explains about the installation/uninstallation and upgrading of Syncfusion Report Designer.

Downloading Report Designer You can download the Report Designer setup from here. You may download either as EXE or as Zip file.

https://www.syncfusion.com/downloads/report

Report Designer Installation


Installing Report Designer Run the saved installer either through clicking on the Run button or by double-clicking on the EXE file from the saved location.

The installer will now extract the files and launch the installation wizard.



Click on Next to proceed the further step.



Read the instructions and accept the license terms and conditions through checking the option I agree to the terms and conditions and click Next.



Browse to the location where you would like to install the Report Designer application and click Install.



Now the installation begins. You can cancel the installation anytime by pressing Cancel, if you prefer.



On successful installation, the above screen appears. Click Finish to close the installation wizard and run the newly installed Report Designer.

Upgrading Report Designer On every new release of Report Designer, it can be downloaded and installed on top without uninstalling the previous version. The installation of Report Designer will replace the previous installation and related files.

Uninstalling Report Designer You can uninstall the Report Designer application, if required, through uninstalling the Syncfusion Report Designer entry from Control Panel.

Report Designer Getting Started


Getting Started This section explains how to create a simple Pivot Table report with the Report Designer by using the Shared Datasource and save it into the Report Server.

Start Report Designer You can start the Report Designer from installed location (C:\Program Files (x86)\Syncfusion\Report Designer\ReportDesigner\ReportDesignerUtility.exe) or you can search it from Start by name of Syncfusion Report Designer.

Shared DataSource Shared datasource are used with the RDL reports for future management. When the connection information changes due to server enhancement, then you can change the connection in the Shared DataSource by using the Report Server roles instead of opening and editing the connection information in all the reports.

Add DataSource This section explain you the steps to create Shared DataSource for report.

1. Create new DataSource for report from Report Data Window.



2. Choose Shared Connection in DataSource Properties Wizard and click browse option to link the Shared DataSource from Report Server.



3. Enter your Report Server URL http://reportserver.syncfusion.com and select open to show the available data source from Report Server and select the DataSource by clicking Open.



4. Now, you can update name and click OK to add the selected Shared DataSource with report.



Add a Dataset RDL Dataset will have collection of fields and query information to retrieve the data from DataSource. This section explains you the steps to create dataset for report.

1. Create new Dataset for report from Report Data.



2. You can enter the query directly in the Query Textbox or you can use the Query Designer to interactively build the query and view the result of the query. Here, the dataset is created with the help of the Query Designer.



Note: In the Query Designer, you can explore the database table, view and interactively build the select query by selecting limited columns in the tables.

3. Click OK to add the created Dataset with report.



Create Pivot Table

1. Click Table option from Insert Tab and select Table Wizard.



2. Select the Dataset from Available Datasets and click on Next to create Pivot Table using selected dataset fields.



3. Drag and Drop the fields into respective category.



4. Report Designer has five built-in themes to create a Table. Select the theme and choose the layout from available options then click on Finish to create pivot Table from selected Fields.



5. Now, you can change the appearance of the Table and cells by selecting respective item in report section and can be changed with the help of Properties Window.



6. You have to select the cells to format as like below screen shot. Also, here “C” used to format cell with currency format.



7. Click Preview from Home Tab to preview the created report with Report Designer.



Note: Refer to the Report Designer documentation from the following link to create a report using various elements and also to use various features of the Syncfusion Report Designer.

Note:

Note: http://help.syncfusion.com/wpf/reportdesigner/overview

Saving Report

1. From the File menu, Click on Save to open the Save dialog.

http://help.syncfusion.com/wpf/reportdesigner/overview



2. Enter your Report Server URL http://reportserver.syncfusion.com and select open to show Report Server with Report Server credential.



Note: Category will be shown with Folder icon.

3. Select the category and provide a name to save the report in respective category.

Report Platform SDK Overview


Note: We must select a category to save the report.

Report Platform SDK Overview The Syncfusion Report Platform SDK includes a ReportViewer control that can be embedded within your application.

Key features Display Reports within your applications --- You can show reports within your ASP.NET, ASP.NET MVC, JavaScript, LightSwitch HTML, WPF and WinRT applications using ReportViewer.

Cost effective licensing --- Our licensing is cost effective for both small and large teams. Please contact us for more details.

Create a support incident If you are still not able to find the information that you are looking for in the self-help resources mentioned above then please contact us by creating a support ticket.

Installation and Deployment This section briefly illustrates the installation and deployment procedure of Syncfusion Report Platform SDK.

Installation The Syncfusion Report Platform SDK can be downloaded and installed through the following procedure.

http://www.syncfusion.com/company/contact-us

http://www.syncfusion.com/company/contact-us

http://www.syncfusion.com/support/

Report Platform SDK ReportViewer


1. Download the installer from here 2. Run the Syncfusion Report Platform SDK installer. 3. Choose the installation location and install. 4. Once installation completes then click on Finish to explore the Samples folder.

Samples Deployment With the installation of Syncfusion Report Platform SDK, samples get installed in the following location.

%localappdata%\Syncfusion\ReportsSDK\Samples

This folder holds samples for ReportViewer in six different platforms such as ASP.NET, ASP.NET MVC, JavaScript, LightSwitch HTML, WPF and WinRT. Each of these platform folders contains two samples, one that shows local RDL report and the other sample shows report files hosted on the Report Server.

The scripts and themes that are required to run the Report Platform SDK application will get placed in the following location.

%localappdata%\Syncfusion\ReportsSDK\Samples\Common\Html

Note: Internet connection is required to run Report Platform SDK samples as their data need to be retrieved from a remote data server.

ReportViewer

Getting Started with ASP.NET Application This section describes how to embed the Report Server report with ASP.NET application using ReportViewer.

Project Creation Create a new ASP.NET Empty Web application project by selecting the WEB category from the listed project template in Microsoft Visual Studio IDE.

https://www.syncfusion.com/downloads/report



Create ASPX Page To create a new Web Forms in the application

1. Right-Click on the project and select Add.



2. Click New Item and select Web Forms from the listed templates.

3. Name the page as Default.aspx and click OK.

Adding References, Scripts, Styles and Control in ASPX Page Add the References, scripts, styles that are required for the ReportViewer.

Add References

1. In the Solution Explorer, right-click on the References folder and then click Add Reference.



2. Add the following assemblies and click OK. o System.Web.Routing o System.Web.Http o System.Web.WebHost o System.Net.Http o System.Net.Http.WebRequest o System.Net.Http.Formatting o Syncfusion.EJ o Syncfusion.EJ.Web o Syncfusion.Linq.Base o Syncfusion.EJ.ReportViewer o Syncfusion.Pdf.Base o Syncfusion.XlsIO.Base o Syncfusion.DocIO.Base o Syncfusion.Shared.Wpf o Syncfusion.Chart.Wpf o Syncfusion.Gauge.Wpf o Syncfusion.SfMaps.Wpf

Note: You can get the above assemblies from the installed location %localappdata%\Syncfusion\ReportsSDK\Samples\Common\Assemblies

Note:



Note: Refer System.Web.Http, System.Web.Http.WebHost, System.Net.Http.WebRequest and System.Net.Http.Formatting assemblies from the NuGet package installed location %localappdata%\Syncfusion\ReportsSDK\Samples\Common\nuget.

Add Scripts and Styles Add the script files and CSS files in the <title> tag of the Default.aspx page.

HTML

<link href="http://cdn.syncfusion.com/reportplatform/2.1.0.8/js/themes/flat-

azure/ej.reportviewer.all.min.css" rel="stylesheet"/>

<script src="http://code.jquery.com/jquery-1.11.3.min.js"

type="text/javascript"></script>

<script

src="http://cdn.syncfusion.com/reportplatform/2.1.0.8/js/scripts/web/ej.repo

rtviewer.all.min.js" type="text/javascript"></script>

Note: Use the above code example while adding scripts and styles

Refer the themes and scripts from the installed location %localappdata%\Syncfusion\ReportsSDK\Samples\Common\Html

Registering Assemblies within the Web.config file In your application’s web.config file, add the below assembly information within the <assemblies> tag and <controls> tag.

HTML

<system.web>

<compilation debug="true" targetFramework="4.5">

<assemblies>

<add assembly="Syncfusion.EJ, Version=13.4450.0.54, Culture=neutral,

PublicKeyToken=3d67ed1f87d44c89"/>

<add assembly="Syncfusion.EJ.Web, Version=13.4450.0.54, Culture=neutral,


<add assembly="Syncfusion.EJ.ReportViewer, Version=13.4450.0.54,

Culture=neutral, PublicKeyToken=3d67ed1f87d44c89"/>

</assemblies>

</compilation>

<pages validateRequest="false">

<controls>

<add namespace="Syncfusion.JavaScript.Web" assembly="Syncfusion.EJ.Web"

tagPrefix="ej"/>

<add namespace="Syncfusion.JavaScript.Web" assembly="Syncfusion.EJ"

tagPrefix="ej"/>

<add namespace="Syncfusion.JavaScript.DataVisualization.Models"

assembly="Syncfusion.EJ" tagPrefix="ej"/>

<add namespace="Syncfusion.JavaScript.Models" assembly="Syncfusion.EJ"

tagPrefix="ej"/>

</controls>

</pages>

</system.web>



Control Initialization Initialize ReportViewer by using the following code example in the <body> tag of the Default.aspx page.

HTML

<!DOCTYPE html>

<html xmlns="http://www.w3.org/1999/xhtml">

<head runat="server">

<title></title>

</head>

<body>

<form id="form1" runat="server">

<ej:ReportViewer ID="Viewer" runat="server"/>

</form>

</body>

</html>

Load RDL Report ReportViewer supports to load local RDL files. The following steps help you to load reports from local path.

Set the ReportPath, ProcessingMode and ReportServiceUrl to ReportViewer.

HTML


<div style="height: 650px;width: 950px;min-height:404px;">

<ej:ReportViewer runat="server" ID="viewer" ReportPath="~/App_Data/Sales

Dashboard.rdl" ProcessingMode="Remote" ReportServiceUrl="/api/ReportApi"/>

</div>

</form>

Add WebAPI controller for ReportViewer The ASP.NET ReportViewer uses WebApi services to process the report file and get the request from control.



IReportController

The ApiController inherits the IReportController and you can add the following code example to its methods definition in order to process the report file. The interface IReportController contains the required actions and helper methods declaration to process the report. The ReportHelper class contains helper methods that helps to process Post/Get request from control and return the response to control.

C#

using Syncfusion.EJ.ReportViewer;

using System;

using System.Collections.Generic;

using System.Linq;

using System.Net;

using System.Net.Http;

using System.Web.Http;

namespace ReportViewerDemo

{

public class ReportApiController : ApiController, IReportController

{

//Post action for processing the rdl/rdlc report

public object PostReportAction(Dictionary<string, object> jsonResult)

{

return ReportHelper.ProcessReport(jsonResult, this);

}

//Get action for getting resources from the report

[System.Web.Http.ActionName("GetResource")]

[AcceptVerbs("GET")]

public object GetResource(string key, string resourcetype, bool isPrint)

{

return ReportHelper.GetResource(key, resourcetype, isPrint);

}



//Method will be called when initialize the report options before start

processing the report

public void OnInitReportOptions(ReportViewerOptions reportOption)

{

//You can update report options here

}

//Method will be called when reported is loaded

public void OnReportLoaded(ReportViewerOptions reportOption)

{


}

}

}

WebAPI Routing

1. Right-click the project and select Add and select Global.asax file from the listed templates.

2. You can route the WebAPI in Application_Start event into Global.asax file as follows.

~ CSHARP

~

HTML



<form id="form1" runat="server" onsubmit="return false" style="overflow:

hidden; padding:0; margin: 0;height:100%;width:100%;">

<ej:ReportViewer ID="ReportViewer1" runat="server" ReportPath="7438b4d8-

ac10-4a75-bf95-56f8b37ec33f"

ReportServerUrl="http://reportserver.syncfusion.com:80/"

ProcessingMode="Remote"/>

</form>

Report Server WebAPI Service Report Server implemented with necessary capabilities to access the contents through WebAPI service. In this tutorial, we are going to use the following API methods from Report Server WebAPI service,

API Method Description

download-report Download the report from Report Server using report id.

download-data-source Download the report from Report Server using shared datasource id related to the Report.

External Reporting Server Configuration

You have to configure the external reporting server through ReportingServer property to process the Reports from External Report Server as like below code.

C#


{

// This is the place to configure the External server and other credential

information.


{


information.

reportOption.ReportModel.ReportingServer = new ReportingServerExt();

// Property to provide the credential to access report from Report Server.

reportOption.ReportModel.ReportServerCredential = new

System.Net.NetworkCredential("guest", "demo");

}

}

public class ReportingServerExt:

Syncfusion.EJ.RDL.ServerProcessor.ReportingServer

{

// This method will invoked from Report Helper to get the Shared Data

Sources from the external Report Server

public override Syncfusion.EJ.RDL.ServerProcessor.DataSourceDefinition

GetDataSourceDefinition(string dataSource)

{

return base.GetDataSourceDefinition();

}

// This method will invoked from Report Helper to get the reports from the

external Report Server

public override System.IO.Stream GetReport()

{

base.GetReport();



}

}

Report Server WebAPI configuration You have to use the Report Server WebAPI in GetDataSourceDefinition and GetReport overridden method. For example, get the created ReportingServerExt from the following location.

http://www.syncfusion.com/downloads/support/directtrac/144495/ze/Classes-1183252846

Add the credential information in ReportApiController’s OnInitReportOptions method that is available

in IReportController.

C#


{

//Add Report Server and database credentials here




}

Following screenshot displays reports from Report Server with help of configured external Reporting Server.




Getting Started with ASP.NET MVC Application This section describes how to embed the Report Server report with ASP.NET MVC application using ReportViewer.

Project Creation Create a new ASP.NET MVC project by selecting the WEB category from the listed project template in Microsoft Visual Studio IDE.

The following screenshot displays how to select Internet application template with razor view engine.



Adding References, Scripts, Styles and Control in CSHTML Page Add the References, scripts, styles that are required for the ReportViewer.

Add References

1. In the Solution Explorer, right-click the References folder and then click Add Reference.



2. Add the following assemblies and click OK. o System.Web.Routing o System.Web.Http o System.Web.WebHost o System.Net.Http o System.Net.Http.WebRequest o System.Net.Http.Formatting o Syncfusion.EJ o Syncfusion.EJ.MVC o Syncfusion.Linq.Base o Syncfusion.EJ.ReportViewer o Syncfusion.Pdf.Base o Syncfusion.XlsIO.Base o Syncfusion.DocIO.Base o Syncfusion.Shared.Wpf o Syncfusion.Chart.Wpf o Syncfusion.Gauge.Wpf o Syncfusion.SfMaps.Wpf


Note:

Note: Refer System.Web.Http, System.Web.Http.WebHost, System.Net.Http.WebRequest and System.Net.Http.Formatting assemblies from the NuGet package installed location %localappdata%\Syncfusion\ReportsSDK\Samples\Common\nuget.

Add Scripts and Styles Add the script files and CSS files in the <title> tag of the Index.cshtml page.

HTML



<add namespace="Syncfusion.JavaScript.DataVisualization"/>

<add namespace="Syncfusion.EJ.ReportViewer"/>

</namespaces>

Control Initialization Initialize ReportViewer by using the following code example in the <body> tag of the Index.cshtml page that is already created.

ASPX-CS

@using Syncfusion.MVC.EJ;

@using Syncfusion.JavaScript;

<body style="overflow: hidden; position: static; margin: 0px; padding: 0px;

width: 100%; height: 100%">

<div style="width:100%; height:100%; position:absolute;">

@(Html.EJ().ReportViewer("reportsample"))

</div>

@(Html.EJ().ScriptManager())

</body>

<style type="text/css">

html, body {

overflow: hidden;

padding: 0;

margin: 0;

height: 100%;

position: static;

}

#reportsample {

width: 100%;

height: 99.9%;

position: absolute;

}

</style>



ASPX-CS




@(Html.EJ().ReportViewer("reportsample").ProcessingMode(Syncfusion.JavaScrip

t.ReportViewerEnums.ProcessingMode.Remote).ReportServiceUrl(VirtualPathUtili

ty.ToAbsolute("~/api/ReportApi")).ReportPath("~/App_Data/Sales

Dashboard.rdl"))

</div>


</body>



Add WebAPI controller for ReportViewer The ASP.NET MVC ReportViewer uses WebApi services to process the report file and get the request from control.

IReportController


C#


using System;


using System.Linq;

using System.Net;




{


{



{


}







{


}




{


}



{


}

}

}

WebAPI Routing



~ CSHARP

~



ASPX-CS

@using Syncfusion.MVC.EJ;

@using Syncfusion.JavaScript;




@(Html.EJ().ReportViewer("reportsample").ProcessingMode(Syncfusion.JavaScrip

t.ReportViewerEnums.ProcessingMode.Remote).ReportServiceUrl(VirtualPathUtili

ty.ToAbsolute("~/api/ReportApi")).ReportPath("7438b4d8-ac10-4a75-bf95-

56f8b37ec33f").ReportServerUrl("http://reportserver.syncfusion.com:80/"))

</div>


</body>

<style type="text/css">

html, body {

overflow: hidden;

padding: 0;

margin: 0;

height: 100%;

position: static;

}

#reportsample {

width: 100%;

height: 99.9%;

position: absolute;

}

</style>

Report Server WebAPI Service Report Server implemented with necessary capabilities to access the contents through WebAPI service. In this tutorial, we are going to use the following API methods from Report Server WebAPI service.






C#


{


information.


{




information.





}

}



{





{


}




{

base.GetReport();

}

}





C#


{





}





Getting Started with JavaScript Application This section describes how to embed the Report Server report with JavaScript application using ReportViewer.

Project Creation Create a new ASP.NET Empty Web application project by selecting the WEB category from the listed project template in Microsoft Visual Studio IDE.



Create HTML Page To create a new Web Forms in the application follow the below steps.

1. Right-Click on the project and select Add.



2. Click New Item and select HTML page from the listed templates.

3. Name the page as Default.html and click OK.

Adding References, Scripts, Styles and Control in HTML Page Add the References, scripts, styles that are required for the ReportViewer.

Add References




2. Add the following assemblies and click OK. o System.Web.Routing o System.Web.Http o System.Web.WebHost o System.Net.Http o System.Net.Http.WebRequest o System.Net.Http.Formatting o Syncfusion.Compression.Base o Syncfusion.Linq.Base o Syncfusion.EJ.ReportViewer o Syncfusion.Pdf.Base o Syncfusion.XlsIO.Base o Syncfusion.DocIO.Base o Syncfusion.Shared.Wpf o Syncfusion.Chart.Wpf o Syncfusion.Gauge.Wpf o Syncfusion.SfMaps.Wpf


Note:

Note: Refer System.Web.Http, System.Web.Http.WebHost, System.Net.Http.WebRequest and System.Net.Http.Formatting assemblies from ASP.NET WebApi NuGet package.

Add Scripts and Styles Add the script files and CSS files in the <title> tag of the default.html page.

HTML





IReportController


C#


using System;


using System.Linq;

using System.Net;




{


{



{


}





{


}






{


}



{


}

}

}

WebAPI Routing



~ CSHARP

~

HTML




100%;"></div>


$(function () {


{

reportServiceUrl: '/api/ReportApi',


reportServerUrl: 'http://reportserver.syncfusion.com:80/',

reportPath: '7438b4d8-ac10-4a75-bf95-56f8b37ec33f'

});

});

</script>







C#


{


information.


{


information.





}

}



{





{




}




{

base.GetReport();

}

}

Report Server WebAPI with External Reporting Server You have to use the Report Server WebAPI in GetDataSourceDefinition and GetReport overridden method. For example, get the created ReportingServerExt from the following location.




C#


{





}





Getting Started with LightSwitch HTML Application This section describes how to embed the Report Server report with LightSwitch HTML application using ReportViewer.

Project Creation Create a new LightSwitch HTML application project by selecting the LightSwitch category from the listed project template in Microsoft Visual Studio IDE.



Adding References, Scripts, Styles and Control in HTML Page Add the References, scripts, styles that are required for the ReportViewer.

Add References




2. Add the following assemblies and click OK. o System.Web.Routing o System.Web.Http o System.Web.WebHost o System.Net.Http o System.Net.Http.WebRequest o System.Net.Http.Formatting o Syncfusion.Compression.Base o Syncfusion.Linq.Base o Syncfusion.EJ.ReportViewer o Syncfusion.Pdf.Base o Syncfusion.XlsIO.Base o Syncfusion.DocIO.Base o Syncfusion.Shared.Wpf o Syncfusion.Chart.Wpf



o Syncfusion.Gauge.Wpf o Syncfusion.SfMaps.Wpf


Note:

Note: Refer System.Web.Http, System.Web.Http.WebHost, System.Net.Http.WebRequest and System.Net.Http.Formatting assemblies from ASP.NET WebApi NuGet package.

Add Scripts and Styles Open default.htm in HTMLClient project. Add the script files and CSS files in the <title> tag of the

default.htm page.

HTML



<script type="text/javascript"

src="//ajax.aspnetcdn.com/ajax/4.0/1/MicrosoftAjax.js"></script>


src="//ajax.aspnetcdn.com/ajax/globalize/0.1.1/globalize.min.js"></script>

<script type="text/javascript" src="Scripts/winjs-1.0.min.js"></script>



<script type="text/javascript" src="Scripts/jquery.mobile-

1.3.0.min.js"></script>

<script type="text/javascript" src="Scripts/datajs-1.1.1.min.js"></script>


src="Scripts/Generated/resources.js"></script>

<script type="text/javascript" src="Scripts/msls-2.5.1.min.js"></script>


src="Scripts/Generated/generatedAssets.js"></script>

<script





Add ReportViewer Template Screen The following steps help you to add ReportViewer Template Screen in HTML Client.

1. Right-Click on Screens folder in HTMLClient project and choose Add Screen.



2. Select Browser Data Screen, type the screen name as ReportViewer and click OK.



3. Click on Add and choose New Custom Control.

4. Specify screen as name for custom control.



5. Click on Edit Render Code option in properties window.



6. Add the custom control code in the JS file.

Control Initialization Initialize ReportViewer by using the following code example in the lsml.js template screen page.

HTML

myapp.ReportViewer.ScreenContent_render = function (element, contentItem) {

var itemTemplate = $("<div></div>").attr('id', 'reportContainer')

itemTemplate.css({ 'width': '100%', 'height': '500px' });

itemTemplate.appendTo($(element));

itemTemplate.ejReportViewer({

});

};




Set the ReportPath, ProcessingMode and ReportServerUrl in the ReportViewer properties.

HTML

myapp.ReportViewer.ScreenContent_render = function (element, contentItem) {





reportServiceUrl: '../api/ReportApi',


reportPath: 'Sales Dashboard.rdl'

});

};

Add WebAPI controller for ReportViewer The LightSwitch HTML ReportViewer uses WebApi services to process the report file and get the request from control.

Right click on the server project, select Add followed by New item and choose Web API from the listed templates.

IReportController

The ApiController inherits the IReportController and you can add the following code example to its methods definition in order to process the report file. The interface IReportController contains the



required actions and helper methods declaration to process the report. The ReportHelper class contains helper methods that helps to process Post/Get request from control and return the response to control.

C#


using System;


using System.Linq;

using System.Net;



namespace LightSwitchApplication

{


{


{


}




{


}


{

var hostedPath = System.Web.HttpContext.Current.Server.MapPath("~/");

var rdlPath = hostedPath +

"bin\\ReportViewerSample.Server\\ReportTemplate\\" +

reportOption.ReportModel.ReportPath;

reportOption.ReportModel.ReportPath = rdlPath;

}


{

}

}

}

WebAPI Routing

1. Right-click on the server project, select Add followed by New item and choose Global.asax file from the listed templates.




~ CSHARP

~

HTML





reportServiceUrl: '../api/ReportApi',


reportServerUrl: 'http://reportserver.syncfusion.com:80/',

reportPath: '7438b4d8-ac10-4a75-bf95-56f8b37ec33f'

});









C#


{


information.


{


information.





}

}



{





{


}




{

base.GetReport();

}

}

Report Server WebAPI with External Reporting Server You have to use the Report Server WebAPI in GetDataSourceDefinition and GetReport overridden method. For example, get the created ReportingServerExt from the following location.




C#


{








}


Getting Started with WPF Application This section describes how to embed the Report Server report with WPF application using ReportViewer.

Project Creation Create a new WPF Application Project using Microsoft Visual Studio IDE.



Adding References.

1. In the Solution Explorer, right-click on the References folder and then click Add Reference.

2. Add the following assemblies and click OK. o Syncfusion.Chart.Wpf o Syncfusion.Compression.Base o Syncfusion.DocIO.Base

o Syncfusion.Gauge.Wpf o Syncfusion.Grid.Wpf o Syncfusion.Linq.Base o Syncfusion.Pdf.Base o Syncfusion.PropertyGrid.Wpf o Syncfusion.ReportControls.Wpf o Syncfusion.ReportViewer.Wpf o Syncfusion.SfMaps.Wpf o Syncfusion.SfSkinManager.Wpf o Syncfusion.Shared.Wpf o Syncfusion.Tools.Wpf o Syncfusion.XlsIO.Base

Note: Refer the above assemblies from the installed location %localappdata%\Syncfusion\ReportsSDK\Samples\Common\Assemblies

Control Initialization Initialize ReportViewer control by using the following code in the XAML page.

XML

<Window x:Class="Samples.MainWindow"

xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"

xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"

xmlns:sync="http://schemas.syncfusion.com/wpf"

xmlns:syncfusion="clr-

namespace:Syncfusion.Windows.Reports.Viewer;assembly=Syncfusion.ReportViewer

.WPF">

<Grid >



<syncfusion:ReportViewer Name="reportViewerControl"/>

</Grid>

</Window>


1. Set the ReportPath, ProcessingMode and ReportServiceURL to ReportViewer in XAML page.

~ XML

~

C#

reportViewerControl.ProcessingMode = ProcessingMode.Remote;

reportViewerControl.ReportServerUrl =

@"http://reportserver.syncfusion.com/";









C#

reportViewerControl.ReportServer = new ReportingServerExt();


http://www.syncfusion.com/downloads/support/directtrac/general/ze/ReportServerService

1. Set the credential information through ReportServerCredential property to process the Reports from External Report Server as like below code.

~ CSHARP

~

~ CSHARP

~

~ XML

~

~ XML

~

http://www.syncfusion.com/downloads/support/directtrac/general/ze/ReportingServerService-1465622250



~ CSHARP

~

~ CSHARP

~

~ CSHARP

~

~ CSHARP

~

C#

using System;



using System.Linq;

using System.Net;



using Syncfusion.Reports.EJ;

using System.Collections;

namespace WebAPIService

{

public class ReportAPIController: ApiController, IReportController

{



{


}





{


}






{


}



{


}

}

}

WebAPI Routing

1. Right click the project, select Add and select Global.asax file from the listed templates.


~ CSHARP

~

~ CSHARP

Report Platform SDK ReportWriter


~

~ CSHARP

~

ReportWriter HTML

<system.web>


<assemblies>

<add assembly="Syncfusion.Chart.WPF, Version=14.1400.0.42, Culture=neutral,


<add assembly="Syncfusion.Compression.Base, Version=14.1400.0.42,


<add assembly="Syncfusion.DocIO.Base, Version=14.1400.0.42, Culture=neutral,




<add assembly="Syncfusion.Gauge.WPF, Version=14.1400.0.42, Culture=neutral,




<add assembly="Syncfusion.Pdf.Base, Version=14.1400.0.42, Culture=neutral,


<add assembly="Syncfusion.SfMaps.WPF, Version=14.1400.0.42, Culture=neutral,


<add assembly="Syncfusion.Shared.WPF, Version=14.1400.0.42, Culture=neutral,


<add assembly="Syncfusion.XlsIO.Base, Version=14.1400.0.42, Culture=neutral,


</assemblies>

</compilation>

</system.web>


• Syncfusion.EJ.ReportViewer

HTML

<namespaces>









</namespaces>

ReportWriter Initialization

1. Set the following properties to ReportWriter. o ReportPath - Set the local file system or Report Server path of report. o ReportProcessingMode - Set ProcessingMode as Remote for RDL and Report Server

report also Local for RDLC report. o WriterFormat - Set WriterFormat as PDF, Excel, Word and HTML.

2. Initialize ReportWriter by using the following code example in the Default.aspx.cs page export button click event.

CSHARP

protected void ExportButton_Click(object sender, EventArgs e)

{

try

{

string fileName = null;

WriterFormat format;

HttpContext httpContext = System.Web.HttpContext.Current;

ReportWriter reportWriter = new ReportWriter();

reportWriter.ReportPath = Server.MapPath("~/App_Data/GroupingAgg.rdl");

reportWriter.ReportProcessingMode = ProcessingMode.Remote;

if (this.ExportFormat.SelectedValue == "PDF")

{

fileName = "GroupingAgg.pdf";

format = WriterFormat.PDF;

}

else if (this.ExportFormat.SelectedValue == "Word")

{

fileName = "GroupingAgg.doc";

format = WriterFormat.Word;

}

else if (this.ExportFormat.SelectedValue == "Html")

{

fileName = "GroupingAgg.Html";

format = WriterFormat.HTML;

}

else

{

fileName = "GroupingAgg.xls";

format = WriterFormat.Excel;

}

reportWriter.Save(fileName, format, httpContext.Response);

}

catch { }

}



3. Add the following code example in the <body> tag of the Default.aspx page to view ReportWriter export options.

HTML

<body>

<div class="container">

<div class="header">

<span style="color: white; font-size: 2em">ReportWriter Demo</span>

</div>

<div class="content_section">


<div id="description_Pane" style="text-align: justify;">

<h3>Description</h3>

<span>

Essential Report Writer is a powerful control for exporting RDL files into

specified

format files.The following are some of the key features of this component:

Provides

support for various chart types that include Area, Bar, Column, Pie, Funnel,

Radar,

Line and so on. Provides support for both Matrix and Table and also provides

support for

both single, and multi-level row groupings and column groupings. Provides

support

for other common controls such as Textbox, Image, Rectangle, Line and both

Circular

Linear Gauges. Provides support for report parameter.

</span>

/div>

<div id="export_Pane" style="margin-top: 4%;">

<h3>Export Report</h3>

<span>

Choose a file format to view the selected document generated from Report

file by using Essential ReportWriter.

</span>

<div id="selection_Pane" style="margin-top: 2%;">

<asp:Label Style="font-size: large;" runat="server">

Save As :

</asp:Label>

<asp:RadioButtonList RepeatLayout="Flow" ID="ExportFormat"

RepeatDirection="Horizontal" runat="server">

<asp:ListItem Selected="True">PDF</asp:ListItem>

<asp:ListItem>Word</asp:ListItem>

<asp:ListItem>Excel</asp:ListItem>

<asp:ListItem>Html</asp:ListItem>

</asp:RadioButtonList>

<asp:Button style="width: 18%; margin-left: 2%;" ID="ExportButton"

runat="server" OnClick="ExportButton_Click" Text="Generate" />

</div>

</div>

</form>

</div>

</div>

</body>



4. Add the style to the ReportWriter by using the following code example in the <head> tag of the Default.aspx page.

HTML

<html>

<head runat="server">

<title>Essential Studio Report Writer</title>

<style>

.container {

width: 72%;

border-color: rgb(39, 161, 174);

border-width: medium;

border-style: double;

position: absolute;

left: 14%;

height: 97.5%;

}

.header {

background-color: rgb(39, 161, 174);

text-align: center;

}

.content_section{

height:100%;

position: absolute;

top: 10%;

left: 3%;

right: 3%;

}

</style>

</head>

5. Run the application. The following output displays ReportWriter export options, Select the export option and click on Generate button.



6. The following output displays exported report in PDF format.



Generate RDL Reports The ReportWriter has options to save the RDL reports. The following code example helps you to generate the RDL report using ReportWriter.

Specify the ReportPath, ReportProcessingMode and WriterFormat properties for ReportWriter to generate report.

C#

string reportPath = @"..\ReportTemplate\GroupingAgg.rdl";

ReportWriter reportWriter = new ReportWriter(reportPath);


reportWriter.Save("GroupingAgg.xls", WriterFormat.Excel);

Generate Report Server Reports The ReportWriter has options to save the Report Server reports. The following code example helps you to generate the Report Server report using ReportWriter.

Specify the ReportPath, ReportServerUrl, ReportServerCredential, ReportProcessingMode and

WriterFormat properties for ReportWriter to generate report.



C#



reportWriter.ReportPath = "45db67a0-3fd6-4684-b03c-aa640a521c97";

reportWriter.ReportServerUrl = "http://reportserver.syncfusion.com:80/";

reportWriter.ReportingServer = new ReportingServerExt();

reportWriter.ReportServerCredential = new



reportWriter.Save("GroupingAgg.doc", WriterFormat.Word,

httpContext.Response);







C#


{

try

{




}

catch { }

}



{





{


}




{



base.GetReport();

}

}



Generating Report Formats The ReportWriter provides support for exporting report as PDF, Word, Excel and HTML documents with the help of the ReportWriter class.

Exporting Report as PDF The report used in ReportWriter can be exported as a PDF document using the following code.

C#

ReportWriter reportWriter = new ReportWriter(reportpath, dataSources);

reportWriter.Save("Sample.pdf", WriterFormat.PDF);

Exporting Report as Word The report used in ReportWriter can be exported as a Word document using the following code.

C#


reportWriter.Save("Sample.doc", WriterFormat.Word);

Exporting Report as Excel The report used in ReportWriter can be exported as an Excel document using the following code.

C#


reportWriter.Save("Sample.xls", WriterFormat.Excel);

Exporting Report as HTML The report used in ReportWriter can be exported as an HTML document using the following code.

C#


reportWriter.Save("Sample.html", WriterFormat.HTML);

Getting Started with ASP.NET MVC Application This section describes how to export the Report Server report as PDF, Word, Excel and HTML formats in ASP.NET MVC application using ReportWriter.

Project Creation This section illustrates how to add ReportWriter to the ASP.NET MVC application. It includes the following steps.




1. Create a new ASP.NET MVC project by selecting the WEB category from the listed project template in Microsoft Visual Studio IDE.

2. The following screenshot displays how to select empty application template with razor view engine.



Create CSHTML Page To create a new CSHTML view page in the application follow the below steps.

1. Right click on the ReportWriter folder from Views followed by Add and then click View.



2. Specify the name and then click on OK.



Add References

1. In the Solution Explorer, Right-click the References folder and then click Add Reference.



2. Add the following references o Syncfusion.Chart.Wpf o Syncfusion.Compression.Base o Syncfusion.DocIO.Base o Syncfusion.EJ.ReportViewer o Syncfusion.Gauge.Wpf o Syncfusion.Linq.Base o Syncfusion.Pdf.Base o Syncfusion.SfMaps.Wpf o Syncfusion.Shared.Wpf o Syncfusion.XlsIO.Base


Registering Assemblies within the Web.config file In your application’s root web.config file, add the below assembly information within the <assemblies> tag.

HTML

<system.web>


<assemblies>

<add assembly="Syncfusion.Chart.WPF, Version=14.1400.0.42, Culture=neutral,




<add assembly="Syncfusion.Compression.Base, Version=14.1400.0.42,


<add assembly="Syncfusion.DocIO.Base, Version=14.1400.0.42, Culture=neutral,




<add assembly="Syncfusion.Gauge.WPF, Version=14.1400.0.42, Culture=neutral,




<add assembly="Syncfusion.Pdf.Base, Version=14.1400.0.42, Culture=neutral,


<add assembly="Syncfusion.SfMaps.WPF, Version=14.1400.0.42, Culture=neutral,


<add assembly="Syncfusion.Shared.WPF, Version=14.1400.0.42, Culture=neutral,


<add assembly="Syncfusion.XlsIO.Base, Version=14.1400.0.42, Culture=neutral,


</assemblies>

</compilation>

</system.web>


• Syncfusion.EJ.ReportViewer

HTML

<namespaces>







</namespaces>

ReportWriter Initialization

1. Initialize ReportWriter by using the controller in the Application. To create a controller in the Application, please follow the below steps.



2. Specify the name to the controller and then click on OK.



4. Set the following properties to ReportWriter. o ReportPath - Set the local file system or Report Server path of report. o ReportProcessingMode - Set ProcessingMode as Remote for RDL and Report Server

report also Local for RDLC report. o WriterFormat - Set WriterFormat as PDF, Excel, Word and HTML.

5. Add the following code to the ReportWriter in the controller class.

CSHARP

public ActionResult Index(string writerFormat)

{

try

{

string fileName = null;

WriterFormat format;



reportWriter.ReportPath = Server.MapPath("~/App_Data/GroupingAgg.rdl");


if (writerFormat == "PDF")

{

fileName = "GroupingAgg.pdf";

format = WriterFormat.PDF;

}

else if (writerFormat == "Word")

{

fileName = "GroupingAgg.doc";

format = WriterFormat.Word;

}



else if (writerFormat == "Html")

{

fileName = "GroupingAgg.Html";

format = WriterFormat.HTML;

}

else

{

fileName = "GroupingAgg.xls";

format = WriterFormat.Excel;

}

reportWriter.Save(fileName, format, httpContext.Response);

}

catch

{

}

return View();

}

6. Add the following code example in the <body> tag of the CSHTML page to view ReportWriter export options.

HTML

<body>

<div class="container">

<div class="header">

<span style="color: white; font-size: 2em">ReportWriter Demo</span>

</div>

<div class="content_section">

@{Html.BeginForm("Index", "ReportWriter", FormMethod.Post);

{

<div id="description_Pane" style="text-align: justify;">

<h3>Description</h3>

<span>

Essential Report Writer is a powerful control for exporting RDL files into

specified

format files.The following are some of the key features of this component:

Provides

support for various chart types that include Area, Bar, Column, Pie, Funnel,

Radar, Line and

so on. Provides support for both Matrix and Table and also provides support

for

both single, and multi-level row groupings and column groupings. Provides

support

for other common controls such as Textbox, Image, Rectangle, Line and both

Circular

and Linear Gauges. Provides support for report parameter.

</span>

</div>

<div id="export_Pane" style="margin-top: 4%;">

<h3>Export Report</h3>

<span>

Choose a file format to view the selected document generated from Report

file by using Essential ReportWriter.

</span>



<div id="selection_Pane" style="margin-top: 2%;">

<span style="font-size:large;">

<strong>Save As : </strong>

</span>

<input type="radio" name="writerFormat" value="PDF" checked="checked" />

<label for="btnPDf">PDF </label>

<input type="radio" name="writerFormat" value="Word" />

<label for="btnWord">Word </label>

<input type="radio" name="writerFormat" value="xls" />

<label for="btnxls">Excel </label>

<input type="radio" name="writerFormat" value="Html" />

<label for="btnHtml">Html </label>

<input type="submit" name="button" value="Generate" style="width: 18%;

margin-left: 2%;"/>

</div>

</div>

Html.EndForm();

}

}

</div>

</div>

</body>

7. Add the style to the ReportWriter by using the following code example in the <head> tag of the CSHTML page.

HTML

<head>

<meta name="viewport" content="width=device-width" />

<title>Essential Studio Report Writer</title>

<style>

.container {

width: 72%;

border-color: rgb(39, 161, 174);

border-width: medium;

border-style: double;

position: absolute;

left: 14%;

height: 97.5%;

}

.header {

background-color: rgb(39, 161, 174);

text-align: center;

}

.content_section{

height:100%;

position: absolute;

top: 10%;

left: 3%;

right: 3%;

}

</style>

</head>



8. Run the application. The following output displays ReportWriter export options, Select the export option and click on Generate button.

9. The following output displays exported report in the PDF format.



Generate RDL Reports The ReportWriter has options to save the RDL reports. The following code example helps you to generate the RDL report using ReportWriter.

Specify the ReportPath, ReportProcessingMode and WriterFormat properties for ReportWriter to generate report.

C#

string reportPath = @"..\ReportTemplate\GroupingAgg.rdl";

ReportWriter reportWriter = new ReportWriter(reportPath);


reportWriter.Save("GroupingAgg.xls", WriterFormat.Excel);

Generate Report Server Reports The ReportWriter has options to save the Report Server reports. The following code example helps you to generate the Report Server report using ReportWriter.

Specify the ReportPath, ReportServerUrl, ReportServerCredential, ReportProcessingMode and

WriterFormat properties for ReportWriter to generate report.



C#



reportWriter.ReportPath = "45db67a0-3fd6-4684-b03c-aa640a521c97";

reportWriter.ReportServerUrl = "http://reportserver.syncfusion.com:80/";





reportWriter.Save("GroupingAgg.doc", WriterFormat.Word,

httpContext.Response);







C#


{

try

{




}

catch { }

}



{





{


}




{

Report Server REST API


base.GetReport();

}

}



Generating Report Formats The ReportWriter provides support for exporting report as PDF, Word, Excel and HTML documents with the help of the ReportWriter class.

Exporting Report as PDF The report used in ReportWriter can be exported as a PDF document using the following code.

C#


reportWriter.Save("Sample.pdf", WriterFormat.PDF);

Exporting Report as Word The report used in ReportWriter can be exported as a Word document using the following code.

C#


reportWriter.Save("Sample.doc", WriterFormat.Word);

Exporting Report as Excel The report used in ReportWriter can be exported as an Excel document using the following code.

C#


reportWriter.Save("Sample.xls", WriterFormat.Excel);

Exporting Report as HTML The report used in ReportWriter can be exported as an HTML document using the following code.

C#


reportWriter.Save("Sample.html", WriterFormat.HTML);

Report Server REST API Using the Syncfusion Report Server REST API, you can manage and change Syncfusion Report Server resources programmatically via HTTP. The API gives you simple access to the functionality behind the resources on a Syncfusion Report Server. You can use this access to create your own custom applications or to script interactions with Syncfusion Report Server resources.


Report Server Installation and Deployment


API Versions

• v2.1

Installation and Deployment This section explains on how to install and deploy the Syncfusion Report Server.

Download Setup

• You can download the Report Server setup from here • Licensed customers can download the install from the downloads section

Note: The key to unlock the setup will be sent to your registered e-mail address.

Installation This topic details the steps required to install the Report Server.

To learn about the system requirements needed to deploy the Report Server in your business environment, see System Requirements.

Run the Report Server Installer and type in the credentials of your Syncfusion account to unlock the setup.

http://www.syncfusion.com/downloads/reportserver

http://www.syncfusion.com/support/directtrac/downloads



You can alternatively type in the unlock key that has been sent to your registered e-mail address to

unlock the setup by selecting the Install with product key option.



You can check the License Agreement of Report Server by clicking on the License Terms and Conditions.

After you read the license agreement, click on Next to select the installation server type, location and the port number on where the Report server has to be hosted.

We have provided the Report Server to be hosted into the following two web server types

1. IIS Express 2. IIS



IIS Express

IIS Need to provide the Port number, Location and Application Name to host the Report Server into the IIS.



Report Server will be installed with the below components in the mentioned installation location.

• Report Server web application • Scheduling Service

Once the installation completes you can start the Report server by checking the "Start Report Server" in the last screen and click on finish.



Or you can also start the report server from the shortcuts available in the desktop.

Desktop shortcuts will be provided for starting and stopping the report server and for the report designer.

Note: Report Server does not support multiple versions installed on the same machine.

Note: Report Server cannot be downgraded to the previous version.

Deployment

• Report Server web application opens in your default browser with the specified port number at

http://localhost:[port_number]/



• By default the Report Server will be hosted in IIS Express.

Host as website in IIS Report Server can also be hosted as website in IIS by following the below steps.

1. Run the program "ReportServerIIS.exe" from the following installed location to host the Report Server in IIS

installed_Location\Syncfusion\Report Server\Utilities\ReportServerIIS\ReportServerIIS.exe

2. Type in a unused port for the Report Server as like in the above image. This program will host the application in IIS and you can open the Report Server from the browse button in the IIS.




Host as Application in IIS Report Server can also be hosted as Application in IIS by following the below steps.

Add Report Server as application

Right click the Website hosted in IIS and choose Add Application as below figure

![Host Report Server as application in IIS - Add Application](images/IIS sub application.png)

And Fill the following details as below figure

1. Alias name 2. Application pool 3. Physical path


Report Server Azure App Service Deployment


Convert the sub folders as application We have the following folders to be converted as application.

1. API 2. WindowsAuthentication

Right click the folder and choose Convert to Application as below figure

![Host Report Server as application in IIS - Convert to sub Application](images/Convert to application.png)

SSL To enable SSL for the Report Server application, you will need a valid SSL certificate. Please check the below link on how to Obtain an SSL certificate and install it to a website in IIS.

http://www.iis.net/learn/manage/configuring-security/how-to-set-up-ssl-on-iis

Note: If you want to access Report Server from a different machine to the one it's installed on, use the URL http://machinename:[portnumber] or http://machineipaddress:[port_number]

Azure App Service Deployment

Installation and Deployment This section explains on how to deploy the Report Server application into Azure cloud.

http://www.iis.net/learn/manage/configuring-security/how-to-set-up-ssl-on-iis



Download Setup

• You can download the Report Server Azure setup from here • Licensed customers can download the install from the downloads section

How to deploy

Create New Web App

Click the New link in the left panel of the Azure portal website. And follow the breadcrumb in the below screenshot.

At the end, you will be landed in the Create Web App form as below,

And click on Create button to create the new Azure cloud web application.

Create New Storage Account You need to create the Azure storage account with the same location of Azure web application.

Click New link in the left panel of the Azure portal website. And follow the breadcrumb in the below screen shot





Note: If you want to choose the above Storage Account for Diagnostics Logs, the location of the Storage Account must be same as Azure Web App service.

And click on Create button to create the new Azure storage account to hold the containers, files, tables, blobs, queues inside it.

Create Container You will need to browse for storage account and choose the corresponding account from the list of storage accounts and choose the blob service from service list, then you can see the list of containers and the Add container button is at the top of the panel.

While click on Add Container button, the form will be opened next to the list of containers.

Please refer the below figure,

![Azure web app Installation - Create Blob Container](images/createBlob container.png)

You have to choose the Access Type as Container.

And click on Create button to create the new Azure storage account container to store the blobs inside it.

Web Configuration file edits You will need the following storage settings to store the files into the Azure Blob container.

• Azure Blob storage Account name • Azure Blob storage Container name • Azure Blob storage Access key • Azure Blob storage Endpoint • Blob Endpoint (If it has the custom endpoint).

You will find the Account name and Access key from the below figure



You will find the Azure storage end point from the below figure

Azure Blob storage Endpoint will be https://example.core.windows.net, if the Account name is

example.

You will find the container name from the below figure



Extract the zip file which you have downloaded earlier and edit the files in the below location and replace the settings as below.

• \Web.Config • \App_Data\jobs\continuous\ReportServerScheduler\Syncfusion.Server.Base.Reports.Scheduler.

AzureWebJob.exe.config • API\Web.Config

![Azure web app Installation - Web Configuration changes](images/Changes in web config.png)

Azure connection type should be one of the following values customendpoint | HTTPS | HTTP.

If the connection type is custom end point, the sub domain of the AzureStorageBlobURL must be

equal to the storage account name. Otherwise leave the AzureStorageBlobURL as empty.

Note: We recommend to set custom end point as the connection type to avoid the below exception from Azure Blob storage.

"No valid combination of account information found."

Save the files and upload them to the Azure Web App FTP folder as discussed below.

Azure Web App Deployment

• To deploy Report Server using FTP click here • To deploy Report Server using Visual Studio click here

After uploading the files into the Azure web app, you will need to configure the virtual path for below applications

• Root Report Server project • API project

https://help.syncfusion.com/report-platform/report-server/Azure-App-Service-deployment/deploy-using-ftp

https://help.syncfusion.com/report-platform/report-server/Azure-App-Service-deployment/deploy-using-visual-studio



To navigate to the below screen, click settings and click on the Application settings link in the settings panel. Then you will see the screen like below figure

![Azure web app Installation - Virtual Directory](images/Azure portal Virtual directory.png)

Enabling Log This section explains how to configure Logging for Report Server to diagnose the application.

To enable logging in the Report Server web application, go to the Report Server web app in Azure portal

and click Settings > Diagnostics logs.

Enable Application Logging (Blob) then set the level as Information and click on Storage Settings then

you will be asked to select the storage account.

![Azure web app Installation - Choose account storage](images/Choose storage account.png)

And click on the storage account which is used in the web application then it will display all the containers inside the storage account.

![Azure web app Installation - Log container](images/Logs container.png)

Choose the container which you have used in the web application to store the logs and click on the Select button. Now you can able to see the storage account selected in the logs menu.

![Azure web app Installation - Application log](images/Application log.png)

Then click on the Save button in the Logs menu. It will log all information produced by the application and the log files will be stored in blob storage container.

Now you can browse your site and configure the startup screens.

Azure Blob Storage settings This section explain how to set up the Azure blob settings to store the static files into the Azure blob.

The system startup screen of hosted Azure Application looks like below figure

![Azure web app Installation - Startup Page](images/startup page.png)



If the application will be hosted as Azure cloud Application, you cannot be create the SQL CE database, so the option to choose the SQL CE has been disabled.

After creating the database, you will be redirected to the Azure Blob storage settings form.

If the application will be hosted as Azure cloud application, the form filled with the Azure blob settings which will be available in the Web.Config and the form will be disabled by default, you cannot be edit the values here. Please refer the below screenshot.

If the provided Azure Blob storage settings are invalid, the error message will be displayed under the form as shown in the below



If the settings are configured without any error, you will be redirected to the admin user creation form.

View/Download logs To view the resources and logs stored in the blob storage, you need Microsoft Azure Storage Explorer.

You can download and install Microsoft Azure Storage Explorer from here.

Add your Azure account in the Microsoft Azure Storage Explorer using your azure account credentials.

![Azure web app Installation - Storage Explorer](images/Storage Explorer.png)

Then the storage accounts will be listed in the Microsoft Azure Storage Explorer, expand the storage account which is used in the web application. Select the container inside the Blob containers.

The log files generated by the Report Server web application will be listed under the Year/Month/Date/Time folder structure and you can download log files from here.

http://storageexplorer.com/



Upgrade to new Version This Section explains on how to upgrade the Syncfusion Report Server Azure App Service to the next version.

Download the latest build

• Download the Report Server Azure package from here. • Licensed customers can download the Report Server Azure package from here.

Steps to upgrade the Report Server Azure Web App

• Extract the downloaded Report Server Azure web App package. • Edit the Azure Storage properties in the below project config files with your existing property

values. • \Web.Config • \App_Data\jobs\continuous\ReportServerScheduler\Syncfusion.Server.Base.Reports.Scheduler.

AzureWebJob.exe.config • API\Web.Config

![Azure web app Installation - Web Configuration changes](images/Changes in web config.png)

• Upload the files into the Azure App Service using FileZilla in the below folder • /site/wwwroot • Restart the Azure App Service as below,

Deploy Using FTP

• Please follow the below link to configure the prerequisite of Azure deployment in Azure Portal.

https://help.syncfusion.com/report-platform/report-server/Azure-App-Service-deployment/prerequisites







How to deploy using FTP After did the Prerequisites, upload the extracted files into the Azure Web application portal, please follow the steps below to configure the web app.

Login into your Windows Azure portal.

Upload the files into Azure web app portal through FileZilla, so it is must to create the FileZilla credentials from the Azure portal website.

Find the settings panel at the left side of the Web Application panel as shown in figure.

![Azure web app Installation - Upload files](images/Azure portal.png)

Configure the FileZilla credentials by click the Deployment Credentials link from the settings panel as shown in below figure.

After get logged into your FTP, upload the files into the below folder in FTP.

/site/wwwroot



Deploy Using Visual Studio This section explains on how to deploy the Report Server application into Azure portal through Visual Studio.

• Please follow the below link to configure the prerequisite of Azure deployment in Azure Portal.

https://help.syncfusion.com/report-platform/report-server/prerequisites

How to deploy using Visual Studio Please follow the below steps to deploy Syncfusion Report Server into Azure portal through Visual Studio.

Step 1 Extract the Azure package of a Syncfusion Report Server which is downloaded from the Syncfusion site.

Step 2 Open extracted Azure package as Web Site from Visual Studio as below in the screenshot.




Step 3

After Open Azure Report Server package as Web Site, Click on Publish Web App under Build main menu, below popup will be appear in Visual Studio.



Step 4

While click on Microsoft Azure App Service the below window will open up,

Step 5 Azure App Service need Microsoft account to publish the web app into Azure portal. Login here by click

Add an Account option as above.



Step 6

After logged with Microsoft account, create new Azure web app by click on New button as below,



Step 7

After click on New button, the below window will be appeared. After fill the details click on Create button.



Step 8

After click on Create button, the Web App has been created in Azure portal and now the files are ready

to move. Click on Publish button in the next window as below.



Step 9 However, occasionally, you might get the following in the output window

Step 10

Alternatively open Web Publish Activity window by click on View=> Other Windows => Web Publish Activity menu option as below,



Step 11 Click on Publish icon in Web Publish Activity window as below.

Step 12 Now the publishing will be started and after publishing, the site will be open in default browser and the success message will be shown in output window as below.

Report Server Application Startup


Application Startup This topic describes how to configure the Syncfusion Report Server.

Application startup screen help you configure storage options and to register a new user.

Storage Options Report Server stores the user management data in the following databases as you select in the first screen.

• SQL CE • SQL Server • MySQL • Oracle * PostgreSQL

1. ### Embedded SQL CE (For Testing purposes only)

Installed along with Report Server Installer to easily set the environment up for testing purposes.

2. ### SQL Server

Can connect to the existing SQL Server instance with the below options.

• Create new Syncfusion Report Server database.



• Use an existing database for Syncfusion Report Server. • Choose one of the database from Select a Database drop down for creating Report Server

tables in that database.

• In order to avoid table name conflicts, we have added a prefix SyncRS by default. It can also be changed. If the prefix is empty, the default prefix SyncRS is added.



Note: The credentials that is given to connect to the SQL Server instance must have permissions to

• Create Database • Create Table • Insert • Update Table • Alter Table • Select • Drop Table • Drop Database

3. ### MySQL

Can connect to the existing MySQL instance with the below options.






• In order to avoid table name conflicts, we have added a prefix SyncRS by default. It can also be changed. If the prefix is empty, the default prefix “SyncRS" is added.



Note: The credentials that is given to connect to the MySQL instance must have privileges to

• Create • Delete • Insert • Update • Alter • Select • Drop • Show Databases

4. ### Oracle

Can connect to the existing Oracle instance with the below options.



Note: The credentials that is given to connect to the Oracle instance must have permissions to

• Create Database • Create Role • Grant Role • Grant Permission • Drop Database

5. ### PostgreSQL

Can connect to the existing PostgreSQL instance with the below options.




Note: The credentials that is given to connect to the PostgreSQL instance must have permissions to

• Create Database • Create Table • Insert • Update Table • Alter Table • Select • Drop Table • Drop Database

Report Server stores the reports, data sources and files that are uploaded to the server in the following location as file system.

`%programdata%\Syncfusion\Report Server\Resources'



Storage System

File Storage The default system is File Storage, in this the Report Server stores the reports and data sources that are uploaded to the server in the following location in the installed machine.

Blob Storage If the Report Server wants to store the reports and data sources that are uploaded to the server in the blob storage location, need to provide details shown in below figure.



You can find the details on How to configure the Azure Blob

here

New User - System Administrator New user should be created to access the Report Server with the details mentioned in the below image.



While creating this new user account, a new group System Administrator is also created.

By default, System Administrator group have permission to do the below

• Create Reports • Create Data Sources • Create Files • Create Schedules • Create Users • Create Groups • Manage Permissions for users and groups

The new user account created will be assigned to this group by default.

/report-platform/report-server/administration/manage-users

/report-platform/report-server/administration/manage-groups

Report Server Administration


Administration

Users

Manage Users This section explains on how to add, edit, activate, deactivate, delete users and also on how to manage the permissions and assign users to groups in the Syncfusion Report Server.

Users can only be added/edited/deleted by the users, belonging to the System Administrator group.

Add new users New users can be added to the Report Server individually or in bulk using CSV import

Add individual users

To add new users to the Report Server, click on New User and then Create User from the User Management page.

The Add User dialog will be shown as like in the image below.

Fill the form with Username, Email address, First name and Last name and click on Add.

New account will be created for the user and an account activation email will be sent to the email address with activation link to activate the Report Server account.



The activation link sent to the user will be valid only for 3 days and if the user have not activated within the 3 days, a new activation link can be sent to the user from the user edit page. Check Activate Users for more details.

The account will be in inactive status till the user activates the account from the activation email.

Import users from CSV To automate the process of adding large number of users to a Syncfusion Report Server, you can download the CSV template file and add the users in it and then import the file.

You can navigate to user management page by click the User Management icon as below.

Note: The section will explain on how to import the users from CSV file which can be downloaded from below location in Report Server application.



Add users from CSV file

In Report Server, click Import from csv.

CSV file Requirements The first row in the CSV template represents the column heading. Syncfusion Report Server assumes that the data from the second line in the file represents the user.

We have the following two types of User account activation.

• Automatic • Email

We have the following columns are considered as mandatory in the downloaded CSV file.

• Username • Email address • Full Name

• Password : If the Syncfusion Report Server configured with Automatic account activation, password field should be filled. Otherwise we can leave the password field as empty.

Follow the below steps to add users using the CSV template

1. Download CSV template. 2. Add users in the CSV file.



3. Save the CSV file and upload it.

4. Once the file is uploaded the user details will be shown in the grid as like in the below image.

If the Syncfusion Report Server configured with Email activation, the activation mail will be send to the

user's mail Id. If the Syncfusion Report Server configured with Automatic activation, the user will be automatically activated.

5. After uploaded the users in Report Server the results are displayed as below.



Edit users User profile details can be edited from the users edit page as shown in the below image.

First Name, Last Name, Email address, Phone number and profile picture and the login password for the user can be edited by the user belonging to the 'System Administrator' group.

Delete users Users can be deleted from the Report Server when the user no longer requires the access. Users can be deleted from the user management page or from the edit page.

From user management page



From user edit page

Deactivate users Users can be deactivated at any time. Once deactivated, the user cannot log into the Report Server.

To deactivate a user, select inactive from the status dropdown in the user edit page.

Activate users

Inactive users can be activated by clicking on the Activate User button in the user edit page.



This will send an account activation email to the user with an activation link to activate the account and again this activation link will be valid only for 3 days.

If the user has not received the activation email within 3 days or missed to activate the account, the

System Administrator has to resend the activation email to the user.



Manage permissions Check the Manage Permissions section to learn how to manage permissions to an user.

Assign users to group Users can be assigned to one or many groups from the user management page.

Users can be assigned to an existing group.



A new group can also be created at this time and the selected users can be assigned to the new group.

Note: All the users in the group will have the permissions of assigned group.

Active Directory User Import This section explains how to search and import users from Active Directory into the Syncfusion Report Server.

Note: Active Directory connection has to be configured in the Active Directory Settings in the General page for importing users.



Users belonging to the System Administrator group only can import Active Directory users into the Report Server.

Search Users You can search the Active Directory users with any one of the below properties and choose them to import into the Report Server.

• User name • First name • Last name • Email Address • Display name

A maximum of 1000 users will be searched and pulled from Active Directory in a single request.

Report Server will list the search results of the users in the grid as shown in the below figure.

Import Users To import the Active Directory users into the Report Server, you have to choose the users from the list

and click on the Import and Activate button at the top right corner.

Report Server will import the chosen users and a confirmation message will be displayed as shown in the below figure.

Duplicate Users Active Directory users who has the same username or email address as that of the Report Server users(who are already present) will be marked as duplicate users and will not be allowed to import into Report Server.



Modify Active Directory Connection

To modify Active Directory configuration settings, click on the Modify link as below

Active Directory User Synchronization This section explains how to synchronize the imported Active Directory users details with the Active Directory.

You can navigate to the user synchronization page from users page as shown in the below figure.

Synchronize Users Report Server will list the Active Directory users that are already imported as shown in the below figure.



Choose the groups you want to synchronize and click on Synchronize at the top.

Synchronization procedure

• Report Server will synchronize the user details - username, first name, last name, email address, contact number with the Active Directory Server.

• Report Server will delete the user if the user has deleted from the Active Directory Server.

After synchronization completes, the number of users modified, deleted, duplicated will be shown in the success message box as shown in the below figure.

Duplicate Users Active Directory users who has the same username or email address as that of the Report Server users(who are already present) will be marked as duplicate users and will not be allowed to synchronize into Active Directory.

User Import from a Database This section explains how to import users from Database into the Syncfusion Report Server.



Note: Account Activation type should be E-mail Activation and E-mail settings has to be configured in

the E-mail Settings in the General page for importing users from Database.

Users belonging to the System Administrator group only can import users from database into the Report Server.

Get Database Connection Details

To add new users to the Report Server, click on New User and then Import from Database from the User Management page.

The link will redirect to another page that will look like below.

Users can be imported from below types of Databases.

1. SQL Server 2. MySQL 3. Oracle 4. PostgreSQL

To select the database type from which the users to be imported, click on Database type dropdown.



SQL Server Database For SQL Server Database, fill the form with Server name, Authentication type, Username, Password and Database name.

The connection details can be tested by click on 'Test Connection'

MySQL Database For MySQL Database, fill the form with DSN, Username, Password and Database name.




Oracle Database For MySQL Database, fill the form with DSN, Admin username, Admin password, Database name and Database password.




PostgreSQL Database For PostgreSQL Database, fill the form with Server name, Port, Username, Password and Database name.




Once the connection details are filled, click on 'Connect' for getting schema of the provided database connection.

Map Database Columns The page will look like below once the database has been connected.



Select the matched columns from the database schema for Username, First name, Email address and Last name (Optional) fields.

If the columns are selected from different tables, below scenarios will happen.

• If the tables have single relationship - The join will be made with the particular relationship. • If the tables have multiple relationships - The relationship can be selected from the list of

relationships and then click on Apply



• If there is no relationship between tables - Form Join with the selected tables and then click on

Apply

After selection of columns, give sort order and record count to pull user data from database.



Select Users and Import After selecting columns the data retrieved from database will be shown in Grid. Select the users to be

imported and click on Import Users to import the users.

Report Server will import the chosen users and a confirmation message will be displayed as shown in the below image.



Groups

Manage Groups This section explains on how to add, edit, delete groups and also on how to assign users and manage permissions to groups in the Syncfusion Report Server.

Groups is a collection of users to which permissions can be assigned.

Add new group

To add new group to the Report Server, click on New Group in the groups management page.

New groups can be added by providing name and description(optional) for the group.



Fill the form with name and description and click on Add. New group will be created and you can add users or manage permissions for it.

Edit group Group Information can be edited from the group's edit page.

Group name and description can be edited in the group edit page. In addition to that, users can also be assigned or removed from the group in this page.

Delete group

Groups can be deleted if it is no longer needed. You cannot delete the System Administrator group.

From group management page

From group edit page



Assign users Users can be assigned to the selected group there by assigning the permissions of the group to the users.

Users can also be removed from the group if the user no longer needs the permissions of the group.

Click on Remove next to the user in the group edit page to remove the user from the group.

Manage permissions Check the Manage Permissions section to learn how to manage permissions to a group.

Active Directory Group Import This section explains how to search and import groups from Active Directory into the Syncfusion Report Server.

Note: Active Directory connection has to be configured in the Active Directory Settings in the General page for importing groups.

Users belonging to the System Administrator group only can import Active Directory groups into the Syncfusion Report Server.

Search Groups You can search the Active Directory groups with any one of the below properties and choose them to import into Syncfusion Report Server.

• Group name • Group description

A maximum of 1000 groups will be searched and pulled from Active Directory in a single request.

Report Server will list the search results of the groups in the grid as shown in the below figure.



Import Groups To import the Active Directory groups into the Report Server, you have to choose the groups from the

list and click on the Import groups button at the top right corner.

Report Server will import the chosen groups and a confirmation message will be displayed as shown in the below figure.

The success message box explains the users who all are get imported/not imported into the Report Server.

Duplicate Groups Active Directory groups who has the same groupname as that of the Report Server groups(which are already present) will be marked as duplicate groups and will not be allowed to import into Report Server.



Active Directory Group Synchronization This section explains how to synchronize the imported Active Directory group and its users with the Active Directory.

You can navigate to the group synchronization page from groups page as shown in the below figure.

Synchronize Groups Report Server will list the Active Directory groups that are already imported as shown in the below figure.

Choose the groups you want to synchronize and click on Synchronize at the top.



Synchronization procedure

• Report Server will update the group's name and description from the Active Directory Server. • Report Server will delete the groups if the group has been deleted from the Active Directory

Server. • Report Server will delete the user from Report Server group, if the user has been deleted from

Active Directory Server group. Report Server will add the user into Report Server, if a new user is added into the Active Directory group. If the new user is not present in the Report Server, then a new user account will be created in the Report Server and will be added into the group.

After synchronization completes, the number of groups modified, deleted, duplicated will be shown in the success message box as shown in the below figure.

Duplicate Groups Active Directory groups who has the same group name as that of the Report Server groups(which are already present) will be marked as duplicate groups and will not be allowed to synchronize with Active Directory.



Manage Permissions This section explains the access modes, entities & scopes and how to manage the permissions for the users and groups.

Permissions can only be managed by the users belonging to the System administrator group.

Permission can be directly added to both users and groups. Permissions are classified in the following structure.

Access Mode – Entity – Scope

Access Modes

• Read – Provides read permission for the chosen entity. • Read and Write – Provides read and write permission for the chosen entity. • Read, Write and Delete – Provides read, write and delete permission for the chosen entity. • Create – Provides permission to create the chosen entity.

Entity

• All Reports – Provides permission to access all reports with the chosen access mode. • Reports in Category – Provides permission to access reports in a specific category with chosen

access mode. • Specific Report – Provides permission to access a specific report with the chosen access mode. • All Data Sources – Provides permission to access all data sources with the chosen access mode. • Specific Data Source – Provides permission to access a specific data source with the chosen

access mode. • All Files – Provides permission to access all files with the chosen access mode. • Specific File – Provides permission to access a specific file with the chosen access mode. • All Categories – Provides permission to access all categories with the chosen access mode. • Specific Category – Provides permission to access a specific category with the chosen access

mode. • All Schedules – Provides permission to access all schedules with the chosen access mode. • Specific Schedule – Provides permission to access a specific schedule with the chosen access

mode.



Scope Scopes can be chosen for the below entities only. Other entities do not require to specify the scope.

• Reports in Category – A specific category has to be chosen to provide access to the reports in that category.

• Specific Report – A specific report has to be chosen to provide access to it. • Specific Data Source – A specific data source has to be chosen to provide access to it. • Specific File – A specific file has to be chosen to provide access to it. • Specific Category – A specific category has to be chosen to provide access to it. • Specific Schedule – A specific schedule has to be chosen to provide access to it.

Note: Create access can only have the scopes, All Reports, Reports in Category, All Data Sources, All Files, All Schedules and All Categories.

Manage Permissions - users

Manage Permissions page for the user can be accessed from any one of the following places.

1. Context menu of the respective user in the users grid on the user management page

2. On top right corner of the user profile edit page

Here you will find both the permissions assigned directly to the user and the permissions that the user got inherited from the groups assigned with.



Click on Add Permission to add permissions to the user. Add Permission dialog box is shown below.

Steps to add permission to the user

1. Select the access mode. 2. Select the entity.

3. Select the scope if the access mode is not Create or if the entity is Specific item type.

4. Click on Add to add the framed permission to the user.

Manage Permissions - groups

Manage Permissions page for the group can be accessed from any one of the following places.

1. Context menu of the respective group in the groups grid on the group management page



2. On top right corner of the group edit page

Here you will find the permissions assigned directly to the group.

Please refer the below screenshot for the Manage Permissions for the user page.

Click on Add Permission to add permissions to the group. Add Permission dialog box is shown below.



Steps to add permission to the group

1. Select the access mode. 2. Select the entity.

3. Select the scope if the access mode is not Create or if the entity is Specific item type.

4. Click on Add to add the framed permission to the group.

Manage Categories This section explains on how to open, add, update and delete categories in the Syncfusion Report Server.

Categories are used to group and manage the reports. Categories that are accessible by the user depends upon the user's permission and the categories whose reports the user has access are displayed in the left panel in the reports page.

Open Category Click on any category in the left panel to view the reports grouped with it.



Add Category

To add a new category you must have Create All Categories permission. Click on the Create button in

the menu and select Category to create a category.

New categories can be added by providing name and description(optional) for the category.



Fill the form with name, description and click on Add.

Note: Read Write Delete permission for that Specific Category will be added for the user who created the category.

Update Category Category can be updated from the context menu with its name and description.

Share Category This section explains on how to share categories with the other users in the Report Server.

Steps to share a category

1. Click the Actions button in the category list context menu and select Manage Permissions option.



2. Select the permission access from the Select Access dropdown and select the users or groups to share the category.

3. After selecting the access and users or groups, click on the Add Permission button.



Note: Only the user who created the category can share the category with other Report Server users.

View Permission If the user is not an owner of the category, user can view the assigned permissions of the category by

clicking the View Permissions option in the category list context menu.

The permission availed to the users can be viewed in the Users tab.



The permission availed to the groups can be viewed in the Groups tab.

Remove Permission

The user who created the category can remove the shared category permissions using the Remove

option in the Actions column of the each permissions.



Delete Category Category can also be deleted from the Report Server when they are no longer required.

Click on delete in the context menu for the category to be deleted.

Note: Category cannot be deleted when it has reports grouped in it.

Manage Reports

How to open Reports This section explains on how to open Reports in the Report Server and in the Report Designer from the Report Server.

Reports that are accessible by the user depending on the user's permission is displayed in the Reports page.

Open Report Click on the Report Name in the list to open it.



Reports are opened in our embedded Report Viewer and Reports can also be exported in PPT format.

Open with Report Designer Reports can be launched directly in the Report Designer from the Report Server.

Click the Actions button in the Reports grid context menu and select Open with Report Designer to open the Report in the Report Designer if it is already installed in the client machine.



If Report Designer is not already installed in the client machine, then Report Designer will be downloaded in the client machine for the user to install.

How to Open Reports with Report Parameter This section explains on how to open the Reports by applying the query parameter in the Report Server.

Apply query parameter The filter parameters can be passed in the Query String and the Reports will be filtered based on the query parameter.



Parameters of the Report The parameter of the report will be the Name of the parameter given while creating the report.



Download Reports This section explains on how to download Reports from the Syncfusion Report Server.

Click the Actions button in the Reports grid context menu and select Download to download the

Report in .rdl format.



Downloaded Report can be loaded in our Report Designer or in the SSRS Report builder.

Add Reports This section explains on how to add Reports in the Syncfusion Report Server.

• If the user has Create All Reports permission, then the user can create reports in any category. • If the user has Create Reports in Category permission with some chosen categories, then the

user can only create reports in those chosen categories. • Reports must be added in any one category. • Reports can be designed in the Report Designer and then added in the Report Server. For client

users, Report Designer can be downloaded from the Report Server. • Reports created by using the SSRS Report Builder can also be uploaded into the Report Server.



Steps to add a report

1. Click on the Create button in the menu and select Reports to add a report.

2. Select a category for the report and fill in the name and description of the report and upload the RDL file in the Add Report dialog box.

3. If the report uses shared data sources, then the data sources also should to be selected.



4. In the select data source dialog, you can either select a data source that is already in the Report Server or create a new data source at that time itself.

5. After choosing the data source, the report can be saved to be added in the Report Server.

Note: Read Write Delete permission for that Specific Report will be added for the user who created the report.

Update Reports This section explains on how to add Reports in the Syncfusion Report Server.

Steps to update a Report Reports can be updated to move the Report to a different category. Name, description and the Report

file(.rdl) can be changed for the Report in the update Report dialog box.

1. Click on the Update option in the context menu of the Report to be updated to open the update Report dialog box.



2. Click on the Update button in the Update Report dialog box after making changes to the

Category, Name, Description or to the Report file(.rdl). Comments can also be added if there is a

change in the Report file(.rdl) to maintain as Version Comments.



Schedule Reports Reports can be made to run at scheduled times and export them in PDF, Word, Excel or HTML formats to mail them to the users in the Report Server.

(Discussed more in the Manage Schedules section)

Share Reports This section explains on how to share Reports with the other users in the Report Server.

Steps to share a Report

1. Click the Actions button in the Reports grid context menu and select Manage Permissions option.



2. Select the permission access from the Select Access dropdown and select the users or groups to share the Report.




Note: Only the user who created the Report can share the Report with other Report Server users.

View Permission If the user is not an owner of the Report, user can view the assigned permissions of the Report by

clicking the View Permissions option in the Reports grid context menu.




Remove Permission

The user who created the Report can remove the shared Report permissions using the Remove option

in the Actions column of the each permissions.



Favorite Report This section explains about how to mark Reports as favorites, remove a particular Report from favorites and view the list of favorite Reports in the Syncfusion Report Server.

Mark a Report as favorite

Reports can be marked as favorite to view them in the Favorite Reports category instead of searching them in the Categories or using keywords in the Reports list.

To mark a Report as favorite, click on the star icon near the Report name.

The star icon will be filled with color to indicate that it is added as favorite Report.



Remove a Report from favorites To remove a Report from favorites, click on the star icon near the Report name.

The star icon color will be emptied to indicate that it is removed from favorites.



Favorite Reports Category

Reports that are marked as favorite can be viewed under Favorite Reports category.

Public Report This section explains on how to make the Reports public and private.

Public Reports are accessible to anonymous users who has the Report link.



Private Reports are accessible to the registered users in the Report Server who has appropriate permissions.

Make public

Make Public option is available only to the owner of the Report.

Follow the steps below to make the Reports accessible to anonymous users.

1. Click on the context menu of the respective Report and choose Make Public option.

2. Click on Make Public in the following confirmation dialog box.



Once the Report made public dialog box with the Report link will be displayed.

Make Private

Make Private option is available only to the owner of the Report.

Follow the steps below to make the Reports accessible only to the users in the Report Server who has appropriate permissions.

1. Click on the context menu of the respective Report and choose Make Private option.



2. Click on Make Private in the following confirmation dialog box.



Once the Report made private dialog box confirmation message will be displayed.

Public Reports Public reports are listed in the below icon section in the home page of Syncfusion Report Server.

Get Report Link This section explains on how to get link to the Reports in the Syncfusion Report Server.

These links are used to navigate to the Report and can be shared with others.

If the Report is public, anyone with this link will be able to view its contents.

If the Report is private, anyone with this link can navigate to the Report, but only users with the appropriate permissions will be able to view its contents.

Get Link

Get Link option is available for all the Reports.

Follow the steps below to get the Reports link.

1. Click on the context menu of the respective Report and choose Get Link option.



2. Respective Report link will be show in the Get Link dialog box.

For Public Reports



For Private Reports

Manage Reports Views This section explains on how to open, add, update, share, delete Report views in the Syncfusion Report Server.

Report Views functionality is enhanced by the ability to save the currently applied parameters to the report.

Saved Report Views can be shared, updated, deleted.

Open Report Views Report Views are opened in our embedded Report Viewer itself as Reports.

Saved Report views of each Reports will be listed in the context menu of the respective Report.



Add Report Views

• User can create Report View in any Report. • Report Views can be shared, updated and deleted only the user who created it.

• Shared Report View has Save As option to save as a new Report View.

Steps to add a Report View

1. Find the expand icon at top left corner, Click on that icon and select Save to add a Report View.



Enter a name for the new view and Click on the Tick as shown in the below figure.

2. Saved Report Views will be displayed in the Saved Views panel.



Share Report Views Saved Report Views can be shared with other users and groups in the Report Server. They can be also shared to anonymous users.

Choose the users and groups from the dropdown and click on Share button to share to the selected users and groups.



Make Public Report View can be shared to anonymous users only by the user who created, marked the Report View as Public as below.



Delete Report Views Report Views can also be deleted from the Report Server only by the user who created it.

Click the Delete icon for the specific report view to delete the Report View.



Report Processing Option This section explains what is Report Processing Option and how it works in Syncfusion Report Server.

Report Processing Option determines how the Report Server process the Report.

There are two options in Report Processing Option

Always run this report with the most recent data Use this option when you want to retrieve report data when the user selects the report. If a cached copy of the report is available, it is returned to the user; otherwise, data retrieval and rendering occurs when a user selects the report.

Do not cache temporary copies of this report Select this option to always run the report with the most recent data. Each user who opens the report triggers a query against the data source that contains data used in the report.

Cache a temporary copy of the report Select this option to place a temporary copy of the report in a cache when a user first opens the report. Subsequent users who run the report within the caching period receive the cached copy of the report. Caching usually improves performance because the report is returned from the cache instead of being processed again.

Render this report from a report snapshot Use this option to retrieve a report that has been stored as a snapshot at a time that you schedule. When you choose this option, you can schedule data processing to occur during off-peak hours. Unlike cached copies that are created when a user opens the report, a snapshot is created and subsequently refreshed on a schedule. Snapshots do not expire; they remain in service until they are replaced by newer versions.

Add Processing Option This section explains how to add the Report Processing Option in Syncfusion Report Server.

Add Processing Option

To Open the Processing option click the Processing Option menu item from context menu as below,



User can choose the desired option from the Processing Option dialog box as below,



If you want to cache the report with the scheduling option, Choose the corresponding option and click

on Configure button as below,



After clicking the button the schedule popup will be appeared as below,



After scheduled your Processing Option the next date of recursion will be displayed here as below,



To choose the multiple Reports/Categories, click on the Select Multiple Reports button as below. And

choose the Reports/Categories from the drop down. And click on Next button to configure the Multiple Reports.



And click on Save button to Save the Processing Option for Selected Reports and Categories.



Update Processing Option This section explains how to update the Report Processing Option in Syncfusion Report Server.

Update Report Processing Option

To update the Report Processing Option for particular Report, choose the Processing option context menu item of the Report.



In the update Processing Option Schedule, the combination of Reports and categories already chosen are selected as default.



If you want to remove Processing option for particular Reports or Categories, you can uncheck it and

click on Next and click on Save button.

If you want to change the Processing Option from the existing one, select it and click on Save button.



Move, Copy and Clone Reports Reports can be moved, copied or cloned from one category to another category.

Move Reports Moves the Report from one to another category.

Copy Reports Copies the Report from one to another category.



Clone Reports

Creates a reference of the Report to destination category. When the Report .rdl file is changed, then it affects the Reports in both the categories.

Version History Versions and file logs for each Report will be maintained in the Report Server for every changes in the Report.

Versions

For each change in the .rdl file, a new version will be created. All versions can be individually opened. At any time, the Report can be rolled back to an older version.



File logs

For each change in the Report including changes in the name, description, category and .rdl file, Report Server logs the changes done in the file logs.



Delete Reports Reports can also be deleted from the Report Server when they are no longer required.

Click the Actions button in the Reports grid context menu and select Delete to delete the Report.



Note: Reports cannot be deleted when they are scheduled by an user.

Manage Data Sources This section explains on how to add, update, download, delete data sources and also on how to view the version history of data sources in the Syncfusion Report Server.

Data Sources that are accessible by the user depending on the user’s permission is displayed in the data sources page.



Add Data Sources

Data source can be created only if the user has Create All Data Sources permission.

Steps to add a data source

1. Click on the Create button in the menu and select Data Source to add a data source.

2. Fill in the form with name and description of the data source, the data source type, connection string and the connection detail on how to connect the specified data source. Data Sources can be created with connections to any one of the following data source types

o Microsoft SQL Server o SQLCE o OLE DB o Oracle o ODBC o XML



3. When clicking on Add, the data source will be added to the Report Server and it can be used in any one of the reports.

Note: Read Write Delete permission for that Specific Data Source will be added for the user who

created the data source.

Update Data Sources Name, description, data source type, connection string and the connection detail on how to connect to the specified data source type can be changed in the update data source dialog box.



Share Data sources This section explains on how to share data sources with the other users in the Report Server.

Steps to share a data source

1. Click the Actions button in the Data sources grid context menu and select Manage Permissions option.



2. Select the permission access from the Select Access dropdown and select the users or groups to share the data source.


Note: Only the user who created the data source can share the data source with other Report Server users.



View Permission If the user is not an owner of the data source, user can view the assigned permissions of the data source

by clicking the View Permissions option in the Datasources grid context menu.





Remove Permission The user who created the data source can remove the shared data source permissions using the

Remove option in the Actions column of the each permissions.

Open with Report Designer Data Sources can be launched directly in the Report Designer from the Report Server.

Click the Actions button in the Data Sources grid context menu and select Open with Report Designer to open the Data Source in the Report Designer if it is already installed in the client machine.



If Report Designer is not already installed in the client machine, then Report Designer will be downloaded in the client machine for the user to install.

Download Data Sources

Click the Actions button in the data sources grid context menu and select Download to download the

data source in .rds format.

Version History Versions and file logs for each data source are maintained in the Report Server for every changes in the data source. Check Version History section in Manage Reports for more details.

Delete Data Sources Data Sources can also be deleted from the Report Server when they are no longer required.

Click the Actions button in the data sources grid context menu and select Delete to delete the data source.



Note: Data Sources cannot be deleted if a report uses it.

Manage Files This section explains on how to add, update, download, delete files and also on how to view version history of files in the Syncfusion Report Server.

Files that are accessible by the user depending on the user’s permission is displayed in the files page.

Add Files

Files can be added in the Report Server only when you have Create All Files permission.

Steps to add a file

1. Click on the Create button in the menu and select File to add a file.



2. Fill the form with name, description of file and upload the file in the Add File dialog box. Any file can be uploaded into the Report Server and the file can be linked/added to the Reports.

3. When clicking on Add, the file will be added to the Report Server and it can be used in any one of the reports.

Note: Read Write Delete permission for that Specific File will be added for the user who created the file.

Update Files Name, description and the physical file can be changed in the update file dialog box.



Share Files This section explains on how to share files with the other users in the Report Server.

Steps to share a Files

1. Click the Actions button in the Files grid context menu and select Manage Permissions option.

2. Select the permission access from the Select Access dropdown and select the users or groups to share the files.




Note: Only the user who created the file can share the file with other Report Server users.

View Permission If the user is not an owner of the File, user can view the assigned permissions of the file by clicking the

View Permissions option in the Files grid context menu.



Remove Permission

The user who created the file can remove the shared file permissions using the Remove option in the

Actions column of the each permissions.

Download Files

Click the Actions button in the files grid context menu and select Download to download the file

compressed in a .zip format.



Version History Versions and file logs for each file are maintained in the Report Server for every changes in the file. Check Version History section in Manage Reports for more details.

Delete Files Files can also be deleted from the Report Server when they are no longer required.

Click the Actions button in the files grid context menu and select Delete to delete the file.

Manage Schedules This section explains on how to add, edit, delete schedules and also on how to run the schedules on demand and enable or disable schedules in the Syncfusion Report Server.

Schedules that are accessible by the user depending on the user’s permission will be shown in the schedules' page.



Add Schedules

Schedules are created from the reports page. Schedules can only be created if the user has Create All Schedules permission.

Steps to create a schedule

1. Click the Actions button in the schedules grid context menu and select Schedule to schedule the corresponding report.



2. Select the recurrence type, recurrence, start and end dates, export formats and the users to which the exported reports has to be emailed in the `Add Schedule' dialog box.

o Reports can be scheduled daily, weekly, monthly and yearly o Reports can be exported in PDF, Word, Excel and HTML formats o Application Time Zone will be shown below the date picker. Start time of the schedule

will be converted to client Time Zone and shown in the right side for the user’s convenience

o Exported reports can be sent to individual users or groups



3. When clicking on Schedule, the report will be scheduled in the selected recurrence.



Note: Read Write Delete permission for that Specific Schedule will be added for the user who created the schedule.

Edit Schedules Name, recurrence type, recurrence, start and end dates, export format and the recipients can be

changed in the Edit Schedule dialog box.

Run Now

Schedules can be made to run on demand by using this Run Now option in the schedule grid context menu. Report will be exported in the format specified and sent to the recipients.

Enable or Disable Schedule Schedules can be disabled at any time which will ignore any next occurrences. When enabled it will get the next occurrence and run accordingly.

Delete Schedules Schedules can be deleted from the Report Server when it is no longer required.

Click the Actions button in the schedules grid context menu and select Delete to delete the schedule.

Report Server Collaboration


Collaboration This section explains on how to collaborate with other users in the Syncfusion Report Server by commenting on Reports.

Collaboration feature in Report Server lets the users write comments on a Report to share with other users who has access to the Report. They are useful for tracking events and providing insights into those events. Users can also add links to other Reports or any other external websites.

Anyone with access to a Report can write comments. When a comment has been added to a Report, users who have notifications enabled in their profile, will be notified through email and system notifications. Learn more about Notifications in this section.

Post a new comment To post a new comment, open the Report and click on the comment icon in the top right corner as shown in the below image.

Type the comment in the text area and click on Post to save the comment for the Report.



Note: Clipboard images can also be added along with the comments by simply copying an image and pasting in the text area.

Reply to a comment To reply to a comment, click on the Reply icon in the comment as shown in the below image.



Type the reply in the text area and click on Reply to save the reply for the comment on the Report.



Note: You can also reply to a reply of a comment. This can be repeated a number of times.

Edit a comment To edit a comment, click on the option Actions button to get more options for a comment or a reply

and click on the Edit button as shown in the below image.



Edit the comment and click on Save to save it.



Delete a comment To delete a comment, click on the option Actions button to get more options for a comment or a reply

and click on the Delete button as shown in the below image.



Show parent comment of a reply To know the parent comment of a reply or to know which comment the reply has been posted, click on

the option Actions button and click on the Show Parent button as shown in the below image.



On clicking, the parent comment is highlighted for the reply as like below.



Mention Users in the comment Users can be mentioned in the comments to notify them about the comment through email.

Type @ followed by the user's name and from the list of possible names select the user to mention them in the comment.

Report Server Notifications


Note: The above options - Post a new comment, reply to a comment, edit a comment, delete a comment and show parent comment of a reply applies to Reports.

Notifications This section explains on how to configure notifications to notify the users for comments on the Reports in the Syncfusion Report Server.

Notifications can be configured by both the System Administrator and the user.

Admin notification settings Configure how the users receive notifications for the comments from the admin notification settings page.

Let's look at the notification settings one by one.

System notifications System notifications are the ones that will appear in the top right before the user name once the user logged into the Report Server as like in the below image.

Report Server Notifications


![System notifications](images/notifications-system notifications.png)

Mail notifications Users will also be notified through email for comments.

Autowatch comments of created items This is a switch for watching the comments of the items that the users have created. Enabling this will send notifications for comments on all the items that the users have created.

Autowatch comments of accessible items This is a switch for watching the comments of the items that the users have access. Enabling this will send notifications for comments on all the items that the users have access.

Now, let's look at the default and allowable notification settings configuration.

Default Settings This is the default settings applied to the user while the user is added into the Report Server. Users can change switch from this setting and make their own or choose to inherit this setting anytime in their profile edit page

Allow/Restrict Settings This is the master settings for the Report Server. Upon enabling or disabling any setting in here will enable or disable it in the Report Server. This will override the default and user settings.

User Notification Settings Configure how the current user receive notifications for the comments from the user notification settings page.

Users can navigate to this page from the profile edit page as shown in the below image.

Refer to the below image for changing the notification settings for the current user.

Report Server Localization


Settings can be enabled or disabled or inherited from global settings which is the default settings of the Report Server.

Specific watch Apart from autowatch of created and accessible item settings, users can also watch on a specific item if they want to watch an item specifically.

Users can toggle between watch and unwatch for a Report comment anytime.

Localization Localization is the process of adapting a website into different linguistic and cultural contexts - involving much more than the simple translation of text.

Syncfusion Report Server is released with localization support.

The default language is English “en-US”.

Read the below documentation on how to add new localizations and how to edit existing localizations in the Syncfusion Report Server.

How to add new localization

How to edit existing localizations

Site Settings

Custom Rebranding This section explains on how to customize the Syncfusion Report Server by changing the organization name, site URL, login screen logo and welcome note text, main screen logo, favorite icon and time zone and date time display formats.

https://github.com/syncfusion/enterpriseserver-global/blob/master/Report%20Server/How-to-add-new-localizations.md

https://github.com/syncfusion/enterpriseserver-global/blob/master/Report%20Server/How-to-edit-localization-messages.md

Report Server Site Settings


Report Server can be rebranded with Organization name, site URL, login screen logo and welcome text, main screen logo, favicon, time zone and date time format.

Organization Name Name of the Report Server can be changed at any time and this is in the title bar of the browser.

Site URL Report Server URL can be changed at any time in the Server Settings page and to get this change reflected you need to configure the same in the IIS. Check the Host in IIS section on how to host the Report Server in IIS. After hosting is done, add the same URL in the site binding in IIS as like below.



Login Screen

• Login page logo image can be changed and the preferred image size is 240x120 pixels. Report Server will have Syncfusion logo as default login logo.

• Welcome note can be changed and the maximum characters is 70. Report Server will have "Welcome to Syncfusion Report Server" as default login welcome text.

Main Screen Main screen logo image can be changed and the preferred image size is 40x40 pixels. Report Server will have Syncfusion logo as default main screen logo.

Favicon Favicon for the Report Server can be changed and the preferred image size is 16x16 pixels. Report Server will have Syncfusion favicon as default favicon.

Display

Time zone Time zone for the Report Server can be changed. Report Server sets the time zone of the system where it is installed by default.

Date format Date format of the Report Server can be changed. Report Server will have "MM/dd/yyyy" as the default date format.



Language Option to localize the Report Server to any culture. Please click here to learn how to add new localization or edit existing localization in the Report Server.

Powered by Syncfusion

Option to show/hide Powered by Syncfusion in the footer of the Report Server. By default, this will be shown.

Copyright Information

Option to show/hide Copyright Information in the footer of the Report Server. By default, this will be shown.

Email Settings This section explains on how to configure the SMTP details in the Syncfusion Report Server to send emails.

SMTP Email Settings are required to perform the following operations

Account Activation --- Sends user account activation email

Forgot Password --- Sends request links to reset the password when the user has forgotten the password

Reset Password --- Sends links to reset the password

Scheduled Reports --- Sends the exported report to the scheduled recipients

The following SMTP details are required to send email from the Report Server.

• SMTP Server • SMTP Port • Sender Name • Sender email • Password • SSL/TLS

https://en.wikipedia.org/wiki/Simple_Mail_Transfer_Protocol



Active Directory

Active Directory Settings This section explains what are the Active Directory details needed and how to configure Active Directory with the Syncfusion Report Server.

You will need the below Active Directory details to configure Syncfusion Report Server with your Active Directory

• Username and Password - username and password of the user who is present in the Active Directory domain

• LDAP URL - IP or DNS name of the Windows Server where you have Active y Domain Services

enabled. For example, LDAP://192.168.1.1 • Distinguished Name - FQDN of the Active Directory. Follow the below procedure to find out the

Distinguished Name of your Active Directory 1. Go to Run(Win + R) and type sysdm.cpl in a machine which is connected to the Active

Directory or in the Windows Server where you have Active Directory Domain Services enabled

https://msdn.microsoft.com/en-us/library/windows/desktop/aa746492



2. The System Properties dialog will be opened and you can find the Distinguished Name labeled

as Domain

For example, if your Domain is www.example.com, then you have to type in as dc=www,dc=example,dc=com

• Enable SSL - Enable this checkbox, if your Windows Server needs SSL connection to connect to the Active Directory

• Port Number - Default port for Non-SSL connections is 389 and for SSL connections is 636

Kerberos Authentication Settings This section explains how to configure Syncfusion Report Server to use Kerberos for user authentication.



Please check the below links for more details about Kerberos authentication protocol.

https://msdn.microsoft.com/en-us/library/bb742516.aspx


Configure Kerberos Settings To configure Report Server to use Kerberos, feed the Machine name and Host Domain name. Report Server will generate a .bat file which has to be run in the Windows Server, where Active Directory Domain Services role is installed.

• Machine name - You can find the machine name using the following steps. 1. Right click on My computer and select Properties.

2. Find the Machine name labeled as Computer name under Computer name, domain, and workgroup settings

• Host Domain name - This is the DNS name of the Report Server. For example, example.com.

Generate SetSPN .bat file

After feeding in the above parameters, click on Generate and Download .bat File. Report Server will generate the .bat file for setting the SPN and will prompt you to download.

Save and run the generated .bat file in the Windows Server machine, where Active Directory Domain Services role is installed.

This will set Service Principal Name to let the Report Server to authenticate users using Kerberos authentication.

Active Directory Synchronization Schedule This section explains how to schedule the synchronization of users and groups from Active Directory with the users and groups in the Syncfusion Report Server.

https://msdn.microsoft.com/en-us/library/bb742516.aspx


Report Server User Profile


Note: Please configure Active Directory Settings, before you schedule synchronization of Active Directory users and groups.

Users and groups from Active Directory can be synchronized on schedule to get the latest details of them into the Report Server.

Please find more details on the synchronization of users and groups from Active Directory with Report Server in the below links.

Synchronize Active Directory Users

Synchronize Active Directory Groups

Email Notifications

Once a scheduled recurrence of synchronization is completed, the users in the System Administrator group will be notified through email about the synchronization status.

Enable/Disable Synchronization schedule Synchronization schedule can be enabled or disabled anytime from the top check box.

User Profile This section explains on how to view and edit profile and also on how to change password for the user profile in the Syncfusion Report Server.

User can view the profile and edit the profile details and can change the password.

View Profile You can view your profile details in this page.

/report-platform/report-server/administration/synchronization-active-directory-users

/report-platform/report-server/administration/synchronization-active-directory-groups

Report Server User Profile


Edit Profile First name, Last name, Email address, Phone number and Profile picture can be changed in the edit profile page.

Change Password Password to log in to the Report Server can be changed in the change password page.

My Permissions Users can view their access permission list for each resources like Reports, Data Sources, Files and Schedules in the Report Server.

Report Server Utilities


Utilities

Database Backup This section explains on how to back up your resources and databases of Report Server.

Note: This utility cannot be worked outside of the native folder.

We have shipped a utility with the Syncfusion Report Server application and it can be found in the below location.

{Installed_location}\Syncfusion\Report Server\Utilities\ReportServerBackup



This utility can take both the resources and database backups for the below types of Databases.

1. SQL CE 2. SQL Server

This utility can take only the resources backup for the below types of Databases.

1. MySQL 2. Oracle 3. PostgreSQL

Embedded SQL CE (For Testing purposes only)

Backup utility layout for Embedded SQL CE database.



On clicking the Backup Resources and Database button, backup is created and success message is displayed.

Created backup is stored as zip file in Installation Folder.

Created zip files' contents are as like below,



SQL Server

Backup utility layout for SQL Server database.

On clicking the Backup Resources and Database button, backup is created and success message is displayed.

Backup of resources is stored as zip file in Installation Folder.




Backup of database is stored as bak file in C:\Program Files\Microsoft SQL Server\MSSQL11.MSSQLSERVER2012\MSSQL\Backup

MySQL

Backup utility layout for MySQL database.



On clicking the Backup Resources button, backup is created and success message is displayed.





Database backup can be taken by following the procedure given in the mentioned link in utility.

Oracle

Backup utility layout for Oracle database.




PostgreSQL

Backup utility layout for PostgreSQL database.




Report Server FAQ



Help Link UG Documentation help link is provided at the title bar of the utility for all the database types.

FAQ The frequently asked questions in Report Server

What all are the files and folders will be generated in the installed machine?

Resources Reports, Data Sources, Data Sets, Files that are added in the Report Server are maintained here.

Scheduler Service Exported reports that are to be emailed and schedule configuration are maintained here.

Content This folder holds profile pictures and application images.

Logs We log errors and debug information from the Report Server application for troubleshooting.

SQLCE Database If you are choosing SQLCE database as the underlying database for the Report Server, a .SDF database file will be created and maintained here.

Report Server FAQ


report platform - olem shoeolemportal.olemshoe.com/install/reportdesigner.pdf · 2017-04-18 ·...

Documents