Introduktion
Mallen Data Dictionary Chain gör det möjligt för användare att samla in och exportera detaljer på hög nivå om specifika tabeller i arbetsytan till en kalkylark. Användare kan ange ett nyckelord för att hitta tabeller, definiera namnet på kalkylarket för export och skapa en tabell i arbetsytan för att lagra schemat för varje tabell.
För ytterligare information, se dokumentationen på Load Data to Wdata Process för en omfattande översikt. Det rekommenderas att du läser igenom den här dokumentationen innan du använder Data Dictionary-mallen .
Förkunskapskrav
Denna mall förutsätter att följande objekt redan är konfigurerade i din Workiva-applikation:
- API Beviljande
- För att kunna utnyttja Workiva API:er måste en användare upprätta ett OAuth API beviljande inom sin arbetsyta. Se den här artikeln för ledande praxis för hantering av OAuth beviljande.
- Följande Connectors måste aktiveras och konfigureras på din arbetsyta:
Obs: Vissa variabelvärden kan innehålla känslig information, t.ex. användarnamn och lösenord. Vi rekommenderar att du använder alternativet "Kryptera" för informationskänsliga variabler och ställer in lämpliga behörigheter för kalkylarket.
- Konfigurera variabler
- För att Ladda data till Wdata-underkedjan i mallen ska fungera som förväntat måste en arbetsyta variabel med titeln wsv-WdataLoadWarningThreshold skapas.
Obs: Det är bäst att ställa in variabelns standardvärde till 50 (vilket motsvarar 50 MB), men det kan justeras vid behov.
-
- Dessutom måste fyra andra variabler för arbetsytan skapas innan Data Dictionary-kedjan kan användas.
Nedan följer en uppdelning av varje variabel som måste ställas in och fyllas i:
Bygg din kedja
Mallen Data Dictionary | ALL | Primary Chain finns i avsnittet Workiva Chains på skärmen Mallar.
Så här hittar du den:
- I Chain Builder går du till fliken Templates .
- Välj Workiva Chains från menyn högst upp
- Sök efter Data Dictionary | ALL | Primary Chain Template längst upp till höger och öppna mallen
När Data Dictionary | ALL | Primary chain distribueras till en arbetsyta, distribueras automatiskt sex ytterligare underkedjor.
Användare måste se till att alla sju kedjorna har distribuerats och publicerats på samma arbetsyta:
- Data Dictionary | ALL | Primär
- Data Dictionary | Skapa dokument och underavsnitt | Skapa kalkylark
- Data Dictionary | Skapa dokument och underavsnitt | Skapa ark
- Data Dictionary | Skapa tabell
- Ladda data till Wdata | Primär kedja
- Ladda data till Wdata | Ersätt dataset
- Ladda data till Wdata | Lägg till nytt dataset
När du har hittat din mall ska du konfigurera för din arbetsyta med hjälp av de variabler som skapades i avsnittet ovan.
Obs: För detaljerade instruktioner om hur du skapar en kedja från en mall, se Skapa och hantera kedjor artikel.
Ingångar för exekvering
När denna primära kedja körs (Data Dictionary | ALL | Primary), måste följande Run Time Inputs fyllas i eller skickas genom en anropande kedja:
| Exekvering Input | Beskrivning | Typ av fält | Krävs? |
|---|---|---|---|
| Kalkylbladets namn | Anger namnet på den kalkylark där tabellschemat ska skrivas. | Text | Ja |
| Sökvärde | Denna inmatning används för att hitta tabeller som innehåller det angivna nyckelordet. | Text | Ja |
| Wdata Tabellnamn | Anger namnet på den data dictionary-tabell som skapas när mallen körs första gången. | Text | Ja |
Wdata-tabell
För att använda denna kedja måste en Data Dictionary Wdata-tabell finnas inom arbetsytan. Kedjan skapar automatiskt denna tabell med namnkonventionen "Data Dictionary Table", om inte användaren anger ett annat tabellnamn.
Följande tabellschema kommer att användas för att bygga upp dataordbokstabellen:
| Namn på kolumn | Beskrivning av kolumnen | Kolumn-ID | Typ av kolumn |
|---|---|---|---|
| Tabell_namn | N/A | tabell_namn | text |
| Alias | N/A | alias | text |
| Läge | N/A | läge | text |
| Namn | N/A | namn | text |
| Typ | N/A | typ | text |
Anpassade justeringar Disclaimer: Om användare upplever problem med att kolumnrubriker inte matchar när de importerar sina data till en Wdata-tabell kan de använda data prep eller andra kommandon för att korrigera detta. Om en användare lägger till några anpassade justeringar i den här mallen rekommenderas det dock att de gör en kopia innan de gör det. Alla ändringar av mallen kommer att hindra dess återanvändbarhet. Detta gäller även om du använder en taggkonfiguration på mallen.
Felsökning
Följande steg kan användas för att felsöka problem med kedjemallen:
Fel i kedjans exekvering
- Kontrollera att alla kedjor är publicerade.
- Se till att OAuth2-legitimationerna (
wsv-Client IDochwsv-Client Secret) är giltiga och uppdaterade. - Kontrollera behörigheten till arbetsytan för den användare som kör kedjan.
Fel vid dataimport
- Bekräfta att kolumnrubrikerna i källfilen stämmer överens med schemat i tabellen Wdata.
- För åtgärden Replace Dataset ska du se till att filnamnen matchar befintliga dataset i tabellen.
- För operationen Add New Dataset ska du se till att arkiveringens namn är unika inom tabellen.
Skapande av dubbla tabeller eller kalkylark
- Använd konsekventa namn för
Wdata Table NameochSpreadsheetNamei alla körningar.
Monitorskärm
- Användare kan diagnostisera orsaken till ett fel genom att navigera till sin bildskärm.
- Variabeln DCV_Chain Result fångar upp kedjans status baserat på det slutliga resultatet. Om ett fel inträffar kommer orsaken till felet att anges i kedjans utmatningstext på bildskärmen.
Användare kan också använda övervakningsskärmen för att avgöra om deras arkivering har importerats framgångsrikt
Bästa praxis
-
Undvik att anpassa originalmallen:
Skapa en kopia om det behövs justeringar. Ändringar av mallen kan hindra återanvändbarhet. -
Tagging for Enhanced Context:
Lägg till exekvering (Tag-KeyochTag-Value) för att tagga dataset, om det behövs. Uppdatera kedjenoderna för att skicka dessa indata. -
Hantering av filstorlek:
Övervaka storleken på datasetet med hjälp av variabelnwsv-WdataLoadWarningThreshold. Överväg att dela upp stora dataset om varningar utlöses.