Invoering
Met de sjabloon Data Dictionary Chain kunnen gebruikers details op hoog niveau over specifieke tabellen binnen hun werkruimte vastleggen en exporteren naar een spreadsheet. Gebruikers kunnen een trefwoord opgeven om tabellen te vinden, de naam van het geëxporteerde spreadsheet definiëren en een tabel in de werkruimte aanmaken om het schema van elke tabel op te slaan.
Voor meer informatie kunt u de documentatie over het Load Data to Wdata Process raadplegen voor een uitgebreid overzicht. Het is aante raden deze documentatie door te nemen voordat u de Data Dictionary-sjabloon gebruikt.
Voorwaarden
Deze sjabloon gaat ervan uit dat de volgende objecten al in uw Workiva-applicatie zijn ingesteld:
- API-toekenning
- Om de Workiva API's te kunnen gebruiken, moet een gebruiker een OAuth API Grant in zijn of haar werkruimte instellen. Raadpleeg dit artikel voor toonaangevende werkwijzen voor het beheren van de OAuth Grant.
- De volgende connectoren moeten in uw werkruimte zijn ingeschakeld en geconfigureerd:
Opmerking: Sommige variabelewaarden kunnen gevoelige informatie bevatten, zoals gebruikersnamen en wachtwoorden. We raden aan om de optie "Versleutelen" te gebruiken voor informatiegevoelige variabelen en de juiste machtigingen voor uw spreadsheet in
te stellen.- Variabelen configureren
- Om ervoor te zorgen dat de subketen Load Data to Wdata in de template naar behoren functioneert, moet een workspace variabele met de titel wsv-WdataLoadWarningThreshold worden aangemaakt.
Opmerking: Het is aanbevolen om de standaardwaarde van deze variabele in te stellen op 50 (wat overeenkomt met 50 MB), maar deze kan indien nodig worden aangepast.
-
- Daarnaast moeten er nog vier andere werkruimtevariabelen worden aangemaakt voordat de Data Dictionary-keten kan worden gebruikt.
Hieronder volgt een overzicht van elke variabele die moet worden ingesteld en ingevuld:
| Variabele | Waarde | Beschrijving |
|---|---|---|
| wsv-WdataLoadWarningThreshold | Aanbevolen: 50 MB | Hiermee wordt de drempelwaarde ingesteld waarna de keten datasets markeert die deze bestandsgrootte overschrijden. |
| wsv-klant-ID | Afgeleid van de API-toestemming van de gebruiker. | Wordt ingevuld na het aanmaken van een API-toekenning. |
| wsv-Client Secret | Afgeleid van de API-toestemming van de gebruiker. | Wordt ingevuld na het aanmaken van een API-toekenning. |
| 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 je ketting
De sjabloon Data Dictionary | ALL | Primary Chain bevindt zich in het gedeelte Workiva Chains van het scherm Templates.
Zo vind je het:
- Ga in Chain Buildernaar het tabblad Templates .
- Selecteer Workiva Chains in het menu bovenaan.
- Zoek rechtsboven naar Data Dictionary | ALL | PrimaryChain Template en open de template.
Wanneer de Data Dictionary | ALL | Primary chain in een werkruimte wordt geïmplementeerd, worden er automatisch zes extra subketens geïmplementeerd.
Gebruikers moeten ervoor zorgen dat alle zeven ketens zijn geïmplementeerd en gepubliceerd in dezelfde werkruimte:
- Gegevenswoordenboek | ALLES | Primair
- Gegevenswoordenboek | Document en subsecties maken | Spreadsheet maken
- Gegevenswoordenboek | Document en subsecties maken | Bladcreatie
- Gegevenswoordenboek | Tabel maken
- Gegevens laden naar Wdata | Primaire keten
- Laad gegevens in Wdata | Vervang dataset
- Gegevens laden naar Wdata | Nieuwe dataset toevoegen
Nadat je je sjabloon hebt gevonden , configureer je deze voor je werkruimte met behulp van de variabelen die in het bovenstaande gedeelte zijn aangemaakt.
Opmerking: Zie het artikel Ketens maken en beheren voor gedetailleerde instructies over het maken van een keten vanuit een sjabloon.
Runtime-invoer
Bij het uitvoeren van deze primaire keten (Data Dictionary | ALL | Primary), moeten de volgende runtime-inputs worden ingevuld of doorgegeven aan een aanroepende keten:
| Runtime-invoer | Beschrijving | Veldtype | Vereist? |
|---|---|---|---|
| Spreadsheetnaam | Hiermee wordt de naam van het spreadsheet opgegeven waarin het tabelschema wordt opgeslagen. | Tekst | Ja |
| Zoekwaarde | Deze invoer wordt gebruikt om tabellen te vinden die het opgegeven trefwoord bevatten. | Tekst | Ja |
| Wdata-tabelnaam | Specificeert de naam van de datawoordenboektabel die wordt aangemaakt bij de eerste uitvoering van de sjabloon. | Tekst | Ja |
W-gegevenstabel
Om deze keten te kunnen gebruiken, moet er een Data Dictionary Wdata-tabel in de werkruimte aanwezig zijn. De keten maakt deze tabel automatisch aan met de naamgevingsconventie "Data Dictionary Table", tenzij een gebruiker een andere tabelnaam opgeeft.
Het volgende tabelschema wordt gebruikt om de datawoordenboektabel op te bouwen:
| Kolomnaam | Kolombeschrijving | Kolom-ID | Kolomtype |
|---|---|---|---|
| Tabelnaam | 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 |
Disclaimer voor aangepaste aanpassingen: Als gebruikers problemen ondervinden met niet-overeenkomende kolomkoppen bij het importeren van hun gegevens in een Wdata-tabel, kunnen ze gegevensvoorbereiding of andere opdrachten gebruiken om dit te corrigeren. Als een gebruiker echter aanpassingen aan deze sjabloon wil maken, is het raadzaam om eerst een kopie te maken. Elke wijziging aan de sjabloon zal de herbruikbaarheid ervan belemmeren. Dit is ook van toepassing als er een tagconfiguratie op de sjabloon wordt toegepast.
Probleemoplossing
De volgende stappen kunnen worden gebruikt om problemen met de ketensjabloon op te lossen:
Kettinguitvoeringsfouten
- Controleer of alle ketens gepubliceerd zijn.
- Zorg ervoor dat de OAuth2-referenties (
wsv-Client IDenwsv-Client Secret) geldig en actueel zijn. - Controleer de werkruimtemachtigingen voor de gebruiker die de keten uitvoert.
Fouten bij het importeren van gegevens
- Controleer of de kolomkoppen in uw bronbestand overeenkomen met het schema van de Wdata-tabel.
- Bij bewerkingen waarbij gegevenssets worden vervangen, moet u ervoor zorgen dat de bestandsnamen overeenkomen met de bestaande gegevenssets in de tabel.
- Zorg er bij het toevoegen van een nieuwe dataset voor dat de bestandsnamen uniek zijn binnen de tabel.
Een tabel of spreadsheet dupliceren
- Gebruik consistente namen voor
Wdata Table NameenSpreadsheetNamein alle uitvoeringen.
Monitorscherm
- Gebruikers kunnen de oorzaak van een fout vaststellen door naar hun monitorscherm te navigeren.
- De variabele DCV_ChainResult legt de status van de keten vast op basis van het eindresultaat. Als er een fout optreedt, wordt de reden voor de fout weergegeven in de uitvoertekst van de keten op het monitorscherm.
Gebruikers kunnen ook via het monitorscherm controleren of hun bestand succesvol is geïmporteerd.
Beste praktijken
-
Vermijd het aanpassen van de originele sjabloon:
Maak een kopie als aanpassingen nodig zijn. Wijzigingen in de sjabloon kunnen het hergebruik ervan belemmeren. -
Tagging voor verbeterde context:
Voeg runtime-inputs (Tag-sleutelenTag-waarde) toe om datasets te taggen, indien nodig. Werk de ketenknooppunten bij om deze invoer door te geven. -
Bestandsgroottebeheer:
Bewaak de grootte van de dataset met behulp van dewsv-WdataLoadWarningThresholdvariabele. Overweeg om grote datasets op te splitsen als er waarschuwingen worden gegenereerd.