Skip to content

Ricoh Advance Dashboard - Documentation Hub

Welcome to the central documentation hub for the Ricoh Advance Dashboard project. This site consolidates comprehensive information for all components involved, including backend services, the frontend administration panel, and the Grafana visualization dashboards.

Project Overview

The Ricoh Advance Dashboard project provides an integrated solution for monitoring, managing, and visualizing data from modern audiovisual environments. It primarily focuses on aggregating status, health, and alert information from Neat devices and Microsoft Teams Rooms (accessed via the Microsoft Graph API).

The system is composed of several key components working together:

  • Backend Services: A suite of REST APIs handling core functionalities:
    • Auth Middleware: Manages user authentication, roles, and service registration.
    • Alarms Service: Handles the creation, management, and lifecycle of alarms and watchers.
    • GraphAPI Service: Interfaces with the Microsoft Graph API to fetch data for Teams Rooms.
    • Neat Service: Interfaces directly with Neat devices to retrieve status and information.
  • Frontend Admin Panel: A web application (built with Vue.js) allowing administrators to configure alert parameters, conditions, device metadata (regions, locations, rooms), and manage active alerts.
  • Grafana Dashboards: Customized dashboards providing near real-time visualization of device status, key metrics, room availability, and triggered alerts sourced from the backend services.

High-Level Architecture

The following diagram illustrates the interaction between the main components:

Ricoh Advance Dashboard Architecture

Component Documentation

This hub provides detailed documentation for each component:

Backend Services

  • Auth Middleware Service: Handles user authentication, role-based access control (RBAC), and service registration within the project's microservices architecture. Built securely using Node.js and Express.
  • Alarms Service: A REST API dedicated to managing alarms and watchers. It supports CRUD operations, interval/filter configuration, database management, and incorporates security features like API key authentication and rate limiting.
  • GraphAPI Service: Provides a REST API to interact with the Microsoft Graph API, focusing on retrieving device information, call records, and health status for Microsoft Teams Rooms.
  • Neat Devices Service: Offers a REST API specifically for managing and monitoring Neat audiovisual devices, including device details, health status, and interval configuration.

Frontend

  • Frontend Admin Panel: A Vue.js application for configuring alert parameters, devices (regions, locations, rooms for GraphApi), and conditions for both GraphApi and Neat services. Users can also view and resolve active alerts directly within this panel.

Visualization

  • Grafana Dashboards: Documentation for the customized Grafana dashboards. These dashboards visualize data fetched by the backend services, offering near real-time monitoring, tailored views (Neat-specific, GraphAPI-specific, combined), and responsive design for various devices.

Use the navigation menu on the left to dive into the detailed documentation for each specific component. You will find installation guides, user manuals, API references, administration details, development guides, and FAQs for each part of the Ricoh Advance Dashboard project.

Explore the sections relevant to your needs to effectively use, manage, or contribute to the project.