Dokumentera en dataprodukt
Senast uppdaterad: 2026-11-18Du kan hitta två typer av dokumentation för var och en av dina dataprodukter.
- Den allmänna dokumentationen som sammanfattar din dataprodukt, såsom datauppsättningarna, datans Senaste aktualisering, datakvaliteten, semantiska modeller etc.
- Delavsnittet Läs mig som innehåller all information som den dataproduktansvarige vill dela om dataprodukten.
Om din dataprodukt innehåller en semantisk modell innehåller den genererade dokumentationen information om de tabeller, relationer, mått och dimensioner som definieras i den semantiska modellen.
Du kan också lägga till nyckelkontakter i dina dataprodukter och koppla affärsordlistor för att göra standardiserade affärsdefinitioner tillgängliga för konsumenter.
- Qlik Talend Cloud Enterprise
- Qlik Talend Cloud Premium
- Qlik Cloud-analys premium
- Qlik Cloud Analytics Enterprise
- Qlik Sense Enterprise SaaS
Generera den allmänna dokumentationen av en dataprodukt
Du kan generera, visa och hämta dokumentationen för en dataprodukt för att samla all information om den i en fil, såsom datakvaliteten, antalet datauppsättningar, kvaliteten på varje datauppsättning, fälten i varje datauppsättning osv.
Generering av den allmänna dokumentationen för en dataprodukt kan även utföras via motsvarande Qlik Public API.
Du kan hämta dokumentationen i markdownformat (.md).
När en datauppsättning i dataprodukten finns i ett utrymme som du inte har åtkomst till kan du fortfarande generera och hämta dokumentationen, men datauppsättningen och dess data inkluderas inte i dokumentationen.
- Öppna dataprodukten från menyn Katalog eller Dataprodukter.
- Till höger klickar du på
> Hämta dokumentation. Fönstret Dokumentation öppnas. - För att hämta i MD-format klickar du på Hämta.
Du kan också hämta i PDF-format från din webbläsare. Högerklicka på dokumentationen > Skriv ut....
Redigera delavsnittet Läs mig
Som dataproduktansvarig kan du redigera delavsnittet Read me så mycket som behövs. Formatet för formaterad text gör att du kan strukturera delavsnittet för att göra det så radera som möjligt.
- Se till att du har följande roller eller behörigheter:
- Rollen Dataproduktansvarig eller behörigheten Hantera dataprodukter.
- Behörigheten att redigera utrymmet.
- Öppna dataprodukten från menyn Katalog eller Dataprodukter.
- Välj fliken Dokumentation.
- Klicka på Redigera i delavsnittet Läs mig.
- Ange informationen och klicka på Spara.
Du kan också redigera delavsnittet Läs mig genom att klicka på
> Dokumentation till höger.
Lägga till nyckelkontakter
Lägg till nyckelkontakter för att ange vem konsumenter kan kontakta vid eventuella frågor eller problem med dataprodukten.
- Se till att du har följande roller eller behörigheter:
- Rollen Dataproduktansvarig eller behörigheten Hantera dataprodukter.
- Behörigheten att redigera utrymmet.
- Öppna dataprodukten från menyn Katalog eller Dataprodukter.
- Välj fliken Dokumentation.
- Klicka på Redigera i delavsnittet Kontakter.
- Ange nyckelkontakterna och klicka på Spara.
Du kan också redigera nyckelkontakterna genom att klicka på
> Dokumentation > Nyckelkontakter till höger.
Visa bifogade affärsordlistor
Dataprodukter kan innehålla bifogade affärsordlistor som tillhandahåller standardiserade affärsdefinitioner för dataproduktens innehåll. Ordlistor visas på fliken Dokumentation tillsammans med delavsnittet Läs mig och viktiga kontakter.
Som förvaltare av dataprodukt
Du kan visa och hantera bifogade ordlistor:
- Öppna dataprodukten från menyn Katalog eller Dataprodukter.
- Välj fliken Dokumentation.
- Rulla till delavsnittet Ordlistor för att se bifogade ordlistor.
- Klicka på Redigera för att lägga till, ersätta eller ta bort ordlistor. För detaljerade instruktioner, se Lägga till affärsordlistor i en dataprodukt.
Som användare av dataprodukt
Du kan visa affärsordlistor som är kopplade till dataprodukter du har åtkomst till:
- Öppna dataprodukten från Katalog.
- Välj fliken Dokumentation.
- Visa delavsnittet Ordlistor för att se affärsdefinitioner som är relevanta för dataprodukten.
Endast ordlistor som du har läsbehörighet till visas. Om du inte kan se en ordlista på fliken Dokumentation kontaktar du din administratör eller dataproduktansvarig för att begära åtkomst.