Skip to content

index.md

Latest commit

 

History

History
71 lines (55 loc) · 2.56 KB

index.md

File metadata and controls

71 lines (55 loc) · 2.56 KB
Raw

Felles kodeverk

KodeverkCalloutService contains methods for fetching codes from Felles kodeverk for ad hoc use or for storing them as Common_Code__c records.

Installation

Set up a Named Credential to https://kodeverk-api.nav.no/ named kodeverk with an appropriate External Credential, Named Principal, and permissions.

Usage

Use getCodes(String) to get the codes for a given kodeverk for immediate use.

Use one of storeCodes(Set<String>) and storeAllCodes() to fetch codes and store them.

Administration

KodeverkCalloutService is Schedulable. Create a cronjob in order to regularly update the Common_Code__c table. Manage Kodeverk_Codeset__mdt to add or remove kodeverks to be updated.

Switch off EnqueueEnabled__c in the default record of Kodeverk_Config__mdt to halt queued jobs.

Workings

In order to not choke when updating a large number of codes, the callout and logic for each code set is queued separately, and if necessary split into multible batches for upsert. Which classes handle this is illustrated in the bottom diagram below.

Ad hoc usage

sequenceDiagram
    user -->> KodeverkCalloutService: getCodes
    KodeverkCalloutService -->> KodeverkHelper: getMeaningMap
    KodeverkHelper -->> kodeverk-api: GET
    kodeverk-api ->> KodeverkHelper: JSON
    KodeverkHelper ->> KodeverkCalloutService: Map<String, Meaning[]>
    KodeverkCalloutService -->> KodeverkHelper: getCodesFromMeaningMap
    KodeverkHelper ->> KodeverkCalloutService: Common_Code__c[]
    KodeverkCalloutService ->> user: Common_Code__c[]
Loading

Store all codes

sequenceDiagram
    user -->> KodeverkCalloutService: storeAllCodes
    KodeverkCalloutService -->> database: SELECT
    database ->> KodeverkCalloutService: Kodeverk_Codeset__mdt[]
    KodeverkCalloutService -->> KodeverkCalloutService: storeCodes
    loop for each kodeverk
        KodeverkCalloutService ->> KodeverkQueueable: label
        KodeverkQueueable -->> KodeverkHelper: getMeaningMap
        KodeverkHelper -->> kodeverk-api: GET
        kodeverk-api ->> KodeverkHelper: JSON
        KodeverkHelper ->> KodeverkQueueable: Map<String, Meaning[]>
        KodeverkQueueable -->> KodeverkHelper: getCodesFromMeaningMap
        KodeverkHelper -->> KodeverkHelper: getExistingCodeMap
        KodeverkHelper -->> database: SELECT
        database ->> KodeverkHelper: Common_Code__c[]
        KodeverkHelper ->> KodeverkQueueable: Common_Code__c[]
        KodeverkQueueable ->> KodeverkBatchable: Common_Code__c[]
        KodeverkBatchable ->> database: Common_Code__c[]
    end
Loading