Versie: 1.5 Datum: 11 mei 2017 Gevoeligheid: Openbaar Status: Definitief www.zivver.com support.zivver.com support@zivver.com
1. Inhoud 1. Inhoud... 2 2. Inleiding... 3 3. Installatie... 3 3.1. De online of offline installer gebruiken... 3 3.2. Online installer... 3 3.3. Offline installer... 4 3.4. Installeren voor iedereen of alleen mij... 4 3.5. De plug-in installeren middels een Group Policy... 5 Installer beschikbaar maken voor installatie... 5 Een Group Policy Object (GPO) aanpassen of aanmaken... 5 De installer koppelen aan de GPO... 5 4. Verbinding maken... 6 4.1. De plug-in verbinding laten maken met ZIVVER... 6 4.2. Wat is er vereist om de plug-in te laten verbinden met ZIVVER?... 6 4.3. Hoe kan ik controleren of de plug-in verbinding heeft met ZIVVER?... 6 4.4. Problemen met verbinding... 8 4.5. De plug-in laden in Outlook of niet... 8 4.6. Problemen met de Office plug-in oplossen (alleen in versie 2.2.3 of hoger) 10 4.7. Het error-log inzien... 11 2
2. Inleiding In deze installatiehandleiding behandelen we de belangrijkste aandachtspunten bij de installatie van de Office plug-in. We leggen de verschillende manieren om de plug-in te installeren uit en behandelen mogelijke problemen die bij de installatie kunnen optreden. 3. Installatie 3.1. De online of offline installer gebruiken Voor de Office plug-in zijn 2 installers beschikbaar; een online en een offline variant. Het verschil tussen de online en offline installer is de manier waarop een nieuwe versie van de plug-in kan worden geïnstalleerd. Als de gebruiker de plug-in zelf mag installeren en updaten, dan raden wij de online variant aan. Als het beheer van de plug-in centraal wordt geregeld en uitgerold, dan raden wij de offline variant aan. 3.2. Online installer De online installer (.exe) downloadt bij het installeren alle benodigde gegevens. Het installeren gebeurt met een gedownload.msi-bestand. Als de plug-in is geïnstalleerd met de online installer, dan controleert de plug-in automatisch of er een nieuwe versie beschikbaar is. Bij het opstarten van Outlook krijgt de gebruiker vervolgens een melding dat de nieuwe versie geïnstalleerd kan worden. De gebruiker kan er op dat moment voor kiezen om de plug-in wel/niet te updaten. Uiteraard moet de gebruiker rechten hebben om de update te mogen installeren op zijn computer. Tijdens het updaten wordt de huidige versie van de plug-in eerst gedeïnstalleerd om vervolgens de nieuwe versie te installeren. Hierna kan Outlook automatisch worden herstart, als de gebruiker deze optie heeft gekozen. 3
3.3. Offline installer Als de plug-in is geïnstalleerd met de offline installer (.msi), dan kan deze alleen worden geüpdatet door een nieuwe versie handmatig te installeren. Hierin verschilt de offline installer met de online installer. De offline installer is een standaard.msi-bestand waarvoor de Windows Installer commando s kunnen worden gebruikt. 3.4. Installeren voor iedereen of alleen mij De Office plug-in kan geïnstalleerd worden voor alle gebruikers van deze computer of voor alleen de ingelogde gebruiker. Het maakt daarbij niet uit of de online of offline installer wordt gebruikt. Wij raden aan om de plug-in te installeren voor iedereen als alle gebruikers in een netwerk gebruik gaan maken van de plugin. Bij deze optie zal ZIVVER bij alle gebruikers die Outlook gebruiken op de computer actief zijn. Wij raden aan om de plug-in te installeren voor alleen mij als slechts enkele gebruikers gebruik gaan maken van ZIVVER (b.v. als de organisatie een pilot doet). Met deze optie is ZIVVER alleen in hun Outlook-omgeving actief en niet bij andere gebruikers op de computer. 4
De keuze om de plug-in te installeren voor iedereen of alleen mij kan tijdens het installeren handmatig worden gemaakt (zie hierboven). Een andere mogelijkheid is om via een Windows Installer commando s de installatie te starten. 3.5. De plug-in installeren middels een Group Policy De plug-in kan geïnstalleerd worden middels een Group Policy. Gebruik daarvoor de Group Policy Management Console (GPMC). Installer beschikbaar maken voor installatie Om de plug-in middels een Group Policy te installeren, moet de installer in het netwerk beschikbaar zijn. Plaats daarvoor de installer in een map op een netwerkschijf. Een Group Policy Object (GPO) aanpassen of aanmaken Pas een bestaande GPO aan of maak een nieuwe GPO aan. Koppel deze policy vervolgens aan de juiste Organizational Unit (OU), domain of site. Houdt daarbij rekening met inheritance: als je de policy koppelt dan is de plug-in uiteraard ook beschikbaar voor alle onderliggende mappen (child containers) in deze OU/domain/site. De installer koppelen aan de GPO Gebruik de Group Policy Management Editor (GPME) voor het koppelen van de installer aan de GPO. 1. Pas de GPO aan: rechtermuisknop > Edit. GPME opent automatisch. 2. Ga naar Computer configuration > Policies > Software Settings > Software installation. 3. Pas software installation aan: rechtermuisknop > New > Package. 5
4. Verbinding maken 4.1. De plug-in verbinding laten maken met ZIVVER De Office plug-in heeft een verbinding nodig met ZIVVER om veilig berichten te kunnen verzenden en ontvangen. In dit hoofdstuk leggen we uit: - Wat er vereist is om de plug-in verbinding te laten maken met ZIVVER. - Hoe je kunt controleren of de plug-in wel/geen verbinding heeft met ZIVVER. 4.2. Wat is er vereist om de plug-in te laten verbinden met ZIVVER? De volgende zaken zijn van invloed op de verbinding die de plug-in met ZIVVER maakt: - De plug-in maakt een HTTPS-verbinding (TLS) via poort 443. Er zijn geen andere poorten in gebruik. - De plug-in maakt verbinding met ZIVVER via het DNS-domein https://*.zivver.com. De wildcard (*) geeft aan dat verschillende subdomeinen hieronder vallen. ZIVVER heeft geen vaste IP-adressen in gebruik en gebruikt daarom dit DNS-domein. - De plug-in maakt voor zijn verbinding gebruik van certificate pinning. Als je gebruik maakt van een Encrypted Traffic Management (ETM) systeem, kan de verbinding met ZIVVER wellicht worden geblokkeerd. Verwijzing naar sectie toevoegen hoe dit te omzeilen - Firewall - Proxy 4.3. Hoe kan ik controleren of de plug-in verbinding heeft met ZIVVER? Als de plug-in verbinding heeft met ZIVVER, dan kan de gebruiker inloggen met zijn ZIVVER-account. Daarnaast geeft de ZIVVER-werkbalk geen meldingen m.b.t. verbinding maken weer (kleur van de werkbalk is grijs of blauw). De verbinding kan worden gecontroleerd in het scherm Over ZIVVER. Ga daarvoor in het ribbon/lint naar het tabblad ZIVVER. Klik vervolgens op Over ZIVVER. 6
Als er achter Backend versie en Backend API versie een versienummer is ingevuld, dan is er een verbinding met ZIVVER gemaakt. Het versienummer voor Plug-in API versie is altijd ingevuld, ook als er geen verbinding is. Als de plug-in geen verbinding heeft, dan wordt dit ook bij het opstellen van een bericht in de ZIVVER-werkbalk aangegeven. Als de plug-in nog bezig is met controleren of er een verbinding is met ZIVVER, dan wordt dit als volgt aangegeven: 7
Als de plug-in geen verbinding met ZIVVER heeft, dan krijg je bij het inloggen de melding Gebruikersnaam/wachtwoord ongeldig. Controleer dan ook de verbinding met ZIVVER, zoals hieronder staat beschreven. 4.4. Problemen met verbinding Als de Office plug-in géén verbinding kan maken met de backend, en in Over ZIVVER worden geen versienummers getoond achter Backend versie en Backend API versie, controleer dan de volgende zaken. 1. De Office plug-in moet via de standaard HTTPS-poort (443) verbinding kunnen maken. Voeg deze toestemming indien nodig ook toe aan een proxyserver. 2. De ZIVVER-backend mag niet geblokkeerd worden door een firewall. Voeg indien nodig https://*.zivver.com als uitzondering toe. 3. Om de verbinding te beveiligen moet een digitaal certificaat ondertekend worden vanuit de plug-in. Als dit in het netwerk niet goed gaat, pas dan het onderstaande bestand aan: %AppData%\Zivver\OfficePlugin\zivver.config.xml Voer in dat bestand de onderstaande regel toe: <PinRootCertificate>false</PinRootCertificate> 4.5. De plug-in laden in Outlook of niet Tijdens het installeren van de plug-in worden enkele registerwaarden geïnstalleerd. Zo wordt voor Outlook de LoadBehavior waarde ingesteld. Deze waarde bepaalt of een plug-in wordt geladen bij het opstarten van Outlook, of niet. LoadBehavior kan per gebruiker of per computer worden ingesteld. Als de Office plug-in voor de huidige gebruiker (just me-optie) wordt geïnstalleerd, dan staat LoadBehavior op onderstaande locatie: Computer\HKEY_CURRENT_USER\SOFTWARE\Microsoft\Office\Outlook\A ddins\zivverofficeplugin.addinmodule 8
Als de Office plug-in voor deze computer (everyone-optie) wordt geïnstalleerd, dan staat LoadBehavior op onderstaande locatie: Computer\HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Office\Outlook\ Addins\ZivverOfficePlugin.AddinModule De belangrijkste waarden voor LoadBehavior zijn: - LoadBehavior = 0 (0x00000000) De plug-in wordt niet automatisch geladen bij het opstarten van Outlook. Als de gebruiker de plug-in handmatig start, dan blijft de waarde 0. Dus de volgende keer dat je Outlook opstart, is de plug-in niet automatisch geladen. - LoadBehavior = 2 (0x00000002) De plug-in wordt niet automatisch geladen bij het opstarten van Outlook. Als de gebruiker de plug-in handmatig start en er treden geen problemen op, dan wordt de waarde aangepast naar 3. - LoadBehavior = 3 (0x00000003) De plug-in wordt automatisch geladen bij het opstarten van Outlook. Als er een probleem met de plug-in is, dan wordt de waarde aangepast naar 2. Anders blijft de waarde 3. Bij installatie van de Office plug-in wordt de LoadBehavior waarde aangemaakt en op waarde 3 gezet. Als de plug-in wordt gedeïnstalleerd, dan wordt de LoadBehavior waarde verwijderd. Een LoadBehavior waarde kan handmatig worden aangepast in het register, door er dubbel op te klikken. Mocht de LoadBehavior waarde niet bestaan, dan kan deze handmatig worden aangemaakt. Maak daarvoor een nieuwe DWORD (32 bits)- waarde aan. Geef vervolgens een waarde op, zoals hierboven benoemd. 9
4.6. Problemen met de Office plug-in oplossen (alleen in versie 2.2.3 of hoger) Als er problemen optreden met de Office plug-in, kan de ingebouwde probleemoplosser heel waardevol zijn bij het stellen van de juiste diagnose. Ga naar het ZIVVER-tabblad en klik op de knop Help om de Probleemoplosser te starten. Je ziet nu een wizard die een aantal zaken controleert en aandachtspunten aangeeft. In het laatste scherm heb je ook de optie om een e-mail te sturen naar onze support-afdeling, waarbij ook meteen diagnostische informatie en een errorlog toegevoegd worden. 10
4.7. Het error-log inzien Het error-log van de Office plug-in geeft nuttige informatie over wat er misgaat. Je kunt dit inzien als je foutmeldingen in de plug-in krijgt, of als er dingen gebeuren die niet volgens de normale gang van zaken zijn. Je kunt het error-log vinden op de volgende locatie: %AppData%\Zivver\OfficePlugin\zivver.error.log Het bestand is gewoon te openen in een simpele tekst-editor, zoals Windows Kladblok. Als je contact opneemt met onze support-afdeling over een probleem in de Office plug-in, is het handig om het error-log als bijlage mee te sturen. Dat geeft ons meer informatie waarmee we het probleem in kaart kunnen brengen. 11