PDF

Hvordan konfigurere generering av PDF

  "FeatureManagement": {
    "NewPdfGeneration": true
  }

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

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.

MERK: Denne metoden viser ikke oppsummerings-komponenter fra skjemaet.

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.

Den programmatiske metoden du velger å sette opp er avhengig av hvilken versjon du kjører, men logikken er helt lik. Oversikten under viser hvordan du setter det opp for den versjonen du kjører:

{
  "$schema": "https://altinncdn.no/toolkits/altinn-app-frontend/4/schemas/json/layout/layoutSettings.schema.v1.json",
  "pages": {
    "order": ["side1", "side2"],
    "excludeFromPdf": ["side2"]
  }
}

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

{
  "$schema": "https://altinncdn.no/toolkits/altinn-app-frontend/4/schemas/json/layout/layoutSettings.schema.v1.json",
  "pages": {
    "order": ["side1"]
  },
  "components": {
    "excludeFromPdf": ["bilde-komponent-id"]
  }
}

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);
}

{
  "$schema": "https://altinncdn.no/toolkits/altinn-app-frontend/4/schemas/json/layout/layoutSettings.schema.v1.json",
  "pages": {
    "order": ["side1"]
  },
  "components": {
    "excludeFromPdf": ["komponent-i-gruppe-1"]
  }
}

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);
}

Egendefinert konfigurasjon

Med Altinn Studio

Du kan legge til et tilpasset PDF-oppsett i Studio ved å konvertere en side til PDF-oppsett i sidekonfigurasjonen:

Du kan bruke komponenten Oppsummering, til å angi hvilke deler av oppsettet du vil ha med i PDF-en.

Manuell konfigurasjon

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 til den filen:

{
  "$schema": "https://altinncdn.no/toolkits/altinn-app-frontend/4/schemas/json/layout/layoutSettings.schema.v1.json",
  "pages": {
    "order": ["side1"],
    "pdfLayoutName": "minPdfLayout"
  }
}

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

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

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

{
  "$schema": "https://altinncdn.no/toolkits/altinn-app-frontend/4/schemas/json/layout/layout.schema.v1.json",
  "data": {
    "layout": [
      {
        "id": "pdf-header",
        "type": "Header",
        "textResourceBindings": {
          "title": "Dette er en ny seksjon"
        },
        "size": "L",
        "pageBreak": {
          "breakBefore": "always",
          "breakAfter": "avoid"
        }
      }
    ]
  }
}

{
  "$schema": "https://altinncdn.no/toolkits/altinn-app-frontend/4/schemas/json/layout/layout.schema.v1.json",
  "data": {
    "layout": [
      {
        "id": "pdf-group-summary",
        "type": "Summary",
        "componentRef": "en-gruppe-komponent",
        "excludedChildren": ["en-komponent-i-gruppen"]
      }
    ]
  }
}

Forhåndsvisning i nettleseren

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. Kjør opp appen din lokalt eller åpne appen din i testmiljøet, og start en instans.
3. Åpne utviklerverktøyet ved å trykke på knappen nederst i høyre hjørne, eller bruk hurtigtasten Ctrl+Shift+K/⌘+Shift+K.
   
   

   

4. Trykk på Forhåndsvis PDF-knappen i utviklerverktøyet.
   
   

   

PDF footer

Forutsetninger

For å bruke PDF footer-funksjonaliteten må applikasjonen din støtte tidssoner. Dette gjøres ved å legge til følgende linjer i Dockerfile:

  # Add globalization timezone support
  RUN apk add --no-cache icu-libs icu-data-full tzdata
  ENV DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=false

Linjene må legges til etter “FROM”-seksjonen som ender på “AS final”

Configuration

Di kan legge til en footer i den genererte PDF-en ved å legge til "DisplayFooter": true i PdfGeneratorSettings-seksjonen i appsettings.json-filen.

  "PdfGeneratorSettings": {
    "DisplayFooter": true
  }

Innhold

Footeren vil inneholde følgende informasjon:

• Navnet på appen

• Navnet på organisasjonen

• Dato og tid for når PDF-en ble generert

• Altinn referanse-ID

• Sidenummer

  

Skjule app-navnet i PDF-en

Du kan skjule app-navnet i toppteksten og bunnteksten i den genererte PDF-en ved å sette hideAppNameInPdf i uiSettings i layout-sets.json.

Egenskapen godtar true, false, eller et boolsk dynamisk uttrykk. Uttrykket må evaluere til true eller false — tekstuttrykk støttes ikke.

{
  "uiSettings": {
    "hideAppNameInPdf": true
  }
}

Se dynamiske uttrykk for mer informasjon.

Lag en PDF i Figma

Hvis du vil teste hvordan du kan sette opp PDF-en din, kan du gjøre det her:
Altinn Studio Komponenter.
Merk at eksempelet ikke er identisk med den faktiske koden, men er tilpasset for å lage prototyper i Figma.