eFormidling

Hvordan konfigurere eFormidling integrasjon for en app.

På denne siden:

Aktivere integrasjon med eFormidling i applikasjonen din

Dersom man har behov for integrasjon med eFormidling i applikasjonen må dette aktiveres.

I filen appsettings.json i mappen App må følgende legges til i seksjonen AppSettings

"EnableEFormidling":  true

I tillegg må det i samme fil opprettes en ny seksjon; EFormidlingClientSettings. Innholdet i kodesnutten nedenfor kan kopieres i sin helhet. Denne setter opp url til integrasjonspunktet. Lenken peker på mocken som kan kjøres opp lokalt. Les mer om oppsettet av eFormidlings mocken her.

Når en app deployes til TT02 eller produksjon vil denne verdien overskrives og peke mot integrasjonspunktet i Altinn Platform.

"EFormidlingClientSettings": {
   "BaseUrl": "http://localhost:9093/api/"
 }

Dersom det ikke er ønskelig å teste integrasjonen med eFormidling når man kjører applikasjonen lokalt kan man overstyre denne konfigurasjonen i appsettings.Development.json.

Opprett AppSettings seksjonen dersom den ikke finnes og sett EnableEFormidling til false.

"AppSettings": {
    "EnableEFormidling": false
}

services.AddEFormidlingServices<EFormidlingMetadata, EFormidlingReceivers>(config);

using Altinn.Common.EFormidlingClient.Models;
using Altinn.Common.EFormidlingClient;
using Altinn.Common.AccessTokenClient.Services;

public App(
IAppResources appResourcesService,
(...)
IHttpContextAccessor httpContextAccessor):base(
appResourcesService,
(...)
httpContextAccessor)

IEFormidlingClient eformidlingClient,
IOptions<AppSettings> appsettings,
IAccessTokenGenerator tokenGenerator,
IOptions<PlatformSettings> platformSettings

eformidlingClient,
appsettings,
platformSettings,
tokenGenerator

public App(
IAppResources appResourcesService,
(...)
IHttpContextAccessor httpContextAccessor,
IEFormidlingClient eformidlingClient,
IOptions<AppSettings> appsettings,
IAccessTokenGenerator tokenGenerator,
IOptions<PlatformSettings> platformSettings):base(
appResourcesService,
(...)
httpContextAccessor,
eformidlingClient,
appsettings,
platformSettings,
tokenGenerator)

Konfigurere nøkkelverdier for eFormidling i applikasjonen din

Det kreves en del metadata om eFormidlingsforsendelsen og denne defineres i applicationmetadata.json_. Filen finner du i repoet under mappen App/config.

Opprett seksjonen eFormidling og fyll ut verdier for følgende parametre.

* per juni 2023 er det støtte for DPF og DPO.

** tilgjengelige prosesser for mottaker er tilgjengelig på https://platform.altinn.no/eformidling/api/capabilities/{mottaker-orgnummer}

Et eksempel for en konfigurasjon i application metadata:

"eFormidling": {
    "serviceId": "DPF",
    "dpfShipmentType": "altinn3.skjema",
    "process": "urn:no:difi:profile:arkivmelding:administrasjon:ver1.0",
    "dataTypes": [ "ref-data-as-pdf" ],
    "sendAfterTaskId": "Task_2",
    "receiver": "910075918",
    "standard": "urn:no:difi:arkivmelding:xsd::arkivmelding",
    "type": "arkivmelding",
    "typeVersion": "2.0",
    "securityLevel":  3
}

Generering av metadata til forsendelsen i applikasjonen

Apputvikler er selv ansvarlig for å sette opp meldingen til en forsendelse som skal via eFormidling. Les om de ulike meldingstypene tilgjengelig i eFormidling.

I versjon 4, 5 og 6 ble dette gjort ved å legge til funksjonen nedenfor i App.cs. Mens i versjon gjør man dette ved å legge til en klasse som implementerer IEFormidlingMetadata grensesnittet som har samme metode og signatur. Husk at i versjon 7 må du også registrere implementeringen din i Program.cs.

Forventet output fra denne metoden er en tuppel som inneholder navnet på metadatafilen som første element og en stream med metadataen som andre element.

/// <inheritdoc />
public override async Task<(string, Stream)> GenerateEFormidlingMetadata(Instance instance)
{
    Altinn.Common.EFormidlingClient.Models.Arkivmelding arkivmelding = new ();

    // bygg opp arkivmeldingen eller annet metadataobjekt her.

    MemoryStream stream = new MemoryStream();
    XmlSerializer serializer = new XmlSerializer(typeof(Altinn.Common.EFormidlingClient.Models.Arkivmelding));
    serializer.Serialize(stream, arkivmelding);
    stream.Position = 0;
    StreamContent streamContent = new StreamContent(stream);
    streamContent.Headers.ContentType = MediaTypeHeaderValue.Parse("application/xml");
    return await Task.FromResult(("arkivmelding.xml", stream));
}

Sette mottaker for forsendelse i applikasjonslogikken

Denne funksjonaliteten kan benyttes dersom mottaker av forsendelsen skal avgjøres dynamisk.

I App.cs kan man overstyre metoden som henter ut mottaker av forsendelsen fra applicationmetadata.json_.

public async Task<List<Receiver>> GetEFormidlingReceivers(Instance instance)
{
    Identifier identifier = new Identifier
    {
        Authority = "iso6523-actorid-upis"
    };

    // 0192 prefix for all Norwegian organisations.
    identifier.Value = "[INSERT ORGANISATION NUMBER HERE WITH PREFIX `0192:`]" ;

    Receiver receiver = new Receiver { Identifier = identifier };
    return new List<Receiver> { receiver };
}

using Altinn.Common.EFormidlingClient.Models.SBD;

Lokal test av applikasjon med eFormidling

Det er mulig å teste eFormidlingsintegrasjonen i applikasjonen lokalt på utviklingsmiljøet ditt. I tillegg til Altinn Localtest og applikasjonen er det to ting som må kjøre:

1. eFormidling integrasjonspunkt
2. mock av eFormidling

Forberedelser

1. Installer siste versjon av Java. Finn nedlastingslenke og beskrivelse av nødvendige steg her

2. Det skal nå lastes ned en rekke filer. Finn en egnet plassering for eFormidling lokalt på maskinen din og navigér dit i en terminal.

3. Klon repoet som inneholder eFormidling mocken med følgende commando

   git clone --branch development https://github.com/felleslosninger/efm-mocks.git
   

4. Last ned integrasjonspunktet herfra. Dette kan plasseres på samme nivå som mappen efm-mocks.

Kjøre eFormidling lokalt

1. Åpne en terminal og navigér til efm-mocks (Command prompt eller bash er anbefalt, PowerShell funker ikke. )
2. Kjør docker-compose up -d
3. Navigér til mappen der integrasjonspunkt-filen ligger
4. Kjør kommandoen java -Xmx2g -Dspring.profiles.active=mock -jar integrasjonspunkt-2.2.0.jar Dersom du har en nyere versjon av integrasjonspunktet enn 2.2.0 må kommandoen siste ledd i siste linje justeres for dette.

Verifiser at eFormidling er satt opp korrekt

Dette steget krever node og npm på maskinen din, men er ikke nødvendig for å bruke mocken.

• Åpne en terminal og navigér til efm-mocks/tests/
• Kjør npm i
• Navigér inn i mappen next-move
• Kjør node NextMove.js dpf
• Verifiser i en broswer på localhost:8001 at det er nye innslag i tabellen med de sendte meldingene.

Les mer om mockløsningen her

Test av eFormidling integrasjon i testmiljø

Integrasjonspunktet eksponerer endepunkter der man kan følge statusen for en forsendelse i testmiljø (tt02). https://platform.tt02.altinn.no/eformidling/api/conversations?messageId={instanceGuid}

Bytt ut {instanceGuid} med guiden til instansen som er blitt innsendt.