Sporvalg

For å overstyre standard sporvalg må det gjøres to endringer.

1. Opprett en klasse som implementerer IPageOrder grensesnittet som ligger i Altinn.App.Core.Features.PageOrder 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.

   using System.Collections.Generic;
   using System.Threading.Tasks;
   using Altinn.App.Core.Features.PageOrder;
   using Altinn.App.Core.Models;
   using Altinn.App.Models;
   
   namespace Altinn.App.AppLogic.Custom;
   
   {
       public class CustomOrder : IPageOrder
       {
           /// <inheritdoc />
           public async Task<List<string>> GetPageOrder(AppIdentifier appIdentifier, InstanceIdentifier instanceIdentifier, string layoutSetId, string currentPage, string dataTypeId, object formData)
           {
               List<string> pageOrder = new List<string>();
   
               // Implement your logic here.
   
               return await Task.FromResult(pageOrder);
           }
   
       }
   
   }
   

2. Registrer din implementering i Program.cs klassen (.Net 6)

   services.AddTransient<IPageOrder, CustomOrder>();
   

   Dette sørger for at din kode er kjent for applikasjonen og at koden blir kjørt når den skal.

Interfacet inneholder en metode med navn GetPageOrder. Forventet output fra denne er en sortert liste over navnene på de relevante sidene i applikasjonen.

Funksjonen får inn en rekke parametere som kan være nyttig dersom man skal benytte skjemadata eller annen informasjon om sluttbruker til å kalkulere sporvalget.

• appIdentifier Inneholder org og app navn for applikasjonen

• instanceIdentifier Inneholder InstanceOwnerPartyId og InstanceGuid. Hvis applikasjonen er stateless vil dette objektet være blankt (InstanceIdentifier.NoInstance) Dersom GetInstanceId kalles på en InstanceIdentifier.NoInstance vil det kastes en Exception.

• layoutSetId Dersom appen din definerer flere layout set vil id på det gjeldende layout settet sendes inn. Dersom applikasjonen ikke har layout set vil denne strengen være tom. Basert på denne parameteren kan man hente ut standard siderekkefølge som er definert i applikasjonen:

List<string> pageOrder = new List<string>();

if (string.IsNullOrEmpty(layoutSetId))
{
    pageOrder = _appResourcesService.GetLayoutSettings().Pages.Order;
}
else
{
    pageOrder = _appResourcesService.GetLayoutSettingsForSet(layoutSetId).Pages.Order;
}

Dette forutsetter at servicen IAppResources gjøres tilgjengelig i klassen. Da servicen allerede er tilgjengelig via dependency injectes inn i klasen er det kun to steg som kreves.

1. Opprett en privat variabel i staten av klassen.

private readonly IAppResources _appResourcesService;

2. Definer en konstruktør som tar inn IAppResources og setter private variabelen som ble opprettet i steg 1.

public CustomOrder(IAppResources appResourcesService)
{
    _appResourcesService = appResourcesService;
}

• CurrentPage Siden man ønsker å navigere fra vil være spesifisert i denne parameteren.

• FormData inneholder skjemadataen. Den kan enkelt jobbes med som et objekt ved å caste den til riktig type Skjema skjema = (Skjema)formData;. Her heter C# modellen til skjemadataen Skjema for din applikasjon kan det være et annet navn. Dette kan du sjekke ved å finne klassenavnet på C# filen i App/models-mappen.

Sette opp sporvalg backend (nuget versjon < 5.0.0)

I App.cs må man overstyre metoden som henter ut den standardrekkefølgen av sider som er definert i Settings.json Dette gjøres ved å legge til funksjonen nedenfor i App.cs. Forventet output fra denne metoden er en stortert liste som inneholder navnet på de relevante sidene i applikasjonen.

/// <inheritdoc />
public override async Task<List<string>> GetPageOrder(string org, string app, int instanceOwnerId, Guid instanceGuid, string layoutSetId, string currentPage, string dataTypeId, object formData)
{
    List<string> pageOrder = new List<string>();
    // Implement your own logic here
    return pageOrder;
}

Funksjonen får inn en rekke parametere som kan være nyttig dersom man skal benytte skjemadata eller annen informasjon om sluttbruker til å kalkulere sporvalget.

• layoutSetId Dersom appen din definerer flere layout set vil id på det gjeldende layout settet sendes inn. Dersom applikasjonen ikke har layout set vil denne strengen være tom. Basert på denne parameteren kan man hente ut standard siderekkefølge som er definert i applikasjonen:

List<string> pageOrder = new List<string>();
if (string.IsNullOrEmpty(layoutSetId))
{
    pageOrder = _appResourcesService.GetLayoutSettings().Pages.Order;
}
else
{
    pageOrder = _appResourcesService.GetLayoutSettingsForSet(layoutSetId).Pages.Order;
}

Dette forutsetter at servicen IAppResources gjøres tilgjengelig i App.cs. Da servicen allerede dependency injectes inn i klasen er det kun to steg som kreves.

1. Opprett en privat variabel i staten av klassen.

private readonly IAppResources _appResourcesService;

2. Definer den nye private variabelen lik servicen som sendes med i konstruktøren til App.cs

 _appResourcesService = appResourcesService;

• CurrentPage Siden man ønsker å navigere fra vil være spesifisert i denne parameteren.
• FormData inneholder skjemadataen. Den kan enkelt jobbes med som et objekt ved å caste den til riktig type Skjema skjema = (Skjema)formData;. Her heter C# modellen til skjemadataen Skjema for din applikasjon kan det være et annet navn. Dette kan du sjekke ved å finne klassenavnet på C# filen i App/models-mappen.