APIs Enhancement
APIs Enhancement Order Number Complaint number
Introduction
Purpose
This document defines the changes to be implemented for Oneview along with the data that is required for performing these tests.
Business Objective
Business requested enhancements on OLO ONT line status parameters to provide better service assurance to OLO customers.
Description
The OLO ONT status (current and historical data of ONT) will be fetched from the OLO provider and will be shown in Oneview for the agents to better troubleshoot the customer issues.
Solution Overview
Agent has to initiate the API request by triggering the function from Oneview. Oneview will fetch the OLO ONT status and other parameters from BSST EAI, APIM and the parameters will be shown in Oneview.
Below is the high-level solution summary for the reference from the SDD.
Assumptions and Constraints
Assumptions
· The reader of this document should be familiar with:
Oneview (NOKIA/Motive SMP 18.1.9)
· ODS, BSST EAI, APIM are highly available systems for Oneview application.
· The change will impact EBU services. CBU business will align with EBU business, so that the delivery of CBU and EBU (CR-50899) for this interface enhancement will be synchronized, else the changes for CBU will not be moved to production.
Scope
1. Scope of this feature is for CBU LL services.
2. Applicable to FTTH line types.
3. Scope is limited to Open Access seeker lines, all OLO providers. (Mobily, Salam, Dawiyat)
4. Scope includes both Oneview and MiniOV.
Functional Requirements
#
User Story
Requirement
IT Impact
Compliance
HLD Mapping
Functional Requirements
FR-1
UST-9837
Mobily is not passing all parameters of line status to STC.
Mobily Line Status Question Assignment API should be enhanced to include below values:
1. ONT signal RX&TX
2. ONT status – Up/down/Switched off (dying gasp)
3. ONT Latency
4. ONT Speed
5. Current Link Quality
6. MAC status and details for both HAG/ONT.
7. Historical data ONT, CPE, and OLO for 7 days
STC Phone Number
OneView
PC
1. Following are not provided by Mobily in the response.
a. Latency
b. Speed
c. MAC
Historical data of ONT will be presented.
6.1.1
6.1.2
6.1.3
FR-2
UST-10141
SALAM Line Status Question Assignment API should be enhanced to include below values:
· RX/TX ONT/OLT level.
Device status … up/down/ switched off
OneView
PC
Rx/Tx as provided by Salam (ONT/OLT) will be presented to the user.
6.1.1
6.1.2
6.1.3
Open Items
ID
Open Item
Comments
Status
O-1
Dawiyat OLO Provider
As Dawiyat provider is not providing with the additional new parameters, the additional new fields will still be shown in Oneview UI with the values as blank.
Open
O-2
Parameters not fetched
In case BSST EAI response status is SUCCESS but some of the parameters or values are missing in the response, then the relevant fields in Oneview UI will be shown as blank.
Open
O-3
Arabic Locale Texts
Business will provide the Arabic locales/texts for the screen items, so that it can be displayed for the Arabic language selection.
Open
O-4
WSDL and Request/Response XMLs
BSST EAI team will provide the WSDL for the interface INT0402 and Request/Response XML during their development.
Open
Technical Solution Details
Solution Details
· The current implementation of fetching OLO line parameters in Oneview, which happens on the initialization of the session will be stopped. Comment by Author: Is it applicable only for OLO? Or STC as well? Comment by Author: It is applicable only for OLO, STC as seeker.
· Agent has to initiate a request to fetch the OLO line status parameters by clicking a link. Comment by Author: Is it a link or button/label? Comment by Author: It is a link, decorated as a tree->leaf. please refer to the mock screens in section 6.1.2.6
· The Network Analyzer summary widget, which is currently populated during the initialization will show a message “Network Analyzer is not applicable for Open Acess seeker lines”.
· New link will be provided under advanced diagnostics section for invoking the OLO line status parameters manually by the Agent.
· Mini Oneview screen needs to be modified to stop fetching the OLO line parameters on startup.
· New link to be provided under the Tools->Internet Tools section for fetching the OLO line status parameters manually by the Agent.
· The below list of parameters to be fetched from BSST EAI->APIM->OLO and shown in Oneview.
· ONT Status
· ONT current link Quality
· ONT Signal Rx
· ONT Signal Tx
· OLT Signal Rx
· OLT Signal Tx
· ONT latency
· ONT Speed
Oneview Changes
Workflow
· A new interactive workflow (STC_OLO_ONT_FETCH_LINE_STATUS) will be created.
· The workflow will perform the following operations
· Fetch the below details from the dictionary.
· Service identifier
· Operator Name
These parameters are being fetched from ODS view (ONVIEW_CUSTOMER_PROFILE) using customer service number as part of Oneview session initialization.
· Invoke the BSST EAI interface INT0402 using Java Service Operation to fetch the OLO line status parameters.
· Display the parameters in a tabular format.
Service Operation Module
· A new Service Operation module will be created which will do the invocation of fetchLineStatus operation to the BSST EAI interface INT0402.
Service Operation Name
JSO Module Display Name
JSO Operation Name
STCOloOntFetchLineStatus
STCOloOntFetchDetails
fetchLineStatus
Java Service Operation
· A new Java Service Operation will be created, which will perform the below operations
· It will fetch the input parameters from workflow and invoke the BSST EAI interface INT0402.
· Process the response from the BSST EAI interface and pass it back to the workflow.
Service Operation Inputs
Name
Type
Description
Backend Mapping
serviceIdentifier
String
Service Identifier of the OLO customer
OLO_OPERATOR_ID from ONVIEW_CUSTOMER_PROFILE view in ODS
operatorName
String
Name of the OLO operator
OLO_OPERATOR_NAME from ONVIEW_CUSTOMER_PROFILE view in ODS
Service Operation Outputs
Name
Type
Description
result
String
Result of the service operation
resolution
List
Resolution of the service operation
error
List of Map
List of errors each member of the list is a Map with: (String errorCode, String errorMessage)
properties
Map
Map of properties to contain the detailed OLO ONT Status Question Assignment results.
OLO ONT Line Status Results
Name
Type
Description
BSST EAI (INT 0402) Mapping
ontStatus
String
ONT Status from OLO Provider
equipmentPort/equipmentPortStatusCode
ontCurrentLinkQuality
String
ONT Link Quality from the OLO Provider
equipmentPort/ equipmentPortLinkQuality
ontSignalRx
String
ONT Signal Rx value from the OLO Provider
Name-equipmentPort/equipmentPortCharacteristics/ equipmentPortCharacteristicsName/ONTSignalRx
Value- equipmentPort/equipmentPortCharacteristics/ equipmentPortCharacteristicsValue
ontSignalTx
String
ONT Signal Tx value from the OLO Provider
Name-equipmentPort/equipmentPortCharacteristics/ equipmentPortCharacteristicsName/ONTSignalTx
Value- equipmentPort/equipmentPortCharacteristics/ equipmentPortCharacteristicsValue
oltSignalRx
String
OLT Signal Rx value from the OLO Provider
Name-equipmentPort/equipmentPortCharacteristics/ equipmentPortCharacteristicsName/OLTSignalRx
Value- equipmentPort/equipmentPortCharacteristics/ equipmentPortCharacteristicsValue
oltSignalTx
String
OLT Signal Tx value from the OLO Provider
Name-equipmentPort/equipmentPortCharacteristics/ equipmentPortCharacteristicsName/OLTSignalTx
Value- equipmentPort/equipmentPortCharacteristics/ equipmentPortCharacteristicsValue
ontLatency
String
ONT Latency value from the OLO Provider
equipmentPort /equipmentPortLatency
ontSpeed
String
ONT Speed value from the OLO Provider
equipmentPort/ equipmentPortExpectedBandwidth
equipmentPort/ equipmentPortExpectedBandwidthCode
ontSignalRxHistory
List of Map
Each Map should have time, ONTSignalRxValue
Historical ONT Signal Rx Data
Type-equipmentPort/technicalParameters/ technicalParameterType/ONTSignalRx
Name- equipmentPort/technicalParameters/ technicalParameterName/
Value-
equipmentPort/technicalParameters/ technicalParameterValue/
Timestamp-
equipmentPort/technicalParameters/timestamp/
ontSignalTxHistory
List of Map
Each Map should have time, ONTSignalTxValue
Historical ONT Signal Tx Data
Type-equipmentPort/technicalParameters/ technicalParameterType/ONTSignalTx
Name- equipmentPort/technicalParameters/ technicalParameterName/
Value-
equipmentPort/technicalParameters/ technicalParameterValue/
Timestamp-
equipmentPort/technicalParameters/timestamp/
status
String
SUCCESS/ERROR
result/status
errorSourceSystem
String
Source system where the error occurred.
result/error/ errorSourceSystem
sourceErrorCode
String
Error code from the source system.
result/error/ sourceErrorCode
errorCode
String
Error code mapped in ESB
result/error/errorCode
errorType
String
Type of the error
result/error/errorType
errorDescription
String
Detailed description of the error message.
result/error/errorDescription
errorDescriptionArabic
String
Description of the error message in Arabic.
result/error/errorDescriptionArabic
Initialization Modules
· Remove the OLOQuestion AssignmentlineStatus invocation from the startup/initialization modules.
· Shared Function – callEAIforOLOQuestion AssignmentlineStatus.
Oneview Customer Profile
· The Network Analyzer summary widget will show a message “Network Analyzer not applicable for Open Acess seeker lines”.
Advanced Diagnostics
· A new section will be created in Advanced Diagnostics tab “OLO Tools”.
· The new workflow created will be nested under the section “OLO Tools” as “OLO ONT Line Status Enquiry”.
· If the result is ‘SUCCESS’ and parameters fetched from the OLO Line Status Enquiry, those will be shown in a tabular format, along with a green status icon.
· In case result is ‘ERROR’, the error message will be shown with a red icon along with the details of the error which will be shown in tabular format.
· The ONT Signal Rx History and ONT Signal Tx History will be will be shown in separate tables.
· Wherever the data is not available from the backend call, the value will be shown as blank. Comment by Author: Is it possible to hide the field instead? Comment by Author: It is not possible to hide the field, hence it is suggested to show blank, this is the current behaviour as well.
· The arabic localization will be done, as applicable.
· Indicative mockup screen for Oneview customer profile section and advanced diagnostics section for the result table with ONT line status parameters are as below.
· SUCCESS Screen:
· ERROR Screen:
MiniOv Changes
360 Degree View:
· The OLO information section which is being loaded during the startup/initialization will be removed. Comment by Author: Please confirm if this is applicable for OLO customers only. For stc, existing process would continue as is. Comment by Author: Applicable for OLO customer, STC as seeker. For stc customers at present there is no “OLO information” section and hence there will be no changes
· The workflow will be modified to remove the startup invocation of Question Assignment OLO line status in the startup/initialization.
· Please see the below existing screen, which will be updated, to remove the “OLO Information” section.
Tools
· The workflow for fetching line status (STC_OLO_FETCH_LINE_STATUS) will be linked under Internet Tools in the Tools section.
· The workflow with fetch the OLO ONT line status parameters and display in the Mini Oneview screen in a tabular format.
· The FTTH NAF related workflows will be hidden for the OLO customer numbers.
· Please refer to the below mockup screen for the link Tools -> Internet Tools.
BSST EAI Interface (INT0402)
The BSST EAI Interface (INT0402) will be enhanced by the BSST EAI team to pass on additional parameters from APIM/OLO.
Below are the sample request and response parameters for the API. For more details, please refer the BSST EAI HLD and Interface Mapping document in Appendix-1.
Request – getEquipmentPortExpectedBandwidth
header
Sample values
messageVersion
1.0
systemID
One View
messageID
1-A7KNC
correlationID
1-123456789
timestamp
Current time (“yyyy-MM-dd’T’HH:mm:ss”)
operationType
Inquiry
processName
GetModemBandwidth
userID
OV
interfaceID
INT0402
systemIP
System IP from Environment Property
customerType
crmSourceSystem from ODS – B2C/B2B
body
operator/operatorName
OLO_OPERATOR_NAME from ODS view (Dawiyat, Salam, Mobily)
service/serviceIdentifier
OLO_OPERATOR_ID from ODS view
Response – getEquipmentPortExpectedBandwidth
body
Sample values
equipmentPort
equipmentPortExpectedBandwidth
4094.0
equipmentPortExpectedBandwidthUnitCode
kb/s
equipmentPortStatusCode
CONNECTED Up/Down Comment by Author: It will be Up/Down Comment by Author: Updated.
equipmentPortLatency
1
equipmentPortLinkQuality
Good/ Bad
equipmentPortCharacteristics
equipmentPortCharacteristicName
ONTSignalRx
equipmentPortCharacteristicValue
-21
equipmentPortCharacteristics
equipmentPortCharacteristicName
ONTSignalTx
equipmentPortCharacteristicValue
2
equipmentPortCharacteristics
equipmentPortCharacteristicName
OLTSignalRx
equipmentPortCharacteristicValue
-5
equipmentPortCharacteristics
equipmentPortCharacteristicName
OLTSignalTx
equipmentPortCharacteristicValue
3
technicalParameters
technicalParameterType
ONTSignalRx
technicalParameterName
ontRx1/ontRx2/…
technicalParameterValue
-13/-12/…
timestamp
1587027629/1587029999/…
technicalParameters
technicalParameterType
ONTSignalTx
technicalParameterName
ontTx1/ontTx2/…
technicalParameterValue
2/3/…
timestamp
1587027629/1587029999/…
result
status
SUCCESS/ERROR
error
errorSourceSystem
Source System of the Error
sourceErrorCode
Error Code of the source system
errorCode
APP.FN.ERROR
errorType
TECHNICAL
errorDescription
No data found
errorDescriptionArabic
NA
Endpoint Details
Environment
URL
Production
http://oneview-bsstprod.stc.com.sa:20900/ws/STC_RMOSupportAndReadiness.wsProviders.v_1_1:ResourceDiscoveryManagement/STC_RMOSupportAndReadiness_wsProviders_v_1_1_ResourceDiscoveryManagement_Port
SIT
http://172.20.204.98:20900/ws/STC_RMOSupportAndReadiness.wsProviders.v_1_1:ResourceDiscoveryManagement/STC_RMOSupportAndReadiness_wsProviders_v_1_1_ResourceDiscoveryManagement_Port
I18N Locales
Below are the text/labels for the Oneview UI. The Arabic equivalent texts will be provided by the business.
Display Text – English
Display Text – Arabic
OLO Tools
OLO ONT Line Status Enquiry
Display of OLO ONT Line Status
ONT Line Status Enquiry Results
ONT Status
Current Link Quality
ONT Signal RX
ONT Signal TX
OLT Signal RX
OLT Signal TX
ONT Latency
ONT Speed
ONT Signal RX History
ONT Signal TX History
Parameter
Value
Time
Date
Successfully retrieved the data
There was an error retrieving the data
Error Source System
Source Error Code
Error Code
Error Type
Error Description English
Error Description Arabic
Network Analyzer not applicable for Open Access seeker lines
Test Scenarios
#Sr
Use Case
Scenario
Target
Expected Result
Status
Remark
1
Network Analyzer Summary Widget
Network Analyzer Summary Widget for OLO Customers.
OV
For OLO customers when the number is searched in Oneview, the Network Analyzer summary widget should display message “Network Analyzer is not applicable for Open Acess seeker lines”
2
Network Analyzer Summary Widget
Network Analyzer Summary widget for STC Customers.
OV
For STC customers when the number is searched in Oneview, the Network Analyzer summary widget should display the details fetched from Network Analyzer backend.
3
Advanced Diagnostics
New link in Advanced Diagnostics for OLO Customers.
OV
For the OLO customers there should be a new link in the Advanced Diagnostics section in Oneview “OLO Tools”-> “OLO Line Status Enquiry”.
4
Advanced Diagnostics
No OLO Tools link for the STC Customers.
OV
For the STC customers there should not be any link “OLO Tools”-> “OLO Line Status Enquiry” in the Advanced Diagnostics section.
5
Advanced Diagnostics
Fetch and display OLO line information for OLO customers.
OV
For OLO customers, when the agent clicks on link “OLO Tools”-> “OLO Line Status Enquiry” in the Advanced Diagnostics section, Oneview should fetch the information from BSST EAI/APIM/OLO and display the information as applicable and available from the OLO systems.
6
MiniOneview 360 view
OLO section should not appear in 360 view for OLO customers.
OV
For OLO customers there will be no OLO section shown in the 360 view when Mini Oneview screen is loaded.
7
MiniOneview Tools
“OLO Line Status Enquiry” to be shown under “Internet Tools” for OLO customers.
OV
For OLO customers the link OLO Line Status Enquiry should appear under “Internet Tools” in the “Tools” section when Mini Oneview screen is loaded for OLO customers.
8
NAF Utility Links
NAF Utility links should be hidden for OLO customers.
OV
For OLO customers the utility tools links should not appear under “Internet Tools” in the “Tools” section when Mini Oneview screen is loaded for OLO customers.
STC IT SystemsOLO ProvidersCC/BO AgentCC/BO
