Installation

This section discusses about the installation/uninstallation, upgrading, service hosting procedures of Syncfusion Dashboard Designer.

Downloading Dashboard Designer

Download the Syncfusion Dashboard Designer from here.Licensed customers can also download the install from the downloads section. You may download either as EXE file or as ZIP file and extract the EXE.

Download Dashboard

Save it to your preferred location in your machine.

Save Dashboard

Installing Dashboard Designer

To learn about the system requirements needed to install the Syncfusion Dashboard Designer 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.

Exctraction image

License agreement

Read and accept the license terms and conditions through checking the option I accept the terms and conditions and click NEXT.

Path Selection Wizard

Browse to the location where you want to install the Dashboard Designer application, and then click Next.

Perform the additional tasks 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 and ` click NEXT.

Additional Setting Wizard

Read and accept the Consent the install CefSharp binaries and Dependencies and click NEXT.

IMPORTANT

cefSharp is a lightweight .NET wrapper around the Chromium Embedded Framework (CEF) used for WPF and WinForms web browser control implementations. CefSharp is BSD licensed, so it can be used in both proprietary and free/open source applications. However, additional non-BSD dependencies may be needed. CefSharp binaries and their dependencies are mandatory to render dashboard widgets in the designer surface.

CefSharp Wizard

Read and accept the Consent to deploy PhantomJS Webkit and click Install.

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

Installation Wizard

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

Finish Wizard

On successful installation, the above screen appears. Click Finish to close the installation wizard and run the newly installed Dashboard Designer. You may also run the application later through unchecking the option Run Dashboard Designer.

Silent Installation

1.Double click the Syncfusion Dashboard Designer setup.

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

Silent Setup Location

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

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

Arguments:

Dashboard Designer V3.1:

/Install silent /InstallPath:{InstallationPath} /Log “{LogFilePath\LogFile.log}”

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

Silent Installation v3.1

Dashboard Designer V3.2:

/Install silent /InstallPath:{InstallationPath} /isdesktopshortcut:{TRUE or FALSE} /isstartmenushortcut:{TRUE or FALSE} /Log “{LogFilePath\LogFile.log}”

Example:
/Install silent /InstallPath:C:\New\Dashboard Designer /isdesktopshortcut:TRUE /isstartmenushortcut:FALSE /Log “C:\temp\Install.log”

Silent Installation v3.2

Now, Syncfusion Dashboard Designer 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 Location:

%ProgramData%\Syncfusion\DashboardDesigner{Version}\IISExpress_DashboardService

Example:

C:\ProgramData\Syncfusion\DashboardDesigner\3.2.0.68\IISExpress_DashboardService

Hosting Dashboard Service in IIS Express

Dashboard Service is a web service through which data requests will be processed by Dashboard Designer application. This service will get hosted in IIS Express and run automatically on previewing a dashboard through Dashboard Designer.

Dashboard Service

Two sites, one representing the dashboard service and the other representing the dashboard preview will be running in IIS Express on clicking the Preview in the Dashboard Designer application. On closing the Dashboard Designer application, these started sites will get stopped automatically.

Upgrading Dashboard Designer

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

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

Upgrading Guidelines

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

  • You can always download the latest Syncfusion Dashboard Designer from here and follow the installation steps from the above section Installing Dashboard Designer.

IMPORTANT

The latest versions of the Dashboard designer are backward compatible. You can refer the KB article for more details on Syncfusion Dashboard Designer application version compatibility.

Uninstalling Dashboard Designer

You can uninstall the dashboard designer application, if required, through uninstalling the Syncfusion Dashboard Designer entry from Control Panel.

Dashboard Uninstall

Troubleshooting the Dashboard Designer installation errors

If you find any difficulties while installing the Dashboard Designer application in your machine, follow the given steps:

  1. Ensure whether your machine meets the minimum system requirements for installing the Dashboard Designer application.

  2. Check whether any other software installation or anti-virus blocks the Dashboard Designer application installation.

  3. Check whether you have enough permission to install applications in the machine.

  4. Collect the log files by following the steps mentioned in the KB article.

  5. Please contact us by creating a support ticket and attach the log files mentioned in the step 4 with your basic machine information.