Handleiding DMS Plugin – Installatie, configuratie & werking
HANDLEIDING DMS Plugin Installatie, configuratie & werking Dit document is de handleiding voor de installatie, configuratie en werking van de DMS Plugin. Versie 1 - 12/09/2005
Inhoudstafel
1
Installatie ............................................................................................................................ 2 1.1 Vereisten vóór compilatie van installatiebestand....................................................... 2 1.2 Vereisten voor lanceren van installatie ...................................................................... 2 1.3 Installatie procedure ................................................................................................... 2 2 Configuratie........................................................................................................................ 5 3 Werking DMS Plugin......................................................................................................... 8 3.1 DMS aanpassingen ..................................................................................................... 8 3.2 Plugin functionaliteiten .............................................................................................. 8
e2e nv
pagina 1/9
Handleiding DMS Plugin – Installatie, configuratie & werking
1 Installatie 1.1 Vereisten vóór compilatie van installatiebestand Er zijn een aantal vereisten die moeten voldaan zijn vooraleer het installatiebestand gecompileerd wordt, aangezien deze gegevens opgenomen zijn in het installatiebestand. Deze gegevens zijn: • Netwerkgebruiker o Gebruiker in AD. De ‘transfer’ service op de lokale computer draait onder deze gebruiker en gebruikersnaam en paswoord van deze gebruiker wordt gebruikt om files naar de DMS server op te laden. Indien deze gebruiker zijn paswoord wordt veranderd, dan moet dit manueel aangepast worden voor alle reeds uitgevoerde installaties van de DMS Plugin. o Voor installatie bij Ieper => gebruikersnaam = ”dmsclient” en paswoord = “1micro+zout” •
DMS Pickup folder o Dit is de folder waarin de gebruiker zijn bestanden zal opslaan om op te laden naar de DMS server. o Voor installatie bij Ieper => “C:\DMS\”
1.2 Vereisten voor lanceren van installatie Er zijn een aantal vereisten die moeten voldaan zijn vooraleer de installatie kan gestart worden op een bepaalde computer. Deze vereisten zijn: • Te installeren computer: o .Net framework v1.1 geïnstalleerd o Verbinding met het lokale netwerk •
DMS server: o DMS upload folder moet gedeeld zijn, met schrijfrechten voor de netwerkgebruiker (zie vorig hoofdstuk)
•
De gebruiker die de installatie uitvoert, moet een gebruiker zijn binnen het AD domein en installatierechten hebben (aangeraden: Administrator rechten)
1.3 Installatie procedure De installatie van de DMS Plugin bestaat uit 3 bestanden: • Setup.exe • Setup.ini • SetupDMSClient.msi De installatieprocedure is in het Engels aangezien deze aangemaakt wordt door de ontwikkelomgeving die enkel in het Engels is. Deze procedure is spijtig genoeg niet aan te passen, dus zal steeds in het Engels zijn.
e2e nv
pagina 2/9
Handleiding DMS Plugin – Installatie, configuratie & werking Na het starten van Setup.exe krijg je volgend welkom schermpje, waarop je op ‘Next’ (Volgende) klikt om de installatie te starten of ‘Cancel’ (Annuleer) om de installatie af te breken.
In het volgende schermpje kan je aangeven waar de noodzakelijke bestanden voor de DMS Plugin moeten geïnstalleerd worden. Om de installatie toegankelijk te maken voor elke gebruiker die aanlogt op de computer, selecteer je onderaan ‘Everyone’. Klikken op ‘Next’ brengt je naar het schermpje waar je de installatie nog moet bevestigen.
e2e nv
pagina 3/9
Handleiding DMS Plugin – Installatie, configuratie & werking Als je op onderstaand bevestigingsschermpje op ‘Next’ klikt, start de installatieprocedure voor de DMS Plugin.
Er zal ook een laatste schermpje getoond worden waarop vermeld wordt of de installatie succesvol verlopen is of niet.
Na de installatie wordt de DMS Plugin automatisch opgestart en kan hij dus onmiddellijk gebruikt worden. De installatieprocedure zal een service aanmaken met als naam ‘DMSTransfer’. Er zal ook een snelkoppeling toegevoegd worden aan het opstart menu naar de applicatie ‘DMSWatcher’. In de folder waar de applicatie geïnstalleerd werd, kan men via de applicatie ‘DMSAdmin’ de configuratie van de DMS Plugin aanpassen.
e2e nv
pagina 4/9
Handleiding DMS Plugin – Installatie, configuratie & werking
2 Configuratie Enkel voor administratieve doeleinden kan de configuratie van de DMS Plugin aangepast worden. De gegevens kunnen aangepast worden via de applicatie ‘DMSAdmin.exe’ die geïnstalleerd wordt in de folder met de Transfer en Watcher applicaties.
Om de configuratie te kunnen aanpassen moet men inloggen met als gebruikersnaam “e2eAdmin” en met paswoord “fire=fox”.
Na in te loggen, verschijnt er een schermpje met de volgende parameters: • DMSClient map: o Folder waar de applicatie geïnstalleerd werd (niet aan te passen) •
Pickup map: o Folder waarin de gebruiker bestanden moet wegschrijven om automatisch naar het DMS op te laden. o Deze folder wordt automatisch door de installatie aangemaakt en is steeds “X:\DMS\”, waarbij de X vervangen wordt door de schijfletter van de DMSClient map. o Door middel van de knop ‘Zoek’ kan deze folder aangepast worden.
e2e nv
pagina 5/9
Handleiding DMS Plugin – Installatie, configuratie & werking •
Update intranet URL: o De URL naar het ‘Update’ platform, waarbinnen het DMS draait o Voor de demo website van Ieper is dit ‘http://demo.ieper.be/’ o Voor het live platform van Ieper is dit ‘http://intranet.ieper.be/’ o Door middel van de knop ‘Controleer’ wordt de ingegeven URL geopend in een webbrowser venster om zo te controleren of de URL beschikbaar (correct) is.
•
Server DMS Upload pad: o De folder op de DMS server waarnaar alle bestanden gekopieerd moeten worden. Dit is een gedeelde folder die enkel voor de gedefinieerde netwerkgebruiker toegankelijk is. o Door middel van de knop ‘Zoek’ kan deze folder aangepast worden. o Ook kan het pad eventueel manueel ingetypt worden in het veld. o Voor de demo website van Ieper is dit ‘\\iep-intraweb\DemoDMSUpload\’ o Voor de demo website van Ieper is dit ‘\\iep-intraweb\DMSUpload\’
•
Pickup Timerinterval: o Het aantal milliseconden tussen het controleren op nieuwe of gewijzigde bestanden in de pickup folder. Een lager getal zorgt voor een snellere reactie, maar ook een grotere belasting van de client pc. o Default waarde is 1000 ms (elke seconde). o De waarde moet zeker groter zijn dan 0.
•
Snooze Timerinterval o Het aantal milliseconden tussen het controleren op gesnoozede bestanden. Een lager getal zorgt voor een snellere reactie, maar ook een grotere belasting van de client pc. o Default waarde is 60000 ms (elke minuut). o De waarde moet zeker groter zijn dan 0.
•
Proberen kopiëren naar server (bij mislukking): o Het aantal keer dat er moet geprobeerd worden om een bestand te verwerken vanuit de pickup folder. Met interval van 1 seconde wordt er X aantal keer geprobeerd. Indien het niet lukt, krijgt de gebruiker een pop-up om het nogmaals te proberen. o Default waarde is 20 keer.
•
Queue XML’s verwijderen na: o Aantal uren waarna aangemaakte XML bestanden uit de Queue folder verwijderd worden. o Enkel gehele getallen zijn toegelaten. o 0 ingeven als waarde, betekent dat bestanden niet bijgehouden worden. o Default waarde is 10 uren.
•
Processed XML’s verwijderen na: o Aantal uren waarna aangemaakte XML bestanden uit de Processed folder verwijderd worden. o Enkel gehele getallen zijn toegelaten. o 0 ingeven als waarde, betekent dat bestanden niet bijgehouden worden. o Default waarde is 10 uren.
•
Failed o o o o
e2e nv
bestanden verwijderen na: Aantal uren waarna bestanden uit de Failed folder verwijderd worden. Enkel gehele getallen zijn toegelaten. 0 ingeven als waarde, betekent dat bestanden niet bijgehouden worden. Default waarde is 10 uren.
pagina 6/9
Handleiding DMS Plugin – Installatie, configuratie & werking Opmerking: Om de veranderingen aan de configuratie door te voeren, dienen de transfer service en de watcher applicatie wel herstart te worden. Best gebeurd dit op de volgende manier: • Stoppen van watcher proces via Task manager (DMSWatcher.exe) • Stoppen van transfer service via Services (DMSTransfer) • Opstarten watcher applicatie via startup folder of installatiefolder • De watcher applicatie start automatisch ook de transfer service op Vanaf nu zal de watcher applicatie en de transfer service de aangepaste parameters gebruiken.
e2e nv
pagina 7/9
Handleiding DMS Plugin – Installatie, configuratie & werking
3 Werking DMS Plugin 3.1 DMS aanpassingen Wanneer je in een overzicht binnen het DMS op het bestandsicoontje van een document klik, krijg je nu een pop-up met twee keuzes: • Het bestand enkel openen • Het bestand openen om aanpassingen te doen
Klik je op de knop ‘Openen’, dan zal het bestand geopend worden, maar gebeurt er verder niks binnen het DMS. Als je dus dit open bestand terug opslaat naar het DMS, zal het steeds als een nieuw bestand toegevoegd worden aan het DMS. Klik je daarentegen op ‘Aanpassen’, dan zal het bestand geopend worden, maar het DMS document wordt tegelijk ook uitgecheckt. Hierdoor kan niemand anders ondertussen aanpassingen doen aan dit document. Het bestand wordt geopend met de ID van het DMS document in de bestandsnaam vervat. Belangrijk is dus dat deze bestandsnaam niet veranderd wordt, anders kan het bestand niet als een bestaand document herkend worden. Wanneer dit bestand nu terug wordt opgeslagen in het DMS, dan herkent de DMS Plugin van welk document dit bestand afkomstig is en zal er van dat bestaande en uitgecheckte document een nieuwe versie aangemaakt worden.
3.2 Plugin functionaliteiten Zodra de DMS Plugin geïnstalleerd is, zal er een folder beschikbaar zijn (“C:\DMS”, verder de pickup folder genoemd) die de gebruiker kan gebruiken om bestanden rechtstreeks naar het DMS op te laden. De ‘Watcher’ applicatie houdt deze folder in de gaten en zal reageren zodra er een bestand in de folder opgeslagen wordt. De ‘Watcher’ applicatie reageert dus zodra een bestand opgeslagen wordt vanuit een open applicatie (MS Word, Notepad, …), maar ook wanneer een bestand geplakt wordt door gebruik te maken van de Windows Verkenner bijvoorbeeld. De pickup folder is zeker geen tijdelijke werkfolder om bestanden in op te slaan. Telkens er een bestand wordt opgeslagen, zal de ‘Watcher’ applicatie van de DMS plugin de nodige acties met het bestand uitvoeren en dan ook het bestand verwijderen uit de pickup folder. Indien het bestand nog openstaat in een applicatie, kan men wel verder werken en een latere versie opnieuw opslaan in de pickup folder. Opmerking: Bestanden met een ~ in de bestandsnaam en bestanden met als extensie ‘.tmp’ kunnen niet via de DMS Plugin in het DMS opgeslagen worden. Bestanden zonder extensie worden niet door de DMS Plugin opgeslagen in het DMS, hetzelfde geldt voor folders. Zodra een bestand in de pickup folder opgeslagen wordt, opent de ‘Watcher’ applicatie een web browser scherm waarin de metadata van het DMS document moet worden ingevuld.
e2e nv
pagina 8/9
Handleiding DMS Plugin – Installatie, configuratie & werking
Alle verplichte velden zijn reeds automatisch ingevuld behalve de menustructuur, deze moet nog worden aangegeven. De naam van het DMS document wordt initieel overgenomen van de bestandsnaam (zonder de extensie). Het type is digitaal en kan niet veranderd worden. Het bestand zelf is reeds toegevoegd. De auteur wordt automatisch ingevuld indien de ingelogde gebruiker ook als DMS gebruiker gedefinieerd is. Is dit niet het geval, dan moet nog een geldige gebruikersnaam en paswoord ingegeven worden om in te loggen in het Intranet. Zodra de menustructuur is aangevuld, kan de gebruiker het DMS document opslaan. Hij kan hier kiezen uit twee opties: • Opslaan en stoppen o Het document wordt ingecheckt, dus kan door andere personen worden aangepast. • Opslaan en verder werken o Het document wordt wel opgeslagen, maar blijft uitgecheckt voor de gebruiker om later een nieuwe versie op te slaan. Wanneer men op annuleren klikt, zal het document niet worden opgeslagen in het DMS. Wanneer men dit web browser scherm afsluit zonder gebruik te maken van de ‘Opslaan’ of ‘Annuleer’ knoppen, zal het document voor 5 minuten ‘gesnoozed’ worden. Dit betekent dat na 5 minuten de DMS Plugin opnieuw het scherm opent om het bestand naar het DMS op te laden. De gebruiker kan ook zelf aangeven om het opslaan in het DMS uit te stellen (te ‘snoozen’) met 5, 15, 30 of 60 minuten via de knop ‘Acties’.
e2e nv
pagina 9/9