KPI Generator

KPI Generator

Getting started

The new KPI Generator collects information from Virtuoso and the SQL Database by connecting to our databases. The program then writes, saves and uploads JSON reporting files to a specific GitLab project in a specific structure.

GitLab structure:

• 🦊 {Reporting Project}
  • 📂 General
    • 🗒️ users.json (File containing User related KPIs extracted from Coscine #2182)
    • 🗒️ projects.json (File containing Project related KPIs extracted from Coscine #2184)
    • 🗒️ resources.json (File containing Resource related KPIs extracted from Coscine #2183)
    • 🗒️ application_profiles.json (File containing Application Profile related KPIs extracted from Coscine #2185)
    • 🗒️ system_status.json (File containing System Status related KPIs extracted from Coscine #2186)
  • 📂 Organizations
    • 📂 {Organization ROR ID} (Folder per organization)
      • 🗒️ users.json (File containing User related KPIs extracted from Coscine #2182)
      • 🗒️ projects.json (File containing Project related KPIs extracted from Coscine #2184)
      • 🗒️ resources.json (File containing Resource related KPIs extracted from Coscine #2183)
    • 📁 ...
      • 🗒️ ...
  • 🗒️ README.md

Generating reporting files

• Executing in dummy mode

  .\Coscine.KpiGenerator.exe <VERB> --dummy

• Complete Reporting (all)

  .\Coscine.KpiGenerator.exe all

• Only Project Reporting

  .\Coscine.KpiGenerator.exe projects

• Only Resource Reporting

  .\Coscine.KpiGenerator.exe resources

• Only User Reporting

  .\Coscine.KpiGenerator.exe users

• Only Application Profile Reporting

  .\Coscine.KpiGenerator.exe applprofiles

• Only System Status Reporting

  .\Coscine.KpiGenerator.exe system

Integrate to Coscine's infrastructure as a CRON Job

Running the Integrator Script will add the script as a CRON Job, that will automatically trigger at 03:00 am every day.