Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Basic start of Broker Transition Solution Documentation #1570

Merged
merged 42 commits into from
Jun 3, 2024
Merged
Show file tree
Hide file tree
Changes from 27 commits
Commits
Show all changes
42 commits
Select commit Hold shift + click to select a range
7320148
Basic start of documentation
Apr 24, 2024
b793fbe
Merge branch 'master' of https://github.com/tomshag/altinn-studio-docs
Apr 24, 2024
f93dcc7
Merge branch 'master' into hvorfor
tomshag Apr 24, 2024
db4f8a5
Merge pull request #1 from tomshag/hvorfor
tomshag Apr 24, 2024
cb6ddce
updated based on comments
May 8, 2024
3f6c285
Merge remote-tracking branch 'upstream/master'
May 8, 2024
f66325f
Merge pull request #2 from tomshag/attempt-sync
tomshag May 8, 2024
b58621c
Merge branch 'Altinn:master' into master
tomshag May 8, 2024
bc02cfb
Merge branch 'master' into Update-of-doc-based-on-prcomments
May 8, 2024
335d7c2
Merge pull request #3 from tomshag/Update-of-doc-based-on-prcomments
tomshag May 8, 2024
3c63427
updated failing link
May 8, 2024
e5889fb
Merge pull request #4 from tomshag/feature/failedlink
tomshag May 8, 2024
b6a4b79
fix link attempt 2
May 8, 2024
a1c84b7
Merge pull request #5 from tomshag/linkfix2
tomshag May 8, 2024
58e9bc8
Merge branch 'Altinn:master' into master
tomshag May 13, 2024
6bf8cc5
updates based on comments
May 13, 2024
f65731b
update for clunky sentence and numbering
May 13, 2024
0ac10e8
Merge pull request #6 from tomshag/update_for_comments2
tomshag May 13, 2024
1872364
Merge branch 'master' into master
tomshag May 21, 2024
dcf9b3a
lagt inn oversatte sider
May 22, 2024
0baeeda
Merge pull request #7 from tomshag/translate
tomshag May 22, 2024
c995c22
Merge branch 'Altinn:master' into master
tomshag May 23, 2024
8597045
oppdatert overskrift og link
May 23, 2024
4ba7127
Merge pull request #8 from tomshag/update_link
tomshag May 23, 2024
c49e185
Merge branch 'master' into master
tomshag May 24, 2024
676e38a
Merge branch 'master' into master
tomshag May 27, 2024
63d39c8
Merge branch 'master' into master
tomshag May 28, 2024
d5288d7
Merge branch 'Altinn:master' into master
tomshag May 29, 2024
5341cbf
updated based on comments
May 30, 2024
feb4b64
Merge pull request #9 from tomshag/translate_comments
tomshag May 30, 2024
b496f62
missed one
May 30, 2024
0737e5e
Merge pull request #10 from tomshag/translate_comments2
tomshag May 30, 2024
6484ce8
oppdatert overgangsløsning
May 30, 2024
ec8b1d8
Merge pull request #11 from tomshag/translate_comments3
tomshag May 30, 2024
195228d
Merge branch 'Altinn:master' into master
tomshag May 31, 2024
213d338
updated some broker translations that were missing and tried to make …
May 31, 2024
1ea47d8
update
May 31, 2024
7303550
Merge pull request #12 from tomshag/translate_comments4
tomshag May 31, 2024
3e55e4a
should resolve the last converastions
May 31, 2024
6e21573
Merge pull request #13 from tomshag/translate_comments5
tomshag May 31, 2024
412cde7
Merge branch 'Altinn:master' into master
tomshag May 31, 2024
a370cc6
Merge branch 'master' into master
tomshag Jun 3, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .vscode/settings.json
tomshag marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -28,5 +28,6 @@
"workbench.editor.customLabels.enabled": true,
"workbench.editor.customLabels.patterns": {
"content/**/*index.*md": "${dirname}/${filename}.${extname}"

}
}
20 changes: 20 additions & 0 deletions content/broker/broker-transition/_index.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: Altinn 3 Broker Transition Solution
linktitle: Transition Solution
description: Altinn 2 Broker Transition to Altinn 3 Broker architecture.
tags: [broker, transition, architecture]
toc: false
weight: 90
---

## About
For broker service owners whose end users are reliant on using Altinn 2, but who wish to migrate their broker service to Altinn 3, Altinn is offering a Transition service.
This enables communication between senders and receivers of files regardless of which Altinn Broker service they are integrated to.

This service will allow service owners to link an existing Altinn 2 service to an Altinn 3 resource, and to forward Altinn 2 Broker Service requests to the Altinn 3 Broker Service app while not substantially changing the Altinn 2 Broker Service End User experience.
This will then allow end users of the Altinn 2 service to communicate with end users of the Altinn 3 resource.

tomshag marked this conversation as resolved.
Show resolved Hide resolved
For Altinn 3 users, the user experience will not be different than if all users are using Altinn 3.

tomshag marked this conversation as resolved.
Show resolved Hide resolved
Altinn 2 users will experience some minor differences related to file transfer and returned values compared to if all users are using Altinn 2.
{{<children />}}
20 changes: 20 additions & 0 deletions content/broker/broker-transition/_index.nb.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: Altinn 3 Broker overgangsløsning
linktitle: Overgangsløsning
tomshag marked this conversation as resolved.
Show resolved Hide resolved
description: Altinn 2 Broker overgang til Altinn 3 Broker arkitektur.
tags: [broker, overgang, arkitektur]
toc: false
weight: 90
---

## About
For eiere av Broker tjenester hvis sluttbrukere er avhengige av å bruke Altinn 2, men som ønsker å migrere sin Broker tjeneste til Altinn 3, tilbyr Altinn en overgangstjeneste.
tomshag marked this conversation as resolved.
Show resolved Hide resolved
Dette muliggjør kommunikasjon mellom avsendere og mottakere av filer uavhengig av hvilken Altinn Broker tjeneste de er integrert i.

Denne tjenesten vil tillate tjenesteeiere å koble en eksisterende Altinn 2 tjeneste til en Altinn 3 ressurs, og for å videresende Altinn 2 Broker Service forespørsler til Altinn 3 Broker Service appen, mens den ikke vesentlig endrer Altinn 2 Broker Servicens sluttbrukeropplevelsen.
tomshag marked this conversation as resolved.
Show resolved Hide resolved
tomshag marked this conversation as resolved.
Show resolved Hide resolved
Dette vil da tillate sluttbrukere av Altinn 2 tjenesten å kommunisere med sluttbrukere av Altinn 3 ressursen.

For Altinn 3 brukere vil brukeropplevelsen ikke være annerledes enn om alle bruker Altinn 3.

Altinn 2 brukere vil oppleve noen mindre forskjeller relatert til fil overføring og returnerte verdier sammenlignet med om alle bruker Altinn 2.
tomshag marked this conversation as resolved.
Show resolved Hide resolved
{{<children />}}
37 changes: 37 additions & 0 deletions content/broker/broker-transition/how-to-get-started/_index.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: How To Get Started
linktitle: How To Get Started
description: How to get started using the Broker Transition solution from Altinn 2 to Altinn 3
tags: [solution, broker, transition, guide]
toc: false
weight: 1
---

## ServiceOwners
In order to use the Broker Transition solution in Altinn 2 to create, upload and retrieve file metadata, a service owner must complete the following steps.
1. Have an existing Altinn 2 Broker Service.
2. Have or create a corresponding Altinn 3 Broker Resource.
See how to get started with Altinn Broker here: TODO: Add link to Get Started
tomshag marked this conversation as resolved.
Show resolved Hide resolved
3. <!-- TODO: Set up of rights for the Altinn 3 Resource>
<!-- TODO: Should we have links here to the different services used by service owners to create the different services? -->
4. Request a transition setup from the Altinn 2 Service to the Altinn 3 Resource. Determine the date for when this should go live. (To minimize the risk of orphaned data in Altinn 2 storage)
5. Go live with transition solution while encouraging consumers to migrate to Altinn Broker.
6. Once all consumers have migrated to Altinn Broker, decommission the Altinn 2 Broker Service.


tomshag marked this conversation as resolved.
Show resolved Hide resolved
### Additional Service Owner information
After a service owner requests that an Altinn 2 service transition to an Altinn 3 Resource,
the Altinn 2 service will no longer pass requests to the Altinn 2 Broker Storage.
This means existing Broker files in the Altinn 2 Broker Storage will become unavailable for end users once the service
is set up to transition to Altinn 3.

## EndUsers
For end users, there is very little technical difference between using an Altinn 2 Broker service and a Broker service that has been transitioned to Altinn 3.
tomshag marked this conversation as resolved.
Show resolved Hide resolved
But all consumers should have their technical team go through this documentation to determine if the changes in the Transition solution require changes to their implementation or code.

Functionally, the files transferred will no longer contain a manifest, and receipts will no longer have a Receipt Id.

Additionally, while in Altinn 2 Broker Services a file is virus-scanned as part of the upload process, in Altinn 3 the virus-scanning is done after upload, which means an uploaded file in Altinn 3 will not be immediately available, unlike in Altinn 2.
The file will be made available once the automatic virus scan is completed.

Calls to get Receipt through external Receipt SOAP endpoint is not supported. If this is a requirement of a service owner or end user, send us a feature request.
37 changes: 37 additions & 0 deletions content/broker/broker-transition/how-to-get-started/_index.nb.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
Title: Hvordan komme i gang
LinkTitle: Hvordan komme i gang
Descriptions: Hvordan komme i gang med å bruke Broker overgangsløsningen fra Altinn 2 til Altinn 3
Tags: [Løsning, Broker, overgang, guide]
TOC: False
Weight: 1
---

## Tjenesteeiere
For å bruke Broker overgangsløsningen i Altinn 2 for å opprette, laste opp og hente fil metadata, må en tjenesteeier fullføre følgende trinn.
1. Ha en eksisterende Altinn 2 Broker tjeneste.
2. Ha eller lag en tilsvarende Altinn 3 Broker ressurs.
Se hvordan du kommer i gang med Altinn Broker her: TODO: Legg til lenke for å komme i gang
tomshag marked this conversation as resolved.
Show resolved Hide resolved
3. <!-- TODO: Oppsett av rettigheter for Altinn 3-ressursen-->
<!-- TODO: Bør vi ha lenker her til de forskjellige tjenestene som brukes av tjenesteeiere for å lage de forskjellige tjenestene?-->
4. Be om et overgangsoppsett fra Altinn 2 tjenesten til Altinn 3 ressursen. Bestem dato for når dette skal gå i live. (For å minimere risiko for foreldreløse data i Altinn 2 lagring)
5. Gå live med overgangsløsning mens du oppfordrer forbrukerne til å migrere til Altinn Broker.
6. Når alle forbrukere har migrert til Altinn Broker en, må du dekommisjonere Altinn 2 Broker tjenesten.


### Tilleggsinformasjon
Etter at en tjenesteeier ber om at en Altinn 2 tjenesteovergang til en Altinn 3 ressurs,
Altinn 2 tjenesten vil ikke lenger sende forespørsler til Altinn 2 Broker lagring.
Dette betyr at eksisterende Broker filer i Altinn 2 Broker lagring vil bli utilgjengelig for sluttbrukere når tjenesten
er satt opp til overgang til Altinn 3.

## Sluttbrukere
For sluttbrukere er det veldig liten teknisk forskjell mellom å bruke en Altinn 2 Broker tjeneste og en Broker tjeneste som er blitt overført til Altinn 3.
Men alle forbrukere bør få det tekniske teamet til å gå gjennom denne dokumentasjonen for å avgjøre om endringene i overgangsløsningen krever endringer i implementeringen eller koden.

Funksjonelt sett vil filene som overføres ikke lenger inneholde en manifest, og kvitteringer vil ikke lenger ha en kvitteringsid.

I tillegg, mens en vil ble virus-scannet under opplasting i Altinn 2, blir den i Altinn 3 gjort asynkront etter opplasting. Dette betyr at en opplastet fil i Altinn 3 ikke vil være umiddelbart tilgjengelig, i motsetning til i Altinn2.
Filen vil bli gjort tilgjengelig når den automatiske virus skanningen er fullført.

Samtaler for å få kvittering gjennom ekstern Receipt SOAP endepunkt støttes ikke. Hvis dette er et krav fra en tjenesteeier eller sluttbruker, kan du sende oss en endringsforespørsel.
43 changes: 43 additions & 0 deletions content/broker/broker-transition/technical-overview/_index.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
title: Technical Overview
linktitle: Technical Overview
description: The Altinn 3 Broker Transition Solution allows service owners who own broker services in Altinn 2 to point those services towards Altinn 3 using an internal Altinn 2 bridge.
tags: [architecture, solution, broker, transition]
toc: false
weight: 1
---

## About

The Altinn 3 Broker Transition service bridge is an internal component in Altinn 2 that transfers Broker requests from Altinn 2 to Altinn 3 for a given request, based on the Service/ServiceCode combination of the request.
This is an implementation of the soft shift solution described [here](../../solution-architecture/#soft-shift-from-altinn-2-to-altinn-3).

## Technical overview

Altinn 2 allows end users in Altinn 2 to make BrokerService requests for specific Broker Services that will be transferred to Altinn 3 instead of being stored in Altinn 2.
Files transferred in this way will be available for Altinn 3 and Altinn 2 users.


1. Requests that have the ability to specify ServiceCode / ServiceEdition.
In this case Altinn will immediately determine that the request should be transferred to Altinn 3 via the Altinn 3 Broker Bridge.
In cases where the SC/SE can be specified, but aren't, requests will not be transferred to Altinn 3.
2. Requests that do not have the ability to specify SC/SE.
In this case a call will first be made to Altinn 2 Broker storage. If nothing is found in Altinn 2, a call will be made to Altinn 3.
3. Files in Altinn 3 cannot be larger than 1 GB, as this is the maximum file size in Altinn 2. The Altinn 3 Resource should be configured with this max filesize restriction.
4. File data and metadata will be stored in the Altinn 3 store, while Altinn 2 will simply call Altinn 3.
5. Receipts will no longer be stored in Altinn 2, instead a pseudo receipt will be generated from Altinn 3 Metadata. Receipt endpoint in Altinn 2 will no longer be used for Transitioned Broker Services. If you require the use of Receipt endpoint, submit a feature request.
6. The use of Manifest file in the submitted file data is deprecated in Altinn 3 and Transitioned Broker Services. If this is a critical requirement, submit a feature request.

<img src="altinn3-broker-transition-flowchart.svg" />

## Switch Over - What to expect
When the Altinn 3 Broker Transition Solution feature is enabled in Altinn 2, the following occurs:
1. ServiceOwners can request that Altinn 2 Broker Services be transitioned to Altinn 3 Resources.
2. End users that use these services will then transmit data to Altinn 3 instead of Altinn 2 data stores.
3. Files that were available in Altinn 2 for the Broker Service will no longer be available.
4. All new files and status changes will occur in the Altinn 3 Broker Service Solution.
tomshag marked this conversation as resolved.
Show resolved Hide resolved
5. ServiceOwners with transitioned Broker Services will have to manage access rights in both Altinn 3 and Altinn 2 simultaneously, as these are not automatically synchronized.

{{<children />}}


43 changes: 43 additions & 0 deletions content/broker/broker-transition/technical-overview/_index.nb.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
title: Teknisk oversikt
linktitle: Teknisk oversikt
description: Altinn 3 Broker overgangsløsningen gjør det mulig for serviceeiere som eier Broker tjenester i Altinn 2 å peke disse tjenestene mot Altinn 3 ved hjelp av en intern Altinn 2 bro.
tags: [arkitektur, løsning, broker, overgang]
toc: false
weight: 1
---

## Om

Altinn 3 Broker Transition Service Bridge er en intern komponent i Altinn 2 som overfører Broker forespørsler fra Altinn 2 til Altinn 3 for en gitt forespørsel, basert på ServiceCode/ServiceEdition kombinasjon av forespørselen.
Dette er en implementering av den myke skiftløsningen beskrevet [her](../../solution-architecture/#myk-overgang-fra-altinn-2-til-altinn-3).
tomshag marked this conversation as resolved.
Show resolved Hide resolved

## Teknisk oversikt

Altinn 2 lar sluttbrukere i Altinn 2 komme med Broker service forespørsler om spesifikke Broker tjenester som vil bli overført til Altinn 3 i stedet for å bli lagret i Altinn 2.
Filer overført på denne måten vil være tilgjengelige for Altinn 3 og Altinn 2 brukere.


1. Forespørsler som har muligheten til å spesifisere ServiceCode / ServiceEdition.
I dette tilfellet vil Altinn umiddelbart avgjøre at forespørselen skal overføres til Altinn 3 via Altinn 3 Broker Bridge.
I tilfeller der SC/SE kan spesifiseres, men er ikke, vil ikke forespørsler bli overført til Altinn 3.
tomshag marked this conversation as resolved.
Show resolved Hide resolved
2. Forespørsler som ikke har muligheten til å spesifisere SC/SE.
I dette tilfellet vil det først bli ringt til Altinn 2 Broker lagring.Hvis ingenting blir funnet i Altinn 2, vil det bli ringt en samtale til Altinn 3.
tomshag marked this conversation as resolved.
Show resolved Hide resolved
tomshag marked this conversation as resolved.
Show resolved Hide resolved
3. Filer i Altinn 3 kan ikke være større enn 1 GB, da dette er den maksimale fil størrelsen i Altinn 2. Ressursen Altinn 3 skal konfigureres med denne MaxFileSize begrensningen.
4. Fil data og metadata vil bli lagret i Altinn 3 butikken, mens Altinn 2 ganske enkelt vil ringe Altinn 3.
tomshag marked this conversation as resolved.
Show resolved Hide resolved
5. Kvitteringer vil ikke lenger bli lagret i Altinn 2, i stedet vil en pseudokvittering bli generert fra Altinn 3 metadata.Kvitteringsendpunkt i Altinn 2 vil ikke lenger brukes til overførte Broker tjenester.Hvis du trenger bruk av endepunktet for kvitteringer, må du sende inn en funksjonsforespørsel.
tomshag marked this conversation as resolved.
Show resolved Hide resolved
6. Bruk av manifestfilen i de innsendte fil data er utdatert i Altinn 3 og overførte Broker tjenester.Hvis dette er et kritisk krav, kan du sende inn en funksjonsforespørsel.
tomshag marked this conversation as resolved.
Show resolved Hide resolved

<img src="altinn3-broker-transition-flowchart.svg" />

## Bytt over hva du kan forvente
tomshag marked this conversation as resolved.
Show resolved Hide resolved
Når Altinn 3 Broker Transition Solution funksjonen er aktivert i Altinn 2, oppstår følgende:
tomshag marked this conversation as resolved.
Show resolved Hide resolved
1. Tjenesteeiere kan be om at Altinn 2 Broker Services blir overført til Altinn 3 ressurser.
2. Sluttbrukere som bruker disse tjenestene vil deretter overføre data til Altinn 3 i stedet for Altinn 2 datalagre.
3. Filer som var tilgjengelige i Altinn 2 for Broker tjenesten vil ikke lenger være tilgjengelige.
4. Alle nye filer og statusendringer vil skje i Altinn 3 Broker Service Solution.
5. Tjenesteeiere med overførte Broker tjenester må administrere tilgangsrettigheter i både Altinn 3 og Altinn 2 samtidig, da disse ikke automatisk blir synkronisert.

{{<children />}}


Loading