Architecture documentation
The Architecture Documentation of the National Registry of Vertical Cabling offers an overview of the current systems and expectations from the perspective of key stakeholders, including MyConnectivity. It outlines their expectations for the future, detailing essential processes, user stories, and architectural principles and best practices. This document serves as a valuable guide for understanding the system’s structure, functionality, and evolution.
1. Life-cycle of the document
The objectif of this document is to provide a scope of work and to be used as work document. It m...
2. Introduction
2.1. Context
As stated in “Luxembourg’s ultra-high-speed broadband strategy 2021-2025”, connectivity is no lon...
2.2. Document purpose and scope
The present document describes the data architecture of the NRVC that has been designed to respon...
2.3. Targeted audience
2.3.1. Confidentiality This document is an internal and confidential document and restricted acc...
3. User management & user roles
4. User stories
4.1. User - Profile management [canceled]
Id 4.1. Description As a Generic User I need to be able to update my personal inform...
4.2. User - Change password
Id 4.2. Description As a Generic User I want to be able to change my password ...
4.3. User - Manage user secrets [canceled]
Id 4.3. Description As a Generic User I want to be able to manage my secrets linked ...
4.4. Application Administrator - Create users
Id 4.4. Description As a Application Administrator, I must be able to create user ac...
4.5. Application Administrator - Update users
Id 4.5. Description As a Application Administrator, I must be able to update user ac...
4.6. Application Administrator - Delete users
Id 4.6. Description As a Application Administrator, I must be able to mark a user fo...
4.7. Application Administrator - Recover users marked for deletion
Id 4.7. Description As a Application Administrator, I must be able to recover a user...
4.8. Application Administrator - Create access tokens [new]
Id 4.8. Description As an Application Administrator I need to be able to create acce...
4.9. Application Administrator - Delete access tokens [new]
Id 4.9. Description As an Application AdministratorI need to be able to delete acces...
4.10. Application Administrator - View audit logs
Id 4.10. Description As an Application Administrator I want to have access to audit ...
4.11. Application Administrator - View all data on the platform
Id 4.11. Description As an Application Administrator I need to see everything that h...
4.12. Application Administrator - Restore deleted records
Id 4.12. Description As an Application Administrator I need to be able to recover re...
4.13. Application Administrator - Un-reject/approve an approved/rejected record
Id 4.13. Description As an Application Administrator I need to be able to un-appro...
4.14. Application Administrator - Export all
Id 4.14. Description As an Application Administrator I want to be able to export the...
4.15. Application Administrator - Monitoring
Id 4.15. Description As an Application Administrator I want to have access to...
4.16. Application Administrator - Alerting
Id 4.16. Description As an Application Administrator I want to be notified if ...
4.17. Application Administrator - Lightweight Administration Panel
Id 4.17. Description As an Application Administrator I need a lightweight admi...
4.18. Application Administrator - Define webhooks [new]
Id 4.18. Description As an Application AdministratorI need to be able to configure w...
4.19. Organisation Administrator - Create organisation users
Id 4.19. Description As an Organisation Administrator, I want to create user a...
4.20. Organisation Administrator - Update organisation users
Id 4.20. Description As an Organisation Administrator, I want to update user account...
4.21. Organisation Administrator - Delete organisation users
Id 4.21. Description As an Organisation Administrator, I want to be able to mark use...
4.22. Organisation Approver - Recover organisation users marked for deletion
Id 4.22. Description As an Organisation Administrator, I want to be able to re...
4.23. Organisation Administrator - Create organisation access tokens [new]
Id 4.23. Description As an Organisation Administrator I need to be able to create ac...
4.24. Organisation Administrator - Delete organisation access tokens [new]
Id 4.24. Description As an Organisation AdministratorI need to be able to delete acc...
4.25. Organisation Administrator - View organisation audit logs
Id 4.25. Description As an Organisation Administrator, I want to have access t...
4.26. Organisation Administrator - Un-reject/approve an approved/rejected record lined to organisation
Id 4.26. Description As an Organisation Administrator I need to be able to un-...
4.27. Organisation Administrator - Restore records deleted by the organisation
Id 4.27. Description As an Organisation Administrator I need to be able to recover r...
4.28. Editor - Create temporary address
Id 4.28. Description As an Editor, I want to be able to add a missing address...
4.29. Editor - Create an additional temporary address for an existing site
Id 4.29. Description As an Editor, I want to be able to add a missing address ...
4.30. Editor - Create an additional temporary address for an existing block
Id 4.30. Description As an Editor, I want to be able to add a missing address ...
4.31. Editor - Add a site
Id 4.31. Description As an Editor, I want to be able to create a site for an a...
4.32. Editor - Update a site
Id 4.32. Description As an Editor, I want to be able to update the site inform...
4.33. Editor - Delete a site
Id 4.33. Description As an Editor, I want to be able to delete a site that has...
4.34. Editor - Add a block
Id 4.34. Description As an Editor, I want to be able to create a missing block...
4.35. Editor - Update a block
Id 4.35. Description As an Editor, I want to be able to update wrong or missin...
3.36. Editor - Delete a block
Id 4.36. Description As an Editor, I want to be able to delete a block that wa...
4.37. Editor - Add a unit
Id 4.37. Description As an Editor, I want to be able to create a missing unit ...
4.38. Editor - Update a unit
Id 4.38. Description As an Editor, I want to be able to update wrong or missin...
4.39. Editor - Delete a unit
Id 4.39. Description As an Editor, I want to be able to delete a unit that was...
4.40. Editor - Add an equipment
Id 4.40. Description As an Editor, I want to be able to create a missing equip...
4.41. Editor - Update an equipment
Id 4.41. Description As an Editor, I want to be able to update wrong or missin...
4.42. Editor - Delete an equipment
Id 4.42. Description As an Editor, I want to be able to delete an equipment th...
4.43. Editor - Attach pictures [postponed]
Id 4.43. Description As an Editor, I want to be able to add pictures to a spec...
4.44. Editor - Delete Pictures [postponed]
Id 4.44. Description As an Editor, I want to be able to delete a picture that ...
4.45. Editor - Search a site by address
Id 4.45. Description As an Editor, I want to be able to search for an address ...
4.46. Editor - Send an update vertical cabling request
Id 4.46. Description As an Editor, I want to be able to send an update for a v...
4.47. Approver - Approve deleted site request
Id 4.47. Description As an Approver, I need to be able to approve site deletio...
4.48. Approver - Approve deleted block request
Id 4.48. Description As an Approver, I need to be able to approve block deleti...
4.49. Approver - Approve deleted unit request
Id 4.49. Description As an Approver, I need to be able to approve unit deletio...
4.50. Approver - Approve deleted equipment request
Id 4.50. Description As an Approver, I need to be able to approve equipment de...
4.51. Approver - Approve or reject update vertical cabling request
Id 4.51. Description As an Approver, I need to be able to approve an update ve...
4.52. Organisation Approver - Approve deleted site request for organisation
Id 4.52. Description As an Organisation Approver, I need to be able to approve...
4.53. Organisation Approver - Approve deleted block request for organisation
Id 4.53. Description As an Organisation Approver, I need to be able to approve...
4.54. Organisation Approver - Approve deleted unit request for organisation
Id 4.54. Description As an Organisation Approver, I need to be able to approve...
4.55. Organisation Approver - Approve delete equipment request for organisation
Id 4.55. Description As an Organisation Approver, I need to be able to approve...
4.56. Organisation Approver - Approve or reject update vertical cabling request for organisation
Id 4.56. Description As an Organisation Approver, I need to be able to approve...
4.57. Analyst - Access to all data
Id 4.57. Description As an Analyst, I need access to all the data in the Syste...
4.58. Analyst - Querying data
Id 4.58. Description As an Analyst, I need perform advanced queries on the ava...
4.59. Analyst - Query historical data
Id 4.59. Description As an Analyst, I need to be able to analyse trends in the...
4.60. Analyst - Query audit logs
Id 4.60. Description As an Analyst, I need to be able to analyse the audit log...
4.61. Analyst - Export data [to be reviewed]
Id 4.61. Description As an Analyst, I must be able to export all or part of th...
4.62. Analyst - Integrate external applications [to be reviewed]
Id 4.62. Description As an Analyst, I must be able to integrate external appli...
4.63. Analyst - Un-reject/approve an approved/rejected record
Id 4.63. Description As an Analyst I need to be able to un-approve/reject tha...
4.64. Viewer - Search sites/blocks/units/equipments by address
Id 4.64. Description As a Viewer, I must be able to search for sites, blocks, ...
4.65. Viewer - Read single entries by ID
Id 4.65. Description As a Viewer, I must be able to access any site / block / ...
4.66. Viewer - Read different versions of connections
Id 4.66. Description As a Viewer, I must be able to access a specific physical...
4.67. ETL - Retrieve addresses
Id 4.67. Description As an ETL user, I must be able to read all address inform...
4.68. ETL - Create and update addresses
Id 4.68. Description As an ETL user, I must be able to create and update addre...
5. Functional requirements
The background colors of the above image are to be interpreted as: purple: the core ...
6. Organisational Cases
6.1. User management
All user management use cases are covered by the processes below. Processes 7.1. User managemen...
6.2. Address ingestion
The background colors of the above image are to be interpreted as: purple: the core ...
6.3. Versioning, approvals and audit logs
In order to fulfil the needs of the different parties, guarantee the data quality and accountabil...
6.4. Data privacy
Data privacy has been one of the key considerations will design the data architecture of the NRVC...
6.5. Data quality
A lot of mechanisms are used to guarantee data quality. You will find below a brief explanation o...
6.6. Data governance
To clearly identify the responsibilities of each user, you will find below a responsibility matri...
6.7. Fair usage (access limitations)
The goal of the NRVC is to created a shared, reliable and fair data source of vertical cabling da...
6.8. Automatic data approvals and deletion
Keeping multiple versions of the system physical links information in the NRVC has some side effe...
6.9. Manual reviews and audits
Once a year data will be manually reviewed and Audited. The review will be done by an internal An...
6.10. Consistency checks
This section is meant to be used and completed during the entire lifetime of the project. All con...
7. Processes
7.1. User management processes
User creation process f an organisation requires a new user, two possible scenarios arise, eit...
7.2. Create missing address process
Name Create Missing Address Request Purpose Allow Editors to add missing addre...
7.3. Create missing address for existing site or block process
Name Create missing address for existing site or block process Purpose Allow E...
7.4. Address ingestion via the ETL process
The background colors of the above image are to be interpreted as: purple: the core ...
7.5. Send update vertical cabling request process
Name Send update vertical cabling request process Purpose Allow Editors to sen...
7.6. Approve update vertical cabling request
Name Approve update vertical cabling request Purpose Allow Approvers to valida...
7.7. Approve delete site request
Name Approve delete site request Purpose Allow Approver to validate a site del...
7.8. Approve delete block request
Name Approve delete block request Purpose Allow Approver to validate a block d...
7.9. Approve delete unit request
Name Approve delete unit request Purpose Allow Approver to validate a unit del...
7.10. Approve delete equipment request
Name Approve delete equipment request Purpose Allow Approver to validate an eq...
8. Data architecture
In this section we will present the data architecture chosen for the Vertical Cabling data. The i...
9. API Proposal
You will find below a link to the latest version of the swagger file that contains all entities m...