PDF

Hvordan konfigurere generering av PDF.

Ny PDF generering

Aktivere ny PDF generering

Fra og med versjon 7.5 av nuget pakkene (Altinn.App.Api og Altinn.App.Core) er det lansert en ny måte å generere PDF’er på. Denne nye måten kan skrus av og på ved å legge til følgende seksjon og innstilling i appsettings.json.

  "FeatureManagement": {
    "NewPdfGeneration": true
  }

Dette vil sørge for at den nye PDF tjenesten kalles. Denne aksepterer en url som peker tilbake til en automatisk generert side i appen. Siden bygges opp og danner grunnlaget for PDF’en. IPdfFormatter grensesnittet som dokumentert nedenfor er fortsatt relevant hvis du trenger spesiallogikk for skjuling av komponenter/sider fra PDF’en.

Innstillinger

Selv om standard innstillingene for den nye tjenesten skal være nok for de fleste applikasjoner kan de overstyres ved å legge til en PdfGeneratorSettings seksjon i appsettings.json (standard innstillinger vises under).

  "PdfGeneratorSettings": {
    "ServiceEndpointUri": "https://{org}.apps.{hostName}/{appId}/#/instance/{instanceId}",
    "AppPdfPageUriTemplate": "https://{org}.apps.{hostName}/{appId}/#/instance/{instanceId}?pdf=1",
    "WaitForSelector": "#readyForPrint",
    "WaitForTime": 5000
  }

Hvis WaitForSelector er satt så blir WaitForTime ignorert. WaitForSelector sikrer at siden er ferdig oppbygd og presentert før PDF’en genereres.

Det er to ulike måter å konfigurere PDF-genereringen på:

  1. Automatisk basert på skjema-sidene dine
  2. Manuelt basert på en egendefinert PDF-side

Det er også mulig å se en forhåndsvisning av hvordan PDF’en kommer til å se ut i nettleseren imens du jobber med den (kun v7.5+).

Automatisk konfigurasjon

Denne metoden brukes som standard dersom du ikke har spesifisert en egendefinert PDF-side. Denne metoden trekker ut alle sidene og komponentene i den rekkefølgen de vises, og tar de med i PDF-dokumentet.

Ekskludering av sider og komponenter

Som regel har man behov for å ekskludere visse sider og komponenter som ikke er relevant for PDF-dokumentet. Dette kan konfigureres på to ulike måter:

  1. Ved å modifisere Settings.json-filen for layout-settet.
  2. Programmatisk ved å implementere det i kode. Dette åpner for dynamisk ekskludering basert på skjemadataen.

Avhengig av hvilken versjon du kjører setter man opp den programmatiske metoden litt forskjellig, men logikken er helt lik. Oversikten under viser hvordan det settes opp for versjonen du kjører:

    1. Opprett en klasse som implementerer IPdfFormatter grensesnittet som ligger i Altinn.App.Core.Features navnerommet.
      Du kan navngi og plassere filene i den mappestrukturen du selv ønsker i prosjektet ditt. Men vi anbefaler at du benytter meningsfulle navnerom som i et hvilket som helst annet .Net prosjekt.
    2. Registrer din implementering i Program.cs klassen
      services.AddTransient<IPdfFormatter, PdfFormatter>();
      Dette sørger for at din kode er kjent for applikasjonen og at koden blir kjørt når den skal.
    Endre PdfHandler.cs-filen under App/logic/Print-mappen.

    1. Settings.json

    Legg til en liste med side-navn som skal eksluderes på excludeFromPdf under pages:

    {
  "$schema": "https://altinncdn.no/schemas/json/layout/layoutSettings.schema.v1.json",
  "pages": {
    "excludeFromPdf": ["side2"]
  }
}

    2. Programmatisk

    public async Task<LayoutSettings> FormatPdf(LayoutSettings layoutSettings, object data)
{
  if (data.GetType() == typeof(Skjema))
  {
    layoutSettings.Pages.ExcludeFromPdf.Add("side2");
  }
  return await Task.FromResult(layoutSettings);
}

    NB: Du trenger kun å velge en av disse metodene.

    1. Settings.json

    Legg til en liste over komponent-IDer som skal ekskluderes på excludeFromPdf under components:

    {
  "$schema": "https://altinncdn.no/schemas/json/layout/layoutSettings.schema.v1.json",
  "components": {
    "excludeFromPdf": ["bilde-komponent-id"]
  }
}

    2. Programmatisk

    public async Task<LayoutSettings> FormatPdf(LayoutSettings layoutSettings, object data)
{
  if (data.GetType() == typeof(Skjema))
  {
    layoutSettings.Components.ExcludeFromPdf.Add("bilde-komponent-id");
  }
  return await Task.FromResult(layoutSettings);
}

    NB: Du trenger kun å velge en av disse metodene.

    Dersom du trenger å ekskludere en komponent fra en spesifikk rad i en repeterende gruppe må du spesifisere rad-nummeret i tillegg til komponent-IDen.

    Formatet er: komponentID-<rad-nummer>.

    1. Settings.json

    {
  "$schema": "https://altinncdn.no/schemas/json/layout/layoutSettings.schema.v1.json",
  "components": {
    "excludeFromPdf": ["komponent-i-gruppe-1"]
  }
}

    2. Programmatisk

    public async Task<LayoutSettings> FormatPdf(LayoutSettings layoutSettings, object data)
{
  if (data.GetType() == typeof(Skjema))
  {
    layoutSettings.Components.ExcludeFromPdf.Add("komponent-i-gruppe-1");
  }
  return await Task.FromResult(layoutSettings);
}

    NB: Du trenger kun å velge en av disse metodene.

    Egendefinert konfigurasjon

    Denne metoden er kun tilgjengelig i versjon 7.5 og høyere.

    Denne metoden lar deg spesifisere en helt egendefinert PDF ved å definere en layout-fil som bestemmer hva den skal inneholde.

    For å ta i bruk denne metoden må du opprette en ny layout-fil for PDF’en og sette pdfLayoutName i Settings.json til å peke på den filen:

    {
  "$schema": "https://altinncdn.no/schemas/json/layout/layoutSettings.schema.v1.json",
  "pages": {
    "pdfLayoutName": "minPdfLayout"
  }
}

    Denne layout-filen konfigureres på akkurat samme måte som andre layout-filer, bortsett fra at ikke alle komponent-typer er tilgjengelig. Komponent-typene som kan brukes i en PDF-layout er følgende:

    • Summary
    • Group
    • InstanceInformation
    • Header
    • Paragraph
    • Image
    • Panel

    Den automatiske PDF-layouten inkluder en forside med instans-informasjon som avsender, mottaker, dato, og referansenummer. Dette bør du også inkludere i din egendefinerte PDF-layout. Eksempelet under viser hvordan du kan inkludere denne informasjonen på akkurat samme måte som i den automatiske metoden:

    {
  "$schema": "https://altinncdn.no/schemas/json/layout/layout.schema.v1.json",
  "data": {
    "layout": [
      {
        "id": "pdf-instans",
        "type": "InstanceInformation",
        "elements": {
        "dateSent": true,
        "sender": true,
        "receiver": true,
        "referenceNumber": true
        },
        "pageBreak": {
          "breakAfter": true
        }
      }
      ...
    ]
  }
}

    Du kan spesifisere at en komponent skal starte på en ny side eller at et sideskift skal komme rett etter en komponent ved å bruke pageBreak-egenskapen. Denne egenskapen er tilgjengelig på alle komponenter. I eksempelet under brukes det på en overskrift for å sørge for at den starter på en ny side:

    {
  "id": "pdf-overskrift",
  "type": "Header",
  "textResourceBindings": {
    "title": "Dette er en ny seksjon"
  },
  "dataModelBindings": {},
  "size": "L",
  "pageBreak": {
    "breakBefore": "always",
    "breakAfter": "avoid"
  }
}

    NB: Verdien av breakBefore og breakAfter kan enten være auto (standard), always, avoid, eller ett uttrykk som returnerer en av disse verdiene.

    Det er mulig å ekskludere enkeltkomponenter inne i en gruppe ved å bruke excludedChildren-egenskapen på en Summary-komponent som refererer til en Group-komponent. Dette gjøres ved å legge IDen til komponenten i listen over ekskluderte komponenter som i eksempelet under:

    {
  "id": "pdf-group-summary",
  "type": "Summary",
  "componentRef": "en-gruppe-komponent",
  "pageRef": "Form",
  "excludedChildren": ["en-komponent-i-gruppen"]
},

    Forhåndsvisning i nettleseren

    Denne funksjonen er kun tilgjengelig i versjon 7.5 og høyere.

    Det er mulig å se en forhåndsvisning av hvordan den genererte PDF’en kommer til å se ut i nettleseren imens du jobber. Følg instruksjonene nedenfor:

    1. Viktig: Bruk Google Chrome til å forhåndsvise PDF.
      PDF-generatoren bruker en variant av Chrome til å generere PDF’en, så andre nettlesere vil ikke produsere et korrekt resultat ved forhåndsvisning.
    2. I appen du ønsker å forhåndsvise, legg til ?pdf=preview på slutten av URLen i nettleseren og trykk enter.
      Dette vil sørge for at PDF-layouten ligger klar i bakgrunnen slik at du kan få en umiddelbar preview. Du kan oppleve svakere ytelse i denne modusen.
    3. Når du er klar til å fohåndsvise, bruk Chrome sin innebygde print-funksjon (Ctrl+P/⌘+P) for å se en forhåndsvisning av hvordan PDF-dokumentet kommer til å se ut.