Skip to content

Commit

Permalink
New broker doc erikhag1-8 (#1300)
Browse files Browse the repository at this point in the history 
* Misc. changes

* Started solution doc

* Minor

* tasks.json

* Housekeeping

* fix link

* Broker Doc - branch broker-erik7

* Some Broker changes

* Fixet typo i FAQ

* Fixed pull request links issue
  • Loading branch information
@erikhag1
erikhag1 authored Nov 29, 2023
1 parent 8210b2d commit 1990715
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 6 deletions.
29 changes: 27 additions & 2 deletions content/broker/1. Introduction/_index.en.md
View file
Original file line number Diff line number Diff line change
@@ -1,21 +1,24 @@
---
title: Altinn Broker Introduction
title: Altinn Broker Introduction
linktitle: Introduction
description: Introduction to the Altinn Broker Service
description: Introduction to the Altinn Broker Service
tags: [architecture, solution]
toc: true
weight: 10
---

{{<notice warning>}} <!-- info -->
This is work in progress.
This is work in progress.
{{</notice>}}

## What is Altinn Broker?

The main use case for Altinn Broker is Managed File Transfer (MFT). It
facilitates secure transmission of files of any size from one provider
to one or more specifically addressed consumers. As such, it offers many
to one or more consumers. As such, it offers many
benefits compared to alternative ad-hoc peer-to-peer file transfer
solutions.

Expand All @@ -34,6 +37,7 @@ transfers, Altinn Broker offers a number of benefits. Some of the main
benefits are:

- Managed service: Take the burden off Service owners and their solution
vendors - security, maintenance, certified compliance with relevant
vendors - security, maintenance, certified compliance with relevant
legislation and regulations.

Expand Down Expand Up @@ -61,14 +65,33 @@ benefits are:
- Advanced monitoring: With the in-built support for adding metadata to file transfers,
it is possible to analyse file transfer sequences between multiple actors involved in e.g. a case management process.

- Observability and Auditability: End-to-end visibility of all activity,
so you know the who, what, where, and when of data transfers. Quickly
access file-transfer logs and analytics to audit transfer activity
whenever needed.

- Advanced monitoring: With the in-built support for adding metadata to file transfers,
it is possible to analyse file transfer sequences between multiple actors involved in e.g. a case management process.

## Context Overview

The following diagram shows the main features, information flow and integration options of Altinn 3 Broker.
The following diagram shows the main features, information flow and integration options of Altinn 3 Broker.

[{{< figure src="./image2.png" title="Figure 2: Altinn Broker Context Diagram" alt="Alt-text">}}](https://altinn.github.io/ark/models/archi-all/?view=id-5824a04f89d04341aba661be649270b4)

Explamation to the diagram:

* The main services provided by Altinn Broker are File Upload and File Download, configured via Service Management, with intermediary storage of files and metadata.
* All features are accessible to End User Systems via APIs.
* Human End Users communicate with Altinn Broker via GUIs provided by either their custom End User Systems or GUI-s provided ny Altinn Broker. Note: Service owners may choose to leverage Altinn Studio for building GUIs.
* End User Systems may be triggered by events via notifications to [Webhooks](https://en.wikipedia.org/wiki/Webhook). The same events may alternatively be detected by polling the APIs,
however supporting Webhooks in the End User Systems is recommended over API polling.
* Service Owners configure the services and receive usage reports, invoices and other information according to the agreed service levels.
* Data Providers upload files and receive status updates.
* Data Consumers receive notifications about available files and download files, and they give status information about download processes (confirming successful download being the regular case).
Explamation to the diagram:

* The main services provided by Altinn Broker are File Upload and File Download, configured via Service Management, with intermediary storage of files and metadata.
* All features are accessible to End User Systems via APIs.
* Human End Users communicate with Altinn Broker via GUIs provided by either their custom End User Systems or GUI-s provided ny Altinn Broker. Note: Service owners may choose to leverage Altinn Studio for building GUIs.
Expand All @@ -91,6 +114,7 @@ Altinn 3 Broker. Also see <https://data.norge.no/concepts>.
| Cloud | TBD |
| Consumer | TBD |
| Data Broker | TBD |
| Data Broker | TBD |
| Dialog | TBD |
| Document | TBD |
| End-to-end process | TBD |
Expand All @@ -102,13 +126,14 @@ Altinn 3 Broker. Also see <https://data.norge.no/concepts>.
| Graphical User Interface (GUI) | TBD |
| Intermediary | TBD |
| Managed File Transfer (MFT) | TBD |
| Message Broker | TBDD |
| Message Broker | TBD |
| On Premise | TBD |
| Process | TBD |
| Provider | TBD |
| Recipient | TBD |
| Seamless services | TBD |
| Sender | TBD |
| Service-based Routing | See https://www.ehelse.no/standardisering/om-standardisering-i-e-helse/tjenestebasert-adressering |
| Service-based Routing | See https://www.ehelse.no/standardisering/om-standardisering-i-e-helse/tjenestebasert-adressering |
| User Journey | TBD |

2 changes: 1 addition & 1 deletion content/broker/10. FAQ/_index.en.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This is work in progress
{{</notice>}}

{{<notice info>}} <!-- info -->
Some the FAQ items may be moved to a less product specific FAQ.
Some of the FAQ items may be moved to a less product specific FAQ.
{{</notice>}}


Expand Down
4 changes: 3 additions & 1 deletion ...lution Architecture (managed file transfers)/5.1 Use Cases Covered/_index.en.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Use Cases Considered
linktitle: Use Cases
linktitle: Use Cases Considered
description: Identification of the of the Use Cases considered for the Altinn 3 Broker foundation architecture description.
tags: [architecture, solution]
toc: true
Expand All @@ -12,6 +12,7 @@ This is work in progress
{{</notice>}}

## One-to-one managed transfers of individual files

Illustration:
[{{< figure src="./image5.png" title="Figure 5a: One-to-one managed transfers of individual files" alt="Alt-text">}}](https://www.vg.no)

Expand All @@ -23,6 +24,7 @@ The initial implementation considers specifically addressed consumers only.


## One-to-many managed transfers of individual files

Illustration:
[{{< figure src="./image1.png" title="Figure 5b: One-to-many managed transfers of individual files" alt="Alt-text">}}](https://www.vg.no)

Expand Down
4 changes: 2 additions & 2 deletions .../5. Altinn 3 Broker Solution Architecture (managed file transfers)/_index.en.md
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Solution Architecture - Managed File Transfers
linktitle: Solution Architecture
description: Altinn 3 Broker Solution Architecture - Managed File Transfers
linktitle: MFT Solution Architecture
description: Altinn 3 Broker Solution Architecture - Managed File Transfers (MFT)
tags: [architecture, solution]
toc: false
weight: 50
Expand Down

0 comments on commit 1990715

Please sign in to comment.