Installationsanvisningar

Systemkrav

För installation på Windows:

  • Windows 10 eller Windows Server 2016
  • Zip-fil med ledningsägarmodulen - Länk
  • Utgående internetanslutning, så att den kan ansluta till Ledningskollens servrar

Obs
Asp.net krävs inte eftersom alla nödvändiga bibliotek är inkluderade i zip-filen.

Testmiljö

Ledningskollen har en testmiljö och det rekomenderas att använda den för att testa hur Ledningsägarmodulen fungerar och används.

För att hantera organisation, användarkonto och api-nyckar, gå till: Länk.

Om du behöver bli inbjuden till en existerande organisation i test-miljön kontakta support

Url till Ledningskollens api i testmiljön är https://integration-v4-test-api.ledningskollen.se,
se Uppdatera inställningar och instruktioner för baseUrl.

Api-nyckel

För att ledningsägarmodulen ska kunna kommunicera med Ledningskollen behövs en api-nyckel. Se här hur du gör för att skapa en.

Installationssteg (Windows)

Här är en lista över mappar du behöver skapa för installationen:

  • Installationsmapp: Lam_folder
  • Inställningsmapp: Settings_folder
  • Loggmapp: Logs_folder
  • Lam databas-mapp: Database_folder
  • Gis data-mapp: Gis_data_folder

En enkel rekommendation är att behålla Lam-mappen på en plats och de andra under en huvudmapp. så här:

  • Lam (Lam_folder)
  • Lam_data
    • Settings (Settings_folder)
    • Logs (Logs_folder)
    • Database (Database_folder)
    • GisData (Gis_data_folder)

Installationsprocessen går till så här:

  1. Packa upp .zip-filen i Lam_folder.
  2. Kopiera innehållet från SettingFiles (från zip-filen) till Settings_folder.

Din nya Settings_folder ska innehålla följande filer:

  • case-handling.json
  • db.json
  • jobs.json
  • lam-settings.json
  • lk-settings.json
  • logs.json

Sätt miljövariabeln LAM_CONFIGURATION_PATH på datorn till sökvägen för Settings_folder, alternativt ange sökvägen som argument när applikationen startas. Se sektion Starta Ledningsägarmodulen.

Viktigt

Gis_data_folderär self managed, dvs att de filer som sparas där hanteras utav Ledningsägarmodulen och ska inte ändras/hanteras manuellt. Det gäller alla mappar utom watch där nya/uppdaterade intressseområden ska placeras.

Uppdatera inställningar

En beskrivning av alla inställningar finns här.

Uppdatera följande filer och inställningar:

db.json

  • dbPath – det ska vara en absolut sökväg till Database_folder

lam-settings.json

  • gisFolder – det ska vara en absolut sökväg till Gis_data_folder
  • coordinateSystem – standard är EPSG:3006 (SWEREF99 TM)
  • port – standard är 5000
    • ändra detta om du vill använda en annan port. Generellt finns det inget behov att ändra detta men om du vill köra flera instanser av Lam, eller manuellt köra vissa jobb kommer du behöva ändra detta.

lk-settings.json

  • apiKey – detta är api-nyckeln du får från Ledningskollen
  • apiUsername – detta är användarnamnet för användarkontot som ska Lam ska köras som
  • apiPassword – detta är lösenordet för användarkontot
  • baseUrl- Url till Ledningskollens api (produktions eller test -miljö)

logs.json

  • LogPath – det ska vara en absolut sökväg till Logs_folder

case-handling.json

  • caseStartDate – sätt ett datum i formatet YYYY-MM-DD för när Lam ska börja hämda ärenden från.

jobs.json

Viktigt - För att säkerställa att allt är korrekt uppsatt utan att börja hantera ärenden, är det starkt rekommenderat att uppdatera följande inställning:

runOnlyAreaSync - true

Det gör att endast intresseområden kommer att hanteras när ledningsägarmodulen och kommunikation kan säkerställas innan full funktionalitet är påslagen.

Starta Ledningsägarmodulen

När installationen är uppsatt och installerad, rekommenderas det att köra applikationen från kommandotolken (PowerShell) första gången för att säkerställa att allt är korrekt uppsatt. Inställningarna läses från miljövariabeln LAM_CONFIGURATION_PATH om denna är uppsatt eller argumentet --settings-path och valideras. Valideringen kommer att skriva ut information om vilka inställningar som saknas eller är felaktigt konfigurerade.

För att sätta miljövariablen kan följande kommando köras:

Set-EnvironmentVariable -Name LAM_CONFIGURATION_PATH -Value "C:\Lam_data\Settings_folder" -Scope User

För att starta Lam, kör följande kommando i Lam_folder:

./LkLemmy.Lam.exe

Alternativt om miljövariablen inte är satt:

./LkLemmy.Lam.exe --settings-path=C:\Lam_data\Settings_folder

Starta Lam som en service

När du är nöjd med att applikationen är korrekt uppsatt, kan du köra den som en tjänst.

För att göra det finns ett script i Lam_folder\windows-service\add-lam-service.ps1.

Innan du kör det, behöver du uppdatera värdet för PublishPath-parametern till sökvägen för Lam_folder.

param(
    [string]$ServiceName = "lk-lemmy",
    [string]$DisplayName = "Ledningsagarmodul",
    [string]$Description = "Ledningsagarmodul - v2",
    [string]$PublishPath = "C:\Path\to\your\Lam\application", # <- This must be changed to the correct path
    [string]$DllName = "LkLemmy.Lam.dll",
    [string]$StartupType = "Automatic",
    [string]$SettingsPath = "" # value only needed in case environment variables are not set, or multi lemmy support is needed
)

$dotnetPath = (Get-Command dotnet).Source
$dllPath = Join-Path $PublishPath $DllName

if (-not (Test-Path $dllPath)) {
    Write-Error "DLL not found: $dllPath"
    exit 1
}

$binaryPath = "`"$dotnetPath`" `"$dllPath`""
# in case you have multiple lemmys, you can create your service this way, passing the --settings path value
if ($SettingsPath) {
    $binaryPath = "`"$dotnetPath`" `"$dllPath`" --settings `"$SettingsPath`""
}

$existingService = Get-Service -Name $ServiceName -ErrorAction SilentlyContinue
if ($existingService) {
    Write-Error "Service '$ServiceName' already exists."
    exit 1
}

New-Service `
    -Name $ServiceName `
    -DisplayName $DisplayName `
    -BinaryPathName $binaryPath `
    -Description $Description `
    -StartupType $StartupType

Start-Service -Name $ServiceName

Write-Host "Service '$ServiceName' created and started successfully."

Stoppa Lam-service

Det finns också ett script för att stoppa och ta bort Lam som en service, Lam_folder\windows-service\remove-lemmy-service.ps1.

Hantera intresseområden

Se instruktioner i Användarhandledning.

Hantera ärenden

För att Lam ska hantera ärenden:

  • Sätt runOnlyAreaSync till false i jobs.json
  • Starta om applikationen

Applikationen kommer då börja hantera ärenden.