Sinds 21-FEB-2022 is versie 3 van de compliance set actief. Dat wil echter niet zeggen dat deze ook gelijk ‘actief' is voor de klanten die al gebruikt maakte van HUMBLE. Versie 3 dient, met terugwerkende kracht, gestart gescand te worden per gebouw. Dit artikel beschrijft hoe dit gedaan moet worden.
Stap 1 - Voorbereiden Postman
Installeer Postman op je PC (zie https://www.postman.com/downloads/.
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
| Note |
|---|
Elke keer wanneer je de compliance scan wenst uit te voeren dient stap 2 opnieuw uitgevoerd te worden. |
...
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 -
...
Compliance scan uitvoeren
| Note |
|---|
Het account (<your email>) waarmee je de import compliance scan wil doen dient wel toegang te hebben tot de organisatie waar je in wil importerenhet gebouw toebehoort. |
Na correct inloggen kan je aan de slag.
ZIP uploaden
Open de request ‘Upload ZIP naar Exchange‘Compliance scan' in de folder 'Document Import’ Compliance scan’ in de collectie.
Open de tab ‘Body‘Headers'. 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.
Verander onderaan de variable 'dg-ap-organisation' in het organisatienummer waar het gebouw toebehoort (zie rood omcirkeld in onderstaande schermafdruk).
Verander in de adresbalk de code tussen ‘locations/' en '/scan’ in het id van het gebouw waar je compliance voor wenst te scannen (zie blauwe pijl in onderstaande schermafdruk).
...
Druk rechtsboven op ‘Send'. De .ZIP scan wordt nu geupload naar HUMBLEuitgevoerd. Als het goed is gegaan verschijnt er onderaan als respons; ‘Compliance scan done’. Mocht je nog niet ingelogd zijn (stap 2), dan is de respons; 'jaaaa’.
Optie A - Documenten importeren middels description.csv
| Note |
|---|
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!
...
403 The token expired’.
Herhaal de laatste stap zo vaak als dat er gebouwen binnen de organisatie zijn waarvoor compliance gescand moet worden.
Stap 4 - Controle en eventueel herstel
Wanneer de compliance scan is uitgevoerd, is het tijd om te controleren of het goed gegaan is.
Ga naar HUMBLE.
Filter in het 'Compliance Activiteiten' scherm op het gebouw in kwestie.
Alle activiteiten van de oude regelset (versie 2) zijn voorzien van de status 'Vervallen' (mits ze al Gereed waren!). Controleer dit steekproefsgewijs.
Alle activiteiten van de nieuwe regelset (versie 3) zijn voorzien van de status 'Gepland'. Controleer dit steekproefsgewijs.
Controleer steekproefsgewijs of er gebouw activiteiten vanuit de compliance regelset zijn gemaakt. Voor deze activiteiten is de kolom ‘Asset' leeg, en staat er in de kolom ‘Asset naam’; 'Gehele gebouw’.
| Info |
|---|
Het is aan te raden om voor de eerste keren dat de compliance scan wordt uitgevoerd de 'Compliance Activiteiten' lijst in HUMBLE al geopend te hebben. Filter al op het gebouw in kwestie. En registreer het aantal regels. Het verversen van het scherm na de compliance scan geeft gelijk zicht op of het wel of niet goed gegaan is (het aantal activiteiten moet toegenomen zijn). |
Stap 5 - Registratie
Leg in het data logboek (in Confluence) vast voor welke gebouwen je de scan gedaan hebt. Wanneer je 100% van de gebouwen in een organisatie hebt gedaan, dan hoef je niet alle losse ID’s te noemen.
/wiki/spaces/PD/pages/1755316608
Stap 6 - Compliance V2 archiveren
Indien de klant nog niets gedaan heeft met versie 2 van compliance kan het verwarrend overkomen als er nu dubbele (soms soortgelijke) activiteiten zijn. Zowel op status ‘Vervallen' (versie 2), als op status 'Gepland’ (versie 3). We kunnen deze eventueel via de database archiveren. Vandaar de noodzaak van de registratie in het logboek. Hetgene we dan archiveren zijn;
Compliance activiteiten (req_requests),
Compliance bewijslast per activiteit (wka_activity_proofs),
Compliance elementen per activiteit (wka_activity_assets),
Compliance problemen (wka_compliance_problems).
Bespreek het uitvoeren van stap 6 met Ivo of Raoul.