Met de Workiva-connector kunt u commando 's in ketens gebruiken om te communiceren met het Workiva-platform, inclusief andere Wdata-functies, spreadsheets en GraphDB. Met deze connector kunt u bijvoorbeeld het volgende doen:
- Tabellen, query's en weergaven maken en beheren.
- Geef de datasets of importfouten van een tabel weer.
- Maak en beheer spreadsheets of bijbehorende werkbladen.
- Beheer gegevens en rapporten
Vereisten
Om met het Workiva-platform te communiceren, maakt de connector gebruik van de WorkivaREST API's. Om de connector in te stellen, hebt u het volgende nodig:
-
Een toegewijde Workiva-integratiegebruiker met een OAuth2-toekenning.
Opmerking: Deze integratiegebruiker heeft de juiste machtigingen nodig voor de opdrachten die de connector uitvoert, zoals Eigenaar van de spreadsheets of werkruimte waarmee deze interactie heeft.
- De OAuth2-grant-ID en het geheim van de integratiegebruiker.
- Om de keten in een testomgeving uit te voeren, moeten de URL's de host- en basispaden van de API overschrijven.
Opmerking: Hoewel de eigenaren van de werkruimte toegang hebben tot ketens die de connector gebruiken, vereist de connector zelf een speciale integratiegebruiker om de opdrachten uit te voeren. Door een speciale integratiegebruiker te gebruiken – in plaats van het gebruikersaccount van een medewerker – kunt u de activiteit van de connector volgen en de toegang beperken tot alleen datgene wat nodig is om de opdrachten uit te voeren.
Configureer de Workiva-connector
- Klik in Chain Builderop Connectionsen vervolgens op Create rechtsboven.
- Onder Verbinding makenselecteer je Workiva en de standaard CloudRunner.
- Voer onder Basisinfoeen unieke naam en beschrijving in om de connector te identificeren.
-
Selecteer onder Resourcesde resources die u aan deze verbinding wilt koppelen.
Deze sectie biedt een veilige locatie voor alle bestanden (scripts, beveiligingstokens, certificaten, enz.) die de connector nodig heeft om te functioneren, bijvoorbeeld voor authenticatie of omgevingsvereisten. Wanneer je de verbinding opslaat, worden deze bestanden automatisch AES-256 versleuteld. Raadpleeg voor meer informatie de pagina over de beveiligingsarchitectuur van Workiva Chain Builder op de ondersteuningspagina.Voordelen:
- Veilige opslag: Omdat deze bestanden bij het opslaan worden versleuteld en op verbindingsniveau worden bewaard, zijn ze ideaal voor gevoelige of statische configuratiegegevens die niet in de keten zelf mogen worden vastgelegd.
- Draagbaarheid: Als u uw keten verplaatst van een "Test"-werkruimte naar een "Productie"-werkruimte, blijven de resources gekoppeld aan de verbindingsinstellingen, wat betekent dat u de bestandspaden in uw ketenknooppunten niet hoeft te herschrijven.
- Toegankelijkheid: Door de bestanden hier op te slaan, zijn ze beschikbaar voor de Runner (de agent die de taak uitvoert) zonder dat het bestand handmatig op de fysieke hostmachine van de runner hoeft te worden geplaatst.
Nadelen:
- Omdat ze versleuteld zijn, kunnen ze niet direct worden bewerkt; u moet het bestand verwijderen en de gewijzigde versie uploaden.
-
Onder Eigenschappenkunt u de verbindingsgegevens invoeren:
Eigendom Details id Voer de ID in voor de OAuth-toekenning van de integratiegebruikers. Geheim Voer het geheim in voor de ID eigenschap. Cerebrale gastheer-override Om de URL-host en het basispad voor de Wdata- eindpunten te overschrijven, bijvoorbeeld voor een testomgeving, voert u in plaats daarvan de te gebruiken URL in. Host-override voor spreadsheets Om de URL -host enhet basispad voor de Spreadsheets-eindpunten te overschrijven, bijvoorbeeld voor een testomgeving, voert u de te gebruiken URL in. IAM-hostoverride Om de URL-host en het basispad voor de Identity and Access Management ( IAM )-eindpunten te overschrijven, bijvoorbeeld voor een testomgeving, voert u de te gebruiken URL in. Beheerder host overschrijven Om de URL-host en het basispad voor de beheerders -eindpunten te overschrijven, bijvoorbeeld voor eentestomgeving , voert u de te gebruiken URL in. GraphDB-host overschrijven Om de URL-host en het basispad voor de GraphDB-eindpunten te overschrijven, bijvoorbeeld voor een testomgeving, voert u de te gebruiken URL in. Platform API-host overschrijven Om de URL -host en het basispad voor de Workiva-platform- eindpunten te overschrijven, bijvoorbeeld voor een testomgeving, voert u de te gebruiken URL in. Opmerking: Alle gevoelige inloggegevens worden automatisch versleuteld en opgeslagen met behulp van AES-256-codering.
- Selecteer de omgevingen die u voor de verbinding wilt gebruiken en klik op Opslaan.
- Om de verbinding te testen, maak en voer een keten uit met het commando List Files van de connector encontroleer of deze een geldige uitvoer retourneert.
URL-overrides
Afhankelijk van de regio van uw productieomgeving kan een afwijkende URL van toepassing zijn.Je kunt dit controleren door de URL te vergelijken die je gebruikt om in te loggen bij Wdesk.Als de URL EU of APAC bevat, is een uitzondering vereist.
Opmerking: Informatie over de VS-regio wordt ter referentie weergegeven.
| Veld | Waarde |
|---|---|
| Cerebrale Host Override | https://h.app.wdesk.com/s/cerebral |
| Host voor spreadsheets overschrijven | https://api.app.wdesk.com/spreadsheets/v1/ |
| IAM-hostoverride | https://api.app.wdesk.com/iam/v1/oauth2/token |
| Beheerder Host Override | https://api.app.wdesk.com/admin/v1 |
| Graph DB Host overschrijven | https://api.app.wdesk.com/graphdb/v1/ |
| Platform API-host opheffen | https://api.app.wdesk.com/platform/v1 |
| Veld | Waarde |
|---|---|
| Cerebrale Host Override | https://h.eu.wdesk.com/s/cerebral |
| Host voor spreadsheets overschrijven | https://api.eu.wdesk.com/spreadsheets/v1/ |
| IAM-hostoverride | https://api.eu.wdesk.com/iam/v1/oauth2/token |
| Beheerder Host Override | https://api.eu.wdesk.com/admin/v1 |
| Graph DB Host overschrijven | https://api.eu.wdesk.com/graphdb/v1/ |
| Platform API-host opheffen | https://api.eu.wdesk.com/platform/v1 |
| Veld | Waarde |
|---|---|
| Cerebrale Host Override | https://h.apac.wdesk.com/s/cerebral |
| Host voor spreadsheets overschrijven | https://api.apac.wdesk.com/spreadsheets/v1/ |
| IAM-hostoverride | https://api.apac.wdesk.com/iam/v1/oauth2/token |
| Beheerder Host Override | https://api.apac.wdesk.com/admin/v1 |
| Graph DB Host overschrijven | https://api.apac.wdesk.com/graphdb/v1/ |
| Platform API-host opheffen | https://api.apac.wdesk.com/platform/v1 |
Probleemoplossing
Als de verbinding met het Workiva-platform mislukt:
- Controleer of de OAuth-gegevens van de connectorapplicatie aanwezig, correct en geldig zijn. OAuth-referenties hebben een vastgestelde vervaldatum en het certificaat kan verlopen zijn. In dat geval moet u een nieuw certificaat aanmaken en het nieuwe clientgeheim in de Connector invoeren.
- Zorg ervoor dat de integratiegebruiker de juiste machtigingen heeft voor de uit te voeren opdracht.
- Als u een hostoverride gebruikt, controleer dan of de URL die u voor de connector hebt ingevoerd correct is.
-
Controleer of de ID van het Workiva-bestand —zoals de tabel, query of spreadsheet— waarmee u werkt, correct is.
Opmerking: De ID van een bestand verschijnt in de URL wanneer het in Workiva wordt geopend. Een spreadsheet-ID verschijnt bijvoorbeeld na
spreadsheet/in de URL; een tabel-ID verschijnt natables/.