Installation and Deployment of Syncfusion Dashboard Server version 3.2

This section explains on how to install and deploy the Syncfusion Dashboard Server version 3.2 along with the User Management Server.

Download Setup

• You can download the latest 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 version 3.2 along with User Management Server.

To learn about the system requirements needed to deploy the Dashboard Server and User Management 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 and User Management Server has to be hosted.

We have provided the Dashboard Server and User Management Server to be hosted into the following two web server types

1. IIS Express
2. IIS

IIS Express

Install User Management Server option will install the User Management Server in mentioned port number.

Connect to User Management Server on a different machine option will able to connect Dashboard Server to the latest User Management on another machine. You can find how to connect to User Management Server here.

After you select the installation server type, click on Next.

NOTE

Latest User Management Server is mandatory to run Syncfusion Dashboard Server version 3.2

IIS

Need to provide the Port number, Location and Site Name to host the Dashboard Server and User Management Server into the IIS.

Install User Management Server option will host the User Management Server in mentioned port number.

Connect to User Management Server on a different machine option will able to connect Dashboard Server to the latest User Management on another machine. You can find how to connect to User Management Server here.

After you select the installation server type, click on Next.

NOTE

Latest User Management Server is mandatory to run Dashboard Server version 3.2

Additional Settings

Perform the additional tasks like desktop shortcuts creation and start menu shortcut creations. If you want to perform the additional tasks, you can check the options. Otherwise, you can uncheck.

Allow firewall for selected ports

This option will allow selected ports of Dashboard Server and User Management Server in firewall to make it accessible outside of the installed machine.

Click Next to proceed further.

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} /isstartmenushortcut:{TRUE or FALSE} /issetfirewallrule:{True or False} /Log “{LogFilePath\filename.log}”

Example:
/Install silent /InstallPath:C:\Program Files (x86)\New\Dashboard Server /pidkey:@1243453sdffdfvv /portno:54321 /servertype:IISExpress /isdesktopshortcut:TRUE /isstartmenushortcut:TRUE /issetfirewallrule:True /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} /isdesktopshortcut:{TRUE or FALSE} /isstartmenushortcut:{TRUE or FALSE} /issetfirewallrule:{True or False} /Log “{LogFilePath\filename.log}”

Example:
/Install silent /InstallPath:C:\Program Files (x86)\New\Dashboard Server /pidkey:@1243453sdffdfvv /portno:54321 /sitename:SyncfusionDashboardServer /servertype:IIS /isdesktopshortcut:TRUE /isstartmenushortcut:TRUE /issetfirewallrule:True /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\API

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

Examples:

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

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

Deployment

• Dashboard Server web application opens in your default browser with the specified port number given during at the time of installation at http://localhost:[dashboard_server_port_number]/

• User Management Server web application opens in your default browser with the specified port number given during at the time of installation at http://localhost:[user_management_server_port_number]/

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

Host Dashboard Server 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 User Management Server as website in IIS Express

1. Run the program ConfigureUserManagementServerIISExpress.exe from the following installed location to host the user management server in IIS Express.

   {Installed_ Location}\Syncfusion\UMS\Utilities\UserManagementServerIISExpress\ConfigureUserManagementServerIISExpress.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 User Management Server application will be launched in browser.

Host Dashboard Server 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 User Management Server as website in IIS

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

1. Run the program ConfigureUserManagementServerIIS.exe from the following installed location to host the user management server in IIS

   {Installed_ Location}\Syncfusion\UMS\Utilities\UserManagementServerIIS\ConfigureUserManagementServerIIS.exe

   

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

   

Host Dashboard Server 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. WebDesignerService

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

SSL for Dashboard Server

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:[dashboard_server_port_number] or http://machine_ip_address:[dashboard_server_port_number]

Host User Management Server as Application in IIS

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

Add User Management 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

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

SSL for User Management Server

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