id
stringlengths 14
14
| text
stringlengths 2
2.42k
| source
stringclasses 1
value |
|---|---|---|
90dbf0adde87-0 | 3550
Please find the AOM External Interface Spec here
Implementation
GetStockAvailability Soap Connector Activity
Activity Name : GetStockAvailability
AppliesToClass: VFUK-FW-AOMFW-Int-TIL-StockAvailabilityAPI
Implementation
EndpointURL, TransactionID, TIL Header, ServiceNumber are set to the SOAP VFUK-FW-AOMFW-Int-TIL-
StockAvailabilityAPI_RequestVFUK-FW-AOMFW-Int-TIL-GSA-Query Supporting classes for
StockAvailabilityAPI_Request
VFUK-FW-AOMFW-Int-TIL-GSA-QueryCriteria Supporting classes for
StockAvailabilityAPI_Request
VFUK-FW-AOMFW-Int-TIL-GSA-QueryExpression Supporting classes for
StockAvailabilityAPI_Request
VFUK-FW-AOMFW-Int-TIL-GSA-ValueExpression Supporting classes for
StockAvailabilityAPI_Request
VFUK-FW-AOMFW-Int-TIL-GSA-QueryItemListResponse Supporting classes for
StockAvailabilityAPI_Response
VFUK-FW-AOMFW-Int-TIL-GSA-ItemIdentification Supporting classes for
StockAvailabilityAPI_Response
VFUK-FW-AOMFW-Int-TIL-GSA-InventoryLocation Supporting classes for
StockAvailabilityAPI_Response
VFUK-FW-AOMFW-Int-TIL-GSA-LocationReference Supporting classes for
StockAvailabilityAPI_Response
VFUK-FW-AOMFW-Int-TIL-GSA-LocationIdentification Supporting classes for
StockAvailabilityAPI_Response
VFUK-FW-AOMFW-Int-TIL-GSA-CustomInventoryLocation Supporting classes for
StockAvailabilityAPI_Response
VFUK-FW-AOMFW-Int-TIL-GSA-ItemQuantityDetails Supporting classes for
StockAvailabilityAPI_Response
VFUK-FW-AOMFW-Int-TIL-GSA-Status Supporting classes for
StockAvailabilityAPI_Response | VODKB-200723-160306.pdf |
90dbf0adde87-1 | StockAvailabilityAPI_Response
VFUK-FW-AOMFW-Int-TIL-GSA-ProductStockAvailability Supporting classes for
StockAvailabilityAPI_Response
VFUK-FW-AOMFW-Int-TIL-ResultStatus Supporting classes for TIL Response
GSA.xlsx
18 Feb 2021, 12:40 PM | VODKB-200723-160306.pdf |
45ba5881bc4f-0 | 3551
StockAvailability SOAP Connector is invoked using the EndpointURL loaded from AOM Config
VFUK-FW-AOMFW-Int-TIL-ProcessedServiceListAPI_Reponse contains the ResultStatus object which explains if the request was
successful.
Primary.Response.ResultStatus.Severity, "S" to confirm if it's successful and all other responses are treated as failures and only one
re-try has to be triggered if there are any 5XX error immediately.
In the case of failure, Error data is pushed into CreateErrorLog Table
For Generic Errors, Error Code=1041 is set and data is pushed into CreateErrorLog.
StockAvailabilityAPISimulationActivity ( Stubbed Response)
Activity Name : StockAvailabilityAPISimulationActivity
AppliesToClass: VFUK-FW-AOMFW-Int-TIL-StockAvailabilityAPI
Implementation
StockAvailabilityAPISimulationActivity is a simulation activity to get the subbed response in case of the real service is not
available or for testing purposes.
Activity is configured on the StockAvailability SOAP Connector rule by clicking the Simulations button on the Service tab. An activity
can be configured for Global or User Session and can be cleared after testing.
The activity contains a Data-Transform to stub the data, currently, it contains the response for a successful and error scenario.
GetProductStockAvailabiity Activity
Activity Name : GetProductStockAvailabiity
AppliesToClass: Code-Pega-List
Implementation
This activity is invoking from the Data page
The aim of the activity is to invoke the PrepareGetStockAvailabiityRequest activity to have a prepared request then invoking the
connector activity to connect-SOAP. After connecting the SOAP, the response is set up in the activity. | VODKB-200723-160306.pdf |
45ba5881bc4f-1 | connector activity to connect-SOAP. After connecting the SOAP, the response is set up in the activity.
If cannot connect-Soap or failed during getting a response, invoking the SetDefaultGSAResponse activity to have a dummy
response to return to the DataPage
Response processing had to be handled as mentioned below
If the API continues to fail post retry activity should return Page List with Details:
ProductId - as per input
StockLocation - as per input
Quantity - 0
QuanityStatus - "Stock Details Unavailable"
For Each Product in Response, simply the response as below and build a page list which will be consumed by Decisioning Layer
ProductId - ItemIdentification.ID
StockLocation - InventoryLocation.LocationReference.LocationIdentification.ID
Quantity - Custom.Quantity
QuantityStatus - Custom.ItemQuantityDetails.Status
OrderLimit - Custom.ItemQuantityDetails.OrderLimit
PrepareGetStockAvailabilityRequest Activity
Activity Name : PrepareGetStockAvailabilityRequest
AppliesToClass: VFUK-FW-AOMFW-Int-TIL-StockAvailabilityAPI_Request
Implementation
This activity is invoking from GetProductStockAvailability activity. | VODKB-200723-160306.pdf |
24a7ba169f01-0 | 3552
The aim of the activity is to prepare the request setup.
Multiple Input ProductIds and StoreLocationIds are split and build the valid GSA SOAP request.
SetDefaultGSAResponse Activity
Activity Name : SetDefaultGSAResponse
AppliesToClass: Code-Pega-List
Implementation
This activity is invoking from GetProductStockAvailability activity.
The aim of the activity is to prepare a dummy response when the response is unreachable from the SOAP connector or has failed.
ConvertAOMChannelToCommonChannel
DataTranform Name : ConvertAOMChannelToCommonChannel
AppliesToClass: VFUK-FW-AOMFW-Int-TIL-GSA-QueryCriteria
Implementation
This DataTransform is invoking from the PrepareGetStockAvailabilityRequest activity and converting the AOM channel to the
common channel.
D_GetStockAvailability Datapage
This data page will be involved/consumed by the Decisioning layer by passing the below input and expecting the data in the output format
described below
Name : D_GetStockAvailability
Object type/AppliesToClass: VFUK-FW-AOMFW-Int-TIL-GSA-ProductStockAvailability
Structure : PageList
Scope: Requestor
Cache Strategy: None
Input to the DataPage
CustomerAccountType (String)
{LOV: Small-Business, Consumer, Sole-Trader, Small-SME, Partner-Managed, CORPORATE, GROUP_CORPORATE, Regional,
Major }
Channel (String)
ProductIdList (Comma Separated Text)
StockLocationList (Comma Separated Text)
The output from the DataPage
Page List - Page Per Product and Stock Location & Amount
Response Page Structure {Class Name: VFUK-FW-AOMFW-Int-TIL-GSA-ProductStockAvailability}
ProductId - String | VODKB-200723-160306.pdf |
24a7ba169f01-1 | ProductId - String
StockLocation - String
Quantity - Integer
QuantityStatus (Optional) - String
OrderLimit (Optional) - Integer
AOM Config | VODKB-200723-160306.pdf |
57d16ca79160-0 | 3553
APIEndpoint StockAvailability <<TIL_URL>>ConfigType ConfigName ConfigValue | VODKB-200723-160306.pdf |
5b9610766412-0 | 3554
Get Customer Party List (GCPL)
Description
Rule Names
Class Names
GetCustomerPartyList Activity
SetupCustomerPartyListRequest
Caching Strategy
AOMConfig
Stub Responses
Description
APIGetCustomerPartyList retrieves the list of customer accounts and summary details matching the search criteria.
GCPL will be used to provide relevant Account Details back to logic (through a data page) to perform RT analysis for Customer Cohorts etc.
Rule Names
Class NamesD_GetCustomerPartyList
D_GetFullDetailsForAccountClass: VFUK-FW-AOMFW-Data-Account
Params:
AccountNumber
Account Type
Refresh strategy: 30 Mins
Return Type: Page
GetCustomerPartyList Connector Handler Activity:
Calls the Connect-REST rule and handles the
response
CustomerPartyList REST Connector Rule
VFUK-FW-AOMFW-Int-TIL-CustomerPartyListAPI Connector Class
VFUK-FW-AOMFW-Int-TIL-CustomerPartyListAPI_Request Request Class
VFUK-FW-AOMFW-Int-TIL-CustomerPartyListAPI_Response Response Class
CustomerPartyListSimulationActivity Simulation activity for Connect REST rule
CustomerPartyListSimulationResponse Simulation data transform for response simulationRule Name Type
VFUK-FW-AOMFW-Int-TIL-CustomerIdentification4 New class for Section
VFUK-FW-AOMFW-Int-TIL-Account New class for Section
VFUK-FW-AOMFW-Int-TIL-CustomerParty New class for SectionClasses Detail | VODKB-200723-160306.pdf |
6f18281bad69-0 | 3555
Please find the AOM External Interface Spec here
GetCustomerPartyList Activity
Set Endpoint, TransactionId and Timestamp - Endpoint will be added to AOMConfig.
Set Local variable MSISDN. If we have an Identifier of type MSISDN then this is set in order to log in to the AOM_Error table.
Call new Data Transform to validate input and set up the request - SetupCustomerPartyListRequest.
Handle any error from the Data Transform.
Set the request Header mandatory properties - source, date and transactionID
Browse the CustomerPartyListResponse Dataset with the keys, If IsPageListEmpty is not empty copy the page and jump to Fin, else;
Invoke REST Connector - CustomerPartyList
If the service call fails, there should be 1 retry on 5XX failure (if returned error starts with “5”, eg “500”). If retry fails, record error. Add
Loop step to the activity to handle retry.
Any errors is made visible through AOM_Error with the relevant Error details. Write error details to AOM_Error table.
Write to AOM_Audit table with relevant details.
Add error code for "Error in GetCustomerPartyList: " to AOM Error Codes document in Confluence.
SetupCustomerPartyListRequest
Check if any of the mandatory fields are empty or null - IdentifierType, Identifier, ResponseCode. If any fields are missing then set the
ErrorMessage.
Set ResponseCode and AccountType on the request.VFUK-FW-AOMFW-Int-TIL-Organisation New class for Section
VFUK-FW-AOMFW-Int-TIL-Contact New class for Section
VFUK-FW-AOMFW-Int-TIL-Person2 New class for Section
VFUK-FW-AOMFW-Int-TIL-ContactPoints New class for Section | VODKB-200723-160306.pdf |
6f18281bad69-1 | VFUK-FW-AOMFW-Int-TIL-ContactPoints New class for Section
VFUK-FW-AOMFW-Int-TIL-ContactPoint New class for Section
VFUK-FW-AOMFW-Int-TIL-Characteristics New class for Section
VFUK-FW-AOMFW-Int-TIL-Telephone New class for Section
VFUK-FW-AOMFW-Int-TIL-Fax New class for Section
VFUK-FW-AOMFW-Int-TIL-Email New class for Section
VFUK-FW-AOMFW-Int-TIL-Address New class for Section
VFUK-FW-AOMFW-Int-TIL-Specification New class for Section
VFUK-FW-AOMFW-Int-TIL-Attribute New class for Section
VFUK-FW-AOMFW-Int-TIL-RelatedParties New class for Section
VFUK-FW-AOMFW-Int-TIL-RelatedParty New class for Section
VFUK-FW-AOMFW-Int-TIL-BillingProfile New class for Section
VFUK-FW-AOMFW-Int-TIL-AdditionalInfo New class for Section
VFUK-FW-AOMFW-Int-TIL-Classification New class for Section
VFUK-FW-AOMFW-Int-TIL-Period Existing class stayPeriod
VFUK-FW-AOMFW-Int-TIL-SellingProfile New class for Section | VODKB-200723-160306.pdf |
635cd588dbcd-0 | 3556
The value of IdentifierType will determine which property is on request.customer identifier is set
If IdentifierType = “CustomerPartyID“ then set customerIdentifier.customerPartyID to the value of Identifier.
If IdentifierType = "MSISDN" then set customerIdentifier.MSISDN to the value of Identifier.
If IdentifierType = "FLN" then set customerIdentifier.FLN to the value of Identifier.
If IdentifierType = "BB_SERVICEID" then set customerIdentifier.bb_serviceID to the value of Identifier.
If IdentifierType = "ContactID" then set customerIdentifier.contactID to the value of Identifier.
If IdentifierType = "UserName" then set customerIdentifier.userName to the value of Identifier.
Caching Strategy
AOMConfig
Stub Responses
CustomerPartyListSimulationActivity & CustomerPartyListSimulationResponse (Data Transform)
Simulation activity for testing and data transform to create test data. CustomerPartyListSimulationActivity is added as a Simulation
activity to CustomerPartyList Connect-REST rule.
Simulation Data for testingDataset Name CustomerPartyListResponse
Dataset Keys Identifier
IdentifierType
Class Property name Property Type Description
IdentifierType Text To browse/save response to
CustomerPartyListResponse Dataset
Identifier Text To browse/save response to
CustomerPartyListResponse Dataset
CustomerPartyListResponse Single Page To store Response of CustomerPartyListClass Name VFUK-FW-AOMFW-Data-CustomerPartyList
TimeToLive CustomerPartyList 14400 (4hours*60min*60sec)
APIEndpoint CustomerPartyList http://get-this-url-from-TIL-debarshiConfigType ConfigName ConfigValue
Search by
CustomerPartyID.
Returns full
CustomerParty responseCustomerPartyID 11112222 FULL
Search by | VODKB-200723-160306.pdf |
635cd588dbcd-1 | Returns full
CustomerParty responseCustomerPartyID 11112222 FULL
Search by
CustomerPartyId. 1 retry CustomerPartyID 99990000 FULLDescription IdentifierType Identifier AccountType (User,
Owner, Billing)ResponseCode (FULL,
BILLINGPROFILE) | VODKB-200723-160306.pdf |
598ab26856d0-0 | 3557
of Connect-REST and
error 500 returned.
Search by
CustomerPartyID.
CustomerParty does not
exist.CustomerPartyID 99991111 FULL
Invalid ResponseCode -
error returnedAny valid value 11112222 Set to any value other
than FULL or
BILLINGPROFILE
Invalid AccountType -
error returnedAny valid value 11112222 Set to any value other
than User, Owner or
BillingAny valid value
Search by MSISDN.
Returns full
CustomerParty responseMSISDN 12345 FULL
Search by MSISDN.
CustomerParty does not
exist.MSISDN 99999 FULL
Search with invalid
IdentifierType. Returns
errorAny invalid value 11112222 FULL
Mandatory IdentiferType
not populated. Returns
errornull or empty 11112222 FULL
Mandatory Identifer not
populated. Returns errorCustomerPartyID null or empty FULL
Mandatory
ResponseCode not
populated. Returns errorCustomerPartyID 11112222 null or empty | VODKB-200723-160306.pdf |
0648f926961f-0 | 3558
Get Live Account Information Data Page (AOM-2734)
Create new class for LiveAccountDetails VFUK-FW-AOMFW-Int-TIL-GCPL-LiveAccountDetails.
Create a property NumberOfPostPayMobileServices under that class.
D_GetLiveAccountInformation datapage on VFUK-FW-AOMFW-Int-TIL-GCPL-LiveAccountDetails class:
Parameters:
AccountNumber (customerPartyID)
AccountType (Owner, User, Billing)
Cache: ( R3.05 -889676)
30 minutes
Update Scope to Requestor
One Load Management Tab
Enable Reload once per interaction
Enable Clear pages after non-use
Enable Limit to a single data page
Source:
GetLiveAccountInformation Activity
GetLiveAccountInformation Activity:
Call GetCustomerPartyList activity with parameters from datapage and get response in GCPL page
Loop through GCPL.response.body_POST.customerParty.account.specification.attribute list
Check for Name as NumberOfPostPayMobileServices and get the value and set it to Primary.NumberOfPostPayMobileServices
property.
End of Loop
Update DataTransform CustomerPartyListSimulationResponse to set required response for NumberOfPostPayMobileServices property | VODKB-200723-160306.pdf |
22b6e11801cf-0 | 3559
Catalogue Sync
Description
Class Structure
CatalogueData - Properties
Configuration
Loader Process Changes
CatalogueSyncHandler--Activity
CatalogueSync-REST-Connector
Watchdog Report Config
Description:
CatalogueSync is a REST service exposed by PM Tool which is invoked by AOM Loader process to sync the product catalogue data.
Class Structure:
Please find the AOM External Interface Spec here
CatalogueDataRequest - Properties:VFUK-FW-AOMFW-Data-TariffStaging pc_tariff_st identifier Identifier
VFUK-FW-AOMFW-Data-PaymHandsetStaging pc_paym_handset_st identifier identifier
VFUK-FW-AOMFW-Data-AccountServiceStaging pc_acct_service_st identifier identifier
VFUK-FW-AOMFW-Data-DiscountStaging pc_discount_st identifier identifier
VFUK-FW-AOMFW-Data-AccessoriesStaging pc_accessories_st identifier identifier
VFUK-FW-AOMFW-Data-BarStaging pc_barred_product_st identifier identifier
VFUK-FW-AOMFW-Int-PMT-CatalogueSyncAPI Top Level Class for all the Request and Response supporting class
structure
VFUK-FW-AOMFW-Int-PMT-CatalogueSyncAPI_Response response
VFUK-FW-AOMFW-Int-PMT-CatalogueSyncAPI_Request request
VFUK-FW-AOMFW-Int-PMT-CatalogueSyncRequestBody request.body_POST
VFUK-FW-AOMFW-Int-TIL-Header request.header_POST & response.header_POST
VFUK-FW-AOMFW-Int-PMT-CatalogueData CatalogueData in CatalogueSyncAPI.request.body_POST
VFUK-FW-AOMFW-Int-PMT-Error Error Class in response.body_POSTRule Name DB Table DB Key Key | VODKB-200723-160306.pdf |
e951f9d39b0c-0 | 3560
Configuration:
AOMConfig:VFUK-FW-AOMFW-Int-PMT-CatalogueData NA NA NAName DB Table DB Key Key
Identifier Text Mandatory Unique Identifier (ex - DP_XXXX,P_XXXXX, AP_XXXX)
ChangeIdentifier Text Mandatory I - Insert, A - Append, D - Delete
ProductId Text Mandatory ProductFullfillmentCode (ex - 110826,111148)
ProductName Text Mandatory Name of the Product (ex - 12mth Dongle 2048MB)
ProductCategory Text Mandatory Type of Product LOV: Handset, Discount, Tariff, Accessory, Service
StartDate String Mandatory Start Date of The Product (1900-01-01)
EndDate String Mandatory End Date of the Product(2050-12-31)
Attributes TextValueGroupOptional Attribute Key/Value PairPropertyName Type Mandatory/Opt
ionalSource
FileAttributes pc_tariff {"InputFilePattern":"TARIFFS_[0-9]
{14}_.*.dsv.zip.gpg",”CatalogueSync”:”true”}
FileAttributes pc_discount {"InputFilePattern":"DISCOUNTS_[0-9]
{14}_.*.dsv.zip.gpg",”CatalogueSync”:”true”}
FileAttributes pc_accessories {"InputFilePattern":"ACCESSORIES_[0-9]
{14}_.*.dsv.zip.gpg",”CatalogueSync”:”true”}
FileAttributes pc_acct_service {"InputFilePattern":"ACC_SERVICES_[0-9]
{14}_.*.dsv.zip.gpg",”CatalogueSync”:”true”}
FileAttributes pc_paym_handset {"InputFilePattern":"HANDSETS_[0-9]
{14}_.*.dsv.zip.gpg",”CatalogueSync”:”true”} | VODKB-200723-160306.pdf |
e951f9d39b0c-1 | {14}_.*.dsv.zip.gpg",”CatalogueSync”:”true”}
FileAttributes pc_barred_product {"InputFilePattern":"BARS_[0-9]{14}_.*.gpg" ,
"CatalogueSync":"true" ,
"PositiveVariationPercentage":10 ,
"NegativeVariationPercentage":10}
APIBatchSize CatalogueSync 1000
APIEndPoint CatalogueSync http://localhost:8080/prweb/PRRestService/PMToolS
ervices/V1/CatalogueSync
BRBModeActivated ProductCatalogue TRUE/FALSE
CatalogueSync RetryCount 3ConfigType ConfigName ConfigValue | VODKB-200723-160306.pdf |
6ea7992f8edb-0 | 3561
Loader Process Changes:
Introduce new process for CatalogueSync Activity After BDC Model Load Process at the end of the PROCESS stage
Have a When Rule to Invoke this process is If the Case Sub type is ProductCatalogue
Step - InvokeCatalogueSync (VFUK-FW-AOMFW-Work-Loader)
Reading APIBatchSize from AOMConfig and assigning to BatchSize Local variable.
Iterate through loader entities.
Check if the CatalogueSync is True for each Loader Entity and copy to new LoaderEntity Page If True else Exit the Iteration.
Call InvokeTariffsCatalogueSync when EntityName is pc_tariffs
Call InvokeDiscountsCatalogueSync when EntityName is pc_discounts,
Call InvokePaymHandsetsCatalogueSync when EntityName is pc_paym_handsets
Call InvokeAccessoriesCatalogueSync when EntityName is pc_accessories,
Call InvokeServicesCatalogueSync when EntityName is pc_act_services
Call InvokeBarsCatalogueSync when EntityName is pc_barred_product
Fine Below steps to perform Entity specific activities.
Create new pages for CatalogueSyncAPI
Initialize Local variables (TotalRecords, BatchSize, RecordCount, PageNumber) and ProductCategory,CurrentEnvironment of API
request body
Perform Obj-Browse on Loader Entity Staging Class
Iterate the Entity Page List for APIBatchSize interval times by checking record counter and page number in the loop
Populate CatalogueData in to catalogue sync API request post body
Call InitialiseConnectQueueStatus (This invokes ProcessQueueItem that will trigger the CatalogueSyncHandler )
SourceId - CaseId
HandlerName - CatalogueSync
PayLoad - JSON of request body.
Capture if Any Errors in the Obj-Browse step and store in AOM_Error table. | VODKB-200723-160306.pdf |
6ea7992f8edb-1 | Capture if Any Errors in the Obj-Browse step and store in AOM_Error table.
Catch If any errors thrown by entity specific activities and propogate the errors back loader case errorstacktrace to put the request in
NotifySupport queue.
CatalogueSyncHandler Activity:
Activity Name : CatalogueSyncHandler
AppliesToClass: VFUK-FW-AOMFW-Data-ConnectQueueStatus
Populate the Endpoint, TransactionId, RetryCount, RetryInnterval
Implementation
Create CatalogueSyncAPI Page
Load the request payload in to CatalogueSyncAPI Page
Setup the Request Headers
Loop Through the Retry count configuredCatalogueSync RetryInterval 30 seconds
GenericRuntimeParameters CurrentEnvironment AOM-DEV
CaseId CatalogueSyncConnectQueueErrorsWatchDog W-61091
CaseStatus CatalogueSyncConnectQueueErrorsWatchDog Completed
SkipCaseFinaliseEmail CatalogueSyncConnectQueueErrorsWatchDog TRUE | VODKB-200723-160306.pdf |
b0f3c41275a9-0 | 3562
Wait for the Retry Interval
Call Connect REST
Capture the Response from The REST API
Handle Non 201 HTTP Error Codes - Capture them in AOM_ERROR table
Retry If the HTTP Error code returned is 500
CatalogueSync REST Connector
Create new Connect REST for Catalogue Sync
Configure Simulations For Unit Testing on Non Integrated Environment
WatchdogReport Config:
Add below conifguration entries to WatchdogConfig Data to reuse the IdentifyConnectQueueStatusErrors reports.
WatchDogConfig:
AlertConfig:
SchedulerConfig:CatalogueSy
ncConnectQ
ueueErrorsVFUK-FW-
AOMFW-
Data-
ConnectQue
ueStatus IdentifyConnectQ
ueueStatusErrorsError Catalogue
Sync Error
Alert: Notifies
the errors
occured in
catalogue sync{"HandlerName":"Cat
alogueSync","ErrorC
ount":"1","ErrorString
":"Error","IntervalPeri
od":"24","IntervalTyp
e":"hours"}TRUE CSVName ClassName SQLR
uleReportDefinition Severi
tyDescription DynamicParametersIncludeAsAtt
achmentAttachmentT
ype
CatalogueSyncConnectQueueEr
rorsWatchDog All
CatalogueSyncConnectQueueEr
rorsWatchDog Error
CatalogueSyncConnectQueueEr
rorsWatchDog Fatal
CatalogueSyncConnectQueueEr
rorsWatchDog Info
CatalogueSyncConnectQueueEr
rorsWatchDog Success
CatalogueSyncConnectQueueEr
rorsWatchDog Warning Alert Process Severity Email | VODKB-200723-160306.pdf |
cd13236c32c6-0 | 3563
CaseIgnitor {"CaseSubType":"
CatalogueSyncC
onnectQueueErro
rs"}VFUK-FW-
AOMFW-Work-
WatchDog0 * ? * * * TRUE WatchDogpyGUID ActivityName ActivityParameter
sClassName CronExpression Enabled Type | VODKB-200723-160306.pdf |
809e5b3584f8-0 | 3564
Get Processed Service List (GPSL)
GPSL is a SOAP service exposed by TIL which returns the Offers and Product details for a given Service Number/MSISDN.
GetProcessedServiceList Activity
ProcessedServiceList DataSet
VFUK-FW -AOMFW -Data-ProcessedServiceList
ProcessedServiceList Connect SOAP
GetProcessedServiceListTH Activity
ProcessedServiceListSimulation Activity
VFUK-FW-AOMFW-Int-TIL-ProcessedServiceListAPI Connector Class
VFUK-FW-AOMFW-Int-TIL-ProcessedServiceListAPI_Request GPSL Request Class
VFUK-FW-AOMFW-Int-TIL-ProcessedServiceListAPI_Response GPSL Response Class
ProcessedServiceList SOAP Connector Rule
GetProcessedServiceList Connector Activity
ProcessedServiceListSimulationActivity Simulation Activity (Configured on the SOAP
Connector Rule)
GetProcessedServiceListTH Test Harness ActivityRule Name Type
This activity browses the ProcessedServiceList Cassandra dataset for a given account number. If the dataset has records then the results
are copied into the Primary page, else the ProcessedServiceList Connect SOAP rule is executed to get the response from TIL and Call
DiscardProductList activity to discard root products whose PromotionId or RootProductId matches with AOMBusinessConfig values and to
discard child products whose ProductId matches with AOMBusinessConfig values from the response and the results are copied into both the
Primary page and the Cassandra dataset.
Applies To VFUK-FW-AOMFW-Int-TIL-ProcessedServiceListAPI
Ruleset AOMFW-Int
Error Handling Includes below error handlers to catch the errors and capture the error info in audit log.
Primary Error handler
TILL Error Handler
Connect SOAP ProcessedServiceListGetProcessedServiceList Activity
This dataset stores the ServiceList for a given account numberProcessedServiceList DataSet | VODKB-200723-160306.pdf |
912f9ea7ce0a-0 | 3565
Applies To VFUK-FW-AOMFW-Data-ProcessedServiceList
Ruleset AOMFW-Database
Dataset Keys AccountNumber
PropertyName Type Sample Value
AccountNumber Text 23456789
ServiceList Page (VFUK-FW-AOMFW-Int-TIL-ServiceList) VFUK-FW-AOMFW-Data-ProcessedServiceList
This activity invokes the TIL service on the endpoint configured in AOMConfig - APIEndPoint for ProcessedServiceList
Applies To VFUK-FW-AOMFW-Int-TIL-ProcessedServiceListAPI
Ruleset AOMFW-Int
Simulation Activity ProcessedServiceListSimulationActivity
Request VFUK-FW-AOMFW-Int-TIL-ProcessedServiceListAPI_Request
Response VFUK-FW-AOMFW-Int-TIL-ProcessedServiceListAPI_ResponseProcessedServiceList Connect SOAP
This is Test Harness activity which Invokes GetProcessedServiceList bypassing the AccountNumber
Applies To VFUK-FW-AOMFW-Int-TIL-ProcessedServiceListAPI
Ruleset AOMFW-Int
Input Paramter AccountNumberGetProcessedServiceListTH Activity
This is simulation activity which invokes ProcessedServiceListSimulationResponse data transform for stubbing GPSL response.
Applies To VFUK-FW-AOMFW-Int-TIL-ProcessedServiceListAPI
Ruleset AOMFW-Int
Data Transform ProcessedServiceListSimulationResponseProcessedServiceListSimulation Activity | VODKB-200723-160306.pdf |
7282b4b2bd45-0 | 3566
IMI -Inbound Webhook Events
Description
Class Structure
Connector Activity
RuleName
SendEmail
Helper Activity
RuleName
Description
Inbound Webhooks are unique endpoints that can be embedded into AOM to notify imiconnect of events occurring in the AOM
Here is the link IMI Spec
Class Structure
Connector Activity VFUK-FW-AOMFW-Int-IMI Top Level Class for all IMI Integrations
VFUK-FW-AOMFW-Int-IMI-InboundWebhookAPI Inbound Webhook Events Class
VFUK-FW-AOMFW-Int-IMI-InboundWebhookAPI-Request IMI Webhook Request Class
VFUK-FW-AOMFW-Int-IMI-InboundWebhookAPI-Response IMI Webhook Request Class
VFUK-FW-AOMFW-Int-IMI-Data Data Class
VFUK-FW-AOMFW-Int-IMI-DeliveryDetails Class to populate all the Delivery information
VFUK-FW-AOMFW-Int-IMI-Offer Class to populate all the Offer Details
Connect Rest Rule
AppliesToClass : VFUK-FW-AOMFW-Int-IMI-InboundWebhookAPIWebhookEvent
Token Profile rule:
RS: AOM-IntIMIEmailJWT
Keystore:
RS: AOM-Intaom-imi-dev-secretRule Name Type
This activity connector activty, which will invoke the connector rule and
process the response RuleNam
eSendEmail | VODKB-200723-160306.pdf |
eebd59696d44-0 | 3567
Helper Activity
Applies
ToVFUK-FW-AOMFW-Int-IMI-InboundWebhookAPI
Ruleset AOMFW-Int
Error
HandlingIncludes below error handlers to catch the errors and capture the
error info in audit log.
Primary Error handler
IMI Error Handler
Connect
RestWebhookEvent
Activity
LogicCreate the JWT Token. This is created using the
IMIEmailJWT Token Profile Rule.
Prepare the request & header values ( as per the spec)
Invoke the VFUK-FW-AOMFW-Int-IMI-
InboundWebhookAPI.WebhookEvent connect rest rule
Do the Error and Audit Logging
This activity will prepare the request parsing the multipe SR pages which are ouput of the logic processing
Applies To VFUK-FW-AOMFW-Int-IMI-InboundWebhookAPI
Ruleset AOMFW-Int
Error Handling Includes below error handlers to catch the errors and capture the error info in audit log.
Primary Error handler
IMI Error Handler
Activity Logic check if, Payload contains valid JSON else throw an error and Move the record into email_send_queue table
after marking it as an Error
Adopt the JSON into SR Page
Populate Header ( Content-Type and Authorization will be on connect-rest rule )
Populate DeliveryDetails Object using the parent SR Page ( Mapping is provided in the External Interface Spec)
Populate the Offer block with the Offer/Treatments details
Token replace should be done before setting the data onto SR.TreatmentAttributes
Populate the Offer.Attributes Value Group using the SR.TreatmentAttributes
Loop through the SR.TreatmentList ( for each Child Offer)
Populate the ChildOffer block with the Offer/Treatments details | VODKB-200723-160306.pdf |
eebd59696d44-1 | Populate the ChildOffer block with the Offer/Treatments details
Token replace should be done before setting the data onto SR.TreatmentAttributes
Populate the ChildOffer.Attributes Value Group using the SR.TreatmentAttributesRuleName PrepareRequest | VODKB-200723-160306.pdf |
4be2d933fe89-0 | 3568
POC - JWT Authentication
JWT - JSON Web Token
JWT is an open standard that defines a compact and self-contained method to securely exchange information between different parties as
a JSON object. For example, the token can contain information about a user that another party can use to validate the identity of the user.
Create a JSON Web Token (JWT) profile data instance to confirm a user's identity between two different processes. You can configure
Pega Platform to act as both a producer or a consumer of JWT.
Generation token profiles
A generation token profile specifies how Pega Platform generates a given JWT.
Processing token profiles
A processing token profile specifies how Pega Platform validates the signature and decrypts each JSON Web Token that it receives.
Before generating a JWT, create a generation JWT profile to specify how Pega Platform generates a JWT.
Create activity to generate JWT
In your activity, add a step to call the activity pxGenerateJWT, and pass these parameters:
profileName - Enter the token profile name that you created.
jwtPageName - Enter the JWT clipboard page name.
inputPagaName - Enter the page name that contains input data used in a custom claim.
payloadPageName - Enter the page name from which you want to map properties.
payloadCustomKeyName - Enter the node name where the data is generated. The default name is pyData.
excludedPropertiesJWTList - Enter a comma-separated list of properties to exclude from the node.
outputPegaName - Enter the generated JWT.
Preview the JWT
Records -> Security -> Token Profile.
on Generation tab, click Preview
POC:
Generation JWT Profile - POC_JWT_Profile (AOMFW-Testing)
This is a Generation token profile.
By default Pega Platform automatically adds the following parameters to the JWT header when it generates the token: | VODKB-200723-160306.pdf |
4be2d933fe89-1 | By default Pega Platform automatically adds the following parameters to the JWT header when it generates the token:
alg – The configured JWS algorithm, if you added one, in the Security section, on the Generation tab.
typ – The type is always JWT.
Add the following Registered Claim:
Issuer (iss) - Y2VjYjgzNDlkYzY4NDhiODgzYTU1ZjUzY2QxNzFjMDM= <<This is the iss (or Service Id) provided by IMI>>
Add Security Signature for Verification:
Security:
Security Configuration: Signature
JSON Web Signature (JWS):
Signature type: Symmetric
Signature algorithm: HS256 | VODKB-200723-160306.pdf |
086f4377b7cf-0 | 3569
Keystore: aom-imi-dev-secret <<This is the name of the Keystore created to hold the Verification Secret String provided by IMI>>
Alias: aom-imi-secret <<Alias for Secret String in Keystore>>
Password: headpiece-stubborn-banjo <<Current password for this Keystore>>
Keystore - aom-imi-dev-secret (AOMFW)
This Keystore is created in Pega to hold the Verification Secret String provided by IMI. This is used to sign the token.
Note: This string should be a decoded string (not a base 64 encoded string). Previously IMI had provided us with the encoded string, which
then needed to be decoded before adding to the Keystore.
<<Asit can help create the Keystore - he will create a file with the string and upload to the Keystore>>
Test Activity - POC_Generate_JWT (RS: AOMFW-Testing)
This simple test activity generates a JWT token using the POC_JWT_Profile profile
Calls the pxGenerateJWT activity passing the following parameters:
profileName: POC_JWT_Profile
outputPageName: JWTOutputPage
Add JWTOutputPage - Embed-Token-JsonWebToken to Pages & Classes tab
JWTOutputPage (Embed-Token-JsonWebToken) is output from call to pxGenerateJWT.
JWTOutputPage.pyJWT holds the token generated.
Test Activity - TestJWTToken (RS: AOMFW-Testing) -
This activity is used to test the response of a call to IMI. The activity does the following:
Creates the JWT token as above.
Calls the WebhookEvent Connect REST rule , setting the EndPointURL to "https://hooks.imiconnect.io/events/COGW0VAE36”
Displays page showing the Response of the call to IMI | VODKB-200723-160306.pdf |
086f4377b7cf-1 | Displays page showing the Response of the call to IMI
Credentials supplied for IMI connectivity:
Connect endpoint: https://hooks.imiconnect.io/events/COGW0VAE36
Service ID (iss): Y2VjYjgzNDlkYzY4NDhiODgzYTU1ZjUzY2QxNzFjMDM=
Service Secret: M2Q0MTVmNGU3Nzk3NGVhOTkyODE4YzgwZmQxN2Y3NzQ= <<Used for Verification Signature. This is the base 64
encoded string.>>
Decoded Secret is 3d415f4e77974ea992818c80fd17f774 <<The decoded string needs to be used in the Pega JWT Profile, stored in
the Keystore>>
Pega Keystore details:
Keystore name: aom-imi-dev-secret
Alias name: aom-imi-secret
pw: <<See environment spreadsheet>>
Notes:
Token Lifetime is set in the Token Profile rule - Token lifetime → Valid till (in seconds). This cannot be dynamically set (eg. from
config) in the Token Profile. To update this, you can access the property .pyExpiryTime on the JWT token output page (eg
JWTOutputPage.pyExpiryTime).
If different JWT credentials are required for different environments
We may need to create environment-specific Token Profile rules | VODKB-200723-160306.pdf |
5e2ddfb97c1c-0 | 3570
Token Profile rule names could be in AOMConfig - accessed in the activity to set the profileName parameter when calling the
pxGenerateJWT activity. | VODKB-200723-160306.pdf |
c2c9be90240d-0 | 3571
Check Product Eligibility
Description
CheckProductEligibility retrieves eligibility status for the ProductId sent as input for the given subscription.
Class Structure
VFUK-FW-AOMFW-Int-TIL-CPE-API Connector Class
VFUK-FW-AOMFW-Int-TIL-CPE-API-Request CPE Request Class
VFUK-FW-AOMFW-Int-TIL-CPE-API-Response CPE Response Class
VFUK-FW-AOMFW-Int-TIL-CPE-API-RequestBody CPE Request Body Class
VFUK-FW-AOMFW-Int-TIL-CPE-API-ResponseBody CPE Response Body Class
VFUK-FW-AOMFW-Int-TIL-CPE Top-Level Class for all the Request and Response objects
VFUK-FW-AOMFW-Int-TIL-CPE-RequestService Service class for CPE Request
VFUK-FW-AOMFW-Int-TIL-CPE-Specification Specification class for CPE Request
VFUK-FW-AOMFW-Int-TIL-CPE-ResourceId ResourceId class for CPE Request
VFUK-FW-AOMFW-Int-TIL-CPE-Device Device class for CPE Request
VFUK-FW-AOMFW-Int-TIL-CPE-Account Account class for CPE Request
VFUK-FW-AOMFW-Int-TIL-CPE-ResponseService Service class for CPE Response
VFUK-FW-AOMFW-Int-TIL-CPE-Eligibility Eligibility class for CPE Response
VFUK-FW-AOMFW-Int-TIL-CPE-Price Price class for CPE Response
VFUK-FW-AOMFW-Int-TIL-CPE-IncompatibleProduct IncompatibleProducts class for CPE Response
CheckProductEligibility Connector REST Rule
CheckProductEligibility Connector Activity | VODKB-200723-160306.pdf |
c2c9be90240d-1 | CheckProductEligibility Connector REST Rule
CheckProductEligibility Connector Activity
CheckProductEligibilityRequestValidation Request Validation Data transformRule Name Type
This activity will prepare the request and invoke the connector rule and process the response
Applies To VFUK-FW-AOMFW-Int-TIL-CPE-API
Ruleset AOMFW-Int
Parameters MSISDN
ProductIdRuleName CheckProductEligibility | VODKB-200723-160306.pdf |
1650ab8ca7c5-0 | 3572
Originator
Connect Rest CheckProductEligibility
Activity Logic Get the APIEndpoint from AOM Config datatype.
Set Request Header with Source, Date, Originator and TransactionID properties.
Do request validation using CheckProductEligibilityRequestValidation data transform.
Prepare request body with msisdn, productID and eligibilityContext.
Loop (retry once again in case of 500 http status code)
Invoke CheckProductEligibility Connect-REST and check status and status codes for all possible scenarios
Do Error handling and log to Error table and Audit table accordingly | VODKB-200723-160306.pdf |
f724f1bf6f52-0 | 3573
AOM Exposed Services
GetRecommendedProductList (GRPL)
Get Next Best Actions REST API
Set NBA Response REST API
Customer REST API
Get Product List REST API
Get Recommendations REST API
Submit Basket REST API
Validate Basket REST API
Validate Delete REST API
GetProductList V2 REST API
Get Customer Usage Rest API
Get Notification Messages REST API
RealTime Triage ToolExpand all Collapse all | VODKB-200723-160306.pdf |
90d9aee14380-0 | 3574
GetRecommendedProductList (GRPL) | VODKB-200723-160306.pdf |
ea488ec1dc6a-0 | 3575
Get Next Best Actions REST API
Overview
Activity Steps
API Specification
Reference Material Related to the User Story
Overview:
GetNextBestActions API is exposed for TIL from AOM which provides the eligible payment methods to various channels in case if customer
is wiling to Trade-in old device as part of Upgrade journey. The calling system would invoke the below API to get the quote details of the
device for the customer to know the trade in value.
GetNextBestActions REST API
VFUK-AOM-Int-NextBestActions API Class
VFUK-AOM-Int-NextBestActions-Request GetNextBestActions Request Class
VFUK-AOM-Int-NextBestActions-Response GetNextBestActions Response Class
GetNextBestActions Activty that handles the request and calls GetNBA Response data
flowRule Name Type | VODKB-200723-160306.pdf |
b4c64192eeae-0 | 3576
Activity Steps:
1. Set the below property values to local variables
StartTimestamp
IdentifierType
Identifier
SeedTestEnabled
2. Invoke data transform called GetNextBestActionsRequestValidation with Primary Page as Input to perform the below validation
checks.
Mandatory & Existence of Service Number
Mandatory validation for Account Number, Status, Type if Service Number is not populated
Mandatory check for Channel
Checking Agent.UserName is mandatory for Assisted Channels (Retails, InboundCC)
Checking Store.StoreIdentifier is Mandatory for Retail channel.
Checking the Product Type whether the values received is in updated list of values
Checking Product Price Type & Value If there is list of products with customer
Checking the Context Details Name & Value Pair If there there are list of context.
Checking the Product Details Context Scope whether its as per the given context in Interface spec
Customer Basket Items Details Name & Value If there is one or more basket items existing for customer.
3. If SeedTest is enabled invoke GetNBASeedTestValidation data transform else skip step
4. Set Error Message From Validation Error Message received from data transform.
5. Set the BRBModeActivated Config value @AOMUtilities.GetCachedAOMConfigValue(“BRBModeActivated”,“GetNextBestActions”,
"false")
6. If BRBModeActivated is True then return the error with Http Status Code 521 and the following message.
"BRB Mode Activated for GetNextBestActions - Not processing Business Logic"
7. Call SetupSubscriptionForNBA activity to handle Subscription data setup
Call GetProspect (if Account.Status is NEW)
If ServiceNumber is not null BUT Account.Status = New then look up Prospect by ServiceNumber
If ServiceNumber is null and Account.Status is NEW then lookup prospect by AccountNumber | VODKB-200723-160306.pdf |
b4c64192eeae-1 | If ServiceNumber is null and Account.Status is NEW then lookup prospect by AccountNumber
If Prospect Exists, convert Prospect data to Subscription using ConvertFromProspect Data Transform
If Prospect does not exist, save the prospect and convert Prospect data to Subscription using ConvertFromProspect Data Transform
Call GetSubscription (if Account.Status is EXISTING)
If the Service_Number is populated and exists in the data table.
Do the request mapping in the Subscription page and set ExecutionMode as ‘GetNBA’ with GetNextBestActionsSubscriptionSetup
Data Transform
8. Call ExecuteNBASeedTest activity if Seed Test is enabled and record exists in SeedUserNBAWhitelist data type else continue BAU
operation of GetNBA
9. Invoke GetNBA Data Flow using Subscription page
10. Handle the empty result error if Data Flow returns no record
11. Loop through the SR results that are the output of the data flow run | VODKB-200723-160306.pdf |
4bcdffb20127-0 | 3577
Copy the ActionListGroup page group with the current index into ActionList page
If ResponseType = Action
Within the ActionList Page, set Action data and InteractionId
Create a instance of a Work page to Setup Detail (Do it only if SR.TreatmentAttributes is not null or empty)
Adopt SR.TreatmentAttributes into property TextValueGroup
Set ErrorMessage for handling AdoptJSONIntoProperty error if the values that returns from logis are not properly. If not skip this step
Loop through the TextValueList in the Work page
Create a Detail Page
Update the Name-Value pair within the Detail page for current TextValueGroup element
Append the Detail into ActionList.Detail
If ResponseType = Item
Create an item page
Set Item data
Create a instance of the Work page to Setup Price
Split the Price and store it into TextValueList, and then Split the Key=Value and store it into TextValueList
Append the Price into Item Page
Append the Item into ActionList Page List
If ResponseType = TreatmentActions
Create Actions Page
Setup Actions’s properties such as Id, Outcome, Type
Create a instance of the Work page to Setup Detail
Adopt SR.ActionTemplateDetai into Work page
Set ErrorMessage for handling AdoptJSON error if the values that returns from logis are not properly. If not skip this step
Loop through WorkActionTemplateDetail.JSONArrayList
Create a detail page
Update the Name-Value pair within the Detail page for current JSONArrayList
Append the Detail page into ActionList.Detail
Append the Actions into ActionList Page List
Copy ActionList back into ActionListGroup
12. Copy ActionList page into Primary.GetNextBestActionsResponse.ActionList list
13. Reset ActionListGroup property
14. If the process is successful, set the Success Response Code as Htttp Status Code to 200
15. Handle Customer Not Found Error if available | VODKB-200723-160306.pdf |
4bcdffb20127-1 | 15. Handle Customer Not Found Error if available
16. Handle Business Logic Validation Error if available
17. Check for any default error like 500 - Internal Server Error
18. Capture the Error entries in the table aom_error log.
19. Capture all successful entries into aom_audit log.
20. Perform the Final Cleanup to remove the Pages created a part of the activity process.
API Specification:
https://docs.google.com/spreadsheets/d/1ODmIR6ulrd6f319gBkaiDngz-uVsArho9hLIbOVGI9s/edit?usp=sharing -
Connect your Google
account | VODKB-200723-160306.pdf |
1f4a41174651-0 | 3578
Reference Material Related to the User Story:
Details of User Stories:
AOM-1762 AOM to provide available interface via REST
AOM to identify invalid requests against
expected specification and respond with
appropriate status code and error
AOM able to identify an error when context is
not in scope
AOM to be able to retrieve details required for
Data Flow
AOM to translate request into context for call
into Logic Data Flow
AOM to translate logic response into
meaningful API response based on mapping
AOM to validate response against expected
format and identify business processing errors
and respond accordingly
AOM to maintain and keep accurate audit and
error logging accordinglyAOM is to expose GetNBA API Endpoint for TIL to call. AOM will be
provided with the context as applicable for customer and / or product
(and future) holding in order for the eligible payment method(s) to be
determined (in line with the API definition associated with AOM-1721)
AOM 1853 Activity handler is able to determine a
'subscription' context based on GetNBA
request details
Activity handler is able to 'build' the
subscription page
Activity handler is able to call / pass the
subscription page into the correct 'subscription'
Data FlowAOM should be able to determine the correct 'context' based on
activities provided in the GetNBA request in order to call the relevant
Data Flow.
Steps:
1. When Request.Identifier.ServiceNumber is NOT NULL
2. When Request.Identifier.ServiceNumber matches to Subscription
Spine on Active Subscription and Returns 1 result
3. When Request.Identifier.Account.Status is NULL or Active
Process should bring the returned subscription into the primary | VODKB-200723-160306.pdf |
1f4a41174651-1 | 3. When Request.Identifier.Account.Status is NULL or Active
Process should bring the returned subscription into the primary
subscription page and passed to Data Flow.
Refer the Flow on Context Design:
https://drive.google.com/file/d/10a795TROtnHZD0BPy993MJWkjZ
wog7oP/view?usp=sharing -
AOM 1855 Activity handler is able to determine a
'prospect' context based on GetNBA request
details
Activity handler is able to 'build' the prospect
page in relation to Subscription
Activity handler is able to call / pass the
prospect page into the Subscription Data Flow
Activity is able to orchestrate the write and
storage of Data to Prospect Data SourceAOM should be able to determine the correct 'context' based on
activities provided in the GetNBA request in order to call the relevant
Data Flow.
Steps
When Request.Identifier.Account.Status = "NEW" or When
Request.Identifier.Account.AccountNumber does not Match from
Account Context Detectiuon and When
Request.Identifier.ServiceNumber does not Match from Subsctipion
Context DescriptionStory ID Acceptance Criteria Description/Steps
Connect your Google account | VODKB-200723-160306.pdf |
fe2684901527-0 | 3579
1. · When Request.Identifier.ServiceNumber is in Prospect Table
- Bring back Record
2. · When Request.Identifier.AccountNumber is in Prospect Table
- Bring back 1 Record (newest)
3. · If Page Exists - Update Entities with latest values and re-
save
4. · If Page Doesnt Exist - Create Prospect Entry
5. · Translate Page to Subscription
6. · Call Subscription Flow
ProspectId
· ProspectId should be unique Alphanumeric String
ProspectId must start with a prefix of "PRO_" to ensure no
combatibility issues with subscriptionId
Refer the Flow on Context Design:
https://drive.google.com/file/d/10a795TROtnHZD0BPy993MJWkjZ
wog7oP/view?usp=sharing -
AOM 1857 Customers Identified as Prospect are captured
and stored within prospect spine
Data Table must be editable allowing for future
updates to relevant spine entryTable entities need to be created in AOM to host prospect data,
Below is the proposed structure
https://drive.google.com/file/d/1mDj9SgHjyVGiw5LBENTJC97pGjf8
iW5J/view?usp=sharing -
AOM 1761 AOM to identify errors in processing NBA(s) and
report accordingly for actions to be taken.
All errors/exceptions to be logged to aom_error;
errors in processing to be exposed via
watchdog(s)
Watchdogs Required:
GetNBAProcessingTime:
Should highlight NBA Events which exceed a
given threshold in Watchdog Config - initial set
5 seconds
Should respond back with the error records,
recorded start and end time and the difference
in seconds between the two | VODKB-200723-160306.pdf |
fe2684901527-1 | recorded start and end time and the difference
in seconds between the two
Should be run every 30 minutes
GetNBABusinessLogicErrors:
Should detail any Exception from Business
Data Flow which occured in NBA Data Flow
Should respond back with Request Details and
the relevant Error in Process
Should be run every 60 minutes
GetNBAInvalidRequests:
Should highlight any NBA request which hasn't
met initial validation
Connect your Google account
Connect your Google account | VODKB-200723-160306.pdf |
ed287ad2dba0-0 | 3580
GetDeviceTradeInQuoteList
This operation provides option to retrieve latest trade-in quotation details of a device based on single quote identifier or device serial
number (for e.g: IMEI in case of mobile handset). Only handset device is supported.
Optionally, this operations provides option for consumers to query the latest trade-in quotation details for a specific period.
While queried with quote identifier or device serial number, below details would be returned as response:
Trade-In Quote details along with Quote price.
Device for which the Quote was provided.
Diagnostics performed on the device during Quote evaluation.
Trade-In Quote Identifier would be used as query parameter while both Trade-In Quote Identifier and Device serial number are provided.
In cases where the quote has expired, this operation would return back appropriate error response.
Flow Diagram:Should respond back with Request Details and
relevant Error in Process
Should be run every 60 minutes
AOM-2501 Actions:
Logic will parse new SR Page with Response
Type TreatmentActions
ActionTemplateId
ActionTemplateType
ActionTemplateDetail
ActionOutcome
AOM App to Map to Actions Element in NBA
Response
ActionTemplateDetail to come in Detail Block
Structure - App to Parse JSON into Block if
present.
TreatmentAttributes
New Variable TreatmentAttributes to be passed
on Action Page
{"MSG_ID": "1320487", "App-tag": "393746"}
Logic to construct in 1.14 - View to Move To
Templates in 2.01
App to Take Value and Convert to Spec
ProvidedIVR integration requires to pouplate list of values for ActionList.Detail
section.
Related attributes should be set by logic & App work required to use
those values generate response.
GetNBA Response Mapping For IVR | VODKB-200723-160306.pdf |
ed287ad2dba0-1 | those values generate response.
GetNBA Response Mapping For IVR
327167 Able to define and maintain list of MSISDN's
linked to specific treatments in AOM
Related treatments are only presented to those
defined MSISDN's in live
Those specific treatment offers do not appear
in live for any other MSISDN'sThe ability to configure live test MSISDN's and associate them with
treatments for given channels so that those treatments only appear for
the specified accounts in live. This enables controlled UAT in the live
environment before rolling those treatments out to the wider base.
This capability in Chordiant is accomplished by having the offer
switched off but override logic which makes it eligible to assigned
MSISDN's | VODKB-200723-160306.pdf |
a8e6476829f2-0 | 3581 | VODKB-200723-160306.pdf |
4dcbd7865599-0 | 3582
GetNextBestActionsV2
Introduction
Technical Details
API Class Structure
Implementation
With the Get Next Best Actions V2 API, the following updates are implemented:
If error message from the data flow is populated as "No Decision" ( SR.ErrorMessage = "No Decision" ) – Return no content with 204
status code
Append logic error details to the response message for 520 error – “Business Logic Error: “ + ErrorMessage
ActivityFeature/Functionality REST API exposed for TIL by AOM
Description GetNBA API V2 provides the eligible payment methods to various channels in case the customer is willing to
trade-in old devices as part of the Upgrade journeyGeneral Availability R2.10
getnextbestactions (v2) REST Service
GetNextBestActionsV2 Service activity that handles the requestRule Name Type
This activity invokes the GetNBA data flow and maps the results to the API Response
Applies To VFUK-AOM-Int-Services
Ruleset AOM-Int
Input Parameters NA
Output Parameters StatusCode [ I n t e g e r ]
ErrorMessage [ S t r i n g ]
Error Handling Primary Catch-all Error Handler: Catches all the unhandled Exceptions or Errors in the activity
Validate Request for mandatory parameters
Subscription Not Found Handler
Business Logic Error and Business Logic Validation ErrorGetNextBestActionV2 Activity | VODKB-200723-160306.pdf |
6eaf17254410-0 | 3583 | VODKB-200723-160306.pdf |
2753f80d7efd-0 | 3584
CRE Call
Call VFUK-FW-AOMFW-Int-TIL-RetentionEligibility.GetRetentionEligility from GetNextBestActionsV2 when GetNBAv2 Request with
channel as eCare and append CRE response to subscription page.
Initally Check RetentionEligility C* Dataset if record found attach it to Subscription page
If data not found make call to CheckRetentionEligibility ConnectSOAP and save the response to RetentionEligility C* Dataset with
TimeToLive 6 hours
Applies To VFUK-FW-AOMFW-Int-TIL-RetentionEligibility
Ruleset AOMFW-Int
Input Parameter SubscriptionType(String)
ServiceNumber(string)
AgentDepartment(String)
Output Parameter N/A
Error Handling ErrorStackTrace is Populated GetRetentionEligility | VODKB-200723-160306.pdf |
872546f9682b-0 | 3585
Set NBA Response REST API
Overview:
Set NBA Response will be used by channels to respond back with relevant outcomes of NBAs in which we responded with.
Activity Steps:
1. Log the Message As start of activity
2. Set the property values to local variable StartTimeStampVFUK-AOM-Int-NBAResponse API Class
VFUK-AOM-Int-NBAResponse-Request SetNBAResponse Request Class
SetNBAResponse Activity that handles the request and calls
CaptureResponse data flow Rule Name Type | VODKB-200723-160306.pdf |
511517c1aa28-0 | 3586
3. Invoke the data transform NBAResponseRequestValidation with Primary Page as Input to perform the mandatory parameters
validations
4. Handle BRB Mode Error if it is set as True
5. If CustomerId request parameter contains ‘PRO’
Call GetProspect to get relevant Prospect data
Copy Prospect data to Subscription page using ConvertFromProspect
6. If CustomerId request parameter does not contain ‘PRO’
Call GetSubscription activity to get relevant Subscription data
7. Set Context parameters in the Subscription page
8. Invoke Capture Response Data Flow
9. Handle Business Logic Error if available
10. If the process is successful, set the Success Response Code as Htttp Status Code to 200
11. Handle Customer Not Found Error if available
12. Check for any default error like 500 - Internal Server Error
13. Set Response Headers
14. Capture the Error entries in the table aom_error log.
15. Capture all successful entries into aom_audit log.
16. Perform the Final Cleanup to remove the Pages created a part of the activity process. | VODKB-200723-160306.pdf |
93c0a5b99c54-0 | 3587
Customer REST API
API - Release 2.5
Functional Overview
Description
Technical Details
API Specification
Implementation
GetCustomer activity
GetSubscriptionsForOwnerAccount activity
GetCustomerForSubscriptionContext activity
PrepareGCPLGPSLCRE activity
TriggerGCPLGPSLCRE activity
SaveGCPLGPSLCREData activity
AssembleSubscriptionXCAR activity
PrepareCustomerAPIResponse activity
PrepareOf ferDetails: ( Changes for R3.1)
PopulateProductConfigDetails:
GetCombiOf ferDetails:
PrepareHandset:
PrepareT ariff:
PrepareInsurance:
Cassandra Data Set
AOMConfig
Error Codes
Access Management
Error Handling and Resolutions
Reference Material Related to the User Story
High Level Design
Details of User Stories
Insurance Promotion Details
Handset Promotion Details
API - Release 2.5
Functional Overview
Description
Customer Rest API is exposed for VADR application from AOM application which provides spine & RT service data for GPSL, GPCL & CRE
for owner account.
All the data returned from RT calls is merged with the spine data for each subscription and stored in cassandra data set
The corresponding API will be used in recommendation screens for Assisted Upgrade in VADR which is a UI application for the assisted
agents integrated into Vodafone customer service Siebel application as web-mashup using iframe. | VODKB-200723-160306.pdf |
0e563abbfd38-0 | 3588
Technical Details
API Specification
https://docs.google.com/spreadsheets/d/1ODmIR6ulrd6f319gBkaiDngz-uVsArho9hLIbOVGI9s/edit?ts=5eaab00f#gid=1953683982 -
Implementation
Co
nnect your Google account | VODKB-200723-160306.pdf |
4f0d558e5253-0 | 3589
customer Rest Service
GetCustomer Activity that handles the request and populates the
data set
GetSubscriptionsForOwnerAccount Activity that returns Active Subscription List for
account owner
AssembleSubscriptionXCAR Activity that assembles GPSL & GCPL results with
customer spine data
PrepareCustomerAPIResponse Activity that prepares GC response
PrepareRootProduct Activity that prepares product roots from GPSL for GC
response
GetCustomerForSubscriptionContext Activity that triggers external API calls (GCPL, GPSL,
CRE) when Context is Subscription
GetCustomerForAccountContext Activity that triggers external API calls (GCPL, GPSL,
CRE) when Context is Account
PrepareGCPLGPSLCRE Activity that prepares external API requests
TriggerGCPLGPSLCRE Activity that triggers external API requests parallelly
SaveGCPLGPSLCREData Activity that saves external API responses into
datasets
SubscriptionXCAR Cassandra data set to keep subscription extended
customer analytical recordsRule Name Type | VODKB-200723-160306.pdf |
395910e446d9-0 | 3590
GetCustomer activity
1. Log the Message As start of activity
2. Set the StartTimeStamp & OwnerAccountNumber to local variables
3. Invoke GetCustomerRequestValidation DT with AOMIntService Page as Input to perform the below validation checks.
a. Call ServiceHeaderValidation DT to validate service headers
b. Mandatory parameter check for OwnerAccountNumber
c. Mandatory parameter check for Channel
d. Mandatory parameter check for Division
4. Set Error Message From Validation Error Message received from data transformation
5. Call GetSubscriptionsForOwnerAccount activity to get active Subscription List for owner account number
6. Call GetCustomerPartyList activity to get GCPL API response for a given owner account number with “CustomerPartyID” IdentifierType
7. Call GetServiceList activity get Service List response from GPSL API
8. Call AssembleSubscriptionXCAR activity to populate API responses into SubscriptionXCAR data set and populate results into
SubscriptionList page
9. Call PrepareCustomerAPIResponse activity to populate Customer API response for request
10. If the process is successful, set the Success Response Code as Htttp Status Code to 200
11. Handle No Active Subscription(s) found for Owner Account Number Error if available
12. Check for any default error like 500 - Internal Server Error
13. Capture the Error entries in the table aom_error log
14. Capture all successful entries into aom_audit log
15. Perform the Final Cleanup to remove the Pages created a part of the activity process
GetSubscriptionsForOwnerAccount activity
1. Browse all active subscription(s) for a given owner account number
2. If no subscription is found, throw error. Else, go on. | VODKB-200723-160306.pdf |
395910e446d9-1 | 2. If no subscription is found, throw error. Else, go on.
3. If there are more than one active Subscription Ids for a service number associated with Owner Account Number, throw error. Else, go on.VFUK.VADR Operator that will be used to call customer service
VFUK-AOM-Int-GC API Class
VFUK-AOM-Int-GC-Request API Request Class
VFUK-AOM-Int-GC-Response API Response Class
VFUK-AOM-Int-Subscription Subscription Class for GC Response
VFUK-AOM-Int-RetentionEligibiltiy RetentionEligibiltiy Class for GC Response
VFUK-AOM-Int-EarlyUpgradeFee EarlyUpgradeFee Class for GC Response
VFUK-AOM-Int-ProductRoot ProductRoot Class for GC Response
VFUK-AOM-Int-ChildProduct ChildProduct Class for GC Response
VFUK-AOM-Int-OfferDetail OfferDetail Class for GC Response
VFUK-AOM-Int-LastUsedDevice LastUsedDevice Class for GC Response
VFUK-AOM-Int-Address Address Class for GC Response
VFUK-FW-AOMFW-Data-CombiBundles Class mapping for oc_bundles_v for Combi Offer
Details (i.e Name and Description) | VODKB-200723-160306.pdf |
d0030925f81c-0 | 3591
4. Populate Primary page for each subscription
GetCustomerForSubscriptionContext activity
1. Get the RetryCount config for TriggerGCPLGPSLCRE, initialize Invoke and Save parameters for the first run and populate identifier
parameters
2. Call GetSubscription activity to populate UpgradingSubscription page. Jump to SNF (Subscription Not Found) step if
Primary.ErrorResponse.Error is populated
3. Call PrepareGCPLGPSLCRE activity to prepare GCPL, GPSL and CRE API requests
4. Loop through the RetryCount
a. Invoke TriggerGCPLGPSLCRE activity - Jump outside of the loop if all invoke parameters are false
5. If pyHTTPResponseCode is 200, log to AOM Audit table for GCPL. Otherwise handle non-200 response for GCPL by setting
GCPLErrorCode and GCPLErrorMessage local variables and Log to AOM Error and AOM Audit tables
6. If Severity is S, log to AOM Audit table for GPSL. Otherwise handle non-S response for GPSL by setting GPSLErrorCode and
GPSLErrorMessage local variables and Log to AOM Error and AOM Audit tables
7. If Severity is S, log to AOM Audit table for CRE. Otherwise handle non-S response for CRE by setting CREErrorCode and
CREErrorMessage local variables and Log to AOM Error and AOM Audit tables
8. If any of error code local variables is null/emtpy, call SaveGCPLGPSLCREData activity to save successfull API results into data sets.
Otherwise jump to SAS (Set Activity Status) step
9. Call IdentifyWatchCustomer activity
10. (SNF) No Active Subscription found for MSISDN Error Handler
11. (SAS) Set Activity status as Failure with ErrorMessage local variables
PrepareGCPLGPSLCRE activity
1. Set Date and Source local variables for headers of the external APIs | VODKB-200723-160306.pdf |
d0030925f81c-1 | PrepareGCPLGPSLCRE activity
1. Set Date and Source local variables for headers of the external APIs
2. Create a new page GCPL
3. Validate incoming request parameters and set up request body for GCPL & Handle request validation errors
4. Setup the request header for CustomerPartyList API
5. Create a new page GPSL, setup the request header and set Account Number to customerPartyID for ProcessedServiceList API
6. Create a new page CRE, setup the request header and set Division to Agent Department for CheckRetentionEligibility API
7. Based on SubscriptionType
a. Set Service Number to MSISDN, if subscription type is Mobile Service or Mobile Broadband Service and service number starts with
447
b. Set Service Number to FLN, if subscription type is Fixed Line or Fixed Service and service number starts with 44
c. Set Service Number to BB_SERVICEID, if subscription type is Fixed Broadband Service
d. Unsupported SubscriptionType Handler
TriggerGCPLGPSLCRE activity
1. If InvokeGCPL parameter is true
a. Get the APIEndpoint for GCPL
b. Invoke TIL CustomerPartyList API with RunInParallel Execution Mode
2. If InvokeGPSL parameter is true
a. Get the APIEndpoint for GPSL
b. Invoke TIL ProcessedServiceList API with RunInParallel Execution Mode
3. If InvokeCRE parameter is true
a. Get the APIEndpoint for CRE | VODKB-200723-160306.pdf |
ece8cf3b9cc5-0 | 3592
b. Invoke TIL CheckRetentionEligibility API with RunInParallel Execution Mode
4. Wait until all APIs run in parallel are completed
5. If InvokeGCPL parameter is not false and pyHTTPResponseCode is 200 (success) or does not start with 5 (not required retry), update
InvokeGCPL parameter as false
6. If InvokeGPSL parameter is not false and Severity is S, update InvokeGPSL parameter as false for successfull GPSL call
7. If InvokeCRE parameter is not and Severity is S (success) or Code does not end with 500 or 408 (not required retry), update InvokeCRE
parameter as false
SaveGCPLGPSLCREData activity
1. If SaveGCPL parameter is true
a. Create a GCPLResponse page
b. Populate GCPLResponse page with GCPL.response and set Local.GCPLTTL from AOMConfig
c. Save GCPLResponse page into CustomerPartyListResponse dataset
2. If SaveGPSL parameter is true
a. Create a GPSLResponse page
b. Get TTL for GPSL from AOMConfig
c. Call DiscardProductList activity to discard root products whose PromotionId or RootProductId matches with AOMBusinessConfig
values and to discard child products whose ProductId matches with AOMBusinessConfig values
d. Set GPSL.Response.ServiceList.OfferDetails to GPSLResponse.ServiceList.OfferDetails
e. Set the AccountNumber and ServiceList for GPSLResponse page to store in dataset
f. Save GPSLResponse page into ProcessedServiceList dataset
g. Create a new page ServiceList and copy ServiceList page from the response into ServiceList page
3. If SaveCRE parameter is true
a. Create a CREResponse page
b. If RetentionEligibility is empty, set the ErrorMessage and activity status | VODKB-200723-160306.pdf |
ece8cf3b9cc5-1 | b. If RetentionEligibility is empty, set the ErrorMessage and activity status
c. Copy CRE.Response.RetentionEligibility page into UpgradingSubscription.RetentionEligibility page
d. Set ServiceNumber with UpgradingSubscription.ServiceNumber and Local.CRETTL from AOMConfig
e. Copy CRE.Response page to CREResponse.RetentionEligibilityResponse page
f. Remove EarlyUpgradeFee page to supress default value if both FeeExcludingVAT and FeeIncludingVAT are null or empty
g. Save CREResponse page into RetentionEligibility dataset
AssembleSubscriptionXCAR activity
1. Loop through Primary Subscription List page list
a. If SubscriptionType is Mobile Service or Mobile Broadband Service, call GetRetentionEligibility activity to CRE API response for a
given service number & populate Subscription.RetentionEligibility. Else, skip step and do populate RetentionEligibility response
b. Loop through ServiceList.ProductRoot
i. If InstallId of ProductRoot matches with service number of subscription and LoanId of productroot is not null or not empty continue
1. Set a local variable SubscriberLoanId with Loandid of product root
2. Set a local variable called SubscriptionAsstIntId with AssetIntegrationId of ProductRoot
3. Jump to PBCP (Popuplate Bingo Customer Products) If LoanId exists else jump to PNBCP (Populate Non Bingo Customer
Products)
c. PBCP: Loop through ServiceList.ProductRoot
i. If SubscriberLoanId matches with LoanId of productroot when service number is not equal to installid of the root product.
1. Set a local variable PromotionInstanceId with PromotionInstanceId of root product else exit iteration
2. Jump to ARP (Append Root Products) If PromotionInstanceId for the LoanId exists.
d. PNBCP: Loop through ServiceList.ProductRoot | VODKB-200723-160306.pdf |
4a76c3bf5ee9-0 | 3593
i. If InstallId of productroot matches with servicenumber of subscription
1. Set a local vale called PromotionInstanceId with PromotionInstanceId of Prfor Non Bingo CustomerductRoot
2. Set a local variable called SubscriptionAsstIntId with AssetIntegrationId of ProductRoot
e. ARP: Loop through ServiceList.ProductRoot
i. Append current page into Subscription.ProductRoot page list If
1. InstallId of product root matches with service number
2. PromotionInstanceId of product root matches with PromotionInstanceId local variable
f. Loop through ServiceList.OfferDetails
i. If root asset integration id of offerdetails matches with local variable SubscriptionAsstIntId.
ii. Apend OfferID to HoldingOffers TextValueList
g. Loop through ServiceList.OfferDetails
i. Check if the OfferId of OfferDetails exists in HoldingOffers TextValueList
ii. Append OfferDetails Page to Subscription.OfferDetails
h. Call AssembleSubscriptionXCAR DF with RT Service Responses to populate outputs with spine data into SubscriptionXCAR data set
and get return results to caller activity
PrepareCustomerAPIResponse activity
1. Call PopulateProductConfigDetails from AOM Business config for type OneNumberProductList, ChildProductTypes.
2. Populate AccountNumber & AcccountCreatedDate for owner account
3. Loop through SubscriptionList
a. Populate SubscriptionId & ServiceNumber for Subscription level response
b. Loop through Product Root
i. If InstallId is matching with the Service Number, Populate Product Root block properties Else Skip Step.
ii. If FulfilmentItemCode is Insurance
1. Call PrepareInsurance
iii. If FullfillmentItemCode is Handset
1. Call PrepareHandset
iv. If FulfilmentItemCode for Product Root is Fixed Line or Mobile Service or Fixed Broadband Service or Fixed Service or Mobile
Broadband Service | VODKB-200723-160306.pdf |
4a76c3bf5ee9-1 | Broadband Service
1. Call PrepareTariff
v. Call PrepareOfferDetails activity to populate combi offers for this subscription
c. Loop through RetentionEligibility.AdditionalInformation to populate AdditionalInformation text value group as name & value pairs
d. Populate LastUsedDevice block properties from Subscription. Device page
e. Append populated subscription response page to Primary.GetCustomerResponse.Subscriptions
4. Populate Primary.GetCustomerResponse.Address page from address page in the GCPL api response
PrepareOfferDetails: ( Changes for R3.1)
Activity Name : PrepareOfferDetails
Applies To Class : VFUK-AOM-INT-SUBSCRIPTION
Class Name: VFUK-AOM-INT-SUBSCRIPTION
Input Parameters: N/A
Processing:
1. Create an OfferDetailsPageGroup New Property on Subscription Class
2. Loop through OfferDetails | VODKB-200723-160306.pdf |
8d90dfb276d4-0 | 3594
a. Check OfferStatus is Pending and RewardSubType is Reward then continue with below process else skip
i. Get the Page from OfferDetailsPageGroup using the keys OfferId_RewardId ( Convert them to Javadentifier)
ii. Populate the below properties for each Active offerdetails block and jump to Fin
1. OfferID - GPSL OfferDetails block, Check
2. RewardType - GPSL OfferDetails block
3. RewardSubType - GPSL OfferDetails block
4. RewardProductName - Get the RewardId If the RewardType is Reward and invoke D_Discount by passing the discount
identifier (i.e DP_XXXX), map the name to this property.
5. Call GetCombiOfferDetails by passing OfferId as input parameter-Populate Offer Description
iii. Put the Page into OfferDetailsPageGroup
b. Check OfferStatus is Active and RewardSubType is Reward then continue with below process else skip
i. Get the Page from OfferDetailsPageGroup using the keys OfferId_RewardId ( Convert them to Javadentifier)
ii. Populate the below properties for each Active offerdetails block and jump to Fin
1. OfferID - GPSL OfferDetails block, Check
2. RewardType - GPSL OfferDetails block
3. RewardProductName - Get the RewardId If the RewardType is Reward and invoke D_Discount by passing the discount
identifier (i.e DP_XXXX), map the name to this property.
4. Call GetCombiOfferDetails by passing OfferId as input parameter- Populate Offer Description
iii. Put the Page into OfferDetailsPageGroup
3. Check OfferStatus is Pending and RewardSubType is Reward Line then continue with below process else skip
a. Get the Page from OfferDetailsPageGroup using the keys OfferId_RewardId ( Convert them to Javadentifier) | VODKB-200723-160306.pdf |
8d90dfb276d4-1 | b. Populate the below properties for each Active offerdetails block and jump to Fin
i. Populate InstallId
ii. RewardSubType - GPSL OfferDetails block
c. Put the Page into OfferDetailsPageGroup
4. Check OfferStatus is Active and RewardSubType is Reward Line then continue with below process else skip
a. Get the Page from OfferDetailsPageGroup using the keys OfferId_RewardId ( Convert them to Javadentifier)
b. Populate the below properties for each Active offerdetails block and jump to Fin
i. Populcate InstallId
ii. RewardSubType - GPSL OfferDetails block
c. Put the Page into OfferDetailsPageGroup
5. Loop through OfferDetailsPageGroup
a. Append each page onto Subscription ( Example) GCSubscription.OfferDetails(<APPEND>)
6. Remove the OfferDetailsPageGroup Property from the Subscription Page
PopulateProductConfigDetails:
Activity Name : PopulateProductConfigDetails
Applies To Class : VFUK-AOM-INT-SERVICES
Class Name: VFUK-AOM-INT-SERVICES
Input Parameters: N/A
Processing:
1. Get the config values from AOMBusinessConfig for Type: OneNumberProductList, ChildProductTypes
2. Split the products with comma, store in text value list called SecondaryProductList
3. Split the products with comma, store in text value list called PrimaryProductList
4. Split the products with comma, store in text value list called AddOnProductType | VODKB-200723-160306.pdf |
a7676a3411f0-0 | 3595
5. Split the products with comma, store in text value list called DiscountProductType
6. Split the products with comma, store in text value list called DeletableDiscountProductType
7. Split the products with comma, store in text value list called DeletableAddOnProductType
GetCombiOfferDetails:
Activity Name : GetCombiOfferDetails
Applies To Class : VFUK-FW-AOMFW-Data-CombiOfferDetails
Class Name: VFUK-FW-AOMFW-Data-CombiOfferDetails
Input Parameters: Identifier
Properties:
OfferId
OfferName
OfferDescription
DataSet: CombiOfferDetails
Keys: Identifier
PrepareHandset:
Activity Name : PrepareHandset
Applies To Class : VFUK-AOM-INT-SUBSCRIPTION
Class Name: VFUK-AOM-INT-SUBSCRIPTION
Input Parameters: N/A
Processing:
1. Set the below properties
a. ProductName = ProductName from GPSL Productroot If available, else call D_PaymHandset with root productid (i.e H_069777) and
assign the name.
b. DisplayName = ProductAttributes(“DeviceName”) if ProductAttributes(“DeviceName”) is not null. Else,
DisplayName = ProductName
c. ProductId = RootProductId frpm GPSL ProductRoot
d. FullFilmentItemCode = FullFilmentItemCode from GPSL ProductRoot
e. UpfrontCost = UpfrontCost from GPSL ProductRoot
f. BuyOutCost = BuyOutCost from GPSL ProductRoot
g. ConnectionType = ConnectionType from BusinessMetadata ProductAttributes
h. DeviceColour = DeviceColour from BusinessMetadata ProductAttributes
i. DeviceStorage = DeviceStorage from BusinessMetadata ProductAttributes
j. Dimensions = DeviceSize from BusinessMetadata ProductAttributes | VODKB-200723-160306.pdf |
a7676a3411f0-1 | j. Dimensions = DeviceSize from BusinessMetadata ProductAttributes
2. Loop through ProductChild for current product root
3. Append Child product to GCProductRoot
4. Append the GCProductRoot to GCSubscription
PrepareTariff:
Activity Name : PrepareTariff
Applies To Class : VFUK-AOM-INT-SUBSCRIPTION
Class Name: VFUK-AOM-INT-SUBSCRIPTION
Input Parameters: N/A | VODKB-200723-160306.pdf |
df59fd7c1430-0 | 3596
Processing:
1. Call D_Tariff using PromotionId (i.e P_111377)
2. Call D_EntertainmentServiceForTariff with PromotionId= P_111377, ( New Data Page with Cassandra Cache)
3. Below is the SQL
4. Datapage will return the compatible services List
5. Set Local.EntertainmentFlag=true when the above list is not empty, by default Local.EntertainmentFlag=false
6. Set the below properties when record found
a. ProductName = Name of the Tariff
b. EntertainmentFlag= Local.EntertainmentFlag
c. DisplayName = ProductAttributes(“PlanName”) if ProductAttributes(“PlanName”) is not null. Else,
DisplayName = ProductName
d. Tenure = Duration of the Tariff
e. Set the LineRentalId from Tariff Page to local variable
i. Iterate through child products
1. set the below properties when linerentalid matches with child productid.
a. CostExclVAT = Price.AdjustedListPrice / 100 (Rounded to two decimal places)
b. CostIncVAT = ((Price.AdjustedListPrice* Tariff.vat_code) + Price.AdjustedListPrice)/ 100 (Rounded to two decimal places)
2. Set Primary.PrimarySubscription to TRUE when child productid exists in the configured product list for OneNumberPrimary,
Else FALSE
3. Get InstallId of child product when product id matches with OneNumberSecondary product list configured in
AOMBusinessConfig.
4. Lookup subscription spine table for the installId
5. Set PrimarySubscriptionId = SubscriptionId if exists in subscription, else throws error “Subscription not found for
OneNumberSecondary.
f. Set the BuyOutCost from GPSL ProductRoot | VODKB-200723-160306.pdf |
df59fd7c1430-1 | OneNumberSecondary.
f. Set the BuyOutCost from GPSL ProductRoot
g. If Status is Active and FulfilmentItemCode exists in CustomerDiscountList or CustomerDeletedDiscountList
i. Call D_Discount using productid
ii. Populate child product properties
iii. If the ProductId exists in CustomerDeletedDiscountList then set Deletable to true else false
iv. Populate below properties when Disount Type is GBP
1. ProductName from Name of the Discount product catalogue page
2. CostExclVAT from Amount of the Discont product catalogue page
3. CostInclVAT from Amount of the Discount product catalogue page
v. Populate below properties when Disount Type is Percentage
1. ProductName from Name of the Discount product catalogue page
2. CostExclVAT = ((ProductRoot.CostExclVAT * Discount Percentage)/100 (Rounded to two decimal places)
3. CostInclVAT = ((ProductRoot.CostInclVAT * Discount Percentage)/100 e.g. ((4057.2/100)*15)/100
h. If Status is Active and FulfilmentItemCode exists in CustomerAddOntList or CustomerDeletedAddOnList
i. If the ProductId exists in CustomerDeletedAddOnList then set Deletable to true else false
ii. Call D_AccountService
iii. Set below properties
1. ProductName from AccountService product catalogue page
1
2
3
4select distinct (pstv.identifier ) from pc_services_tariff_v pstv , product_attributes pa
where tariffs_identifier ='P_106401' and
pa .identifier =pstv.identifier and
pa ."attributes" :: json ->> 'DefaultEntertainment' ='true'; | VODKB-200723-160306.pdf |
ccb8a13a18a1-0 | 3597
2. FulfilmentItemCode from product child FulfilmentItemCode
3. ProductId from product id of the child product
4. CostIncVAT = 0 if Price.AdjustedListPrice is 0, Else MonthlyCostExclVAT should be taken from (CostExclVAT *
ProductCatalogue.vat_code) + CostExclVAT / 100
5. CostExclVAT =0 If Price.AdjustedListPrice is 0, Else Price.AdjustedListPrice / 100
i. Append product child to ProductRoot.
7. Append GCProductRoot to GCSubscription
PrepareInsurance:
Activity Name : PrepareInsurance
Applies To Class : VFUK-AOM-INT-SUBSCRIPTION
Class Name: VFUK-AOM-INT-SUBSCRIPTION
Input Parameters: N/A
Processing:
1. Set the below properties when record found.
a. CostIncVAT = CostIncVAT from AccountService Page
b. CostExclVAT = CostExclVAT from AccountService Page
c. DisplayName = ProductName
2. Loop through ProductChild for current product root
3. Append Child product to GCProductRoot
4. Append GCProductRoot to GCSubscription
Cassandra Data Set
AOMConfig
Error CodesSubscriptionXCAR VFUK-FW-AOMFW-Data-Subscription CustomerID
CombiOfferDetails VFUK-FW-AOMFW-Data-CombiOfferDetailsIdentifierData Set Name Class Keys
TimeToLive SubscriptionXCAR 86400ConfigType ConfigName ConfigValue
2016 “Error in
AssembleSubscriptionXCAR:
“Primary Catch-all Error Handler in the VFUK-FW-AOMFW-Data-
Subscription.AssembleSubscriptionXCAR activity
2017 "Error in
PrepareCustomerAPIRespon | VODKB-200723-160306.pdf |
ccb8a13a18a1-1 | Subscription.AssembleSubscriptionXCAR activity
2017 "Error in
PrepareCustomerAPIRespon
se: "Primary Catch-all Error Handler in the VFUK-AOM-Int-
Services.PrepareCustomerAPIResponseactivityCode Message Prefix Details | VODKB-200723-160306.pdf |
30c2f7a7c211-0 | 3598
Access Management
Error Handling and ResolutionsAccess Role To Object VFUK-FW-AOMFW-INT-TIL-
RETENTIONELIGIBILITYAPIPermission to call CRE service
Access Role To Object VFUK-FW-AOMFW-INT-TIL-
RETENTIONELIGIBILITYPermission to call CRE service
Access Role To Object VFUK-FW-AOMFW-INT-TIL-
PROCESSEDSERVICELISTAPIPermission to call GPSL service
Access Role To Object AOM:API VFUK-FW-AOMFW-INT-TIL-
SERVICELISTPermission to call GPSL service
Access Role To Object AOM:API VFUK-FW-AOMFW-INT-TIL-
CUSTOMERPARTYLISTAPIPermission to call GCPL service
Access Role To Object AOM:API VFUK-AOM-INT-SUBSCRIPTION Permission to call
GetSubscriptionsForOwnerAccount activity
Operator VFUK.VADR Operator for VADR application to call
Customer APIRule Type Rule Name Description
Invalid TransactionId 400 TransactionId is
mandatory for Service
HeaderPopulate TransactionId for calling
corresponding service
Invalid Source 400 Source is mandatory
for Service HeaderPopulate Source for calling corresponding
service
Invalid Timestamp 400 Timestamp is
mandatory for
Service Header
Timestamp must
be in ISO formatPopulate Timestamp for calling
corresponding service & ensure that it is in
ISO format
Invalid OwnerAccountNumber: Empty
OwnerAccountNumber passed400 OwnerAccountNumber
is mandatory for
Service ParametersPopulate OwnerAccountNumber parameter
for calling corresponding service
Invalid Channel: Empty Channel passed 400 Channel is mandatory
for Service ParametersPopulate Source parameter for calling
corresponding service
Invalid Division: Empty Division passed 400 Division is mandatory | VODKB-200723-160306.pdf |
30c2f7a7c211-1 | corresponding service
Invalid Division: Empty Division passed 400 Division is mandatory
for Service ParametersPopulate Division parameter for calling
corresponding serviceError HTTP Code Description Resolution | VODKB-200723-160306.pdf |
ba8178dfbffc-0 | 3599
Reference Material Related to the User Story
High Level Design
Details of User StoriesAuthentication Failure 401 Authentation may fail
due to invalid operator
or passwordCheck if you are using VFUK.VADR
operator and correct password
Customer Details are not available for
Owner Account Number404 No Active
Subscription(s)
found for Owner
Account Number
Multiple active
service number
found associated
with owner account
numberCheck subscription spine if there is/are
active subscription(s) associated with
owner account number
Check subscription spine and see if
there are more than one active
Subscription Ids for a service number
associated with Owner Account Number
Internal Server Error 500 Any internal error such
as GPSL, GCPL or
CRE errors are
returned back as
internal server error Check aom.error table & pega logs to trace
the issue
Get_Customer_
16 Apr 2021, 02:49 PMHLD.pdf
341902 Ability to
Call AOM
to Get
Relevant
Customer
ResultsThe API should retrieve all
necessary information about a
customer and save it for later
processing and pass into other
Processes - this data should
be stored in Cassandra for
Fast Retrieval with a relative
TTL
The process should be able to
make simultaneous calls and
processing where necessary
in order to speed up the
process
GPSL and GCPL are
independent and should be
able to be called
simultaneously.To Support VADR Application - AOM will be invoked to
orchestrate the call and retrieval of customer information from its
Database and 3rd Party Systems. This is the initial call which will | VODKB-200723-160306.pdf |
ba8178dfbffc-1 | Database and 3rd Party Systems. This is the initial call which will
support all subsequent calls made to AOM to retrieve Upgrade
Retention Deals. Azure
Devops
Task Id Title Acceptance Criteria Description Releas
e | VODKB-200723-160306.pdf |
4d70b1fb1ae7-0 | 3600
Each Subscription on the
Account should then be
able to process
sequentially in order to
speed up the process
The Process should store the
customer record as is in C*
and format the results for Get
Customer Acccordingly
GetCustomerAPI on
Invocation should be the
necessary cache strategy for
All Assisted Upgrades Calls
On Invocation should clear
cache and rebuild
customer records
341942 Create
Subscripti
on/Custo
mer Data
StoreNot Available In order to minimise calls to Database and improve performance
the relative Subscription Record should be stored in C* for future
use in other services between NBAA and AOM.
Data should be stored for configurable TTL and contain the full
subscription record.
The Subscription Record will be built from relative Real Time
Calls from GPSL, CRE, and Spine Data.
341946 Create
Customer
Data Flow
for NBAANot Available Create New Data Flow to Support Generation of Customer
Record.
1. Should Take Subscription Page as Context in to Data Flow to
orchestrate calls
2. Should do All necessary joins on data of "Spine" Data
a. Should not store and cache any realtime, interaction
history, or any other data sources which come in to AOM
directly to support continual real time updates to these
data sets.
3. Data Flow should write record to new Customer Data Set
Created
4. Data Flow should exit and throw relative error accordingly
342010 Call CRE
For All
Subscripti
ons on
AccountNot Available To Support UI Visibility of Upgrade Fee - Call CRE for Every
Subscription on Account.
The CRE Call should only happen once for All Non | VODKB-200723-160306.pdf |
4d70b1fb1ae7-1 | Subscription on Account.
The CRE Call should only happen once for All Non
Fixed/Broadband Lines on the Account:
FIC Code/SubscriptionType =
Mobile Service
Mobile Broadband Servic
The CRE Result should then be attached to Retention Eligibility
Class Structure on Subscription - a future task will be to allow | VODKB-200723-160306.pdf |
3e2dbca13226-0 | 3601
logic to read from this instance rather than current context
properties as we establish more of the journey in NBAA
341996 Source
Current
Holding
Through
GetCusto
merNot Available After Invocation of GPSL:
For Each Subscription on Account:
First Match the Subscription Service Number to the Root
Product InstalledId - this will provide the relative Tariff
Promotion Product
Based on the PromotionInstanceId of the Tariff Root Product
look up for additional Root Products and attach them to the
Subscription Page
This will give you Insurance and Handset Products and
provide linkage to the full Subscription Product Holding
The Original "Root Product" will also have the Same
PromotionProductId as the Handset and Insurance it
must not re-pick up the same Root Product More than
Once:
Add Conditional Join that InstalledID is Different to
That of the Service Number or Exclude by Fulfilment
Item Code
496348 Display
Customer
detailsNot Available When a TSAR Agent clicks customer name from the customer
panel then the following is displayed below (see UI for detail
representation)
Customer contact address is displayed as:
Primary Address (label)
Address Flat
Address Number
Building Number
Street
City
Postcode
Update Address Page in the GetCustomer API Response
form GCPL Response
Type: Address.type
FlatNumber: Address.flat
BuildingName: Address.building
BuildingNumber: Address.buildingNumber
Street: Address.street
Locality: Address.locality
City: Address.city
PostCode: Address.postcodeR 2.9 | VODKB-200723-160306.pdf |
ffc0d3933bf3-0 | 3602
342002 Format
Insurance
Promotion
Details
For
Response
in
GetCusto
merNot Available Insurance Promotion Details
The Promotion can be identified by the Root ProductId in
GPSL Response and can be retrieved from Account Services
Reference In Product Catalogue
CostIncVAT should be taken from Acct Services Product
Catalogue cost_inc_vat
Rounded to 2 decimal places
CostExclVAT should be taken from Acct Services Product
Catalogue cost
Rounded to 2 decimal places
Take All Children Products if presentR 2.9
342001 Format
Handset
Promotion
Details for
Response
in
GetCusto
merNot Available Handset Promotion Details
The Product Name Can be taken directly from the GPSL Call
or can be retrieved from PAYM devices based on Root
Product Id of GPSL Response
If the Product name is populated in GPSL response, map
it; else take from the data page
FulfilmentItemCode can be retrieved directly from GPSL
Response
UpfrontCost can be retrieved directly from GPSL Response
BuyOutCost can be retrieved directly from GPSL Response
Cost is not relevant and can be left blank
Take All Children Products if presentR 2.9
341998 Format
Tariff
Promotion
Details for
Response
in
GetCusto
merNot Available Where FulfilmentItemCode in Fixed Line Mobile Service Fixed
Broadband Service Fixed Service Mobile Broadband
Service Lookup Tariff Product from Product Catalogue using
PromotionID of the relevant Root Product from
Above ProductName should be taken from the Product
Catalogue "Name" Property For the Tariff Record in Product | VODKB-200723-160306.pdf |
ffc0d3933bf3-1 | Catalogue "Name" Property For the Tariff Record in Product
Catalogue get value of: linerentalid Traverse Child Products of
Tariff where the Product Code = linerentalid & update
the ProductRoot price from matching child productCostExclVAT
should be taken from Price.AdjustedListPrice / 100 to create £
not pence value - needs to be rounded to 2 decimal
places CostIncVAT needs to be calculated based on the
((Price.AdjustedListPrice* ProductCatalogue.vat_code) +
Price.AdjustedListPrice)/ 100 to create £ not pence value -
needs to be rounded to 2 decimal places UpfrontCost is not
relevant BuyOutCost (Provide if in API Response otherwise
leave blank)
Example Tariff Product Child for Mobile Service Type
<ns0:ProductChild> <ns0:ProductID>109964</ns0:Product
ID> <ns0:ProductName>Mobile Phone
Plan</ns0:ProductName> <ns0:AssetIntegrationID>1-
896BSJH</ns0:AssetIntegrationID> <ns0:RootAssetIntegra
tionID>1-
896BSHM</ns0:RootAssetIntegrationID> <ns0:FulfilmentItR 2.9 | VODKB-200723-160306.pdf |
e314abac264a-0 | 3603
emCode>Bundle</ns0:FulfilmentItemCode>
<ns0:InstallDate>2021-07-
21T00:00:00Z</ns0:InstallDate> <ns0:Status>Active</ns0
:Status> <ns0:Price> <ns0:AdjustedListPrice>3831</ns0:
AdjustedListPrice> <ns0:Category>Recurring</ns0:Catego
ry> </ns0:Price> <ns0:PaymentChargeUnit>Per
Month</ns0:PaymentChargeUnit> </ns0:ProductChild>
The Child Products should be restricted to where the fulfiment
item code is:
Discount Add On (service acct Catalogue) For Discount
Products:
Lookup Discount Product from Product Catalogue - using
Discount Product Id Take name from Product Catalogue
If Discount Type is GBP then
MonthlyCostExclVAT should be presented as is from Product
Catalogue
MonthlyCostInclVAT should be presented as is from Product
Catalogue
If Discount Type is Percentage then
MonthlyCostExclVAT should be calculated by:
((RootProduct.CostExclVAT * Discount
Percentage)/100 (Rounded to two decimal places)
e.g. ((33.81)*15)/100 = 5.07
MonthlyCostIncVAT should be calculated by:
(RootProduct.CostIncllVAT * Discount
Percentage)/100
e.g. (40.57*15)/100 = 6.08 (Rounded to two decimal
places)
For Add On Products Lookup Add On Product in
Product Catalogue - using Add On Product Id
Take name from Product Catalogue | VODKB-200723-160306.pdf |
e314abac264a-1 | Product Catalogue - using Add On Product Id
Take name from Product Catalogue
If Price.AdjustedListPrice = 0 then Just automatically Put 0 in
Relevant Fields
MonthlyCostExclVAT should be taken from
Price.AdjustedListPrice / 100 to create £ not pence value -
needs to be rounded to 2 decimal places
MonthlyCostIncVAT needs to be calculated based on the
(MonthlyCostExclVAT * ProductCatalogue.vat_code) +
MonthlyCostExclVAT / 100 to create £ not pence value - needs
to be rounded to 2 decimal places
496349 Identificati
on of
Lionheart
Offers - 2Not Available To support the visulalisation of Lionheart offers in the UI, the
Offer Block on the UI must be represented in the Customer API.
For Each OfferDetail Block, attached the InstalledID to that of
the subscription as per the GPSL implementation
API Formatting R 2.9 | VODKB-200723-160306.pdf |
507cc9bcb179-0 | 3604
OfferID should be taken from GPSL Offer Block
RewardType should be taken from GPSL Offer Block
RewardSubType should be taken from GPSL Offer Block
OfferDescription should be taken from
the OfferCatalogue accordingly based on the OfferId
RewardProductName should be taken from the Product
Catalogue discounts screen accordingly.
583579 Customer
Pannel -
Existing
Package
Display
Names &
Connectiv
ity
IndicatorNot Available R 2.12
583581 Karma
File
Indicator Karma Indicator to Get Customer
Add LoanEligibilityIndicator in to Get Customer
Add Property to Subscription class in VADR
Map from Property:
Subscription.SubsFlexAttribute.CustomStringField019R 2.12
933266 Refresh
GetCusto
mer info
every time
VADR is
launchedAn Agent launches VADR
GetCustomer sources the
customer's information in real
time (for example CRE, GPSL,
GCPL, Ex CAR)
The Agent closes VADR
The Agent performs some
changes in Halo (change contract
end date, add a product to
customer's product holding etc..)
The Agent relaunches VADR
GetCustomer sources the
customer's information in real
time (for example CRE, GPSL,
GCPL, Ex CAR)
The information changed by the
customer and sourced from these
real time services is displayed in
VADR
During Pilot is was discovered that the Agents perform clock
back activities whereby they change some information on the
customer's account in order to be able to perform an upgrade. In
AOM, we are currently caching external APIs information for a | VODKB-200723-160306.pdf |
507cc9bcb179-1 | AOM, we are currently caching external APIs information for a
period of 6 hours. However, this does not satisfy the clockback
requirement for Contact Centre.
As a short term measure, we have changed the timeout for CRE
to 1 min, allowing the agents to refresh upgrades eligibility by
relaunching VADR once they have made a upgrade eligibility
change in Halo.
However, we would like to investigate and implement a solution
that would allow GetCustomer to be refreshed every time an
Agent relaunch VADR and for VDAR to only catch the
information sourced from external sources only for the duration
of the session
Please see attached information on caching from Accord today
for information
Revised High Level Design:
1. GetCustomerAPI - Subscription Context
a. Add new parameter “RequestContext” added to request
which passed by VADR UI Whether the request is for TBD | VODKB-200723-160306.pdf |
1ef825d066f1-0 | 3605
subscription context or account context
b. Call GetSubscriptionsForOwnerAccount using
OwnerAccoutNumber and Upgrading Subscription
Number
c. Prepare Subscription List for the Single Upgrading
Subscription
2. GetCustomerAPI - Account Context
a. Add new parameter “RequestContext” added to request
which passed by VADR UI Whether the request is for
subscription context or account context
b. Call GetSubscriptionsForOwnerAccount using
OwnerAccoutNumber and Upgrading Subscription
Number
c. Prepare Subscription List for the Single Upgrading
Subscription
3. GetCustomerPartyList
a. Remove the C* population and save for GCPL as its called
on account context.
4. GetServiceList
a. Remove the C* population and save for GPSL as its called
on account context.
5. Prepare CRE and call based on the Request Context and
remove the C* population and save
a. Subscription Context - Only for Single Subscription
b. Account Context - Full Account
6. Call AssembleSubscriptionXCAR only for the subscription
Context
7. Call PrepareCustomerAPIResponse
a. Call using Single Subscription in case Subscription
Context.
b. Call using all subscriptions in case of Account Context. | VODKB-200723-160306.pdf |
225c935134eb-0 | 3606
CRE Call for Multiple Customers Simultaneously
Overview
Update: GetCustomer Activity
PrepareCREDataforSubscriptionList Activity
Update: AssembleSubscriptionXCAR Activity
AOM Config
Overview
841516 - Ability to Call CRE for Multiple Customers Simultaneously
As a result of CRE Migration into AOM being delivered later than expected it has resulted in the need to change the CRE Call within Get
Customer to be more performant when requesting for multi subscription line accounts. CRE has the ability to query and fetch results for up
to 10 CTNs at a time, where currently we request for Each CTN individually as part of XCAR.
What does CTN stand for?
Update this activity to call new PrepareCREDataforSubscriptionList activity by passing the SubscriptionList for the given account as
step page before AssembleSubscriptionXCAR.
Applies To VFUK-AOM-Int-Services
Ruleset AOM-Int
Activity Logic If Channel is not equal to ‘Web’, Call PrepareCREDataforSubscriptionList activity
Otherwise skip stepUpdate: GetCustomer Activity
Prepares batch CRE data for SubscriptionList up to 10 CTNs at a time and calls CRE
Applies To VFUK-FW-AOMFW-Data-Subscription
Ruleset AOM-Int
Input Parameters NA
Output Parameters NA
Error Handling Primary Catch-all Error Handler
Logs to Error Log
Activity Logic 1. Initalise local variables:
a. Set LoopLimit as @AOMUtilities.GetCachedAOMConfigValue(CREBatchLoopLimit,CRE,false)
b. Set LoopCounter as 0
c. SubscriptionCounter as 0
2. Loop through the SubscriptionList passed from the parent activity GetCustomer
a. Copy CURRENT page into Subscription
b. Update LoopCounter and SubscriptionCounterPrepareCREDataforSubscriptionList Activity | VODKB-200723-160306.pdf |
3b9436c02530-0 | 3607
AOM Config
i. Set LoopCounter = @String.equals(LoopCounter,LoopLimit) ? 1 (to reset LoopCounter if it
reaches to LoopLimit): LoopCounter + 1 (otherwise continue to incease it)
ii. Set SubscriptionCounter = SubscriptionCounter + 1
c. Create a new page CRE for RetentionEligibilityAPI
d. Router based on SubscriptionType to add Subscription & Subscription Type to CRE Request Body
i. If SubscriptionType is "Mobile Service" || "Mobile Broadband Service", Jump to MSDN step
ii. If SubscriptionType is "Fixed Line" || "Fixed Service", Jump to FLN step,
iii. If SubscriptionType is "Fixed Broadband Service", Jump to BB step,
iv. Otherwise Jump to USH step (Unsupported SubscriptionType Handler)
e. Step MSDN: Set Service Number to MSISDN, if subscription type is Mobile Service or Mobile
Broadband Service
f. Step FLN: Set Service Number to FLN, if subscription type is Fixed Line or Fixed Service
g. Step BB: Set Service Number to BB_SERVICEID, if subscription type is Fixed Broadband Service
h. Step USH: Set Local.ErrorMessage by passing SubscriptionType
i. Set Agent Department by using existing clipboard page ‘AOMIntService.GetCustomerRequest.Division’
j. If (LoopLimit = LoopCounter) || (SubscriptionCounter=@length(SubscriptionList)), Call
CheckRetentionEligibility activity, Otherwise exit iteration
i. If Call Fails - Exit activity and present Error back in Get Customer
ii. If RetentionEligibility is empty, set the ErrorMessage and Jump to Err
k. Loop through <Response>
<TBD>
Update this activity to remove CRE Invocation
Applies To VFUK-FW-AOMFW-Data-Subscription | VODKB-200723-160306.pdf |
3b9436c02530-1 | Update this activity to remove CRE Invocation
Applies To VFUK-FW-AOMFW-Data-Subscription
Ruleset AOMFWUpdate: AssembleSubscriptionXCAR Activity
APIBatchSize RetentionEligibility 10ConfigType ConfigName ConfigValue | VODKB-200723-160306.pdf |
867c1a1bbf15-0 | 3608
1347204 - Handling of Prepay subscriptions in GPSL within an Post pay
upgrade
As part of the AOM assisted upgrades solution, the AOM application calls GPSL in order to understand all the subscriptions on the account.
The processing retrieves plan details from the product catalogue. For prepay subscriptions this process currently fails as the prepay plans
are not within the product catalogue data feeds. This stops the upgrade journey and the agent cannot continue. An incident has been
raised.
Adding the prepay products to the catalogue feeds is the long term fix but a tactical fix is needed to ensure that agents can continue with an
upgrade.
The tactical fix is to ignore the prepay subscriptions received from GPSL.
We don't want to process any prepay subscriptions received from GPSL, so that prepay subscriptions do not stop a post pay upgrade from
completing.
Acceptance Criteria:
On processing GPSL data AOM will not process any mobile subscriptions with a root product of '100000' (Prepay mobile root product)
On processing GPSL data AOM will not process any MBB prepay subscription by using the plan id to look up whether the subscription
plan is in a configured list of MBB prepay plans (emails with CMT attached).
AOM App/VADR GetCustomer processing completes successfully for accounts with prepay mobile subscriptions
AOM App/VADR GetCustomer processing completes successfully for accounts with prepay MBB subscriptions
The customer account panel functions as designed and does not show the prepay subscriptions (mobile/MBB).
The change CTN functionality in the Usage and Billing panels functions as designed and does not show the prepay subscriptions
(mobile/MBB).
The upgrade of a PAYM Mobile or MBB subscription with prepay subscriptions (mobile/MBB) on the account can be completed | VODKB-200723-160306.pdf |
867c1a1bbf15-1 | successfully and an order can be sent to Siebel.
AOM Business Config
DiscardProductList RootProduct 100000
DiscardProductList Promotion 102216, 102217, 105586, 105587, 105588ConfigType ConfigName ConfigValue
Applies To VFUK-FW-AOMFW-Data-ProcessedServiceList
Ruleset AOMFW-Int
Activity Logic 1. Get DiscardProductList for Child, Root and Promotion products from AOMBusinessConfig
2. Split the comma separated values into specific TextValueList properties
3. Loop through GPSL.Response.ServiceList.ProductRoot
a. Check if current product’s RootProductId or PromotionId exists in discard list products; If product
matches then exit iteration, otherwise copy current page to ProductRoot
b. Loop through ProductRoot.ProductChild
@Utilities.IsInPropertyList(.ProductId,DiscardProductList.TextValueList). If true then set
pyDeletedObject to true, otherwise exit iterationNew: DiscardProductList Activity | VODKB-200723-160306.pdf |
cc96aa364015-0 | 3609
c. @Utilities.RemoveDeletedObjects(ProductRoot.ProductChild) remove the child products which has
pyDeletedObject to true
d. Copy ProductRoot to Primary.ServiceList.ProductRoot(<APPEND>)
Applies To VFUK-AOM-Int-Services
Ruleset AOM-Int
Activity Logic Remove steps 6 to 8 and call DiscardProductList activity with GPSLResponse step page.
Do Error HandlingUpdate: SaveGCPLGPSLCREData Activity
Applies To VFUK-FW-AOMFW-Int-TIL-ProcessedServiceListAPI
Ruleset AOMFW-Int
Activity Logic Remove steps 9 to 11 and call DiscardProductList activity with ProcessedServiceList step page.
Do Error HandlingUpdate: GetProcessedServiceList Activity | VODKB-200723-160306.pdf |
b958b3f851ee-0 | 3610
Get Product List REST API
Introduction
Technical Details
API Rule Structure
Service ActivityFeature/Functional
ityRest API expoosed by AOM
Description GPL API returns the list of prioritized pellable products pertaining to a particular product typeGeneral
AvailabilityR2.5
productlist REST Service
VFUK-AOM-Int-GPL API Class
VFUK-AOM-Int-GPL-Request API Request Class
VFUK-AOM-Int-GPL-Response API Response Class
VFUK-FW-AOMFW-Int-LineItem Line Item class
VFUK-FW-AOMFW-Int-Stock Stock class
GetProductList Service activity that handles the requestRule Name Type
This activity validates the request and invokes the GetProductList Dataflow and maps the Dataflow result to the API Response
Applies To VFUK-AOM-Int-Services
Ruleset AOM-Int
Input
ParametersNA
Output
ParametersStatusCode
ErrorMessage
Error
HandlingRuntime Exception
Validation Error
Subscription Not Found Error
Business Logic Value ErrorGetProductList Activity | VODKB-200723-160306.pdf |
11044b4673e5-0 | 3611
Business Logic Error | VODKB-200723-160306.pdf |
a8eb9b4b5e87-0 | 3612
Get Recommendations REST API
Introduction
Technical Details
API Class Structure
Service Activity
991849 - Bundle Recommendations
Introduction
Technical Details
API Class Structure
Service ActivityFeature/Functional
ityRest API expoosed by AOM
Description Get Recommendations is the Rest Service Exposed by AOM which returns the Top recommended offers for the
customer in the context as part of the upgrade journeyGeneral
AvailabilityR2.5
VFUK-AOM-Int-GR API Class
VFUK-AOM-Int-GR-Request Request Class
VFUK-AOM-Int-GR-Response Response Class
VFUK-AOM-Int-GR-Recommendation Recommendation Class
VFUK-AOM-Int-GR-Offer Offer Class
VFUK-AOM-Int-GR-Reward Reward Class
VFUK-AOM-Int-GR-QualifyingCriteria QualifyingCriteria Class
VFUK-FW-AOMFW-Int-LineItem LineItem Class
VFUK-FW-AOMFW-Int-Stock Stock ClassRuleName Type
This is Get Recommendations API Service Activity Validates the Request data, prepare Subscription data and invoke Dataflow to get the
recommendations which further needs to be processed to map to the API response structure
Applies ToVFUK-AOM-Int-ServicesGetRecommendations | VODKB-200723-160306.pdf |
7e3667cc703c-0 | 3613
991849 - Bundle Recommendations
Create the following properties:Ruleset AOMInt
Input
Parameter
sN/A
Output
Parameter
sStatusCode: Status Code
ErrorMessage: Error Message
Error
HandlingDataflow Exception : Any Failure in the Dataflow would be handled gracefully with the ErrorCode and Error Message in the
logs and Error Table
Primary Catch-all Error Handler: Catches all the unhandled Exceptions or Errors in the activity
This is helper activity which re-formats the Dataflow response of SR Pages List into API Response as Recommendations with corresponding
LineItems and Offers as child elements
Applies ToVFUK-AOM-Int-Services
Ruleset AOMInt
Input
Parameter
sN/A
Output
Parameter
sStatusCode: Status Code
ErrorMessage: Error Message
Error
HandlingException in Split String Function
Validate response for madnatory parametersPrepareRecommendations
InteractionId VFUK-AOM-Int-GR-Request Text No Context(AOMInteractionId
)
ServiceNumb
erVFUK-AOM-Int-GR-Request Text If SubscriptionId
is empty-
AccountStatu
sVFUK-AOM-Int-GR-Request Text Out of scope
AccountTypeVFUK-AOM-Int-GR-Request Text Out of scope
AccountCate
goryVFUK-AOM-Int-GR-Request Text Out of scopeProperty
NameClass Name Type Mandatory Subscription Page
Mapping | VODKB-200723-160306.pdf |
b4992e4ba4db-0 | 3614
Update Request Validation data transform to check Channel value and distinguish between ‘InboundCC' and ‘Web’ values
Validation for Channel = 'InboundCC' remains unchanged
Validation for Channel = ‘Web’ no longer includes SubscriptionId, AgentId, Division, CaseId, PrimaryContext or SecondaryContext,
but now includes Name & Value for each Detail
Update Request & Response Validation data transforms
Add newly created SetupSubscriptionXCAR child activity to VFUK-AOM-Int-Services.GetRecommendations, when Channel = ‘Web’,
include it as a replacement for the set of steps in that activity that already performs the same logic. Otherwise, follow the original journeySubscriptionT
ypeVFUK-AOM-Int-GR-Request Text No Context(SubscriptionType
)
PrepayPostp
ayTypeVFUK-AOM-Int-GR-Request Text No Context(PrepayPostpayT
ype)
Detail VFUK-AOM-Int-GR-Request Page List (VFUK-AOM-Int-
NameValuePair)Web only Context(Detail Name)
using Detail Value
SubscriptionI
dVFUK-AOM-Int-GR-Response Text Yes CustomerID
This is a child activity which tries to find a SubscriptionXCAR record that matches the given input params or, failing that, creates a new
SubscriptionXCAR to be used instead
Applies ToVFUK-AOM-Int-Services
Ruleset AOM-Int
Input
Parameter
sSubscriptionId: Customer Id
ServiceNumber: MSISDN
Output
Parameter
sN/A
Logic If SubscriptionId is available, load Subscription record from SubscriptionXCAR
If not, use ServiceNumber to load Subscription from GetSubscription:
Load Subscription record from SubscriptionXCAR
If SubscriptionXCAR record is found, update the Subscription record Context from the request Detail: | VODKB-200723-160306.pdf |
b4992e4ba4db-1 | If SubscriptionXCAR record is found, update the Subscription record Context from the request Detail:
Save the SubscriptionXCAR record to the data set
If the SubscriptionXCAR record was not found:
[If SubscriptionId was available], load Subscription from GetSubscription
Update the Subscription record Context from the request Detail
Invoke GetServiceList child activity
Invoke AssembleSubscriptionXCAR child activity on the previously obtained Subscription record
Send the newly created SubscriptionXCAR to the parent activity as a Subscription page
Clean all pages created as part of this activity except for the Subscription page to be sent to the parent
Error
HandlingPrimary Catch-all Error Handler: Catches all the unhandled Exceptions or Errors in the activity
Subscription Not Found Error Handler: Routes to a different error step so that the appropriate status code can be given
Both of these errors are propagated to the parent activity to be fully handled therePrepareSubscriptionXCARForWeb | VODKB-200723-160306.pdf |
db11bb772a17-0 | 3615 | VODKB-200723-160306.pdf |
f16b79b01e4c-0 | 3616
Submit Basket REST API
Introduction
Process Flow
Technical Details
API Class Structure
Service Activity
Introduction
Process Flow
Technical Details
API Class StructureFeature/Functional
ityRest API expoosed by AOM
Description To provide the ability for an Upgrade Deal to be submitted into AOM for processing Create Sales Order API.General
AvailabilityR2.7
VFUK-AOM-Int-SB API Class
VFUK-AOM-Int-SB-Request Request ClassRuleName Type | VODKB-200723-160306.pdf |