| Nästa version. | Föregående version. |
| miner:integrationer:metadata [2026/06/05 09:03] – skapad dokuadmin | miner:integrationer:metadata [2026/06/05 10:45] (aktuell) – [Namn, beteckningar och visningsnamn] dokuadmin |
|---|
| |
| Med metadata menas information som beskriver en datapunkt och dess sammanhang och ger den kontext. Metadata gör det möjligt att förstå vad en datapunkt representerar, var den hör hemma, hur den ska användas och hur den relaterar till andra objekt. | Med metadata menas information som beskriver en datapunkt och dess sammanhang och ger den kontext. Metadata gör det möjligt att förstå vad en datapunkt representerar, var den hör hemma, hur den ska användas och hur den relaterar till andra objekt. |
| | |
| | Miner ger användaren möjlighet att ange valfri uppsättning av metadata, för valfri utgående anslutning från ett dataöverföringsjobb. Dessa metadata kallas för ''attribut'' i Miner. |
| |
| För en övergripande beskrivning av integrationsområdet, se [[miner:integrationer|Integrationer]]. | För en övergripande beskrivning av integrationsområdet, se [[miner:integrationer|Integrationer]]. |
| ^ Attribut ^ Beskrivning ^ Kommentar ^ | ^ Attribut ^ Beskrivning ^ Kommentar ^ |
| | ''UUID'' | Unik identifierare för datapunkten i Miner-jobbet. | Ska normalt inte ändras manuellt. Används för att Miner ska kunna känna igen datapunkten vid uppdateringar. | | | ''UUID'' | Unik identifierare för datapunkten i Miner-jobbet. | Ska normalt inte ändras manuellt. Används för att Miner ska kunna känna igen datapunkten vid uppdateringar. | |
| | ''io_label'' | Datapunktens beteckning eller identifierare i källsystemet. | Viktig för spårbarhet mot källsystemet. Bör normalt inte ändras. | | | ''source_label'' | Datapunktens beteckning eller identifierare i källsystemet. | Viktig för spårbarhet mot källsystemet. Bör inte kunna ändras. | |
| | ''orbiq_label'' | Beteckning som används vid leverans eller presentation mot Orbiq, om Orbiq används som mottagare. | Kan ofta vara samma som ''io_label'', men kan anpassas vid behov. | | | ''label'' | Beteckning som används vid leverans eller presentation mot mottagarsystemet. | Kan ofta vara samma som ''source_label'', men kan anpassas vid behov för varje output_connection. Om kunden har en specifik standard för märkning av datapunkter som skiljer sig från hur datapunkterna är märkta i källsystemet, går det att justera detta genom att ändra ''label'', eller lägga till ett anpassat attribut med önskad sammansättning.| |
| | ''poll_interval_sec'' | Anger hur ofta Miner ska läsa datapunkten från källsystemet. | Anges i sekunder. Relevant för jobb där Miner pollar datapunkter. | | | ''poll_interval_sec'' | Anger hur ofta Miner ska läsa datapunkten från källsystemet. | Anges i sekunder, exempelvis 300 för 5-minutersavläsningar. Relevant för jobb där Miner pollar datapunkter. | |
| | ''cov'' | Change of Value. Anger hur stor förändringen måste vara för att ett nytt värde ska sparas. | Vid CSV-import ska punkt användas som decimaltecken, exempelvis ''0.5''. | | | ''cov'' | Change of Value. Anger hur stor förändringen måste vara för att ett nytt värde ska sparas. | Vid CSV-import ska punkt användas som decimaltecken, exempelvis ''0.5''. | |
| | ''minimal_save_interval'' | Anger största tillåtna tid mellan två sparade värden. | Rekommenderas tillsammans med ''cov'' för att undvika långa luckor i tidsserier. | | | ''minimal_save_interval'' | Anger största tillåtna tid mellan två sparade värden. | Rekommenderas tillsammans med ''cov'' för att undvika långa luckor i tidsserier. Värdet anges i hela sekunder, exempelvis 3600 för en timme. | |
| | ''data_access'' | Anger om datapunkten kan läsas eller både läsas och skrivas. | Vanliga värden är ''r'' och ''rw''. Bör kontrolleras särskilt vid onboarding. | | | ''data_access'' | Anger om datapunkten kan läsas eller både läsas och skrivas. | Vanliga värden är ''r'' och ''rw''. Bör kontrolleras särskilt vid onboarding. | |
| | ''config_status'' | Anger om datapunkten är färdigkonfigurerad. | ''Done'' används för datapunkter som är klara att användas i dataöverföringen. | | | ''config_status'' | Anger om datapunkten är färdigkonfigurerad. | ''Done'' används för datapunkter som är klara att användas i dataöverföringen. | |
| | ''data_type'' | Datapunktens datatyp, om attributet används av aktuell integration. | Kan exempelvis påverka hur värden tolkas i mottagande system. | | |
| | ''unit'' | Enhet för datapunkten, om attributet används. | Kan komma från källsystemet eller anges som metadata. | | |
| |
| Vilka grundattribut som finns kan variera mellan olika integrationsprofiler, jobbtyper och Miner-versioner. Utgå därför alltid från det CSV-underlag som exporteras från det aktuella jobbet. | Vilka grundattribut som finns kan variera mellan olika integrationsprofiler, jobbtyper och Miner-versioner. Utgå därför alltid från det CSV-underlag som exporteras från det aktuella jobbet. |
| * kombinationer av flera olika källor | * kombinationer av flera olika källor |
| |
| Exempel på standardiserade eller återanvändbara metadataupplägg kan vara klasslistor, komponentlistor, systembeteckningar, namngivningsregler eller scheman som används för en viss mottagande plattform. | Exempel på standardiserade eller återanvändbara metadataupplägg kan vara klasslistor, komponentlistor, klasslistor ur ontologier, systembeteckningar, namngivningsregler eller scheman som används för en viss mottagande plattform. |
| |
| Vissa anslutningar kan också tillhandahålla metadatalistor eller mallar som stöd i onboardingarbetet. Det kan exempelvis handla om listor över byggnader, rum, komponenter, klasser eller andra objekt som datapunkter kan kopplas till. | Vissa anslutningar kan också tillhandahålla metadatalistor eller mallar som stöd i onboardingarbetet. Det kan exempelvis handla om listor över byggnader, rum, komponenter, klasser eller andra objekt som datapunkter kan kopplas till. |
| * eventuellt ett prefix eller en struktur som anger hur attributet ska tolkas | * eventuellt ett prefix eller en struktur som anger hur attributet ska tolkas |
| |
| Exempel: | Exempel för att illustrera principen: |
| |
| ^ Attribut ^ Exempelvärde ^ Beskrivning ^ | ^ Attribut ^ Exempelvärde ^ Typ av attribut ^ Beskrivning ^ |
| | ''source_label'' | ''LB01-GT11-PV'' | Ursprunglig beteckning eller etikett från källsystemet. | | | ''source_label'' | ''VS01-EM01-PV'' | Grundattribut | Ursprunglig beteckning eller etikett från källsystemet. | |
| | ''data_access'' | ''r'' | Anger om datapunkten kan läsas eller skrivas. | | | ''label'' | ''2455_A-VS01-EM01-E'' | Grundattribut | Kundspecifik standard, där beteckningen ska anges enligt standarden: fastighetsbeteckning_byggnadsbetecking-systembeteckning-komponentbeteckning-komponentkvalificerare. Komponentkvalificerarna ska vidare baseras på en standardiserad lista, där "E" representerar "Energianvändning". | |
| | ''building'' | ''Hus A'' | Anger byggnad eller anläggning. | | | ''data_access'' | ''r'' | Grundattribut | Anger om datapunkten kan läsas eller skrivas. | |
| | ''system'' | ''LB01'' | Anger tekniskt system. | | | ''config_status'' | ''Done'' | Grundattribut | Anger att datapunkten är färdigkonfigurerad. | |
| | ''equipment'' | ''GT11'' | Anger utrustning eller komponent. | | | ''!building'' | ''Hus A'' | Konstant | Anger byggnad eller anläggning. | |
| | ''qualifier'' | ''PV'' | Anger datapunktens funktion eller kvalificerare. | | | ''!system'' | ''VS01'' | Konstant | Anger tekniskt system. | |
| | ''unit'' | ''°C'' | Anger enhet. | | | ''!equipment'' | ''EM01'' | Konstant | Anger utrustning eller komponent. | |
| | ''quantity_kind'' | ''Temperatur'' | Anger vilken typ av mätstorhet datapunkten representerar. | | | ''!qualifier'' | ''E'' | Konstant | Anger datapunktens funktion eller kvalificerare. | |
| | ''display_name'' | ''Tilluftstemperatur'' | Namn som kan visas i mottagande system. | | | ''!unit'' | ''kWh'' | Konstant | Anger enhet. | |
| | ''config_status'' | ''Done'' | Anger att datapunkten är färdigkonfigurerad. | | | ''!brick:PointClass'' | ''Energy_Usage_Sensor'' | Konstant | Anger klassificering av datapunkten enligt Brick Schema. | |
| | | ''!brick:SystemClass'' | ''Radiation_Hot_Water_System'' | Konstant | Anger klassificering av systemet enligt Brick Schema. | |
| | | ''!brick:EquipmentClass'' | ''Hot_Water_Meter'' | Konstant | Anger klassificering av komponenten enligt Brick Schema. | |
| | | ''!description'' | ''Energimätning VS01'' | Konstant | Namn som kan visas i mottagande system. | |
| | | ''@qa_status'' | ''0'' | Dynamisk | Anpassad flagga för att ange om värdet för mätarens räkneverk har kontrollerats mot den fysiska mätaren eller ej. | |
| |
| Fältnamn och värden kan anpassas efter projektets behov. I vissa integrationer används särskilda prefix eller scheman för att skilja mellan olika typer av attribut. | Fältnamn och värden kan anpassas efter projektets behov. I vissa integrationer används särskilda prefix eller scheman för att skilja mellan olika typer av attribut. |
| | ''@'' | Dynamiskt attribut | Attribut vars värde kan ändras över tid och hanteras som dynamisk information. | Status, driftläge eller annan metadata som kan förändras. | | | ''@'' | Dynamiskt attribut | Attribut vars värde kan ändras över tid och hanteras som dynamisk information. | Status, driftläge eller annan metadata som kan förändras. | |
| | ''!'' | Konstant attribut | Attribut som ska behandlas som fast metadata. | Byggnad, system, komponent, enhet eller annan metadata som ska gälla som konstant information. | | | ''!'' | Konstant attribut | Attribut som ska behandlas som fast metadata. | Byggnad, system, komponent, enhet eller annan metadata som ska gälla som konstant information. | |
| | inget prefix | Grundattribut eller vanligt attribut | Attribut som hanteras direkt av Miner eller av aktuell integration. | ''io_label'', ''cov'', ''config_status'', ''data_access'' med flera. | | | inget prefix | Grundattribut | Attribut som hanteras direkt av Miner eller av aktuell integration. | ''source_label'', ''cov'', ''config_status'', ''data_access'' med flera. | |
| |
| Exakt hur prefixen används kan bero på integration och mottagande system. Kontrollera därför alltid aktuellt arbetsflöde och integrationsprofil. | Exakt hur prefixen används kan bero på integration och mottagande system. Kontrollera därför alltid aktuellt arbetsflöde och integrationsprofil. |
| | ''#onboarding'' | ''9'' | Datapunkten behöver kontrolleras eller diskuteras vidare. | | | ''#onboarding'' | ''9'' | Datapunkten behöver kontrolleras eller diskuteras vidare. | |
| | ''#comment'' | ''Kontrollera placering'' | Intern notering. | | | ''#comment'' | ''Kontrollera placering'' | Intern notering. | |
| | ''#building'' | ''Hus A'' | Arbetsfält för byggnad. | | | ''#building'' | ''Hus A'' | Arbetsfält för byggnad. Värdet ska inte sparas med avläsningen. | |
| | ''#system'' | ''LB01'' | Arbetsfält för systembeteckning. | | | ''#system'' | ''LB01'' | Arbetsfält för systembeteckning. Värdet ska inte sparas med avläsningen. | |
| | ''#equipment'' | ''GT11'' | Arbetsfält för komponentbeteckning. | | | ''#equipment'' | ''GT11'' | Arbetsfält för komponentbeteckning. Värdet ska inte sparas med avläsningen. | |
| | ''#qualifier'' | ''PV'' | Arbetsfält för datapunktens funktion eller kvalificerare. | | | ''#qualifier'' | ''PV'' | Arbetsfält för datapunktens funktion eller kvalificerare. Värdet ska inte sparas med avläsningen. | |
| |
| Prefixet ''#'' är särskilt användbart i kalkylblad och CSV-underlag där man vill ha med arbetskolumner som stöd för klassificering, formler eller QA utan att dessa nödvändigtvis ska bli metadata i mottagande system. | Prefixet ''#'' är särskilt användbart i kalkylblad och CSV-underlag där man vill ha med arbetskolumner som stöd för klassificering, formler eller QA utan att dessa nödvändigtvis ska bli metadata i mottagande system. |
| | |
| | **Observera** att attribut med prefixet ''#'' kommer att överföras till grafdatabaser som del av Miners graf, om det aktuella jobbet är del av ett dataöverföringsjobb till en grafdatabas. I grafdatabasen kommer det däremot att anges att attributet är att anse som just en kommentar. |
| |
| ===== Prefixet @ ===== | ===== Prefixet @ ===== |
| |
| * ''UUID'' | * ''UUID'' |
| * ''io_label'' | * ''source_label'' |
| * ''orbiq_label'' | * ''label'' |
| * ''poll_interval_sec'' | * ''poll_interval_sec'' |
| * ''cov'' | * ''cov'' |
| Vilken metadata som är obligatorisk beror på användningsfallet. | Vilken metadata som är obligatorisk beror på användningsfallet. |
| |
| En enkel dataöverföring till en tidsseriedatabas kan fungera med relativt lite metadata, medan provisionering till en mottagande plattform eller grafdatabas ofta kräver mer strukturerad information. | En enkel dataöverföring till en tidsseriedatabas kan fungera med relativt lite metadata, medan provisionering till en mottagande plattform eller grafdatabas kan kräva strukturerad information. |
| |
| Exempel på metadata som ofta är viktig: | Exempel på metadata som ofta är viktig: |
| * kommentarer | * kommentarer |
| * kvalitetssäkringsstatus | * kvalitetssäkringsstatus |
| | * systemspecifika attribut |
| * kundspecifika attribut | * kundspecifika attribut |
| |
| | Komponentbeteckning | Anger vilken komponent datapunkten hör till. | ''GT11'' | | | Komponentbeteckning | Anger vilken komponent datapunkten hör till. | ''GT11'' | |
| | Funktion | Anger datapunktens roll. | ''Mätvärde'' | | | Funktion | Anger datapunktens roll. | ''Mätvärde'' | |
| | Visningsnamn | Användarvänligt namn i mottagande system. | ''Tilluftstemperatur'' | | | Visningsnamn | Användarvänligt namn i mottagande system. | ''Tilluftstemperatur LB01'' | |
| |
| En bra princip är att bevara teknisk metadata för spårbarhet och samtidigt komplettera med läsbara namn för användning i gränssnitt, rapporter och analyser. | En bra princip är att bevara teknisk metadata för spårbarhet och samtidigt komplettera med läsbara namn för användning i gränssnitt, rapporter och analyser. |