Inleiding
Met de sjabloon Data Dictionary Chain kunnen gebruikers details op hoog niveau over specifieke tabellen in hun werkruimte vastleggen en exporteren naar een spreadsheet. Gebruikers kunnen een sleutelwoord opgeven om tabellen te lokaliseren, de naam van de exportspreadsheet definiëren en een tabel in de werkruimte aanmaken om het schema van elke tabel op te slaan.
Raadpleeg voor meer informatie de documentatie over het Load Data to Wdata Process voor een uitgebreid overzicht. Het wordt aanbevolen om deze documentatie door te nemen voordat u de sjabloon Data Dictionary gebruikt: .
Vereisten
Dit sjabloon gaat ervan uit dat de volgende objecten al in uw Workiva-toepassing zijn ingesteld:
- API-subsidie
- Om gebruik te kunnen maken van Workiva API's, moet een gebruiker een OAuth API Grant binnen zijn werkruimte instellen. Raadpleeg dit artikel voor leading practices voor het beheren van de OAuth Grant.
- De volgende Connectors moeten ingeschakeld en geconfigureerd zijn in uw werkruimte:
Opmerking: Sommige variabele waarden kunnen gevoelige informatie bevatten, zoals gebruikersnamen en wachtwoorden. Wij raden u aan de optie "Coderen" te gebruiken voor informatiegevoelige variabelen en de juiste machtigingen in te stellen voor uw spreadsheet.
- Variabelen configureren
- Om ervoor te zorgen dat de subketen Load Data to Wdata in de sjabloon naar behoren functioneert, moet een workspace variabele met de titel wsv-WdataLoadWarningThreshold worden gemaakt.
Opmerking: Het is het beste om de standaardwaarde van deze variabele op 50 in te stellen (wat staat voor 50MB), hoewel dit indien nodig aangepast kan worden.
-
- Bovendien moeten er vier andere werkruimtevariabelen worden gemaakt voordat u de Data Dictionary-keten kunt gebruiken.
Hieronder vindt u een uitsplitsing van elke variabele die moet worden ingesteld en ingevuld:
| Variabel | Waarde | Beschrijving |
|---|---|---|
| wsv-WdataLoadWarningThreshold | Aanbevolen: 50mb | Stelt de drempel in waarbij de ketting datasets die deze bestandsgrootte overschrijden zal markeren. |
| wsv-cliënt-ID | Afgeleid van de API-subsidie van de gebruiker | Wordt ingevuld na het aanmaken van een API grant. |
| wsv-cliëntgeheim | Afgeleid van de API-subsidie van de gebruiker | Wordt ingevuld na het aanmaken van een API grant. |
| wsv-IAMBaseURL | https://api.app.wdesk.com/iam/v1 |
Basis URL voor de Workiva IAM API's. Opmerking:De basis URL is afhankelijk van de locatie van de integratiegebruiker. |
| wsv-PlatformBaseURL | https://api.app.wdesk.com/platform/v1 |
Basis URL voor de Workiva Platform API's. Opmerking:De basis URL is afhankelijk van de locatie van de integratiegebruiker. |
Bouw uw ketting
Het sjabloon Data Dictionary | ALL | Primary Chain vindt u in de Workiva Chains sectie van het scherm Templates.
Zo vindt u het:
- Ga in Chain Builder naar het tabblad Templates .
- Selecteer Workiva Ketens in het menu bovenaan
- Zoek naar Data Dictionary | ALL | Primary Chain Template rechtsboven en open de sjabloon
Wanneer de Data Dictionary | ALL | Primary chain in een werkruimte wordt geïmplementeerd, worden automatisch zes extra subketens geïmplementeerd.
Gebruikers moeten ervoor zorgen dat alle zeven ketens in dezelfde werkruimte zijn geïmplementeerd en gepubliceerd:
- Gegevenswoordenboek | ALLES | Primair
- Gegevenswoordenboek | Document en subsecties maken | Werkblad maken
- Gegevenswoordenboek | Document en subsecties maken | Blad maken
- Gegevenswoordenboek | Tabel maken
- Gegevens laden naar Wdata | Primaire keten
- Gegevens laden naar Wdata | Dataset vervangen
- Gegevens laden naar Wdata | Nieuwe dataset toevoegen
Nadat u uw sjabloon hebt gevonden, kunt u deze configureren voor uw werkruimte met behulp van de variabelen die zijn gemaakt in de bovenstaande sectie.
Opmerking: Zie het artikel Ketens maken en beheren voor gedetailleerde instructies over het maken van een keten vanuit een sjabloon.
Runtime-ingangen
Na het uitvoeren van deze Primaire Keten (Data Dictionary | ALL | Primary), moeten de volgende Run Time Inputs worden ingevuld of doorgegeven via een aanroepende Keten:
| Runtime-invoer | Beschrijving | Veldtype | Vereist? |
|---|---|---|---|
| Werkbladnaam | Specificeert de naam van de spreadsheet waar het tabelschema zal worden weggeschreven. | Tekst | Ja |
| Zoekwaarde | Deze invoer wordt gebruikt om tabellen te zoeken die het opgegeven trefwoord bevatten. | Tekst | Ja |
| Wdata Tabel Naam | Specificeert de naam van de tabel in de gegevenswoordenboek die bij de eerste uitvoering van de sjabloon wordt aangemaakt. | Tekst | Ja |
Wdatatabel
Om deze keten te gebruiken, moet er een tabel Data Dictionary Wdata bestaan in de werkruimte. De keten zal deze tabel automatisch aanmaken met de naamgevingsconventie "Data Dictionary Table," tenzij een gebruiker een andere tabelnaam opgeeft.
Het volgende tabelschema zal gebruikt worden om de data dictionary-tabel op te bouwen:
| Kolom Naam | Kolom Beschrijving | Kolom ID | Kolom Type |
|---|---|---|---|
| Tabel_naam | n.v.t. | tabel_naam | sms verzenden |
| Alias | n.v.t. | alias | sms verzenden |
| Modus | n.v.t. | modus | sms verzenden |
| Naam | n.v.t. | naam | sms verzenden |
| type | n.v.t. | letterbeeld | sms verzenden |
Aangepaste aanpassingen Disclaimer: Als gebruikers problemen ondervinden met kolomkoppen die niet overeenkomen bij het importeren van hun gegevens in een Wdatatabel, kunnen ze gegevensvoorbereiding of andere opdrachten gebruiken om dit te corrigeren. Als een gebruiker echter aangepaste aanpassingen aan deze sjabloon toevoegt, is het aan te raden om eerst een kopie te maken. Elke wijziging aan de sjabloon zal de herbruikbaarheid ervan belemmeren. Dit is ook van toepassing als u een tagconfiguratie toepast op de sjabloon.
Probleemoplossing
De volgende stappen kunnen gebruikt worden om problemen met het kettingsjabloon op te lossen:
Fouten bij de uitvoering van de keten
- Controleer of alle ketens gepubliceerd zijn.
- Zorg ervoor dat de OAuth2-referenties (
wsv-Client IDenwsv-Client Secret) geldig en actueel zijn. - Controleer de rechten van de werkruimte voor de gebruiker die de ketting uitvoert.
Fouten bij het importeren van gegevens
- Controleer of de kolomkoppen in uw bronbestand overeenkomen met het schema van de Wdata-tabel.
- Zorg er bij het vervangen van datasets voor dat de bestandsnamen overeenkomen met bestaande datasets in de tabel.
- Voor het toevoegen van een nieuwe dataset, moet u ervoor zorgen dat de bestandsnamen uniek zijn binnen de tabel.
Aanmaken van dubbele tabellen of spreadsheets
- Gebruik consistente namen voor
Wdata Table NameenSpreadsheetNamein verschillende runs.
Scherm
- Gebruikers kunnen de oorzaak van een fout vaststellen door naar hun monitorscherm te navigeren.
- De DCV_Chain Resultaat variabele legt de status van de keten vast op basis van het uiteindelijke resultaat. Als er een fout optreedt, wordt de reden voor de fout toegepast op de uitvoertekst van de ketting binnen het monitorscherm.
Gebruikers kunnen het monitorscherm ook gebruiken om vast te stellen of hun bestand met succes is geïmporteerd
Beste Praktijken
-
Vermijd het aanpassen van de originele sjabloon:
Maak een kopie als aanpassingen nodig zijn. Wijzigingen aan de sjabloon kunnen herbruikbaarheid in de weg staan. -
Tagging voor verbeterde context:
Voeg runtime-ingangen toe (Tag-KeyenTag-Value) om datasets te taggen, indien nodig. Werk kettingknooppunten bij om deze invoer door te geven. -
Beheer van bestandsgrootte:
Bewaak de grootte van de dataset met behulp van dewsv-WdataLoadWarningThresholdvariabele. Overweeg om grote datasets te splitsen als er waarschuwingen worden gegeven.