DOCSEARCHbyAlgolia
Submit Docs

Ferronext Platform Documentation

website·Indexed 31 days ago

https://3r93bhxm6i.eu-west-3.awsapprunner.com

User guides for the Ferronext platform, covering the configuration and management of data sources, applications, and alerts. Includes instructions for data ingestion, source association, deployment configurations for OPC UA, MQTT, and REST APIs, and the creation of monitoring alerts.

Tokens
31.8K
Snippets
10
Records
278
Agent score
46%

What's inside Ferronext

  1. Overview of Ferronext Data Sources

    A data source in Ferronext is a structured set of information originating from files, sensors, external APIs, or other information systems. Data sources serve as the central entry point for all analyses, alerts, visualizations, and calculations within the ecosystem. They can be created manually, imported, or synchronized via streams. Users can visualize data through tables, interactive maps, graphs, curves, and heatmaps, or use them to calculate indicators and automate business processes.

  2. Manage external MQTT broker users

    The 'External Users' (Utilisateurs externes) tab allows the management of accounts belonging to users or systems external to the organization. Each user is represented by a card showing their name and the number of topics they are authorized to access. A menu (accessible via the '...' button) provides options to view detailed user information or add new topic access.

  3. Manage data sources via the Source List page

    The 'Liste des sources' page allows administrators to view and manage all platform data sources. Each source entry displays the following information: Name, Creation Date, Number of Applications, Used Storage, Storage Limit, Storage Monitoring, Last Upload, Category, and Status (Enabled or Disabled).

  4. Understand the Ferronext Downloads activity page

    The Downloads page in Ferronext provides a centralized history of all download actions performed from a user account. It is divided into two primary categories to help users track where data was exported from:

    1. Sources: Contains all downloads originating from data sources, such as files, raw data, or tables.
    2. Applications: Contains files generated or exported from the platform's internal tools and applications.

  5. Manage applications via the Application List page

    The Liste des applications page allows administrators to view and manage all platform applications. Each application entry provides key details including: Name, Creation Date, Number of Sources, Storage Used, Storage Limit, Storage Monitoring, Last Update (Dernière remontée), Category, and Status (Enabled/Disabled).

  6. Report an anomaly or technical issue in a data source

    To notify administrators about incorrect data, outdated sources, configuration errors, or technical problems, use the reporting feature from the data source detail page.

    Steps to create a report:

    1. Navigate to the detail page of the source.
    2. Click the Signaler (Report) button located in the page header.
    3. In the pop-up window, provide a detailed description of the issue in the Motif du signalement (Reason for report) field.
    4. Review the entered information and click Signaler to submit the report to the source administrators.

    Recommended reasons for reporting include:

    • Incorrect or inconsistent data
    • Outdated or non-updated sources
    • Configuration errors
    • Incomplete content
    • Access or visibility issues
    • Other observed anomalies

  7. Understand the Alerts menu and monitoring types

    The Alerts menu allows users to be notified when specific events or conditions are detected on their sources based on defined evaluation criteria. The menu is divided into three main tabs:

    • Surveillances d’état (Status Monitoring): Time-based alerts triggered when a source variable meets a specific condition for a defined duration.
    • Alertes stockages (Storage Alerts): Alerts based on storage thresholds to prevent saturation or capacity overflow.
    • Critères d’évaluation (Evaluation Criteria): The rules applied to sources that determine the trigger conditions for an alert.

    Each tab provides a summary table containing the alert name, type, affected sources, trigger threshold/condition, current status, and creation date. New alerts or criteria can be created using the + button within each tab.

  8. Manage resource subscriptions via the Subscriptions page

    The Subscriptions page centralizes all resources a user is subscribed to in order to track their evolution. The page is divided into two primary tabs: 'Sources' for tracking data source subscriptions and 'Applications' for tracking tool and platform application subscriptions. For each subscription, users can access the specific resource, track data updates, and view the modification history.

  9. Use the Ferronext Chatbot to query platform data

    The Chatbot is a conversational assistant used to quickly obtain information about available data and resources, search for specific data, ask questions about the platform, or get guidance on Ferronext features. To access it, log into the platform and select 'Chatbot' from the side menu.

  11. Navigate the Dashboard overview

    The Dashboard serves as the central control center for a structure. To use it, ensure you are logged into the platform and have selected the specific structure you wish to view from the Dashboard menu. The interface is divided into three primary functional areas:

    1. Featured Sources (Top Banner): Displays the three most recently created data sources for quick access.
    2. Structure Dashboard (Left Sidebar): Provides real-time indicators and statistics for the selected structure.
    3. Mapping (Central/Right Area): An interactive visualization of the relationships between applications and data sources.

  12. Understand Application types and data dependencies

    An application is an entity that uses one or more data sources to provide actionable results. There are two types of applications:

    1. Simple Application: Connected to one or more sources; used exclusively for importing data results.
    2. Fusion Application: Aggregates multiple sources to combine data and produce a consolidated view.

    Critical Dependency: Every application requires at least one data source. If a data source is deleted, all associated applications become invalid.