Skillnader

Här visas skillnader mellan den valda versionen och den nuvarande versionen av sidan.

--- miner:anvandning:kommaigang [2025/12/09 10:19] – ↷ Länkar som ändrats på grund av flytt/namnändring dokuadmin
+++ miner:anvandning:kommaigang [2026/06/02 11:32] (aktuell) – [Komma igång] dokuadmin
@@ Rad 1: / Rad 1: @@
-======= Komma igång med miner =======
+====== Komma igång ======
+Den här guiden beskriver hur du skapar din första integration i Miner.
+En typisk integrationsprocess består av följande steg:
+  - Skapa en anslutning till datakällan
+  - Skapa ett jobb
+  - Välj vilka datapunkter som ska ingå
+  - Komplettera datapunkterna med metadata
+  - Starta dataöverföringen
+<mermaid>
+flowchart LR
+    A["1. Skapa anslutning<br/>till datakälla"]
+    B["2. Skapa jobb"]
+    C["3. Välj datapunkter"]
+    D["4. Komplettera med metadata"]
+    E{"Behövs provisionering?"}
+    F["5. Provisionera metadata eller objekt"]
+    G["6. Starta dataöverföring"]
+    A --> B
+    B --> C
+    C --> D
+    D --> E
+    E -->|Ja| F
+    F --> G
+    E -->|Nej| G
+</mermaid>
+Provisionering är endast aktuellt i vissa integrationsflöden, exempelvis när metadata ska laddas upp till en [[integration:rdf-store|grafdatabas]] eller när Miner används för att provisionera data till [[integration:proptech_os|ProptechOS]].
+För en mer detaljerad beskrivning av onboarding och metadatahantering, se [[miner:integrationer:onboardingprocess|Onboardingprocess]].
 ===== Översikt =====
-Efter installationen av miner hamnar du på en översiktlig vy.
+När Miner startas läses samtliga anslutningar och jobb in automatiskt.
-{{:miner:anvandning:pasted:20250311-153142.png?direct&200 |}}
-När miner startas läser den in Jobb och Anslutningar. Därefter listas alla Jobb som rader i tabellen.
+På startsidan visas:
-Via den vänstra panelen får se och redigera minerns grundkonfiguration, anslutningar, samt ladda ned loggfiler och ta backup av minerns konfiguration.
+  * konfigurerade jobb
+  * anslutningar
+  * statusinformation
+  * loggar
+  * systemfunktioner
+Via toppmenyn kan du:
+  * administrera anslutningar
+  * administrera jobb
+  * hantera grundinställningar
+  * ladda ned loggfiler
+  * skapa backup av konfigurationen
+===== Backup =====
+Vi rekommenderar att backup skapas regelbundet, särskilt innan större förändringar görs.
+Backupfunktionen skapar en zip-fil som innehåller Miner-instansens konfiguration.
+===== Steg 1 – Skapa en anslutning =====
+En anslutning beskriver hur Miner kommunicerar med ett externt system.
+För att skapa en ny anslutning:
+  - Klicka på plusknappen längst ned till höger
+  - Välj ''Anslutning''
+  - Välj anslutningstyp
+  - Ange nödvändiga parametrar
+Olika anslutningstyper kräver olika uppgifter beroende på protokoll, API eller datakälla.
+Läs mer på sidan [[miner:integrationer:systemintegration|Systemintegration]].
+===== Steg 2 – Skapa ett jobb =====
+När anslutningen är skapad kan ett jobb konfigureras.
+Ett jobb definierar:
+  * vilken data som ska hämtas
+  * vilka datapunkter som ska användas
+  * hur data ska behandlas
+  * vart data ska skickas
+Nya jobb skapas via plusknappen på översiktssidan.
+===== Steg 3 – Välj datapunkter =====
+Efter att jobbet skapats identifieras de datapunkter som ska ingå i integrationen.
+Beroende på anslutning kan Miner:
+  * läsa in datapunkter automatiskt
+  * importera datapunktlistor
+  * låta användaren konfigurera datapunkter manuellt
+===== Steg 4 – Lägg till metadata =====
+För att göra datapunkterna användbara över flera system rekommenderas att de kompletteras med metadata.
+Metadata kan användas för att beskriva:
+  * byggnader
+  * system
+  * utrustning
+  * funktioner
+  * mätvärdestyper
+Läs mer på sidan [[miner:integrationer:metadata|Metadata]].
+===== Steg 5 – Provisionering =====
-**Använd gärna backupfunktionen ofta**, exempelvis innan du påbörjar förändring eller uppdatering av ett jobbs inställningar. Backupfunktionen laddar ned en kopia av minerns inställningar som en zip-fil, som du kan spara på ditt system. Om du behöver återställa en backup, behöver du just nu hjälp av oss på [[https://helpdesk.iquest.se|iquest]]. Vi planerar att införa en återställningsfunktion i kommande versioner av miner.
+När datapunkterna har klassificerats och kompletterats med metadata kan de provisioneras till mottagande system.
-===== Anslutningar =====
+Provisioneringen skapar den struktur som behövs för att datapunkterna ska kunna användas i målplattformen.
-Du kan skapa nya anslutningar genom att klicka på plusknappen längst ned till höger på översiktssidan och därefter välja alternativet "Anslutning". Du kan även klicka på pennsymbolen uppe till vänster på översiktssidan, till höger om rubriken "anslutningar". Därefter startar en guide som låter dig välja typ av anslutning och ange nödvändiga uppgifter med hjälp av ett formulär som skiljer sig åt beroende av vald anslutningstyp.
+Läs mer på sidan [[miner:integrationer:provisionering|Provisionering]].
-Om du vill redigera befintliga anslutningar, får du gå via den vänstra panelen och pennsymbolen till höger om rubriken "Anslutningar".
+===== Steg 6 – Starta dataöverföringen =====
-===== Jobb =====
+När konfigurationen är klar kan jobbet startas.
-Nya jobb konfigureras genom att klicka på plussymbolen nere till höger på översiktssidan.
-Redigering av befintliga jobb sker genom att först stoppa jobbet via översiktssidan, och därefter klicka på jobbet och därefter klicka sig in i jobbet för att göra ändringar och justeringar, genom att klicka på tabellraden för jobbet på översiktssidan.
+Miner börjar då läsa, bearbeta och distribuera data enligt jobbets inställningar.
-**Glöm inte att** starta jobbet igen, efter att ha gjort dina ändringar.
+===== Nästa steg =====
-I miner skiljer vi mellan fyra typer av jobb. Idag redovisas jobb av typen Poller för sig, medan Miner och Exporter visas i samma tabell. I kommande versioner av miner, kommer samtliga jobb att visas via en och samma tabell och jobbtyperna "Miner" och "Poller" kommer successivt att bakas ihop i smarta generella Jobb som kombinerar funktionerna hos "Miner" och "Poller", beroende av de möjligheter som finns hos datakällan.
+När den första integrationen är igång rekommenderas följande sidor:
-==== Miner ====
-Vissa datakällor har egna databaser med historiklagring och tillåter bulkhämtningar av data. Med en bulkhämtning (eller batchhämtning) menas att minern kan koppla upp sig vid valfri tidpunkt och fråga efter all data som har lagrats i datakällan sedan senaste hämtningen. Förutsatt att datakällan (exempelvis ett överordnat styrsystem) kontinuerligt lagrar data från anslutna system (exempelvis DUC/PLC), så kan en minerinstans som körs inom ett annat nätverk (exempelvis inom en molnmiljö), koppla upp sig med jämna mellanrum och ladda över önskat urval av data som har lagrats inom datakällan.
-Dylika jobb, som kan hämta bulkdata, kallar vi för "miners". Vi är medvetna om att det kan uppstå viss förvirring eftersom själva produkten också kallas för miner
+  * [[miner:integrationer:onboardingprocess|Onboardingprocess]]
-==== Poller ====
+  * [[miner:integrationer:metadata|Metadata]]
-Om datakällan inte har en egen databas, alternativt inte har stöd för bulkhämtning av data, kan minern kontinuerligt och enligt inställda intervaller, läsa av varje datapunkt, bygga en egen databas samt ladda över dataavläsningarna till Orbiq. Vi pratar då om att plocka "polla" datapunkterna i jobbet. I anslutning till varje körcykel, går miner igenom samtliga datapunkter och läser av värden från datakällan i enlighet med inställd intervall. I pollerjobb finns det möjlighet att anpassa läsfrekvens och sparintervall med hjälp av följande inställningar som kan anges för var och en av datapunkterna i ett jobb.
+  * [[miner:integrationer:systemintegration|Systemintegration]]
-=== poll_interval_sec: Pollningsintervall ===
+  * [[miner:integrationer:provisionering|Provisionering]]
-Anger hur ofta data ska __läsas__ från datapunkten. Anges i hela sekunder.
-=== cov: ChangeOfValue ===
-Anger hur stor förändringen av datapunktens värde ska vara, i relation till det senast __sparade__ värdet, för att nytt värde ska sparas. Kan anges i decimalformat (**OBS! Använd punkt som decimaltecken**) om cov anges via import/export av CSV-filer.
-=== minimal_save_interval: Största "hålet" mellan två sparade avläsningar i databasen ===
-Anger maxtiden som ska gå mellan två __sparade__ värden och anges i sekunder. minimal_save_interval rekommenderas att anges, om ni väljer att använda ChangeOfValue. Tänk er exempelvis, att en poller läser av statusen för en pumps driftindikering, där pumpen är i drift i flera dygn. Om vi inte använder "minimal_save_interval" tillsammans med "cov", så kommer miner endast att spara värden när pumpen slås på/av. I en visualisering som endast visar den senaste veckan, kommer då driftindikeringen att se ut att sakna data.
-==== Exporter ====
-Exporterjobb är en typ av Minerjobb, där dataströmmen går åt motsatt håll. Data hämtas då från Orbiq och skickas till en extern datakälla.
-==== Överskrivning ====
-Vissa integrationer ger möjligheten att skriva ett värde till en datapunkt, vi kallar detta för överskrivning.\\
-[[..:intro:hantering-av-oeverskrivningar|Du kan läsa mer om överskrivning här]]
-==== Quality Stamp (qstamp) ====
-Varje värde för en datapunkt skickas med en stämpel som informerar om kvalitén på värdet. Nedan listas samtliga qstamps som skickas med avläsningarna:
-: unknown
-: good
-: bad, sending interpolated value
-: bad, sending null
-: bad, sending last good value
-: good, overwritten value
-: bad, sending extrapolated value
-: bad, untrusted value