Dashboard Configuration Tool

After completing this document, you should be able to run the Dashboard Configuration tool.  You will have an understanding of the different tasks that can be completed from the tool and how to review existing dashboard configurations.  

1. Log in to the computer with a user that has administrator privileges

2. Run the configuration tool

 Click the Shortcut Dashboard Config 10.5 on the Desktop, so the EvIT Dashboard Manager opens.  

3. Dashboard SetUp

OrientDB Auto Backup Setting 

Click on the Auto Backup Setting Button.  

The OrientDB Back Up configuration file is opened with NotePad. 

 Backup Configuration Options

• delay: Defines the delay time for each backup. Supports the following suffixes:  
  
• h: Delay measured in hours. 
  
• d: Delay measured in days.
  
• enabled: Defines whether it uses automatic backups 
  
• true: Enables automatic backups 
  
• false: Disables automatic backups 
  
• firstTime: first time defines when to initiate the first backup in the schedule.  
  • It uses the format of HH:mm:ss 
    
• targetDirectory: The backup folder, by default it is %EVOLVEIT_DATA%\databasebackup folder 
  

NOTE:  

• This file must be valid JSON file format; you cannot close the notepad if you break the syntax of this file. 
  
• If this file format is broken, OrientDB cannot start properly. 
  
• If you edit this file setting and your OrientDB service is already running, Restart-Service is required to make this in effect. 
  

 Set Up Dashboard with one click 

• Simply click “SetUp EvolveIT Dashboard” button, it will take care of all required set up, and you get CM evolveIT Dashboard open in your browser.  
  
• This process may take several minutes when your system has not enabled IIS. 
  
• The takes completed by this process include 
  • Enable IIS 
    
  • Install JRE 
    
  • Install OrientDB Service and start 
    
  • Save necessary Configuration files 
    
  • Start Dashboard 
    
• When the dashboard is set up,  a popup window will display with the validation results.   
  
• Close the popup, and the dashboard login screen will open.  
  
• Log in with Built-in user administrator with password admin@1234! 
  

Open Environment Variable 

• Click on the Open System Environment Variable button.  
  
• The Computer Environment Variables screen will display.   

4. OrientDB management

Install OrientDB Service 

• The OrientDB Service will be installed when setting up the dashboard with one click. 
  
• If the service has been uninstalled, it can be reinstalled by clicking on the Install OrientDB Service button.  
  

Uninstall OrientDB Service 

• The OrientDB Service can be uninstalled by selecting the Uninstall OrientDB Service button.   
  
• Before uninstalling the OrientDB Service, the Service must first be stopped in the Service UI.   
  

Open Service UI 

• Click on the Open Service UI  button in the Dashboard Component Section of the dashboard manager.   
  
• You can start/stop the service from this UI.  
  
• It takes several minutes for the service to stop, be patient.  
  

5. Process Manager Management

Install Process Manager 

• The Process Manager will be installed when setting up the dashboard with one click. 
  
• If the service has been uninstalled, it can be reinstalled by clicking on the Install Process Manager button.  
  

Uninstall Process Manager 

• The Process Manager can be uninstalled by selecting the Uninstall Process Manager button.   
  
• Before uninstalling the Process Manager, the Service must first be stopped in the Service UI.   
  

Start/Stop Service UI 

• Click on the Start/Stop Process Manager Service  button in the Dashboard Component Section of the dashboard manager.   
  
• You can start/stop the service from this UI.  
  
• It takes several minutes for the service to stop, be patient. 

6. Elastic Search Service Management

Install Elastic Search Service 

• The Elastic Search Service will be installed when setting up the dashboard with one click. 
  
• If the service has been uninstalled, it can be reinstalled by clicking on the Install Elastic Search Service button.  
  

Uninstall Elastic Search Service 

• The Elastic Search Service can be uninstalled by selecting the Uninstall Elastic Search Service button.  

Open Service UI 

• Click on the Open Elastic Search Service UI  button in the Dashboard Component Section of the dashboard manager.   
  
• You can start/stop the service from this UI.  
  
• It takes several minutes for the service to stop, be patient. 
  

7. Dashboard Websites Management

 CM evolveIT requires two websites to function correctly.  

• Dashboard UI 
  
• WebAPI  
  

Websites 

• The Websites section is used to Create, Remove and Update the two websites.   
  
• Create Dashboard Websites. 
  • Creates the dashboard website.
    
  • Sets up the WebAPI website.
    
• Remove Dashboard Websites.
  • Removes the dashboard website.
    
• Update Dashboard Websites 
  • Updates the dashboard UI website.  
    

IIS  

• The IIS section of the Dashboard Manager allows you to start, stop and restart the websites.   
  
• Open IIS UI 
  • Opens the IIS Manager in Windows.  
    
• The deployed websites can be seen in IIS 
  
• View application pools in IIS 
  

Start Websites 

• Click on Start Websites starts websites in IIS but does not open it in the browser.   
  
• There will be a message Dashboard Websites are Started. 
  

Stop Websites 

• Click on Stop Websites to stop the Dashboard websites in IIS. 
  
• There is not a message when the Websites are stopped.   
  

Restart Websites 

• Click on Restart Websites to restart a the websites when they are running.   
  
• There will be a message Dashboard Websites are Restarted.  
  

View in IIS UI that websites are successfully deployed

Application Pools 

8. Manage Data Folder

Open Data folder 

• This opens the dashboard data folder.   
  
• The default folder is: C:\Users\Public\Documents\CMFirst\evolveIT\evolveIT_data 

Open Logging Folder

• This button opens the Dashboard log folder.  
  
• The default location is: C:\Users\Public\Documents\CMFirst\evolveIT\evolveIT_data\Logs 
  

Open WebData Folder

• This button opens the Dashboard WebData folder.  
  
• The default location is: C:\CMFirst\evolveIT-{$version}\WebData
  

9. Run

• Run the deployed CM evolveIT Dashboard  
  

WEBAPI (Browser) 

• Run the WebAPI webpage 
  

10. Trouble shooting

Stopping OrientDB service takes long time 

• It is normal. Please wait  
  

Dashboard opens but cannot login 

• OrientDB Service Startup type says “Manual” 
  
• Database startup parameter is invalid.
  
• Please contact CM First support with an image of this screen and the full-text copy of “Java Options:” 
  

OrientDB Service UI Startup type says “Disabled” 

• Restart your System is required 
  

OrientDB Service UI, both Start and Stop buttons are disabled 

• Uninstall OrientDB Service and restart your System