Installation and Deployment

This section explains on how to install and deploy the Syncfusion Dashboard Server.

Download Setup

• You can download the Dashboard 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 Dashboard Server.

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

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

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 Use Unlock Key option.

You can check the License Agreement of Dashboard 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 dashboard server has to be hosted.

We have provided the Dashboard 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 Site Name to host the Dashboard Server into the IIS.

PhantomJs

IMPORTANT

PhantomJS is a headless WebKit scriptable with JavaScript. This is a free software/open source, and it may contain MIT, BSD, LGPL, or GPL, or other similar licenses that contain third-party code. This executable file is necessary to achieve Image and PDF export functionalities in the Dashboard and widgets. Without this file, the image and PDF export options in the Dashboard and widgets will no longer be available. If you choose to download PhantomJS, must accept all terms and conditions to use it with Syncfusion’s products.

NOTE

If you have any problem with internet connection or do not have internet connection, unselect the PhantomJS download option and continue to install. To manually install the PhantomJS, please refer this.

Read and accept the license and third-party terms and conditions through checking the option LICENSE and Third-party for install PhantomJS and click INSTALL.

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

• Dashboard Server web application
• Scheduling Service

Once the installation completes you can start the dashboard server by checking the “Start Dashboard Server” in the last screen and click on finish.

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

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

NOTE

Dashboard Server does not support multiple versions installed on the same machine.

NOTE

Dashboard Server cannot be downgraded to the previous version.

Silent Installation

1.Double click the Syncfusion Dashboard Server setup.

2.Syncfusion Dashboard Server setup will be extracted in Temp location (%temp%).

3.Copy the extracted Dashboard Server setup to some other location and cancel the installation.

4.Open the command prompt with administrative privileges and run the extracted Dashboard Server setup with the following arguments.

Arguments:
IIS Express
/Install silent /InstallPath:{InstallationPath} /pidkey:{unlock_key} /portno:{port_no} /servertype:{server_type} /Log “{LogFilePath\filename.log}”

Example:
/Install silent /InstallPath:C:\Program Files (x86)\New\Dashboard Server /pidkey:@1243453sdffdfvv /portno:54321 /servertype:IISExpress /Log “C:\Program Files (x86)\New\Install.log”

IIS
/Install silent /InstallPath:{InstallationPath} /pidkey:{unlock_key} /portno:{port_no} /sitename:{site_name} /servertype:{server_type} /Log “{LogFilePath\filename.log}”

Example:
/Install silent /InstallPath:C:\Program Files (x86)\New\Dashboard Server /pidkey:@1243453sdffdfvv /portno:54321 /sitename:SyncfusionDashboardServer /servertype:IIS /Log “C:\Program Files (x86)\New\Install.log”

Now, Syncfusion Dashboard Server will be installed in silent mode.

Consent to deploy PhantomJS WebKit

PhantomJS is a headless WebKit scriptable with JavaScript. It is a free software/open source that may contain MIT, BSD, LGPL or GPL, or other similar licenses It contains third-party code. This executable file is necessary to achieve Image and PDF export functionalities in dashboard, widgets and schedules. Without this, the Image and PDF export options in dashboard, widgets and schedules no longer available. It is your decision if you choose to download Phantom JS, but you must accept all of their terms and conditions if you want to use it with Syncfusion’s products.

To download PhantomJS application and deploy it on your machine, you should accept it’s license terms on LICENSE and Third-Party document. Then, you can download PhantomJS by clicking here.

Once download completed, extract the zip file and then copy the PhantomJS application from the zip extracted location and paste it in the below mentioned install locations.

Install Locations:

1. {InstallPath}\Dashboard Server\DashboardServer.Web\DashboardService

2. {DeploymentPath}\Dashboard Server\DashboardServer.Web\DashboardService

Examples:

1. C:\Program Files (x86)\Syncfusion\Dashboard Server\DashboardServer.Web\DashboardService

2. C:\Syncfusion\Dashboard Server\DashboardServer.Web\DashboardService

Deployment

• Dashboard Server web application opens in your default browser with the specified port number at http://localhost:[port_number]/

We have shipped two utilities with the Dashboard Server to host the application in IIS and in IIS Express.

Host as website in IIS Express

1. Run the program ConfigureDashboardServerIISExpress.exe from the following installed location to host the dashboard server in IIS Express.

   {Installed_ Location}\Syncfusion\Dashboard Server\Utilities\DashboardServerIISExpress\ConfigureDashboardServerIISExpress.exe

   

   Note: By default, it will show a random port number. An unused port can also be chosen to host in that port.

2. Click Submit and this program will host the application in IIS Express and Dashboard Server application will be launched in browser.

Host as website in IIS

Dashboard Server can also be hosted in IIS by following the below steps.

1. Run the program ConfigureDashboardServerIIS.exe from the following installed location to host the dashboard server in IIS

   {Installed_Location}\Syncfusion\Dashboard Server\Utilities\DashboardServerIIS\ConfigureDashboardServerIIS.exe

   

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

   

Host as Application in IIS

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

Add Dashboard Server as application

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

And Fill the following details as below figure

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

Convert the sub folders as application

We have the following folders to be converted as application.

1. API
2. WindowsAuthentication
3. DashboardService

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

SSL

To enable SSL for the Dashboard 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 Dashboard Server from a different machine to the one it’s installed on, use the URL http://machine_name:[port_number] or http://machine_ip_address:[port_number]

SSL for Dashboard Service

It is must to enable the SSL for the Dashboard Service if you have configured the SSL for Dashboard Server Application.

To configure SSL for Dashboard Service, run Syncfusion Dashboard Service Configuration Manager application.

Dashboard Server is deployed in the below location by default.

{Windows_Drive}\Syncfusion\Dashboard Server\DashboardServer.Web\

For example, C:\Syncfusion\Dashboard Server\DashboardServer.Web\

We have shipped a utility with the Syncfusion Dashboard Server application in the below location by default.

{Windows_Drive}\Syncfusion\Dashboard Server\DashboardServer.Web\DashboardService

Choose the type of configuration required and click on Save button.

NOTE

SyncfusionDashboardServiceConfigurationManager.exe execution requires administrator mode.

Upgrading Syncfusion Dashboard Server

Syncfusion releases several major versions in a year. Each version includes new features, bug fixes and other improvements.

Syncfusion Dashboard Server can be upgraded to latest version at any time manually, and there are no automatic updates for Syncfusion Dashboard Server. Before upgrading, you can refer the features and enhancements from the Release Notes.

Upgrading Guidelines

Syncfusion recommends you to follow below guidelines while upgrading the Dashboard Server from an older version to latest version.

• Save all the open settings and the unsaved items.
• Ensure no one is currently working with dashboards.
• Inform about the maintenance time to the users.
• For SQL, MySQL, Oracle and Postgre SQL databases, make sure you have a valid network connection to the database while upgrading to the new version.
• Download the latest Syncfusion Dashboard Server from here.
• Follow the installation steps from the above section Installation.

The upgrade process will retain all the resources and settings from the previous installation.

Dashboard Server updates the database schema of your current version to the new version.

Please ensure the below steps if the dashboards are not rendered properly.

1. Ensure that the Site URL is updated properly as the hosted Syncfusion Dashboard Server URL.

   

2. If you have enabled SSL for Dashboard Server in IIS, it is must be enabled in Dashboard service also, Please follow the steps in the below link to enable the SSL in Dashboard service

https://help.syncfusion.com/dashboard-platform/dashboard-sdk/installation-and-deployment#configuring-ssl-for-dashboard-service