# 4G & 5G Onyx Portal 3.1.2 Release Notes
## Release Information
This release note provides information about the 4G and 5G Onyx Portal 3.1.2 release.
### Component Compatibility Information
This release has been verified to be compatible with the following component releases.
Component Compatibility Information for 4G Networks
| For details, contact GXC Technical Support. |
## New Features, Enhancements, and Behavior Changes
This section describes new features, enhancements, and behavior changes introduced in this release.
### Analytics Plot Reports Enhancements
{% hint style="info" %}
**NOTE:** This change is applicable to both 4G and 5G networks.
{% endhint %}
In the Onyx Portal's Analytics interface, the Plot Reports KPI selection panel includes new KPIs, now categorized into Common, 4G, and 5G groups.
Onyx Portal Context: Administrator Dashboard > **Analytics** > **Plots** tab > **Manage Reports**
New KPI Categories:
* **Common KPIs** (4G and 5G):
* **Access Point Uptime** — Time percentage an AP has been operational and available.
* **Average Downlink Throughput** — Average data rate achieved in the downlink direction per UE or cell.
* **Average Number of Active UEs** — Average number of UE actively transmitting or receiving data.
* **Average Number of Registered UEs** — Count of UE attached and ready for service (registered but not necessarily active).
* **Average Uplink Throughput** — Average data rate in the uplink direction.
* **Downlink Traffic Volume** — Total data sent from the network to UE (in MB/GB).
* **Peak Downlink Throughput** — Maximum observed downlink throughput in a given time window.
* **Peak Uplink Throughput** — Maximum observed uplink throughput.
* **PRB Utilization Downlink** — Percentage of Physical Resource Blocks used in downlink.
* **PRB Utilization Uplink** — Percentage of PRBs used in uplink.
* **SAS Availability** — Availability status of the Spectrum Access System (SAS) (for CBRS compliance).
* **UE Connection Requests** — Number of requests made by UE to connect to the network.
* **UE Connection Success** — Successful connection count or success rate after UE attempts.
* **Uplink Traffic Volume** — Total data sent from UE to the network.
**4G KPIs:**
* **Dropped Call Rate** — Percentage of active 4G sessions that were dropped before expected termination.
* **GPS Signal Availability** — Availability and consistency of GPS lock (often used for synchronization).
**5G KPIs:**
* **Cell SRS SNR** — The average Signal-to-Noise Ratio of Sounding Reference Signals, used for uplink channel quality estimation.
* **Downlink Cell BLER** — The average downlink Block Error Rate in percentage, measures error rate after decoding.
* **RRC Success Percentage** — The average success rate of Radio Resource Control (RRC) connection setups in 5G.
* **Uplink Cell BLER** — The average uplink Block Error Rate in percentage, measures error rate after decoding.
### Events-Related Changes
#### New Event Types
The following event types have been added to improve operational visibility across the Onyx platform.
* (4G) disconnected\_enodeb – An AP has disconnected from the network.
* (4G) handover\_completed – A UE successfully completed a handover.
* (4G) handover\_failed – A UE handover attempt failed.
* (4G) handover\_initiated – A UE initiated a handover.
* (4G & 5G) ip\_allocation\_failure – IP allocation failed during session creation.
* (4G & 5G) onyxedge\_config\_updated – The Onyx Edge’s configuration was updated from the Orchestrator.
* (4G) tr069\_periodic\_inform\_missed – An AP missed a scheduled TR-069 periodic inform message, possibly due to connectivity or service issues.
* (4G) ue\_detached – A UE disconnected from the network.
* (4G) unrecognized\_enodeb – The Onyx Edge received a TR-069 message from an unregistered or unauthorized AP.
#### Modified Event Types
The following events have been enhanced with improved naming conventions, updated/additional data fields providing clearer system insights and better operational visibility.
* “onyxedge\_tr069\_primary” renamed to “ha\_primary\_elected”. Indicates the Onyx Edge has been elected as the Auto-Configuration Server (ACS) for APs.
* “established\_sync\_rpc\_stream” renamed to “connected\_with\_orc8r\_to\_receive\_commands”. Indicates the Onyx Edge is connected with the Orchestrator and can respond to remote commands.
* “disconnected\_sync\_rpc\_stream” renamed to “disconnected\_with\_orc8r\_to\_receive\_commands”. Indicates the Onyx Edge is disconnected from the Orchestrator and cannot respond to commands.
* The “s1\_setup\_success” event’s details now includes the following updated/refined fields:
* “AP Name” – The AP’s Onyx Portal name.
* “enb\_id” – The AP’s ID.
* “enb\_name\_in\_req” – The AP’s name as transmitted in the S1-setup-req message.
* The “restarted\_services” event now includes the following restart types:
* expected – Includes planned maintenance, configuration updates, or administrative restarts
* unexpected – Includes service crashes, system failures, or unplanned recovery events
* The “session\_terminated” event’s details now includes the following fields:
* event\_type – Type of event that occurred.
* timestamp – Local date and time when the event was recorded.
* event\_source – System component or process that generated the event.
* description – Brief explanation of the event.
* IMSI – International Mobile Subscriber Identity for the SIM/subscriber.
* apn – Access Point Name defining the network connection type.
* duration – Length of the session in seconds.
* enb\_id – Identifier for the eNodeB (cell base station).
* imeisv – IMEI Software Version identifying device hardware and software version.
* internal\_session\_id – Internal unique reference for the session.
* ip\_addr – IP address assigned to the subscriber device.
* total\_rx – Total bytes received by the device in the session.
* total\_tx – Total bytes transmitted by the device in the session.
* utc\_pdp\_end\_time – UTC time when the PDP context ended.
* utc\_pdp\_start\_time – UTC time when the PDP context began.
* The “ded\_bearer\_create\_success” and “ded\_bearer\_create\_failure” events have been updated with the following changes:
* Removed the “policy\_rule” and duplicate “imsi” fields.
* Policy information is now abstracted under the “engineering\_debug\_info” section.
* Replaced the “failure\_event\_cause” field with “3GPP\_cause code” field.
* The “enb\_alarm\_cleared” event has been updated with the following changes:
* “perceived\_severity” field now matches the value from the corresponding “enb\_alarm\_raised” event (e.g., Major, Critical), instead of always being "Cleared". Falls back to "Unavailable" if the original severity is not available.
* “utc\_alarm\_event\_time” reports the timestamp at which the alarm was raised from the AP.
* The “enb\_configuration\_updated” event has been updated to display the “updates” field’s output as key-value pairs with contrasting colored formatting.
* The “unexpected\_fault\_received” event’s details now include the following additional/refined information:
* “fault\_code”
* “fault\_string”
* “message\_name” and “set\_parameter\_fault” – Grouped together under the “engineering\_debug\_info” section.
* The “tr069\_event\_received” event is no longer triggered for the following cases:
* “2 PERIODIC"
* “4 VALUE CHANGED”
* “7 TRANSFER COMPLETE”
* “10 AUTONOMOUS TRANSFER COMPLETE"
* “M Upload"
* “X 000FBB measurement data upload complete"
#### Deprecated Event Types
To improve system performance and reduce log noise, the following periodic and routine events have been deprecated from event logging:
* processed\_updates
* updated\_stored\_mconfig
#### Other Event-Related Changes
* General changes to the event summary view:
* The **Tag** column has been replaced with an **Entity** column. The Entity column displays the associated entity's name such as the equipment name, subscriber IMSI, etc., depending on the type of event. The entity value is clickable, allowing users to easily navigate to the corresponding Onyx Edge, AP, or Subscriber details view.
Onyx Portal Context: **Equipment** > **Onyx Edge** tab > Onyx Edge details page > **Events & Alerts** tab > **Events** section
* The **Stream Name** label has been renamed to **Module** to better reflect its purpose. Users can now filter events by module to view events coming from specific modules.
Onyx Portal Context:
* **Equipment** > **Onyx Edge** tab > Onyx Edge details page > **Events & Alerts** tab > **Events** section
* **Equipment** > **Access Point** tab > Access Point details page > **Events & Alerts** tab > **Events** section;
**Subscribers** > **Subscriber** tab > subscriber details page > **Events** tab
* General changes to the Event Details view:
* All AP names, Cell IDs, and APN names are now hyperlinked to their corresponding details pages for quick navigation.
* The **AP Serial** field label has been renamed to **AP Name**, accurately reflecting the displayed information.
* The **cause** field label has been renamed to **3GPP\_cause**.
* The **extra\_info** field label has been renamed to **engineering\_debug\_info**.
* Any lists displayed under events are now numbered with color-coded numbering for improved readability. For example, in the case of the `onyxedge_restarted_services` event, shows list of restarted services in colored format.
* All UE event details now include corresponding IMEI and AP/Cell ID details.
* In subscriber-related event details, the **mme stream** field now displays IMSI prefix in tag information. For example, "IMSI001010003000260".
### Onyx Portal User Creation with Temporary Password
To improve user onboarding in the Onyx Portal, administrators can now create users without relying solely on email activation links. A new option allows assigning a temporary password at account creation, providing greater flexibility, particularly in enterprise environments where credentials may be distributed through alternate channels.
Administrators can now choose between two flows:
* Send Activation Link – The default option, where the user receives an email with an activation link to set their password. The user account remains in Verification Pending state until activation is completed.
* Set Temporary Password – The new option, where the administrator assigns the user a temporary password. On first login, the user is redirected to reset the temporary password. After the user resets the temporary password, the account is activated, and the temporary password is securely deleted.
Temporary passwords are stored in the Onyx Portal database with BCrypt encryption until replaced.
GXC Administrators or Super Administrators (Partner or Customer Default users) may set multiple temporary passwords for a user until the user completes password setup.
This feature streamlines user onboarding and gives admins more control over how new users are activated, reducing dependency on email-based activation in enterprise scenarios.
### Onyx Portal User Idle Session Timeout — Per-User Control
{% hint style="info" %}
**NOTE:** This change is applicable to both 4G and 5G networks.
{% endhint %}
This release introduces a user-level idle session timeout configuration. While users inherit the timeout settings of their partner or customer accounts by default, administrators can now configure custom timeouts for individual users based on their roles, operational needs, or security policy.
Onyx Portal Context: Add/Edit Onyx Portal user accounts
To inherit the partner/customer account-level setting, select the checkbox.
To configure a custom value, clear the checkbox and enter a value in one of the following ranges: 5–59 minutes, 1–23 hours, or 1–7 days.
For SSO user accounts, Onyx Portal manages session timeouts independently of the SSO/SAML IdP configuration. This creates two distinct user experiences:
* When Onyx Portal timeout < IdP timeout — The Onyx Portal automatically logs users out when its timeout expires, then seamlessly reauthenticates them in the background if their IdP session remains active. Users experience a brief logout followed by automatic re-entry without entering credentials.
* When Onyx Portal timeout > IdP timeout — Users must manually reauthenticate with full credentials once the shorter IdP session expires, even if the portal session would otherwise remain active.
For multi-tenant user accounts, the idle session timeout is determined by the base tenant's timeout setting.
### Onyx Portal User Interface Improvements
This section describes changes in this release as part of our ongoing effort to simplify configuration management, align default behaviors, and improve usability.
* The Onyx Edge Event Aggregation and Log Aggregation configuration controls have been permanently removed to simplify configuration management. These functionalities are now always enabled and cannot be disabled, ensuring comprehensive monitoring capabilities for all Onyx Edge deployments.
* Event Aggregation — Aggregates Onyx Edge service events for display in event lists and charts in the Onyx Portal interface.
* Log Aggregation — Aggregates logs from gateway services for display in log lists and charts in the Onyx Portal interface.
Onyx Portal Context: **Equipment** > **Onyx Edge** tab > add/edit Onyx Edge > **Others** tab
* (4G VLAN Mode and 5G VLAN Mode) The subscriber details page now displays the subscriber's MAC address. This is intended to facilitate DHCP reservations in corporate-managed DHCP environments. The MAC address is displayed only when the network and Onyx Edge are in VLAN mode.
Onyx Portal Context: **Subscribers** > **Subscriber** tab > subscriber details page > **Overview** tab > **Subscriber Details** section)
* (4G and 5G) In the subscriber details page, the **Service** parameter now displays status as "**Enabled**/**Disabled**" for clarity and consistency.
Onyx Portal Context: **Subscribers** > **Subscriber** tab > subscriber details page > **Overview** tab > **Subscriber Details** section)
### Signal Analyzer
{% hint style="info" %}
**NOTE:** This change is applicable only to 5G Onyx Edge (NR+Core) deployments.
{% endhint %}
This release introduces the Signal Analyzer feature for the Onyx 5G platform. It provides real-time, per-cell analysis and visualization of uplink and downlink power characteristics across the RF spectrum, enabling network operators to monitor signal quality, detect interference, and optimize network performance.
The following analysis plots are available in this release:
* Average Power
* Maximum Power
* Power Over Time
The Signal Analyzer can be enabled/disabled from the Onyx Portal, in the Onyx Edge details. It is disabled by default.
Onyx Portal Context: **Equipment** > **Onyx Edge** tab > add/edit Onyx Edge > **Others** tab > **Signal Analyzer** toggle switch
The Signal Analyzer can be launched from the Onyx Portal, in the Onyx Edge details page.
Onyx Portal Context: **Equipment** > **Onyx Edge** tab > Onyx Edge details page > **RAN** section > **Actions** column > shortcut menu > **Start Signal Analyzer**
On launching, configure the following:
* **Listen-Only Mode** — When enabled, the analyzer passively listens without the gNB transmitting any RF signals.
* **Analysis Interval** — Select the duration for which the analyzer captures and reports data. Default: 5 minutes.
* Analysis Plots:
NOTE: The plots refresh every 10 seconds.
* **Average Power** — Displays the average power distribution across the frequency spectrum to highlight interference sources and power anomalies.
Plot Detail:
* X-Axis: Subcarrier Frequencies (MHz); Y-Axis: Average Power (dBFS)
* Blue line: Uplink Average Power; Orange line: Downlink Average Power
* **Max Power** — Displays peak power levels across frequencies to highlight transmission spikes, interference sources, or power anomalies.
Plot Details:
* X-Axis: Subcarrier Frequencies (MHz); Y-Axis: Maximum Power (dBFS)
* Blue line: Uplink Maximum Power; Orange line: Downlink Maximum Power
* **Power Over Time** — Displays uplink and downlink power per symbol for one frame (10 ms).
Plot Details:
* X-Axis: Slot Number; Y-Axis: Power (dBm)
* Blue line: Uplink Power Over Time; Orange line: Downlink Power Over Time
To zoom in on a plot, click at the desired point and drag horizontally, to the left or right.
To reset the plot after zooming in, click (Reset Zoom).
To stop analysis and close the Signal Analyzer dialog box, click **Stop**.
### Subscriber Management Changes
This section describes subscriber management related changes in this release.
#### Enhanced Subscriber Details
The subscriber details page now includes the following additional details and refinements.
Onyx Portal Context: **Subscribers** > **Subscriber** tab > subscriber details page > **Overview** tab
* **Subscriber Details:**
* **Allowed Cell** — Displays the specific cell(s) the subscriber is permitted to attach to.
* **Subscriber Group Details:**
* **Subscriber Group Name** — The subscriber group that the subscriber account is associated with.
* **APN** — The Access Point Name associated with the subscriber group.
* **Device Details:**
* **IMEI** — The device's IMEI number.
* **IMEISV** — The device's IMEISV.
* **Brand** — The device's manufacturer or vendor name.
* **Model** — The device's model name or number.
* **Last IMEI Lookup Time** — Timestamp of the last successful query to the IMEI Cloud database for the device's metadata.
#### Subscriber Analytics
This release introduces comprehensive subscriber-level analytics providing real-time and historical data usage and connection performance metrics per subscriber.
Onyx Portal Context: **Subscribers** > **Subscriber** tab > subscriber details page > **Analytics** tab
* **Summary** — Displays quick metrics for the selected time range.
* **Throughput Summary:**
* **Downlink Throughput** — Subscriber's downlink throughput in the core.
* **Uplink Throughput** — Subscriber's uplink throughput in the core.
* **Data Usage Summary:**
* **Downlink Data Usage** — Subscriber's downlink data usage.
* **Uplink Data Usage** — Subscriber's uplink data usage.
* **Connection Latency** — Latency for ping from Onyx Edge to UE.
* **Connection Latency** (If available) – Note that for this analytics to populate, CPE Monitoring (**Add**/**Edit Onyx Edge** > **Others** tab) must be enabled.
* **Plots** — Displays time-series plots visualizing usage patterns, spikes and drops, and latency gaps with time granularity for the selected time range.
To manage the plots displayed, click **Manage Reports** and select the required KPIs.
* **Common KPIs:**
* **Downlink Throughput** — Subscriber's downlink throughput measured at the core.
* **Uplink Throughput** — Subscriber's uplink throughput measured at the core.
* **Downlink Data Usage** — Total downlink data consumed by the subscriber.
* **Uplink Data Usage** — Total uplink data consumed by the subscriber.
* **Connection Latency** — Ping latency from Onyx Edge to UE (requires CPE Monitoring enabled).
* 4G Only KPIs: Displayed only if the current network is a 4G network.
* **Serving Cell Transition** — Frequency of UE switching between LTE cells due to mobility or radio conditions.
* 5G Only KPIs: Displayed only if the current network is a 5G network.
* **DL Radio Throughput** — Downlink data rate from base station to UE.
* **DL MCS** — Modulation and coding level used in downlink.
* **DL CQI** — Downlink channel quality as reported by the UE.
* **DL BLER** — Downlink block error rate before retransmission.
* **DL RANK** — Number of active MIMO layers used in downlink.
* **UL Radio Throughput** — Uplink data rate from UE to base station.
* **UL MCS** — Modulation and coding level used in uplink.
* **UL CQI** — Estimated uplink channel quality.
* **UL BLER** — Uplink block error rate before retransmission.
* **UL RANK** — Number of active MIMO layers used in uplink.
#### Subscriber Detach Support
{% hint style="info" %}
**NOTE:** This change is applicable to both 4G and 5G networks.
{% endhint %}
Operators can now forcefully disconnect active subscribers/UE directly from the Onyx Portal in any of the following ways:
* From the subscriber summary view (**Subscribers** > **Subscriber** tab) — **Actions** column > shortcut menu > **Detach Subscriber**.
* From the subscriber details page (**Subscribers** > **Subscriber** tab > subscriber details page) — in the top-right corner, click the **Detach Subscriber** button.
* From the Onyx Edge details page (**Equipment** > **Onyx Edge** tab > Onyx Edge details page) — in the top-right corner, click **Actions** > **Detach Subscriber**.
#### Subscriber Handover Events
{% hint style="info" %}
**NOTE:** This change is applicable only to 4G networks.
{% endhint %}
The Onyx Portal now supports the following subscriber events for S1 handover operations, providing real-time visibility into handover status and enabling faster detection and troubleshooting of mobility issues.
* handover\_completed — Handover completed successfully.
* handover\_failed — Handover failed, with cause codes: handover\_cancel, handover\_failure, handover\_preparation\_failure.
* handover\_initiated — Handover procedure started.
Onyx Portal Context: **Equipment** > **Onyx Edge** tab > Onyx Edge details page > **Events & Alerts** tab > **Events** section
#### UE Attach Status Monitoring Enhancements
{% hint style="info" %}
**NOTE:** This change is applicable to both 4G and 5G networks.
{% endhint %}
The Onyx Edge UE Attach Status graph now includes new filter options.
* In 4G Networks — The UE Attach Status graph in the Onyx Edge summary view now includes a new filter option: **Handovers**. This option allows operators to visualize and monitor UE handover event frequency and success/failure rates across a specified time range.
Onyx Portal Context: **Equipment** > **Onyx Edge** tab > **UE Attach Status** section
* In 5G Networks — The UE Attach Status graph in the Onyx Edge summary view now displays new dropdown filter options specific to 5G (NR) core network attach procedures. These filters allow operators to visualize the success and failure trends of key signaling events that occur during 5G UE registration and session management across a specified time range.
Onyx Portal Context: **Equipment** > **Onyx Edge** tab > **UE Attach Status** section
* **Registration (Initial)** — First network registration attempt after UE power-on or SIM activation.
* **Registration (MobUpd)** — Registration updates triggered by UE mobility (changing tracking areas).
* **Registration (Periodic)** — Scheduled periodic re-registration to maintain network presence.
* **Auth Request** — Authentication procedure events.
* **PDN Establishment Request** — Session setup for data connectivity.
* **Service Request** — Resume of idle-mode UE sessions.
## Resolved Issues
The following issue is resolved in this release.
### **"Provisioning Server Connection Failure" Alert Not Triggered for NR Box**
The "Provisioning Server Connection Failure" alert is not generated from the NR box, even after 15 minutes of connection failure.
## Open Issues
{% hint style="info" %}
**NOTE:** Open issues reported in previous releases, unless subsequently reported as resolved, may exist in this release.
{% endhint %}
The following new open issue is reported in this release.
### **Temporary Mismatch in 5G Subscriber Analytics Data After gNB Restart**
Following a gNB restart, 5G subscriber analytics plots may temporarily display data mapped to incorrect subscribers for a few minutes.
**Workaround:** No action is required. This display issue automatically resolves after a few minutes and does not affect actual traffic flows or subscriber services. This issue is under investigation and will be fixed in an upcoming release.
## Revision History
Date
Updates
2025-08-28
Initial release.
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://docs.gxc.io/release-notes/release-notes-archive/onyx-portal-release-notes/4g-and-5g-onyx-portal-3.1.2-release-notes.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.