dsd-dbs / capella-addons Goto Github PK

The idea is to create an addon (deployable .jar that can be put into the dropins folder of a Capella installation).

Requirements:

R1
The plugin shall automatically be activated when Capella starts

R2
When the plugin has been activated, it shall identify the Capella Collaboration Manager session id once.

Comment: The Capella Collaboration Manager session id will be provided as environment variable CAPELLACOLLAB_SESSION_ID as documented here.

R3
The plugin shall run a timer with a frequency of 500 ms

R4
When the timer runs a loop, the plugin shall determine the (list of) selected element(s) and information about the corresponding Capella model (project)

R5
When the timer runs a loop and the selection of elements differs from the previous loop, the plugin shall send (HTTP POST request) the following data:

[
    {
        "element_uuid": "...",
        "element_name": "...",
        "model_uuid": "...",
        "model_path": "..."
    }
]

R6
The plugin shall send the data to a network host that will be specified in the environment variable SELECTED_ELEMENTS_SERVICE_TARGET_URL. The endpoint will accept a parameter named capellacollab_session_id.

Comment: The HTTP POST request will be sent to https://host/endpoint?capellacollab_session_id=(...)

Implementation status:

• R1
• R2
• R3
• R4
• R5
• R6

The planned plugin will send the list of selected elements to a dedicated target. This is not a broadcast.

A user has asked for an option to auto-save all models before session termination in the Capella Collaboration Manager in DSD-DBS/capella-collab-manager#621.

To implement this, we need a plugin that saves all models on request.