Edit README.md

Edit LENA_MODEL_REPORTING_PARAMETERS

Author: AbdoKhaled27

README.md

@@ -171,6 +171,31 @@ This setup leverages a hybrid of open-source tools and Orange’s internal platf
 
 
 
+## 5. LENA Module Reporting Parameters
+
+To support custom xApp development on top of this platform, a dedicated reference document is available that maps every reportable KPI to its exact source in the 5G-LENA NR module:
+
+📄 [`docs/LENA_MODEL_REPORTING_PARAMETERS.md`](docs/LENA_MODEL_REPORTING_PARAMETERS.md)
+
+### What this document provides
+
+- A **complete layer-by-layer catalogue** (PHY, MAC, RLC, PDCP, RRC, E2/O-RAN) of all parameters that can be extracted from the 5G-LENA module (`src/nr/`).
+- A clear **status for each parameter** — whether it is directly **IMPLEMENTABLE** via a trace source or public API, **DERIVABLE** through post-processing, or **NOT_SUPPORTED** in the current codebase.
+- The exact **file, class, function, and TraceSource** needed to access each metric, so you know precisely where to connect your reporting logic.
+- Documented **known corrections** between the simulator implementation and the 3GPP KPM naming conventions (e.g. RLC byte counts reported under PDCP KPM names).
+
+### How it helps you build a custom xApp
+
+When developing a custom xApp that requires specific KPIs from the LENA simulation — such as per-UE throughput, SINR, PRB utilization, PDCP delay, or RRC events — this document tells you:
+
+1. **Whether the parameter is available** in the current 5G-LENA codebase.
+2. **How to enable reporting** of that parameter (trace connection call, helper method, or derivation formula).
+3. **Where the data flows** from the simulator layer through the E2 indication message to your xApp.
+
+This makes the document the starting point for any custom reporting extension, enabling you to identify the required parameters, wire the correct trace sources, and include them in the KPM indication messages sent to FlexRIC.
+
+---
+
 ## 6. Installation Instructions
 
 ### System Requirements

docs/LENA_MODEL_REPORTING_PARAMETERS.md

@@ -10,7 +10,35 @@ The purpose of this document is to help developers understand what information i
 
 In the next step, this document will demonstrate how to develop a custom xApp by extending the reporting framework to extract and report custom parameters that are not available by default.
 
-> **Note:** in 5G
+To Report a any prameter from any protocol Layer in LENA module to your Custom xApp you should follow the next steps :
+
+1. navigate to `../mmwave-LENA-oran/scratch` and open `orange-rf-kpi-reporting.cc` VS Code .
+   we createthis sceanrio to able the users to enable the reporting flags of any layer that he need to report from
+
+2. go to the object of `NrKpiReportingConfig` caled `kpiCfg` and you will see the reporting flags of each layer and you can choose the sepcific KPI for example
+
+   ```cpp
+   kpiCfg.enablePhyReporting = true;
+   kpiCfg.selectedPhyKpis = {
+       "PHY.DlDataSinr", "PHY.DlCtrlSinr", "PHY.Rsrp", "PHY.Rsrq",
+       // "PHY.Cqi", "PHY.Mcs", "PHY.Ri",
+       // "PHY.RxPacketTbSize", "PHY.Tbler", "PHY.CorruptTb",
+       // "PHY.PrbUtilizationDl", "PHY.ActivityFactor",
+       // "PHY.TxPowerWatts", "PHY.AntennaPortsOn",
+       // "PHY.EnergyConsumptionJ", "PHY.InstantaneousPowerW",
+       // "PHY.SlotDataUsedSym", "PHY.SlotAvailRb", "PHY.SlotCtrlUsedSym",
+   };
+   ```
+
+3. you can now save your edits
+
+4. Navigate to `/path/to/flexric/build/examples/ric/` and then run `./nearRT-RIC`.
+
+5. Navigate to `/path/to/mmwave-LENA-oran` and then run `./ns3 --run scratch/orange-rf-kpi-reporting`
+
+6. Navigate to `/path/to/flexric/build/examples/xApp/c/orange/` and then run `./xapp_kpm_rc`.
+
+in the bellow you can fined the all prameters and its locations that supported in 5G-LEAN
 
 ---