7.5. Send update vertical cabling request process

Name 

 Send update vertical cabling request process 

 

 

 

 

 Purpose 

 Allow Editors to send an update request for a vertical cabling entry between two equipments 

 

 

 Linked user stories 

 

 4.46. Editor - Send an update vertical cabling request 

 

 

 

 APIs used 

 POST /physical-links 

 

 

 Scope 

 This process only handles the creation of an update request for a vertical cabling entry between two existing equipments. The process of validating and approving the entry is handled in a dedicated process. 

 

 

 Roles 

 Organisation Editor, System 

 

 

 Input 

 - source equipment (mandatory) - destination equipment or destination unit (mandatory) - link type (mandatory) - additional metadata 

 

 

 Output 

 - confirmation that the update request has been transmitted 

 

 

 

 Detailed Process description 

 Main Process 

 

 

 

 Step 

 Description 

 Actor(s) 

 Input(s) 

 Output(s) 

 Decision points 

 

 

 

 

 1 

 An Editor sends a “update vertical cabling request” for two existing equipments and a specific link type. 

 Editor 

 - source equipment (mandatory) - destination equipment or destination unit (mandatory) - cable type (mandatory) - additional metadata 

 - 

 

 

 

 2 

 The System verifies that the two equipments exist 

 System 

 

 - yes / no 

 If the equipments / unit exist: - the process continues (Step 3) If the equipments / unit do not exist: - An error is returned (E.1. Equipments not found) 

 

 

 3 

 The System verifies if the equipments / unit are geographically close enough to be connected 

 System 

 - equipments / unit addresses 

 - yes / no 

 If the equipments / unit are close enough: - the process continues (Step 4) If the equipments / unit are not close enough: - An error is returned (E.2. Equipments out of reach) 

 

 

 4 

 The System stores the connection in the database, adds the flag “approved = false” and the organisation of the Editor 

 System 

 - update vertical cabling request 

 - connection stored with the flag “approved = false” and linked to the Editor’s organisation 

 

 

 

 5 

 The System triggers the approval process for the created connection 

 System 

 - stored connection 

 - approval process is triggered 

 

 

 

 6 

 The Editor gets a confirmation that the update was successfully submitted 

 Editor 

 - submission confirmation 

 

 

 

 

 

 Error Processes 

 E.1. Equipments or 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) or the unit do not exist 

 System 

 - 

 Error: Equipments or unit do not exist 

 

 

 

 

 E.2. Equipments or unit out of reach 

 

 

 

 Step 

 Description 

 Actor(s) 

 Input(s) 

 Output(s) 

 Decision points 

 

 

 

 

 1 

 System returns an error indicating that the two equipments or uni are not geographically close enough to be connected. 

 System 

 - 

 Error: Equipments or unit not in connection range 

 

 

 

 

 Additional Information 

 Deleting a cable type in between two equipments or unit 

 Deleting a cable type between two instances follows the same process as above. In that case the user indicates in the update request that he wants to flag the connection as “deleted = true”. 

 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) do not exist. 

 [409 Conflict] Equipments or unit out of reach 

 If the Editor attempts to add connection between two equipments or 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.