7 File management

28.5373GPPManagement and orchestrationManagement capabilitiesRelease 17TS

7.1 File transfer

7.1.1 Description

File management deals with transferring files between MnS producers and MnS consumers.

Existing file transfer protocols are used. These protocols need to comply to requirements specified in this clause.

7.1.2 Use cases

This clause describes the benefits of the subject capability.

Editor’s note: This clause will be extended with the benefits of the subject capability.

7.1.3 Requirements

REQ-FMG-1: The file transfer protocol shall preserve the formatting of the file during exchange.

REQ-FMG-2: The file transfer protocol shall preserve the encoding of the file during exchange.

REQ-FMG-3: The MnS producer shall support at least one of the following file transfer protocols: SFTP, FTPES, HTTPS.

REQ-FMG-4: The MnS consumer shall use the file transfer protocol supported by the MnS producer.

7.2 File retrieval from a MnS producer by a MnS consumer

7.2.1 Description

File retrieval is when the MnS consumer retrieves (gets) a file from the MnS producer. Either the MnS consumer retrieves a file from the MnS producer because the MnS consumer receives a file ready notification from the MnS producer or the MnS consumer reads the list of available (ready) files on the MnS producer and decides to retrieve an available file.

7.2.2 Use cases

This clause describes the benefits of the subject capability.

Editor’s note: This clause will be extended with the benefits of the subject capability.

7.2.3 Requirements

REQ-FMR-1: The MnS producer shall support the capability allowing a MnS consumer to retrieve (get) a file from the MnS producer.

REQ-FMR-2: The MnS producer shall support the capability allowing a MnS consumer to retrieve the list of files available for transfer from the MnS producer.

REQ-FMR-3: The MnS producer shall support the capability to inform a MnS consumer about files that are available for retrieval.

REQ-FMR-4: The MnS producer shall support the capability to inform a MnS consumer about errors that occurred during the preparation of a file.

REQ-FMR-5: The information transferred to a MnS consumer about an available file shall allow associating the file to the process on the MnS producer that generated the file, if any such process exists and has an identifier.

REQ-FMR-6: The MnS producer shall support the capability allowing a MnS consumer to indicate to the MnS producer, that the MnS consumer does not need a file anymore, such that the MnS producer hides the file in responses to subsequent read requests or decide to delete it altogether.

7.3 File push from a MnS producer to a MnS consumer

7.3.1 Description

For file push, the MnS producer pushes a file to the MnS consumer or a designated file server. Either the MnS producer pushes the file because the MnS consumer requests the MnS producer to push the file or the MnS consumer configures the MnS Producer to push a file based on an event occuring on the MnS producer, such as the availability of a file.

7.3.2 Use cases

This clause describes the benefits of the subject capability.

Editor’s note: This clause will be extended with the benefits of the subject capability.

7.3.3 Requirements

REQ-FMP-1: The MnS producer shall support the capability to push a file to a MnS consumer or a designated file server when triggered by a MnS consumer.

REQ-FMP-2: The MnS producer shall support the capability allowing a MnS consumer to trigger the MnS producer to push a file from the MnS consumer or a designated file server.

REQ-FMP-3: The MnS producer shall support the capability to inform the MnS consumer, that has triggered a file push, or any other MnS consumer about the progress of that file push.

REQ-FMP-4: The MnS producer shall support the capability to push a file to the MnS consumer or a designated file server when configured by a MnS consumer.

REQ-FMP-5: The MnS producer shall support the capability for a MnS consumer to configure the MnS producer to push a file to the MnS consumer or a designated file server based on an event occurring on the MnS producer.

REQ-FMP-6: The MnS producer shall support the capability to inform the MnS consumer, that has configured a file push, or any other MnS consumer about the progress of that file push.

7.4 File download from a MnS consumer to a MnS producer

7.4.1 Description

File download is when the MnS producer gets a file from the MnS consumer or a designated file server because the MnS consumer requests the MnS producer to download the file.

7.4.2 Use cases

This clause describes the benefits of the subject capability.

Editor’s note: This clause will be extended with the benefits of the subject capability.

7.4.3 Requirements

REQ-FMD-1: The MnS producer shall support the capability to download a file from a MnS consumer or a designated file server when triggered by a MnS consumer.

REQ-FMD-2: The MnS producer shall support the capability allowing a MnS consumer to trigger the MnS producer to download a file from the MnS consumer or a designated file server.

REQ-FMD-3: The MnS producer shall support the capability to inform the MnS consumer that has triggered a file download, or any other consumer about the progress of that file download.

Annex A (informative):
Heartbeat PlantUML source code