Installation and Deployment

This section briefly illustrates the installation and deployment procedure of Syncfusion Dashboard Platform SDK.

Installing Dashboard Platform SDK

To learn about the system requirements needed to install the Syncfusion Dashboard Platform SDK in your machine, see System Requirements section.

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

Extraction Image

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

Installation with Email

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.

installation with product key

Installation Step 1

You can check the License Agreement of Dashboard Platform SDK by clicking on the License Terms and Conditions.

Path Selection Wizard

Browse to the location where you would like to install the Dashboard Platform SDK application and click NEXT.

Perform the additional task desktop shortcuts creation. If you want to perform the additional tasks, you can check the option. Otherwise, you can uncheck it and click NEXT.

Additional Setting Wizard

CefSharp Wizard

Read and accept the license terms through checking the option LICENSE for download and install CefSharp and click NEXT.

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.

PhantomJS Wizard

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.

Installation Wizard

Now the installation begins. You can cancel the installation anytime through pressing CANCEL, if you prefer.

Finish Wizard

On successful installation, the above screen appears. Click Finish to close the installation wizard and check any one radio button for run Sample Browser or Explore Samples.

Silent Installation

1.Double click the Syncfusion Dashboard Platform SDK setup.

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

Silent setup location

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

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

Arguments:

Dashboard Platform SDK V3.1:

/Install silent /InstallPath:{InstallationPath} /pidkey:{unlock_key} /Log “{LogFilePath\filename.log}”

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

Silent Installation v3.1

Dashboard Platform SDK V3.2:

/Install silent /InstallPath:{InstallationPath} /pidkey:{unlock_key} /isdesktopshortcut:TRUE /Log “{LogFilePath\filename.log}”

Example:
/Install silent /InstallPath:C:\Program Files (x86)\New\DashboardPlatformSDK /pidkey:@1243453sdffdfvv /isdesktopshortcut:TRUE /Log “C:\Program Files (x86)\New\Install.log”

Silent Installation v3.2

Now, Syncfusion Dashboard Platform SDK will be installed in silent mode.

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 Platform SDK\Utilities\Windows Service

  2. %localappdata%\Syncfusion\Dashboard\Samples\Common\Service

Examples:

  1. C:\Program Files (x86)\Syncfusion\Dashboard Platform SDK\Utilities\Windows Service

  2. C:\Users\John\AppData\Local\Syncfusion\Dashboard\Samples\Common\Service

Samples deployment

By installing the Syncfusion Dashboard Platform SDK, the samples are installed in the following location.

%localappdata%\Syncfusion\Dashboard Platform SDK\Getting Started Samples

The scripts, styles, and fonts that are required to run the dashboard application will be placed in the following location.

%localappdata%\Syncfusion\Dashboard Platform SDK\Getting Started Samples\Common\Html

This folder contains samples of different platforms such as ASP.NET, ASP.NET Core, ASP.NET MVC, Angular 1, Angular 2, TypeScript, Aurelia, LightSwitch HTML, PHP, UWP, Windows Forms, and WPF.

NOTE

Internet connection is required to run sample dashboards as their data need to be retrieved from a remote data server.

Service installation

With the installation of Syncfusion Dashboard Platform SDK, a windows service called Syncfusion Dashboard Windows Service is installed and started automatically to run as a background process. This service is essential for the Dashboard Viewer to render the dashboard. You can also stop and restart the service through the Task Manager, if required.

Hosting dashboard service as Windows service background process

To install Dashboard Service as windows service, copy the folder Windows Service with its contents from the following location, and paste in a desired location and run the Syncfusion Dashboard Service Installer.exe.

C:\Program Files (x86)\Syncfusion\Dashboard Platform SDK\Utilities

NOTE

  1. Running Syncfusion Dashboard Service Installer.exe requires administrator access for the current user.
  2. Dashboard service can be accessible only at local machine as this service is running as a Windows service background.
  3. Dashboard Service as windows service is not recommended for the production environment. Refer here to learn about how to host the Dashboard Service in IIS.

Service not Installed

Running Service

You can stop/restart/uninstall the service through this EXE when you deal with any error related to service as follows.

Service not running

Hosting dashboard service in IIS express

To host Syncfusion dashboard service in IIS express and run on deployment machines, copy the folders DashboardServiceInstaller and Service along with their contents from the following location, and paste in a desired location in the deployment machine and run the SyncfusionDashboardServiceInstaller-IISExpress.exe available in the DashboardServiceInstaller folder.

%localappdata%\Syncfusion\Dashboard Platform SDK\Getting Started Samples\Common

Hosting dashboard service in IIS

To host Syncfusion Dashboard Service in IIS and run on deployment machines, copy over the folders DashboardServiceInstaller and Service along with their contents from the following location, and paste in a desired location in the deployment machine and run the SyncfusionDashboardServiceInstaller-IIS.exe available in the DashboardServiceInstaller folder.

%localappdata%\Syncfusion\Dashboard Platform SDK\Getting Started Samples\Common

SyncfusionDashboardServiceInstaller-IIS.exe can be executed using command prompt to host the service in the specified port after copying the required file.

Command

C:\Windows\system32>[Path of SyncfusionDashboardServiceInstaller-IIS.exe] [Portnumber]

Example:

C:\Windows\system32> C:\Users\administrator\AppData\Local\Syncfusion\Dashboard Platform SDK\DashboardServiceInstaller\SyncfusionDashboardServiceInstaller-IIS.exe 400

NOTE

  1. SyncfusionDashboardServiceInstaller-IIS.exe execution requires administrator mode.
  2. Hosting dashboard service at IIS is recommended for the production environment for object management and other memory management features.Refer here to learn about how to host the Dashboard Service in IIS manually.

Configuring SSL for Dashboard Service

To configure SSL for Dashboard Service, run the Syncfusion Dashboard Service Configuration Manager application from the following location.

%localappdata%\Syncfusion\Dashboard Platform SDK\Service

Dashboard Service Configuration

Choose the required type of configuration and click Save.

SSL Configuration

NOTE

SyncfusionDashboardServiceConfigurationManager.exe execution requires administrator mode.

Restart the service in IIS Installer after configuring the SSL. The previous steps are not applicable for Window service.

Configuring Syncfusion Dashboard Viewer JavaScript Bower Packages

Overview

Bower is a package manager for the web. Syncfusion Dashboard JavaScript Components allows you to use the Syncfusion Dashboard Viewer Control in an efficient way.

IMPORTANT

Syncfusion Dashboard JavaScript Components bower package is available as public Git Repository and also registered as Syncfusion-Dashboard-Javascript in the Bower registry.

Bower Installation

To configure the Bower in your machine, install node, npm and git. For more information to configure the Bower package please refer the official site for bower.

Syncfusion Dashboard JavaScript Components Bower package can be configured in the following ways.

  1. Using command prompt

  2. Using bower.json file

  3. From local directory

Using command prompt

Perform the following steps to install Syncfusion Dashboard JavaScript Components using command prompt in your web application:

  1. Open your web project’s location in a command prompt window.

  2. Run the command Bower install .

  • html
  • bower install syncfusion-dashboard-javascript

    Using bower.json file

    You can add the packages to the bower.json file by specifying the package name. This will install/restore the packages to your project. Refer to the following image.

    json file

    NOTE

    ASP.NET 5 (preview) projects have bower.json file by default. If your project does not have bower.json file, run the following command from your project directory by Command prompt.
    ‘bower init’

    bower.json file

    From local directory

    To refer the Syncfusion Dashboard JavaScript Components from local directory, follow the given steps below:

    1. Navigate to the Syncfusion Dashboard JavaScript Components repository on GitHub and download the repository as zip by clicking the “Download ZIP” button and extract the contents in your computer’s local directory.

      GitHub repository

    2. Run the install command by providing the package content’s location.

      Commands

    Bower Update

    To update the installed Bower packages, run the command Bower update .

  • html
  • bower update syncfusion-dashboard-javascript