Skip to main content
Version: 2.0.0

Install / Deploy

Install Package​

npm install @cw/cherrywork-analytics
import Dashboard from "@cw/cherrywork-analytics/Dashboard";

Named Import​

import { Dashboard } from "@cw/cherrywork-analytics";

Deployment Prerequisites:​

  • Config Server: Must be fully operational with a reachable public/internal URL.
  • Backing Services: You must have instances of a XSUAA and the Destination Service created and available for binding.
  • For the multi instance Db Credentials are fetched from the config server and for the single instance it is from binded database schema

Deployment Configuration (Manifest):​

 applications: 
  - name: cherrywork-btp-dev-dashboard 
    memory: 1024M 
    random-route: false 
    docker: 
      image: wblnd.azurecr.io/cherrywork-dashboard:v6.0.0 
      username: wblnd 
    env: 
      application_properties: "https://cherryworkproducts-config-server.cfapps.eu10-004.hana.ondemand.com/application/default/main/dashboard-new/application_properties.json"

Once the service is deployed, you must maintain and update the following properties within your Config Server These properties allow dashboard handle DB/API based graphs and Kpis.

application_properties.jsonAuthentication,Configuration link of dashboard instances
crud-objects-sample.ymlDashboard crud queries
dashboard_applications.jsonDashboard DB/API Configs

dashboard_applications.json​

{ 
  "scp_dev": { 
    "dashboard_config": "{BASE_URL}/application/default/main/dashboard-new/SCP/dashboard_dev_configs.json", 
    "map_config": "{BASE_URL}/application/default/main/dashboard-new/SCP/dashboard_dev_table_map_configs.json", 
    "scheduler_id": "DASHBOARD_SCP", 
    "crudapi_url": "{BASE_URL}/application/default/main/dashboard-new/crud-objects-sample.yml", 
    "dashboardapis_yaml": "{BASE_URL}/application/default/main/worknet-dev-btp/composite/SCPDashboardApis.yaml" 
  }, 
  "apa_dev": { 
    "dashboard_config": "{BASE_URL}/application/default/main/dashboard-new/APA-DEV/dashboard_dev_configs.json", 
    "map_config": "{BASE_URL}/application/default/main/dashboard-new/APA-DEV/dashboard_dev_table_map_configs.json", 
    "scheduler_id": "DASHBOARD_APA", 
    "crudapi_url": "{BASE_URL}/application/default/main/dashboard-new/crud-objects-sample.yml", 
    "dashboardapis_yaml": "{BASE_URL}/application/default/main/worknet-dev-btp/composite/APADashboardApis.yaml" 
  } 
}