OS2sofd

- Om OS2sofd: https://www.sofd.io/
- Brugervejledning: https://www.sofd.io/brugervejledning/
- Arkitektur: https://www.sofd.io/arkitektur/
- Implementeringsdrejebøger: https://www.sofd.io/implementation-guides/
- Drejebog: OPUS-kommune: https://www.sofd.io/implementation-guides/opus-loen-integration/
- Drejebog: SD-kommune: https://www.sofd.io/implementation-guides/sd-loen-integration/
- Brugerstyring: https://www.sofd.io/idm/
- Forudsætninger og forberedelse: https://www.sofd.io/idm/prerequisites/
- Processer og hændelser: https://www.sofd.io/idm/processes/
- Personinaktivering: https://www.sofd.io/idm/person-inactivation/
- Konfiguration: https://www.sofd.io/idm/configuration/
- Login og SAML: https://www.sofd.io/login/
- API: https://www.sofd.io/api/
- OData (læsning): https://www.sofd.io/api/odata/
- REST-API: https://www.sofd.io/api/rest/
- Fremtidig API-udvikling: https://www.sofd.io/api/strategi/
- Integrationer: https://www.sofd.io/integrationer/
- On-premise agenter: https://www.sofd.io/agents/
- Brugerkonto Agent: https://www.sofd.io/agents/user-account-agent/
- AD Writeback Agent: https://www.sofd.io/agents/ad-writeback-agent/
- AD Replikator Agent: https://www.sofd.io/agents/ad-replikator/
- AD indlæsningsintegration: https://www.sofd.io/agents/ad-indlaesningsintegration/
- OPUS indlæsningsintegration: https://www.sofd.io/agents/opus-indlaesningsintegration/
- Indlæsning af skoleelever: https://www.sofd.io/agents/skoleelev-indlaesning/
- OS2vikar - Brugerkonto Agent: https://www.sofd.io/agents/os2vikar-agent/
- Download: https://www.sofd.io/downloads/
- Ændringslog: https://www.sofd.io/changelog/
- Support og kontakt: https://www.sofd.io/support/


OPUS indlæsningsintegration leverer KMD OPUS' datafil videre til OS2sofd, så organisationshierarki og medarbejderoplysninger fra OPUS kan indlæses. Komponenten er en on-premise Windows-service, der overvåger et lokalt filområde, matcher OPUS-filen ud fra et navnemønster, og uploader den til Digital Identitys FileShare-middleware. OS2sofd indlæser derefter data fra filen.

| Komponent | Servicenavn | Download | Ændringslog |
| --- | --- | --- | --- |
| OPUS indlæsningsintegration | `S3 File Uploader` | [Download](https://www.sofd.io/download/S3FileUploader.exe) | [Ændringslog](#ændringslog) |

> [!NOTE]
> I Windows Services hedder servicen "S3 File Uploader". Det er en generel
> fil-overførselskomponent, der også kan bruges til at uploade andre filer, men i
> OS2sofd-sammenhæng er det OPUS-indlæsningsintegrationen.

## Forudsætninger

### Windows Server

- Læseadgang til filområdet, hvor OPUS-filen fra KMD lægges (typisk et KFS-LAN share).
- Udgående HTTPS-adgang til FileShare-middlewaren (`https://fileshare.digital-identity.dk`).

### Service konto

Hvis filområdet kræver en domænekonto for at kunne læses, skal servicen afvikles under en sådan (angives på "Log On"-fanen i Windows Services). Ellers kan den køre som Local System.

### API-nøgle til FileShare

Udleveres af Digital Identity. Kan valgfrit hentes via CyberArk (PAM).

## Installation

### Download service

Hent installeren via download-linket øverst på siden eller fra den samlede [Download-oversigt](../../downloads/).

### Konfiguration af service

Konfigurationen foretages i filen `appsettings.json` i installationsmappen. For OPUS skal der være en upload med navnet `Opus`, der peger på mappen, hvor OPUS-filen fra KMD lægges.

```json
{
  "LogFile": "C:/Logs/s3fileuploader/S3FileUploader.log",
  "CronSchedule": "0 0/15 * ? * * *",
  "FileShare": {
    "url": "https://fileshare.digital-identity.dk",
    "apiKey": ""
  },
  "PAMSettings": {
    "Enabled": false,
    "CyberArkAppId": "",
    "CyberArkSafe": "",
    "CyberArkObject": "",
    "CyberArkAPI": ""
  },
  "FileUploads": [
    {
      "Name": "Opus",
      "DirectoryPath": "C:/Temp",
      "InputFileNamePattern": "ZLPE(?<year>\\d{4})(?<month>\\d{2})(?<day>\\d{2})",
      "OutputFileNameTemplate": "opus-<year><month><day>.xml"
    }
  ]
}
```

| Indstilling | Beskrivelse |
| --- | --- |
| `LogFile` | Sti til logfilen. |
| `CronSchedule` | Hvor ofte filområdet tjekkes for nye filer (default hvert 15. minut). |
| `FileShare.url` | Adressen på FileShare-middlewaren. |
| `FileShare.apiKey` | API-nøgle til FileShare (udleveres af Digital Identity). |
| `PAMSettings` | Valgfrit: hent `apiKey` fra CyberArk i stedet for klartekst. |
| `FileUploads[].Name` | Navnet på uploaden. For OPUS er det `Opus`. |
| `FileUploads[].DirectoryPath` | Mappen (typisk et KFS-LAN share), hvor OPUS-filen fra KMD lægges. |
| `FileUploads[].InputFileNamePattern` | Regulært udtryk, der matcher OPUS-filnavnet (`ZLPE` efterfulgt af dato) og udtrækker år/måned/dag. |
| `FileUploads[].OutputFileNameTemplate` | Filnavnet ved upload, med dato indsat. |

> [!NOTE]
> Komponenten kan også konfigureres til at **hente** filer fra FileShare via en
> tilsvarende `FileDownloads`-sektion (samme felter: `Name`, `CronSchedule`,
> `DirectoryPath`, `InputFileNamePattern`, `OutputFileNameTemplate`). Det bruges
> til andre formål end OPUS-indlæsningen og er ikke nødvendigt for OPUS-flowet.

### Start af service

Efter konfiguration startes servicen via Windows Services. Ved start køres en upload med det samme, og derefter efter `CronSchedule`. Kræver filområdet en domænekonto, angives den på "Log On"-fanen.

## Ændringslog

Ændringslog for OPUS indlæsningsintegration. Nyeste version øverst.

| Version | Dato | Ændring |
| --- | --- | --- |
| <span class="nowrap">1.3.0</span> | <span class="nowrap">01.08.2024</span> | Tilføjet understøttelse af CyberArk (Privileged Access Management) |
| <span class="nowrap">1.2.0</span> | <span class="nowrap">14.03.2024</span> | Rettet fejl i fil-download-koden |
| <span class="nowrap">1.1.0</span> | <span class="nowrap">13.10.2023</span> | Tilføjet valgfri overstyring af encrypt-indstilling for uploads |
| <span class="nowrap">1.0.3</span> | <span class="nowrap">24.05.2022</span> | Rettet cron-udtryk i appsettings.template.json |
| <span class="nowrap">1.0.2</span> | <span class="nowrap">04.05.2022</span> | Forbedret noget logning |
| <span class="nowrap">1.0.1</span> | <span class="nowrap">10.12.2019</span> | Uploaderen kræver ikke længere skriveadgang til kildemapperne, kun læseadgang |
| <span class="nowrap">1.0.0</span> | <span class="nowrap">10.12.2019</span> | Første version |