7.6. Approve update vertical cabling request
| Name | Approve update vertical cabling request |
|---|---|
| Purpose | Allow Approvers to validate an update request for a vertical cabling entry between two equipments |
| Linked user stories |
4.51. Approver - Approve or reject update vertical cabling request 4.56. Organisation Approver - Approve or reject update vertical cabling request for organisation |
| APIs used | PUT /physical-links/<physical-link-id>/approve PUT /physical-links/<physical-link-id>/reject PUT or PATCH /physical-links/<physical-link-id> |
| Scope | This process only handles the validation of an already created update vertical cabling request The process of creating the entry is handled in a dedicated process. |
| Roles | System, Approver / Global Approver |
| Input | - id of the physical link update to validate - optionally the information to amend: - source equipment (mandatory) - destination equipment or unit (mandatory) - cable type (mandatory) - additional metadata |
| Output | - confirmation that the update request has been approved/rejected |
Detailed Process description
Main Process
| Step | Description | Actor(s) | Input(s) | Output(s) | Decision points |
|---|---|---|---|---|---|
| 1 | The System sends out notifications to the Global approvers and organisation approvers, indicating that an approval a pending. | System | - Outside trigger (e.g. Editor sent a new update request) | - notification to the Global and organisation Approvers | |
| 2 | The Approver verifies if the entry is valid and up to the expected quality standards | Approver | - Update physical link request | - yes / no | If the entry is valid: - Go to step 4 Else: - Go to secondary process S.1 |
| 3 | The Approver verifies if pictures linked to the entry contain any private data | Approver | - Update physical link request | - yes / no | If the entry is valid: - Go to step 4 Else: - Go to secondary process S.1 |
| 4 | The Approver approves the entry | Approver | - Update physical link request | - update physical link request approval | |
| 5 | The System verifies if the equipments/unit for which a physical link approval is sent exist | System | - update physical link request to approve | - yes / no | If the equipments/unit exist: - Go to step 6 Else: - Go to error E.1 |
| 6 | The System verifies that the two equipments/unit are geographically close enough to be connected | System | - update physical link request to approve | - yes / no | If the equipments/unit are close enough: - Go to step 7 Else: - Go to error E.2 |
| 7 | The System marks the update as approved and adds the approval date as well as the approver | System | - update physical link request to approve | - Approved update request | |
| 8 | The Approver gets notified that the approval was successfully done | Approver | - update request approval confirmation | - |
Secondary Processes
S.1. Submitted update physical link request needs adaptations
| Step | Description | Actor(s) | Input(s) | Output(s) | Decision points |
|---|---|---|---|---|---|
| 1 | The Approver verifies if the update physical link request is partially valid and can be corrected | Approver | - update physical link request | - yes / no | If the request can be corrected by the approver: Go to step 2 Else: Go to secondary process S.2. |
| 2 | The Approver corrects the submitted update request | Approver | - update physical link request | - corrected update physical link request | Go back to main process Step 4 |
S.1. Submitted update is rejected
| Step | Description | Actor(s) | Input(s) | Output(s) | Decision points |
|---|---|---|---|---|---|
| 1 | The Approver rejects the entry | Approver | - update physical link request | - update physical link request rejection | |
| 2 | The System marks the request as rejected and adds the date as well as the approver to the rejected update request | System | - update physical link request rejection | - rejected update physical link request | |
| 3 | The Approver gets a confirmation that the update request has been rejected | Approver | - update physical link request rejection confirmation |
Error Processes
E.1. Equipments / unit not found
| Step | Description | Actor(s) | Input(s) | Output(s) | Decision points |
|---|---|---|---|---|---|
| 1 | System returns an error indicating that one or both equipment(s) / unit do not exist | System | - | Error: equipments / unit do not exist |
E.2. Equipments / unit out of reach
| Step | Description | Actor(s) | Input(s) | Output(s) | Decision points |
|---|---|---|---|---|---|
| 1 | System returns an error indicating that the two equipments / unit are not geographically close enough to be connected. | System | - | Error: equipments / unit not in physical link range |
Additional Information
Exceptions
[400 Bad Request] Invalid input:
If mandatory fields are missing or fields are invalid, the system returns an error message. This includes the case in which one or both equipment(s) / unit do not exist.
[409 Conflict] Equipments / unit out of reach
If the Editor attempts to add physical link between two equipments / unit that are geographically too far away to be connected, the system should return an error.
[500 Internal Server Error] System Error
If the system fails to save changes due to an internal error, it displays an appropriate message and logs the error for further investigation.
No comments to display
No comments to display