LLD Edh
LLD Edh
e:                Design
                                                         Owner:            Unified Quality System
                                                         Author:           SSDM/Analysis &
                                                                           Design
Document Summary
                    Federated Inventory 3.0: Low Level Design: SupervisionE
Document Name       DH
Document
                    757660631.docx.docx                           Version: V1.3
Reference
                                   Orange Restricted
                           Federated Inventory 3.0: Low Level Design: Supervision
Change History
              V1.3        29/09/2020    S.COLLONGUES        G4R2C3 [BOOST DIGITAL] Enriched View Pivot S4-
                                                            CMS_FEI
                                                      Orange Restricted
                           Federated Inventory 3.0: Low Level Design: Supervision
                                                    Orange Restricted
                           Federated Inventory 3.0: Low Level Design: Supervision
                                                     Orange Restricted
                             Federated Inventory 3.0: Low Level Design: Supervision
                                                     Table of Contents
         1    INTRODUCTION...........................................................................................................5
             1.1    PURPOSE....................................................................................................................... 5
             1.2    REFERENCE DOCUMENTS............................................................................................... 5
         2    COMPONENT DETAILED SCHEMA..........................................................................6
         3    REQUIREMENTS...........................................................................................................8
         4    FUNCTIONAL DESCRIPTION OF PROCESS................................................................10
             4.1    EXTRACTION................................................................................................................ 10
             4.2    PREPARATION.............................................................................................................. 11
              4.2.1       “FINV-Inventory” Enrichment data..................................................................12
              4.2.2       “FINV-Relationships” Enrichment data............................................................19
              4.2.3       “FINV_INSTALLEDOFFER” Enrichment data...................................................20
             4.3    USAGE......................................................................................................................... 21
              4.3.1       “FINV_Commercial_Inventory_init_bvpn” Usage data........................................21
              4.3.2       “FINV_Commercial_Inventory_init_Numeris” Usage data..................................24
             4.4    REINIT......................................................................................................................... 27
              4.4.1       Process...............................................................................................................27
              4.4.2       Rules...................................................................................................................28
         APPENDIX A - GLOSSARY.............................................................................................29
                                                                     Orange Restricted
                           Federated Inventory 3.0: Low Level Design: Supervision
         1 INTRODUCTION
         1.1 PURPOSE
         This document provides a functional and a technical description of the process to
         transfer, enrich and usage of Federated Inventory data in EDH.
                                                    Orange Restricted
2 COMPONENT DETAILED SCHEMA
                                                          Orange Restricted
                           Federated Inventory 3.0: Low Level Design: Supervision
                                                                            Orange Restricted
                           Federated Inventory 3.0: Low Level Design: Supervision
                                                                            Orange Restricted
3 REQUIREMENTS
REF.                REQUIREMENT
Usage Data
                    One usage data file is generated with data way FINV_Commercial_Inventory_init_bvpn containing
EDH-US001-MR001
                    filtered and formatted data for reinit use
                    One usage data file is generated with data way FINV_Commercial_Inventory_init_numeris containing
EDH-US001-MR002
                    filtered and formatted data for reinit use
                    With a jsonlinear configuration file provided by FINV, EDH team create the reinit JSON file from
EDH-US001-MR003
                    dedicated usage views and provide them to partners
Enrichment Data
REQ-EDH-ENR-001     One enriched data file is generated with data way FINV-Inventory_beneficiary
REQ-EDH-ENR-002     One enriched data file is generated with data way FINV-Inventory_billing
REQ-EDH-ENR-003     One enriched data file is generated with data way FINV-Inventory_contracting
                    Enriched data file FINV-Inventory_all is UNION of FINV-Inventory_beneficiary, FINV-Inventory_billing
REQ-EDH-ENR-004
                    and FINV-Inventory_contracting
REQ-EDH-ENR-005     One enriched data file is generated with data way FINV_Relationships_installed_offer
REQ-EDH-ENR-006     One enriched data file is generated with data way FINV_Relationships_installed_resource
REQ-EDH-ENR-007     One enriched data file is generated with data way FINV_Relationships_installed_service
                    One enriched data file is generated presenting a pivot view bringing together FINV_INVENTORY_ALL
REQ-EDH-ENR-008
                    datas with S4CMS perimeters: FINV_INVENTORY_ALL_S4CMS
                                                                Orange Restricted
                           Federated Inventory 3.0: Low Level Design: Supervision
REQ-EDH-ENR-009 The data enriched in the customer table will appear in the FINV-Inventory_all file
                                           The data enriched in the customer table will appear in the FINV-Inventory_beneficiary file
            REQ-EDH-ENR-010
REQ-EDH-ENR-011 The data enriched in the customer table will appear in the FINV-Inventory_billing file
REQ-EDH-ENR-012 The data enriched in the customer table will appear in the FINV-Inventory_contracting file
            Data Extraction
            REQ-EDH-EXT-001                Vertices and Edges from Database can be extracted in JSON files
            REQ-EDH-EXT-002                JSON files must be transferable to EDH server
            Prepared Data
            REQ-EDH-PRE-001                JSON files from FINV must be prepared for integration in EDH
            REQ-EDH-PRE-002                For each @class Vertex or Edges, only fields defined in IC must be present in prepared files
            REQ-EDH-PRE-003                Customer data must be exposed by EDH Team
                                                                            Orange Restricted
                           Federated Inventory 3.0: Low Level Design: Supervision
                                                                            Orange Restricted
                           Federated Inventory 3.0: Low Level Design: Supervision
4.2 PREPARATION
After receiving data in JSON format, EDH will prepare them to be integrated before enrichment.
                                                                            Orange Restricted
                           Federated Inventory 3.0: Low Level Design: Supervision
         After preparation, data are enriched depending on required Usage specified in [2] EDH_Graphs.pptx and                            [5] EDH-
         EnrichmentContract-V7.3-OBSIT-FINV(FEI)v1.4.xlsm.
                                                                            Orange Restricted
                           Federated Inventory 3.0: Low Level Design: Supervision
                                                                            Orange Restricted
                           Federated Inventory 3.0: Low Level Design: Supervision
FINV_INVENTORY_BILLING
                                                                            Orange Restricted
                           Federated Inventory 3.0: Low Level Design: Supervision
                                                                            Orange Restricted
                           Federated Inventory 3.0: Low Level Design: Supervision
FINV_INVENTORY_CONTRACTING
                                                                            Orange Restricted
                           Federated Inventory 3.0: Low Level Design: Supervision
                                                                            Orange Restricted
                           Federated Inventory 3.0: Low Level Design: Supervision
                                                                             Orange Restricted
                           Federated Inventory 3.0: Low Level Design: Supervision
                                                                            Orange Restricted
                           Federated Inventory 3.0: Low Level Design: Supervision
          CODRU                     NAMERU
                                                                                                   RULE DESCRIPTION
          ¤EDH-ENR004-              Attributes exposed on EDH
                                                                          Attribute (salesRegionLabel, salesCluster and SalesCountry) must be
          MR004¤
                                                                          exposed through EDH on prepared data (through Customer) and
                                                                          enriched data (through finv_inventory_all, finv_inventory_beneficiary,
                                                                          finv_inventory_billing, finv_inventory_contracting
                                                                            Orange Restricted
                           Federated Inventory 3.0: Low Level Design: Supervision
              4.2.1.2 FINV_INVENTORY_ALL
                    CODRU                       NAMERU                                                RULE DESCRIPTION
          ¤EDH-ENR005-              Data join model                      Enriched data are calculated from prepared data with a LEFT OUTER JOIN
          MR001¤                                                         request, depending on Enrichment Contract (cf [2]) and data ways (cf [3])
          ¤EDH-ENR006-              “GraphOrigin” field calculation      For each line calculated in enriched data, a “GraphOrigin” column is added
          MR002¤                                                         and contains information related to the data path.
                                                                            Orange Restricted
                           Federated Inventory 3.0: Low Level Design: Supervision
              4.2.1.3 FINV_INVENTORY_ALL_S4CMS
                    CODRU                       NAMERU                                                  RULE DESCRIPTION
          ¤EDH-ENR008-              S4CMS perimeter criteria             Extract from S4CMS preparedData from perimeters_criteria and
          MR001¤                    extraction                           perimeters_inheritance views the criterias defining the perimeter criterias and
                                                                         their dependencies:
                                                                             -      ID
                                                                             -      ICO1
                                                                             -      IDENT
                                                                             -      SIREN
                                                                             -      SATIN_ACCOUNT
                                                                             -      SATIN_SUBACCOUNT
                                                                             -      OFFER
                                                                             -      ID_PARENT
          ¤EDH-ENR008-              S4CMS datas and FINV datas join      Enriched data FINV_INVENTORY_ALL_S4CMS is created with an inner join
                                                                            Orange Restricted
                           Federated Inventory 3.0: Low Level Design: Supervision
                                                                          peri
                                                                          met
                                                                                                                           SATIN_A SATIN_SUBACC
                                                                          er        ICO1          IDENT           SIREN                             OFFER
                                                                                                                           CCOUNT OUNT
                                                                          crite
                                                                          ria
                                                                          inve
                                                                          ntor
                                                                                    Customer.int Customer.e Customer. BillingAc InstalledOffer.bill MarketingOffer.s
                                                                          y
                                                                                    lCustomerId   nterpriseId siren_duns count.uId ingSubAccount    econdaryOfferId
                                                                          crite
                                                                          ria
          ¤EDH-ENR008-              S4CMS perimeter information          Add perimeters informations from S4CMS with an inner join between
          MR003¤                    addition                             FINV_INVENTORY_ALL_S4CMS and:
                                                                                                            S4CMS COLUMN
                                                                                S4CMS VIEW FROM                 FROM                     LABEL
                                                                              Orange Restricted
                           Federated Inventory 3.0: Low Level Design: Supervision
          ¤EDH-ENR008-              ExternalRefs                           Attribute externalRefs (id and origin) must be present on all enriched views
          MR003¤
                                                                             Orange Restricted
                           Federated Inventory 3.0: Low Level Design: Supervision
                                                                             -      For installedOffer:
                                                                                       o Relies_on
                                                                                       o Is_composed_of
                                                                                       o Derives_as
                                                                             -      For installedService:
                                                                                       o Is_linked_to
                                                                                       o Is_delegated
                                                                             -      For installedResource:
                                                                                       o Is_cascaded_by
                                                                                       o Is_composed_of
                                                                                       o Is_connected_to
                                                                                       o Is_divided_into
                                                                                       o Is_loadbalanced_by
                                                                            Orange Restricted
                           Federated Inventory 3.0: Low Level Design: Supervision
                                                                             Orange Restricted
                           Federated Inventory 3.0: Low Level Design: Supervision
4.3 USAGE
                                                                            Orange Restricted
                           Federated Inventory 3.0: Low Level Design: Supervision
          ¤EDH-US001-MR002¤ Relationship calculation                     An additionnal column ‘relationship_direction’ to express the direction of the
                                                                         union.
          ¤EDH-US001-MR003¤ IdType valorisation                          An additionnal column ‘s4cms_idType’ is valorised with the value 'CMS'
          ¤EDH-US001-MR004¤ Filter objects columns                       Every column corresponding to the following objects : installedResource,
                                                                         ResourceSpec, PerimeterCriteria, CustomerPerimeter,
                                                                         User,Filter,Role,ResourceCost,CustomerOrder, is absent from this usage view
          ¤EDH-US001-MR005¤ Filter perimeters lines                      Every line with a perimeter that has no subscription to PARCWEB
                                                                         ( s4cms_subscription != 'PARC' and s4cms_statutperim !='ENABLED' ) is
                                                                         absent from this usage view
          ¤EDH-US001-MR006¤ Filter status lines                          Every line where the installedoffer_standardstatus is not 'Active' or is not
                                                                         'Created' is absent from this usage view
          ¤EDH-US001-MR007¤ Filter offer lines                           This usage view will filter every line where the offerSpecification_uId is not
                                                                         present in ["ALLSERV004","5-ALLSERV002","5-ALLSERV005","5-
                                                                         ALLSERV001","5-ALLSERP006","5-ALLSERP007","5-BVPNSOLMIP","5-
© Copyright: France Telecom Group                     757660631.docx                              Page 30 of 37
Orange Restricted
                                                                            Orange Restricted
                           Federated Inventory 3.0: Low Level Design: Supervision
          ¤EDH-US001-MR008              Role formatted creation          Partner needs a specific customer role format.
                                                                         New attribute Role_tmf is created :
                                                                                graphOrigin            Role_tmf
                                                                           Beneficiary_Party    Beneficiary
                                                                           Contracting_Party    Contracting Party
                                                                           Billing_Party        Holder
                                                                            Orange Restricted
                           Federated Inventory 3.0: Low Level Design: Supervision
                                                                            Orange Restricted
                           Federated Inventory 3.0: Low Level Design: Supervision
          ¤EDH-US001-MR003¤ IdType valorisation                          An additionnal column ‘s4cms_idType’ is valorised with the value 'CMS'
          ¤EDH-US001-MR004¤ Filter objects columns                       Every column corresponding to the following objects : installedResource,
                                                                         ResourceSpec, PerimeterCriteria, CustomerPerimeter,
                                                                         User,Filter,Role,ResourceCost,CustomerOrder, is absent from this usage view
          ¤EDH-US001-MR005¤ Filter perimeters lines                      Every line with a perimeter that has no subscription to PARCWEB
                                                                         ( s4cms_subscription != 'PARC' and s4cms_statutperim !='ENABLED' ) is
                                                                         absent from this usage view
          ¤EDH-US001-MR006¤ Filter status lines                          Every line where the installedoffer_standardstatus is not 'Active' or is not
                                                                         'Created' is absent from this usage view
          ¤EDH-US001-MR007¤ Filter offer lines                           This usage view will filter every line where the offerSpecification_uId is not
                                                                         present in ['90-GPTPRDCOM','90-NUB','90-NUDUO','90-NUMACCRPV','90-
                                                                         NUMJGNIP','90-NUP','90-SDA']
          ¤EDH-US001-MR008              Role formatted creation          Partner needs a specific customer role format.
                                                                         New attribute Role_tmf is created :
© Copyright: France Telecom Group                     757660631.docx                              Page 33 of 37
Orange Restricted
                                                                            Orange Restricted
                            Federated Inventory 3.0: Low Level Design: Supervision
                                                                                 graphOrigin               Role_tmf
                                                                            Beneficiary_Party      Beneficiary
                                                                            Contracting_Party      Contracting Party
                                                                            Billing_Party          Holder
         4.4       REINIT
         All the products contained in FINV concerning a specific offer are sent to partners via EDH.
         Reinit is available for :
               -    BVPN offers
               -    Numeris offers
4.4.1 Process
                                                                             Orange Restricted
                            Federated Inventory 3.0: Low Level Design: Supervision
         4.4.2      Rules
                     CODRU                         NAMERU                                                           RULE DESCRIPTION
          ¤EDH-RE001-MR001¤              Json construction                  Federated Inventory provides to EDH a jsonLinear configuration files describing expected json format.
                                                                            The usage view is translated to json.
                                                                               Orange Restricted
                           Federated Inventory 3.0: Low Level Design: Supervision
                                                                            Orange Restricted
                           Federated Inventory 3.0: Low Level Design: Supervision
Appendix A - Glossary
Acronym Description
Orange Restricted