# Harmonic Sequence Details

**Content**
* [Overall Sequence](#Sequence)
* [Continuous Operation](#Continuous-Operation)
* [Measure Simulation](#Measure-Simulation)
* [Prepare Optimization](#Prepare-Optimization)
* [TTA Optimization](#TTA-Optimization)
* [TTA Distribution](#TTA-Distribution)
* [Conclude Regulation](#Conclude-Regulation)

## Sequence

@startuml

participant "NM B2B" as nm
participant "AUs (flight\npreferences)" as au
participant "ANSP\n(FMP)" as ansp
participant "Airport\n(actor)" as airport
participant "Airport\n(data repository)" as bridge
participant "Orchestrator" as orchestrator
participant "TTMS\nController" as controller
participant "TTMS\nOptimizer" as optimizer
participant "Equity Manager\n+Dashboards" as em
autonumber

==Continuous Operation==
orchestrator -> orchestrator: business rules/governance\n(low/medium full privacy; changed a few times a year)
au -> bridge: send preferences\n(every few minutes)
ansp -> bridge: send constraints\n(a few times a day, from NM B2B)
airport -> bridge: send constraints\n(a few times a day)
ansp -> nm: issue network cherry pick regulation

group Active Regulation
ansp -> nm: update network cherry pick regulation
==Measure Simulation==
orchestrator -> nm: retrieve ATFCM measures list\n(periodic queries, every 2min?)\nrequest regulationListRequest (flow Services) - page 18
orchestrator -> orchestrator: check if list includes measure\nstarting with 'XSZH' and still active
orchestrator -> nm: request measure information
orchestrator -> nm: request: SimulationStartRequest (flow Services)
orchestrator -> nm: request simulated flight list for Traffic Volume
orchestrator -> orchestrator: record simulation data
orchestrator -> nm: stop simulation

group Iterative Optimization
==Prepare Optimization==

orchestrator -> nm: request flight list (not based on regulation)
orchestrator -> orchestrator: compute arrival slot list\n(based on measure info + flight list)
orchestrator -> bridge: request current preferences
orchestrator -> controller: request optimization
controller -> em: retrieve stakeholder data?
controller -> controller: compile data package\nfor optimization
controller -> optimizer: send data for optimization

==TTA Optimization==
optimizer -> optimizer: iterative optimization\n(optional use of\nPrivacy Engine)
controller -> optimizer: request updates\noptimization results
controller -> em: store optimization results
controller -> orchestrator: provide optimization results

==TTA Distribution==
orchestrator -> orchestrator: check KPIs and simulation results if TTA Optimization\nis good enough? -> might re-run (for first optimization)\n2..n optimzations: compare with previous solution
orchestrator -> nm: send TTA request
orchestrator -> bridge: store optimization results
orchestrator -> nm: request new flight sequence

end

end

==Conclude Regulation==
nm -> nm: end network cherry\npick regulation
orchestrator -> em: store actual flight sequence and difference to proposed TTA sequence
em -> em: update equity\nstatus
@enduml

## Continuous Operation

### 1. Set Business Rules / Governance
* [ ] Actors: AU, ANSP?
* [ ] Documentation
* [ ] Data format
* [ ] Components:
* Orchestrator: processes data
* [ ] Interface
* [ ] Stakeholders writing data?

### 2. Provide AU Preferences
* [ ] Actor: Airspace Users (Swiss)
* [ ] Documentation
* [ ] Data format: similar to SlotMachine, OSED mentions UDPP
* [ ] Components
* [ ] AU Client-IF
* [ ] AU Client-UI
* [ ] ZRH Bridge stores data

### 3. Provide ANSP Constraints
* [ ] Actor: ANSP (Skyguide)
* [ ] Documentation
* [ ] Data format
* [ ] Components
* [ ] ZRH Bridge stores data
* [ ] ANSP Client-IF

### 4. Provide APT Preferences & Constraints
* [ ] Actor: Airport (Zurich Airport)
* [ ] Documentation
* [ ] Data format
* [ ] Components
* [ ] ZRH Bridge stores data
* [ ] APT Client-IF

### 5. Issue Network Cherry Pick Regulation
* [ ] Actor: ANSP (Skyguide)
* [ ] Documentation
* [ ] Data format
* [ ] Components
* [ ] Skyguide Tool
* [ ] Existing Interfaces
* [ ] NM B2B

### 6. Issue Network Cherry Pick Regulation
* [ ] Actor: ANSP (Skyguide)
* [ ] Documentation
* [ ] Data format
* [ ] Components
* [ ] Skyguide Tool
* [ ] Existing Interfaces
* [ ] NM B2B

## Measure Simulation

### 7. retrieve ATFCM measures list
* [ ] Actor: ?
(periodic queries, every 2min?)
request regulationListRequest (flow Services)
* [x] Documentation:
* Simulation of Measures via B2B - Use Cases.pdf, page 18
* Regulation Proposal via NM B2B Detailed Use Cases 2023.pdf
* [ ] Data format
* [ ] Components
* [ ] Existing Interfaces
* [ ] NM B2B

### 8. check list

### 9. request measure information

### 10. SimulationStartRequest (flow Services)

### 11. request simulated flight list for Traffic Volume

### 12. record simulation data

### 13. stop simulation

## Prepare Optimization

### 14. Request Flight List

### 15. Compute Arrival Slot List

### 16. Request Current Preferences
* [ ] Actors: APT
* [ ] Documentation
* [ ] Data format
* [ ] available Slots: Paul, Email 27.11.2023 - `SlotUndFlugDaten/slots.json`
* [ ] flights: Paul, Email 27.11.2023 - `SlotUndFlugDaten/flights_*.json`
* mix from AU & APT preferences?
* [ ] Components:
* ZRH Bridge: provides data
* Orchestrator: forwards data to TTMS Controller
* TTMS Controller receives data

### 17. Trigger Optimization

### 18. Retrieve Stakeholder Data

### 19. Compile Data Package for Optimization
* [ ] Actors: APT
* [ ] Documentation
* [ ] Components
* [ ] TTMS Controller

### 20. Send Data for Optimization
* [ ] Actors: APT
* [ ] Documentation
* [ ] Data format
* [ ] Optimizer Input: Paul, Email 27.11.2023 - `OptimierungsInputs/*.json`
* [ ] Components
* [ ] TTMS Controller
* [ ] TTMS Optimizer

## TTA Optimization

### 21. Iterative Optimization

### 22. Request Status of Optimization / Optimization Results
* [ ] Actors: APT
* [ ] Documentation
* [ ] Data format
* [ ] Optimizer Result: Paul, Email 27.11.2023 - `OptimierungsErgebnisse/*.json`
* [ ] Components
* [ ] TTMS Controller
* [ ] TTMS Optimizer

### 23. Store Optimization Results

### 24. Provide Optimization Results

## TTA Distribution

### 25. Compare Simulation with Optimization

### 26. Send TTA Request

### 27. Store Current Flight Sequence

### 28. Request New Flight Sequence

## Conclude Regulation

### 29. End network cherry pick regulation

### 30. Store actual flight sequence and difference to proposed TTA sequence

### 31. Update Equity Status