Elecard Boro Solution - User Guide

{
  "last_commit": {
    "date": "2024-11-06 05:41:54 UTC",
    "hash": "a2bac77",
    "describe": "2.2.1-9-ga2bac77"
  },
  "build": {
    "date": "2024-11-06T05:42:07Z",
    "clean repo": true,
    "sphinx version": "sphinx-build 4.5.0",
    "machine": "runner-5ga9frafr-project-40-concurrent-0"
  },
  "note": ""
}

Notices

Elecard Boro Solution - Software solution for UDP, RTP, HTTP streams and OTT services quality control. User guide.

First edition: 01/12/2015.

Date modified: 06/11/2024.

More information can be found at elecard.com.

For Technical Support, please contact the Elecard Technical Support Team: tsup@elecard.com.

Elecard provides this publication “as is” without warranty of any kind, either expressed or implied.

Whilst we make every attempt to ensure the accuracy and reliability of the information contained in the document, it may still contain technical inaccuracies or typographical errors. We would appreciate any feedback about inaccuracies or errors you may find when examining the documentation. While every precaution has been taken in the preparation of this document, the publisher and author assume no responsibility for errors or omissions. Nor is any liability assumed for damages resulting from the use of the information contained herein. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. Elecard may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time.

Other company, product, trademarks, and service names are trademarks or service marks of other companies or corporations.

Copyright © 2000-2024 Elecard. All rights reserved.

Attention

Boro Solution User Guide is an addition to Boro User Guide. It contains description of settings and features that cloud version (Boro Service) lacks.

Contents

• 1. Introduction
• 2. Installation and Configuration
  • 2.1. Installing Boro Solution
    • 2.1.1. Introduction
    • 2.1.2. Preparing the Server
    • 2.1.3. Installing the Boro Solution Server
    • 2.1.4. Installing certificates
    • 2.1.5. Initial Testing
  • 2.2. Configuring Boro Solution
    • 2.2.1. Migrating Projects from Boro service
    • 2.2.2. Changing the Server Name (Hostname)
    • 2.2.3. Changing the Location of the Database Files
    • 2.2.4. Establishing Access to the Web Interface Over HTTPS
    • 2.2.5. Enabling ControlAPI in Nginx
    • 2.2.6. Changing the Statistics Storing Period
    • 2.2.7. Resetting the Administrator Password
  • 2.3. Updating Boro Solution
    • 2.3.1. Overview
    • 2.3.2. Installing the update
• 3. Administration
  • 3.1. Configuring Telegram
    • 3.1.1. Creating a Bot
    • 3.1.2. Adding a Telegram Bot to Boro Solution
    • 3.1.3. Adjusting a Notification Profile
• 4. Describing System
  • 4.1. Guest Mode
• 5. Server Management and Data Request API
  • 5.1. General Information
    • 5.1.1. Description
    • 5.1.2. Hierarchy of Boro System Entities
    • 5.1.3. Message Format Description
  • 5.2. Access and Authentication
    • 5.2.1. User Access Control
    • 5.2.2. Signing API Requests
  • 5.3. Common Response Errors
  • 5.4. Account Specific Methods
    • 5.4.1. ProjectsList
  • 5.5. Probe Specific Methods
    • 5.5.1. AppList
    • 5.5.2. AppState
    • 5.5.3. AppTasks
    • 5.5.4. AppStoppedTasks
  • 5.6. Task Specific Methods - Information and Control
    • 5.6.1. TaskInfo
    • 5.6.2. TaskStart
    • 5.6.3. TaskStop
    • 5.6.4. TaskResume
    • 5.6.5. TaskChangeConfig
  • 5.7. Task Specific Methods - Data Request
    • 5.7.1. TaskLastStates
    • 5.7.2. TaskStatistics
    • 5.7.3. TaskAlarms
    • 5.7.4. TaskEvents
    • 5.7.5. TaskKpi
    • 5.7.6. TaskKpiHistory
  • 5.8. Profile Specific Methods
    • 5.8.1. ProfilesList
    • 5.8.2. ProfileInfo
    • 5.8.3. ProfileChange
    • 5.8.4. ProfileCreate
    • 5.8.5. ProfileDelete
    • 5.8.6. ProfileSettings
  • 5.9. Project Specific Methods
    • 5.9.1. ProjectTableView
  • 5.10. Tables
    • 5.10.1. Elementary Stream Types
    • 5.10.2. Detected Elementary Stream Types
    • 5.10.3. Trigger Description
    • 5.10.4. Table of Message Identifiers
  • 5.11. Config File
    • 5.11.1. General Information
    • 5.11.2. File Structure
    • 5.11.3. Examples of Tasks Setting
• 6. Integration
  • 6.1. Dataminer
    • 6.1.1. Introduction
    • 6.1.2. Configuration of the Protocol
    • 6.1.3. The Projects Page
    • 6.1.4. The Probes Page
    • 6.1.5. The Task Pages
    • 6.1.6. The Active Alarms Page
    • 6.1.7. The Settings Page
    • 6.1.8. The Start Task Page
    • 6.1.9. Alarms and Trends