Documenten upload en import (bulk) via Postman
- Ivo Korteweg (Unlicensed)
- Raoul Huisman
Momenteel (februari 2022) is het enkel mogelijk om in bulk documenten te uploaden in HUMBLE via Postman. In een later stadium wordt het ook mogelijk om bulk documenten uploads te doen via de user interface van HUMBLE. Op dat moment is deze tijdelijke oplossing niet langer noodzakelijk.
Stap 1 - Voorbereiden Postman
Installeer Postman op je PC (zie Download Postman | Get Started for Free.
Download het volgende HUMBLE Exchange Postman collectie bestand;
Druk linksboven naast ‘My Workspace’ op de knop ‘Import’. Upload hier het Postman collectie bestand van de vorige stap.
Collection
Wanneer dit gedaan is, ga dan op de collectie staan (HUMBLE Exchange [2022-01-11]).
Open de tab 'Variables', het scherm ziet er nu als volgt uit;
Je vervangt de waardes <your email> door je mailadres waarmee je in HUMBLE bekend bent.
Je vervangt de waardes <your password> door het bij het mailadres behorende wachtwoord in HUMBLE. Het wachtwoord blijft leesbaar.
Je vervangt de waardes <otp_secret_key> door je eigen TOTP secret key. Deze lange aaneengesloten reeks hoofdletters en cijfers werd getoond bij het instellen van twee factor authenticatie in HUMBLE. Zie de eerste afbeelding in het volgende Confluence artikel; Instellen Twee-factor-authenticatie voor HUMBLE; bestaande klanten. In het voorbeeld op Confluence begint de secret key met '72ARTSL'.
Druk rechtsboven op 'Save'.
Environment
Klik links in het menulint op 'Environments'.
Klik op de knop ‘New' en kies voor 'Environment’.
Hernoem de environment naar 'HUMBLE productie'.
Voeg twee variabelen zonder waarden toe; ‘cognitoIdToken', 'bearer’. Type; default.
Druk rechtsboven op 'Save'.
De environment zou nu rechtsboven moeten staan (zie rode pijl in onderstaande schermafdruk).
Stap 2 - Inloggen
Elke keer wanneer je documenten in bulk wenst te importeren dient stap 2 opnieuw uitgevoerd te worden.
Ga op de folder ‘Login steps’ staan. Druk rechtsboven op de knop 'Run'.
Druk in het scherm wat geopend wordt op de brede blauwe knop rechts 'Run HUMBLE Exchange…'.
Wanneer in het volgende scherm voor de drie requests ('AWS Authentication', ‘AWS TOTP' en ‘HUMBLE Api Login') rechts als respons '200 OK’ hebben, ben je succesvol ingelogd.
Stap 3 - Documenten uploaden en importeren
Het account (<your_email>)waarmee je de import wil doen dient wel toegang te hebben tot de organisatie waar je in wil importeren.
Na correct inloggen kan je aan de slag.
ZIP uploaden
Open de request ‘Upload ZIP naar Exchange' in de folder 'Document Import’ in de collectie.
Open de tab ‘Body'. Verwijder het vorige importbestand door middel van het kruisje rechts van de bestandsnaam.
Zoek vervolgens het juiste .ZIP bestand op je lokale pc. Deze wordt nu als ‘waarde bij ‘importfile’ getoond.
Druk rechtsboven op ‘Send'. De .ZIP wordt nu geupload naar HUMBLE. Als het goed is gegaan verschijnt er onderaan als respons; 'jaaaa’.
Optie A - Documenten importeren middels description.csv
Voor het uitvoeren van deze stap dient eerst een set documenten voorbereid te zijn. Meer informatie hierover is te vinden via; Document import.
In deze situatie beschik je over een .ZIP bestand met daarin documenten en een .CSV bestand (genaamd description.csv) voorzien van de eigenschappen van deze documenten.
Open nu de request ‘Document Import via Exchange’ in de folder 'Document Import’ in de collectie.
Open de tab 'Body'.
Vul bij import → source → filename de naam van het net geüploade bestand in (inclusief .ZIP).
Vul bij export → organisationId het ID van de organisatie in waar de bestanden moeten worden geïmporteerd.
Vul bij export->options->notify_to_user_id je eigen user ID binnen HUMBLE. Dit is in HUMBLE te vinden via Applicatiebeheer > Gebruikers. Het gaat dan om kolom ‘Id’.
Druk vervolgens op ‘Send'. Wanneer het bij HUMBLE is aangeboden verschijnt er ‘200 OK’ bij ‘Status’, en als respons; 'yeah’.
Optie B - Documenten importeren zonder description.csv
In deze situatie beschik je over een .ZIP bestand met daarin documenten. Er is dus geen .CSV description bestand samengesteld. Alle documenten worden rechtstreeks aan dezelfde resource gekoppeld (zie hieronder).
Open nu de request ‘Document Import via Exchange’ in de folder 'Document Import’ in de collectie.
Open de tab 'Body'.
Vul bij export->options->resource de resource aanduiding waar de documenten aan gekoppeld moeten worden.
Vul bij export->options->reference_id het ID van het record waar de documenten aan gekoppeld moeten worden.
Druk vervolgens op ‘Send'. Wanneer het bij HUMBLE is aangeboden verschijnt er ‘200 OK’ bij ‘Status’, en als respons; 'yeah’.
Stap 4 - Controle en eventueel herstel
Wanneer je upload en import acties zijn uitgevoerd is het tijd om te controleren of het goed gegaan is.
Ga naar HUMBLE.
Wanneer je upload en import klaar is, ontvang je een notificatie in HUMBLE.
Open de notificatie, en klik rechtsboven op 'Media', en open vervolgens het gegenereerde .CSV bestand. Dit bestand zal (als je Chrome hebt) gelijk in de browser openen. Per document wordt aangegeven of het goed gegaan is of niet.
Ok = goed; je bent klaar.
Error = niet goed; je dient het document opnieuw aan te bieden.
Alle documenten die goed gegaan zijn, zijn via 'Documentbeheer' in HUMBLE te openen.
In de verschillende tabs bij het document is te zien aan welke records het document gekoppeld is binnen HUMBLE.
Stap 5 - Relax!
Je bent klaar, relax!