Professional Documents
Culture Documents
IG1228 ODA API Call Flow Use Cases v3.0.0
IG1228 ODA API Call Flow Use Cases v3.0.0
IG1228 ODA API Call Flow Use Cases v3.0.0
IG1228
Team Approved Date: 29-Jan-2021
© 2021 TM Forum | 1
Notice
© 2021 TM Forum | 2
Summary
• Introduction
• Use Case 2: Browse B2C catalogue and check Fiber technical eligibility
• We started to share this presentation with other TMF working groups, and it could be modified
according to their remarks
– Open APIs workgroup
– ODA Reference Implementation workgroup
© 2021 TM Forum | 4
Different approaches regarding management of the overall process
• Frontends can define the processes autonomously while leveraging the Open APIs provided by the
SoRs
• The components implementing the Open APIs, in case of creation or update of entities, have to
check the business rules (e.g. when creating the ProductOrder its content is fully checked by the
ProductOrdering component)
• It’s the responsibility of each frontend to optimize the/its process by analyzing the global status
obtained by interrogating the entities from the Open APIs (e.g. if an installation address has
already been defined for a Product in the Shopping Cart the frontend may skip querying that
address again)
© 2021 TM Forum | 7
Approach B: SoR steer the process
© 2021 TM Forum | 8
Summary
• Introduction
• Use Case 2: Browse B2C catalogue and check Fiber technical eligibility
2
Success!
Your account is
created.
© 2021 TM Forum | 10
UC1 Description
• Step 0
– A person, not yet known by the operator, connects to one of the operator front-end and is proposed to create his
« account »
• For the operator the global term « account » corresponds to a set of information to be registered
– Create a Party/person, status initialized
– Create a contact method (mail address)
– Assign a default « Prospect » or « Portal User » Role to the Party/person
– Create an Electronic Identity (login / Password) and associate it to the Party/person
– He agrees to create his « account »
• Step 1
– The Front-end presents the set of information to enter
– The person enters the information and triggers the « account » creation
• Step 2
– Information entered have been transmitted to the process layer, checked and registered.
– The « account » is created so the person can now identify / authenticate himself
© 2021 TM Forum | 11
UC1 – Approach A: SoE steer the process - sequence diagram
Welcome!
No account yet?
No account yet?
Note: current version of TMF 701 doesn’t manage SessionId as a dedicated parameter © 2021 TM Forum | 13
UC1 – Approach B: SoR steer the process – Step 1
© 2021 TM Forum | 14
UC1 – Approach B: SoR steer the process – Step 2
© 2021 TM Forum | 15
Summary
• Introduction
• Use Case 2: Browse B2C catalogue and check Fiber technical eligibility
2
Internet
Fix Number tested: 1234567890
Good News ! Fiber is available for you
• Step 0
– A person connects to one of the operator front-end and want to browse the operator catalogue.
– He has the choice between several lines of product, and he can also browse the operator current best offers
– He chooses the Internet Line of Product
• Step 1
– The front-end displays a selection of internet offers, and propose to check fiber technical eligibility based
on the person fix phone number or geographical address
– The person enters his fix phone number et triggers the test
• Step 2
– Eligibility check is OK.
– The person can now start an order capture process, choosing one of the proposed fiber offers
© 2021 TM Forum | 18
UC2 – Approach A: SoE steer the process - sequence diagram
© 2021 TM Forum | 19
UC2 – Approach B: SoR steer the process – Step 0
© 2021 TM Forum | 20
UC2 – Approach B: SoR steer the process – Step 1
© 2021 TM Forum | 21
UC2 – Approach B: SoR steer the process – Step 2
Remark: For this UC we have only data retrieval or ‘smart retrieval’ via task-based API so no requirement to leverage
Process Flow API – TMF701
© 2021 TM Forum | 22
Summary
• Introduction
• Use Case 2: Browse B2C catalogue and check Fiber technical eligibility
Next step
Appointment not
managed in this 2
version
© 2021 TM Forum | 24
UC3 – Touchpoint view - lambda operator
2
2
Your Fiber Contract 1 -Select your add-ons
Your offer : Fiber Access – speed XXX (or to be chosen)
Basic TV Extra TV
Box 1 Box 2 channel channel
Next step
3
© 2021 TM Forum | 25
UC3 – Touchpoint view - lambda operator
3
3
Your Fiber Contract 1 -Select your add-ons
Your offer : Fiber Access – speed XXX (or to be chosen)
Basic TV Extra TV
Box 1 Box 2 channel channel
Next step
4
© 2021 TM Forum | 26
UC3 – Touchpoint view - lambda operator
4
Your cart 3
Confirm
5
© 2021 TM Forum | 27
UC3 – Touchpoint view - lambda operator
5
Enter your contract data 3
Confirm
© 2021 TM Forum | 28
UC3 – Touchpoint view - lambda operator
5
Enter your contract data 3
Confirm 6
© 2021 TM Forum | 29
UC3 – Touchpoint view - lambda operator
6
Order confirmation
© 2021 TM Forum | 30
UC3 – Approach A: SoE steer the process – step 1
© 2021 TM Forum | 31
UC3 – Approach A: SoE steer the process – step 2
© 2021 TM Forum | 32
UC3 – Approach A: SoE steer the process – step 3
© 2021 TM Forum | 33
UC3 – Approach A: SoE steer the process – step 4
© 2021 TM Forum | 34
UC3 – Approach A: SoE steer the process – step 5
© 2021 TM Forum | 35
UC3 – Approach B: SoR steer the process – step 1
ProcessFlow
ProcessFlow takes
takes charge
charge of
of Installed
Installed base
base in
in updated
updated in
in
shoppingCart
shoppingCart creation.
creation. parallel
parallel in
in pending
pending state.
state.
Let’s
Let’s configure
configure the
the cart…
cart…
© 2021 TM Forum | 36
UC3 – Approach B: SoR steer the process – step 2
Let’s
Let’s configure
configure the
the cart…
cart…
© 2021 TM Forum | 37
UC3 – Approach B: SoR steer the process – step 3
© 2021 TM Forum | 38
UC3 – Approach B: SoR steer the process – step 4
© 2021 TM Forum | 39
UC3 – Approach B: SoR steer the process – step 5
© 2021 TM Forum | 40
Summary
• Introduction
• Use Case 2: Browse B2C catalogue and check Fiber technical eligibility
Note: for this UC4 only one approach has been identified
© 2021 TM Forum | 42
UC4 GUI– Order fulfillment and confirmation to customer
FROM: OrderMgt@lambda.com
TO: james.bond@tmforum.org
© 2021 TM Forum | 43
UC4 – Step 1
© 2021 TM Forum | 44
UC4 – Step 2
© 2021 TM Forum | 45
UC4 – Step 3
© 2021 TM Forum | 46
UC4 – Step 4
© 2021 TM Forum | 47
Summary
• Introduction
• Use Case 2: Browse B2C catalogue and check Fiber technical eligibility
ResourceSpec
ProductSpec
ProductSpecCaracteristic
Hyp: Fiber Access Product defined
with no configuration choice except
geographic address
Hyp: TV Channels Product
Requires configurable with 2 possible
values
Requires Requires
Box 1 Fiber Access Connectivity TV Channels
OR
Speed: XXX Car1: Basic or Extra
Box 2 Address: ?
Requires
OR
© 2021 TM Forum | 49
Catalogue View (UC3 & UC4) - Global
Welcome Discount: -5€ /
month first 10 months
Fiber Contract
Min 0, Max 1
Min 0, Max 1
Requires
Requires Requires
Box 1 Fiber Access Connectivity TV Channels
OR
Speed: XXX Car1: Basic or Extra
Box 2 Address: ?
Requires
OR
Fiber Contract
CustomerProductOrderItem CustomerProductOrderItem
Action
(ProductOffering level) (Product level) ProductSpecCaracteristic ProductOfferingPrice
© 2021 TM Forum | 51
Summary
• Introduction
• Use Case 2: Browse B2C catalogue and check Fiber technical eligibility
L2 - Product & Offer Capability Delivery Product (& Product Offering) Catalog
Component
L2 - Product Capacity Mgt
L4 - Customer Order Provisioning Activities Identification Process Flow – TMF701 Service Ordering Mgt –
TMF641
L4 - Customer Order Provisioning Orchestration
post L2 – Service Configuration &
L4 - Customer Order Provisioning Activities Tracking Activation
1.0.0 02-Oct-2020 Alan Pope Final edits prior to publication Sylvie Demarest Orange
Release Status Date Modified Modified by Description of changes Ludovic Robert Orange
© 2021 TM Forum | 58
Annexes
© 2021 TM Forum | 59
Complete API Footprint (except component suite APIs)
Engagement Party Customer Bill Customer Privacy
Intelligence
Communication Payment Users Role & Permission Payment method
Management Partnership Type Document Account
Management
Party Role
Recommendation
Party Interaction Federated Identity Sales
Product Offering
Product Ordering SLA Loyalty
Qualification Risk Management
Process Flow
Core Commerce Management
Process Flow
Service
Service Catalog Service Qualification Service Quality
Activation & Configuration
Process Flow
Production © 2021 TM Forum | 60
UC1 - Touchpoint – abstract (step B) – not yet illustrated
1
Create your account
0
Welcome!
Mr Ms
Firstname: Lastname:
No account yet?
3 2
Success!
Verify that you are the owner of the mail address
Your account is
Received code:
created.
Verify
© 2021 TM Forum | 61
Service Catalogue View – Fiber Access CFSSpec
usages usages operations characteristics Multi-instance characteristics operations values rules
WI
Modify Technical eligibility Yes
P
Delete Initialize Modify
has
Guaranteed Bandwidth 50% or 100%
Factory Access Network
Initialize Modify
[Access] has
has
Fiber Fixed Access Downsteam max throughput Value (400MB or 2GB)
Initialize Modify
has
QoS Ex : RealTime, Premium, Gold,Silver, Bronze
Initialize
has
Access physical interface on customer
premises Optical
Initialize
© 2021 TM Forum | 62
Service Catalogue View – IP Fix Connectivity CFSSpec
usages usages operations characteristics Multi-instance characteristics operations values rules
Create
Modify
Initialize Modify
Administrate
Access on Internet (via browser,
Delete Full / URL value
applications, …)
Initialize Modify
Requires
Initialize
VoIP
Login fti…
Initialize Modify
TV Password password
Initialize Modify
Plug&Play? Yes/no
Initialize Modify
Triplet ? Acces/box
© 2021 TM Forum | 63
Service Catalogue View – TV CFSSpec
usages usages operations characteristics Multi-instance characteristics operations values rules
Create
Modify
Administrate
Delete
Initialize Modify
Requires Base bouquet id (or name), with its
Connectivity TV Base bouquet
corresponding planned end dates
validation
Initialize Modify
List of channel packages id (or names),
Channel packages
with their corresponding planned end dates
validation
Initialize Modify
List of SVOD services id (or names), with
SVOD services
Browse VOD catalog their corresponding planned end dates
validation
Watch VOD
Initialize Modify
watch programs in progress, from the beginning (start-over) NPVR Simultaneous recordings quota Number of recordings
© 2021 TM Forum | 64