Technisch ontwerp van de One Fox edav module Kenmerk: TO_EDAV_MVDB_51 Document: V1,2 / TO edav v2.2 Status: Publicatie: Definitief 28-2-2013
Documenthistorie Wanneer Versie Wie Wat en waarom 25-02-2010 0,1 Ron v. Oosterhout Initiële versie van technisch ontwerp 30-03-2010 1,0 Ron v. Oosterhout Encryptie toevoeging. 16-04-2010 1,1 Ron v. Oosterhout Opmerkingen verwerkt (Michel Hummel) 17-07-2012 1.2 Matthijs van den Bovenkamp Uitbreiding voor tablets. Dienstverlener One Fox www.onefox.nl Jens Peters Tel.: 030-2324 350
Inhoudsopgave 1 Inleiding... 4 2 Functionele beschrijving... 5 3 Systeem vereisten... 6 3.1 SERVER... 6 3.2 CLIËNT... 6 4 Technieken... 7 5 Architectuur... 8 5.1 OVERVIEW... 8 5.2 DEPLOYMENT DIAGRAM... 9 5.3 CLASS DIAGRAM... 10 6 Encryptie...12 7 Configuratie...13 8 Lijst bestanden...16 3 / 16
1 Inleiding Dit document is het technisch ontwerp van de One Fox edav module. De edav module is een WebDAV adapter, waarmee documentatie uit OpenText DM gehaald kan worden. Deze documentatie kan vervolgens met bijhorende client applicaties bekeken en bewerkt worden en dan via edav weer terug geüpload worden naar OpenText DM. De edav module maakt gebruik van de WebDAV techniek, wat een uitbreiding is op het http protocol. Voor deze oplossing is geen cliënt software noodzakelijk, behalve de applicatie waarmee het document bewerkt kan worden. De edav module maakt gebruik van de DM API om de juiste documentatie uit edocs te halen. Er zijn verschillende authenticatie modules gemaakt voor het afhandelen van de authenticatie. Zo is er bijvoorbeeld een windows authenticatie module zodat via de windows credentials documenten uit EDOCS geopend kunnen worden. Deze module wordt onder andere gebruikt wanneer edav toegepast wordt via een ipad of windows verkenner. Ook is er een basic authenticatie module die onder andere gebruikt wordt wanneer edav wordt toegepast via een Android Tablet, en een url authenticatie module zodat via een webapplicatie via "Single-Sign On" documenten uit edocs geopend kunnen worden. Om een document te openen dient een request gestuurd te worden naar de edav module die afhankelijk van de gekozen authenticatie module anders opgebouwd wordt. Hoe dit verschilt per authenticatie module, vind je terug in hoofdstuk 4 Authenticatie Modules van de FO. 4 / 16
2 Functionele beschrijving De edav module is een oplossing die het mogelijk maakt om documenten uit OpenText edocs direct te openen in bijhorende cliënt applicaties zonder het document eerst lokaal te downloaden en zonder dat hiervoor een installatie van een edocs cliënt noodzakelijk is. Het desbetreffende document dat is geopend in de cliënt applicatie, wordt ook rechtstreeks weer opgeslagen in edocs. De edav module maakt dit mogelijk door gebruikt te maken van WebDAV techniek wat een uitbreiding is van het http protocol. Voor deze oplossing is geen cliënt software noodzakelijk behalve de applicatie waarmee het document geopend of bewerkt kan worden. Voor het gebruik van de edav module op een tablet moet er ook een applicatie aanwezig zijn die een WebDAV verbinding kan maken. Om een document te openen dient een request gestuurd te worden naar de edav module. Er zijn verschillende authenticatie modules gemaakt voor het afhandelen van de authenticatie. Deze verschillende modules zijn: Windows Authentication Module: Authenticatie vindt plaats via windows authenticatie (onder adere gebruikt bij een windows verkenner map en de ipad). Basic Authentication Module: Authenticatie vindt plaats via basic authenticatie (onder andere gebruikt bij de tablets met Android). Url Based Authentication Module: Gebruikersnaam en wachtwoord worden meegestuurd in de request. Samen met de library en het document nummer (onder andere gebruikt bij een webapplicatie). Encrypted Url Based Authentication Module: Gebruikersnaam en wachtwoord worden meegestuurd in de request, waarbij het wachtwoord versleuteld wordt. Ook de library en het documentnummer worden meegestuurd. Encrypted Url Based Authentication Module V2: Documentnummer, library, gebruikersnaam en wachtwoord worden versleuteld meegestuurd als virtuele map. Hierdoor kan je de naam naar wens invullen. De request ziet er dan als volgt uit: http://<servernaam>/<edav virtual directory>/[versleutelde gegevens]/<document naam>.<extensie> versleutelde gegevens: [<docnumber>][<library>][<loginname>][<password>] Deze vijf modules zullen uitgebreider beschreven worden in het functioneel ontwerp. 5 / 16
3 Systeem vereisten Om de edav module te installeren, dient uw systeem aan de volgende eisen te voldoen: 3.1 Server Hardware Verbinding kunnen maken met een DM server; Beschikbaar via http en/of https voor de cliënt; Software DM API; Internet Information Services (IIS) 7; Microsoft.NET Framework 3.5; Microsoft Windows 2008 R2 Server. 3.2 Cliënt Hardware op de cliënt is niet van toepassing. Software Tablet Besturingssysteem o IOS; o Android. Een applicatie met WebDAV ondersteuning o ReaddleDocs (ipad) o WebDAV Navigator (Android) Bijhorende cliënt applicaties om de edocs documenten mee te openen o Polaris Office o Open Office o Documents To Go o Office Suite Software werkstation Besturingssysteem o Windows XP; o Vista (incl. http://support.microsoft.com/kb/841215); o Windows 7 (incl. http://support.microsoft.com/kb/841215). Browser o Internet Explorer 7, of hoger. Bijhorende cliënt applicaties voor de ondersteunde bestanden, bijvoorbeeld: o Microsoft Office (Word, Excel, PowerPoint); Windows verkenner 6 / 16
4 Technieken De edav module maakt gebruik van verschillende componenten. Deze componenten zorgen onder andere voor de integratie met edocs. Microsoft.NET Framework 3.5 o Framework van Microsoft voor het ontwikkelen van software op het Windows platform. DM API 5.2.1.0 o Technische interface om te kunnen integreren met Open Text edocs. Dit is onderdeel van DM Extensions. ITHit WebDav Server versie 2.1 o Een framework dat basis functionaliteit biedt voor het gebruik maken van WebDAV. o Dit component is onderdeel van de edav installatie en behoeft geen extra handelingen en licenties. o informatie over IT Hit webdav server vindt je hier: http://www.webdavsystem.com/server o Informatie over de licentie vindt je hier is meegeleverd als bijlage document. WebDav is een protocol dat staat voor Web-based Distributed Authoring and Versioning. Het is een uitbreiding op het HTTP protocol en is ontworpen om mogelijkheden te bieden voor het lezen en schrijven van documenten op het wereldwijde web. De edav koppeling maakt gebruik van de IT Hit WebDav server die de afhandeling van de WebDAV requests afhandelt. De edav houdt zich dan ook niet bezig met de afhandeling van alle verschillende WebDAV operaties, maar maakt gebruik van de interfaces die IT Hit WebDAV server blootstelt voor het opslaan, ophalen en vergrendelen van documenten. Onze koppeling maakt gebruik van dit protocol waardoor we de mogelijkheid hebben om edocs documenten over het web te openen, bewerken en uit en in te checken. 7 / 16
5 Architectuur 5.1 Overview Bovenstaande figuur beschrijft de architectuur van een inrichting van OpenText edocs waarbij edav geïnstalleerd is. In een procesapplicatie (webapplicatie, verkenner) op een werkstation of tablet wordt op een link geklikt waardoor een aanvraag voor een document over http naar de edav koppeling gestuurd wordt. Afhankelijk van de gekozen authenticatie module kan deze aanvraag er anders uit zien. De authenticatie module valideert de gebruiker die de aanvraag doet. Is deze aanvraag valide dan pakt de edav koppeling de aanvraag op en haalt met behulp van de DM API het document uit edocs en stuurt deze over http met behulp van webdav naar het werkstation of de tablet. Op dit moment wordt het document vergrendeld binnen edocs. Het document wordt op het werkstation of de tablet geopend vanaf de server in de applicatie voor dit documenttype (bijvoorbeeld MS Office of Adobe Reader). Op het moment dat de gebruiker in de applicatie opslaat wordt het document via webdav opgeslagen op de server. Tevens wordt bij het sluiten van de applicatie het document weer ontgrendeld binnen edocs. De DM API maakt het mogelijk om applicatie te laten communiceren met edocs. Dit is een set met functionaliteiten die ontwikkelaars de mogelijkheid biedt om hun applicaties te integreren met edocs. De edav module maakt dan ook gebruik van deze API om te communiceren met edocs. De verdere beschrijving van de architectuur gebeurt middels een aantal diagrammen. Eerst zal een "deployment diagram" getoond worden die een globaal overzicht geeft van de edav module. Vervolgens zal een "class diagram" de module in detail beschrijven. 8 / 16
5.2 Deployment diagram In onderstaande schema zijn fysieke servers weergegeven waar de verschillende componenten geïnstalleerd worden. De interfaces op deze componenten worden in de volgende paragraaf uitgewerkt. De edav module dient uitgerold te worden op een Windows 2008 R2 Server met Microsoft.Net Framework 3.5 De edav module ondersteunt integratie met client applicaties die WebDAV ondersteuning hebben. Zo heb je bijvoorbeeld: ipad o ReaddleDocs o GoodReader o Pages o IAnnotate Android Tablet o WebDAV navigator Polaris Office Open Office Office Suite Documents To Go Werkstation o Browser o Windows Verkenner o Microsoft Office 9 / 16
5.3 Class Diagram 5.3.1 edav module Bovenstaande "class diagram" is het klasse diagram van de One Fox edav module. De interfaces waar van afgeleid wordt zijn de interfaces die worden aangeboden door het IT HIT WebDAV server framework. Folder: Folder representeert een folder uit OpenText edocs. De edav koppeling ondersteunt nog geen folders. Er zijn meerdere soorten folders binnen edav, bijvoorbeeld RootFolder. Document: Document representeert een document uit OpenText edocs. De koppeling biedt ondersteuning voor onder andere Microsoft Word, Microsoft Excel en Microsoft Powerpoint. HierarchyItem: HierarchyItem is de basis class voor zowel folders als documenten. WebDavHander: WebDavHander is een HttpHandler die de request afhandelt. WebDavEngine: als de request een webdav request is, wordt deze opgepakt door de DMWebDavEngine, die vervolgens het juiste HierarchyItem aanmaakt. DocNumberNotFoundException: het opgegevend document nummer kon niet gevonden worden. InvalidApplicationIdException: Het aangevraagde document heeft een applicatie id, waarvan de extensie niet geconfigureerd is." PermissionDeniedException: De opgegeven credentials hebben niet genoeg rechten. 10 / 16
DMException: De DM API geeft een foutmelding terug voor de aanvraag. Deze foutmelding is voorzien van een code en beschrijving en wordt middels deze exception gelogd. Deze melding zal o.a. gegeven worden als de DM-server niet beschikbaar is of als de gebruiker niet valide is. 5.3.2 Authenticatie module Hierboven staat het voorbeeld van een authenticatie module "class diagram". De authenticatie module bestaat uit een HttpModule die de authenticatie voor een request afhandelt. De authenticatie module die gebruikt wordt is middels het configuratie bestand van de edav koppeling aangegeven. Hoe een authenticatie module geconfigureerd wordt kun je terug lezen in de installatie handleiding, en in het functioneel ontwerp. 11 / 16
6 Encryptie Het is mogelijk om voor de edav koppeling te kiezen voor het gebruik van de URLBased authenticatie module. Deze authenticatie module maakt gebruik van encryptie. Waarbij gebruikt gemaakt wordt van de volgende instellingen: Algorithm = Symmetric Password-based key generation = PBKDf2 standard Het wachtwoord dat door de edav authenticatie module verwacht wordt bevat een timestamp om te bepalen of de aanvraag na een ingestelde tijdslimiet niet meer geldig is. De waarde die versleuteld wordt, ziet er dan ook als volgt uit: syntax: <wachtwoord>+yyyy-mm-dd HH:mm:ss voorbeeld: welkom+2010-03-09 12:15:21 De "+" wat gebruikt wordt is een "carriage return teken" In de edav module wordt geconfigureerd welke sleutel gebruikt wordt voor de versleuteling van het wachtwoord en hoe lang het duurt voor een aanvraag niet meer geldig is (Timeout). In het FO staat beschreven hoe deze waardes in te stellen zijn. Bij het openen van het document zit de timestamp verwerkt in de bestandsnaam van het document. Er wordt geen sessie gebruikt in WebDav, acties in Word(zoals opslaan, en afsluiten) sturen een request naar de edav koppeling, deze requests bevatten nog steeds dezelfde bestandsnaam en ook dezelfde timestamp. Als zo'n actie na de ingestelde timeout wordt uitgevoerd, is de timestamp niet meer geldig, en zal edav de actie niet meer uitvoeren op edocs. Als Office niet tijdig wordt afgesloten zal het bestand gelocked blijven in DM. Als dezelfde gebruiker het bestand opnieuw opent dan kan dit omdat hij ook het bestand heeft gelocked. De gebruiker kan hem dan verder bewerken. 12 / 16
7 Configuratie Dit hoofdstuk beschrijft hoe de edav module geconfigureerd moet worden. Dit kan gedaan worden met behulp van het bestand "web.config". Dit bestand is een XML document en bevat een aantal onderdelen waarmee de edav module geconfigureerd wordt. Niet alle secties in het bestand mogen aangepast worden, hieronder worden dan ook alleen die onderdelen besproken die aanpassing vereisen voor de installatie van de edav module met behulp van Basic Authentication. <DMConfiguration DefaultLibraryName="<Library>" DefaultLibraryDbName="<DbName>" ProfileHierarchieItemFormat="{0} [{1}]{5}" ProfileHierarchieItemRequestSyntax="^(.*?)\ \[([^\]]*)\](\..*$ $)" RequestSyntaxRegexGroupOffset="1" UseFileShareAccess="false" SearchLimit="500" > <ProfileForm FormName="<ProfileForm>" /> <SearchForm FormName="<SearchForm>" /> <PublicFoldersFolder LocalizedName="Publieke mappen" /> <RecentItemsFolder LocalizedName="Recent bewerkte documenten" /> <SearchFolder LocalizedName="Snelzoekopdrachten" /> <SearchContentFolder LocalizedName="Zoeken op inhoud" /> <SearchProfileFolder LocalizedName="Zoeken op registratievelden" /> <SearchContentProfileFolder LocalizedName="Zoeken op registratievelden en inhoud" /> <Applications> <! Aan deze lijst kunnen items toegevoegd worden --> <Application Extension="<extenties>" ApplicationName="<APP>" /> <! Voorbeeld --> <Application Extension="doc;docx;rtf" ApplicationName="MS WORD" /> <Application Extension="xls;xlsx" ApplicationName="MS EXCEL" /> <Application Extension="ppt;pptx" ApplicationName="MS POWERPOINT" /> <Application Extension="pdf" ApplicationName="ACROBAT" /> <Application Extension="jpg" ApplicationName="JPG" /> <Application Extension="" ApplicationName="FOLDER" /> <Application Extension="txt" ApplicationName="NOTEPAD" /> </Applications> <NewProfileParameters> <Document> <! Aan deze lijst kunnen items toegevoegd worden --> <Field Name="<eDOCS Field>" Value="eDOCS Value" /> <! Voorbeeld --> <Field Name="DOCNAME" Value="$NAME" /> <Field Name="TYPIST_ID" Value="$IDENTITY" /> <Field Name="APP_ID" Value="$APP" /> <Field Name="TYPE_ID" Value="DOCUMENT" /> <Field Name="PD_TERM" Value="Proces 001" /> <Field Name="DIENST_ID" Value="Dienst 001" /> <Field Name="DATUMDOC" Value="28-02-2013" /> <Field Name="BEVEILIGINGSNIVEAU" Value="Openbaar" /> <Field Name="DOCUMENTSTATUS" Value="Concept" /> </Document> <Folder> 13 / 16
</Folder> </NewProfileParameters> </DMConfiguration> DMConfiguration: Deze sectie in de "web.config" bestaat uit een aantal algemene parameters voor de edav module. DMConfiguration.ProfileHierarchieItemFormat Met behulp van de reguliere expressie die vermeld staat in de ProfileHierarchieItemRequestSyntax wordt de Request opgedeeld in stukken. Deze parameter geeft aan in welke volgorde de stukken staan. BasicAuthenticationModule: {0} [{1}]{5} DMConfiguration.ProfileHierarchieItemRequestSyntax: Deze parameter beschrijft de syntax van de request die binnen komt voor het openen van bestanden. Dit is een reguliere expressie en wordt gebruikt om de EDMS bibliotheek, gebruikersnaam, wachtwoord en documentnummer uit de request te halen. Deze waarde is afhankelijk van de authenticatie module die gekozen wordt. Hieronder staan de waardes voor de verschillende modules. BasicAuthenticationModule: ^(.*?)\ \[([^\]]*)\](\..*$ $) DMConfiguration.DefaultLibraryName: De naam van de bibliotheek van edocs die gebruikt zal worden. DMConfiguration.DefaultLibraryDbName: De naam van de database waarvan edocs gebruik maakt. ProfileForm.FormName: Dit is de naam van het formulier dat gebruikt wordt door de edav module om documenten die opgevraagd worden te locken en te unlocken. Daarnaast wordt dit formulier gebruikt voor het ophalen en wegschrijven van het bestand. SearchForm.FormName: Dit is de naam van het formulier dat gebruikt wordt om aan de hand van de opgegeven bibliotheek en documentnummer het juiste document te vinden wat opgehaald moet worden. Item.LocalizedName Dit zijn de taalinstellingen voor de verschillende termen die gebruikt worden. De verschillende eigenschappen zijn: PublicFoldersFolder, RecentItemsFolder, SearchFolder, SearchContentFolder, SearchProfileFolder, SearchContentProfileFolder. Applications: De applications sectie beschrijft de verschillende applicaties die ondersteund worden door de koppeling. Application.Extension: De extension beschrijft de extensie voor de applicaties zoals deze geconfigureerd is in edcos voor deze applicatie. Application.ApplicationName: De applicationname beschrijft de naam van de applicatie zoals deze geconfigureerd is in edcos. 14 / 16
NewProfileParameters: Binnen deze node worden de verplichte velden aangegeven voor het aanmaken van nieuwe documenten en mappen. NewProfileParameters.Document: Hier binnen komen de verplichte velden voor documenten. NewProfileParameters.Folder: Hier binnen komen de verplichte velden voor folders. NewProfileParameters.Document.Field.Name: De naam van het verplichte veld. NewProfileParameters.Document.Field.Value: De waarde voor het verplichte veld. Hier zijn 3 dynamische waarde mogelijk: $NAME = Bestandsnaam $IDENTITY = Ingelogde gebruiker $APP = Applicatie Met behulp van de volgende sectie in het configuratie bestand kan de gebruikte authenticatie module ingesteld worden. Er kan maar één module tegelijk gebruikt worden. <httpmodules> <remove name="fileauthorization" /> <add name="authenticationmodule" type="onefox.edav.modules.basicauthentication.basicauthenticationmodule" /> </httpmodules> httpmodules.add.type: Deze waarde geeft aan wat de class is die gebruikt moet worden en in welke.dll bestand deze staat. de syntax hiervoor is "class, library". Er zijn vijf mogelijke modules voor het afhandelen van de authenticatie. Deze zullen uitgebreider beschreven worden in het functioneel ontwerp. In de configuratie is nu gekozen voor de volgende module: OneFox.eDav.Modules.BasicAuthentication.BasicAuthenticationModule Deze module is gebaseerd basic authentication en vraagt met behulp van een formulier aan de gebruiker om zijn gebruikersnaam en wachtwoord in te vullen. Een request ziet er dan als volgt uit: http://<servername>/onefox.edav/[<library>] [<document nummer>].<extensie> 15 / 16
8 Lijst bestanden Het uitrolpakket van de edav module bevat de volgende bestanden: Binaire componenten: /bin/hummingbird.dm.server.interop.pcdclient.dll /bin/ithit.webdav.server.dll /bin/license.lic /bin/log4net.dll /bin/log4net.xml /bin/onefox.dm.dll /bin/onefox.dm.pdb /bin/onefox.edav.dll /bin/onefox.edav.modules.customauthentication.dll /bin/onefox.edav.modules.customauthentication.encrypted.dll /bin/onefox.edav.modules.customauthentication.encrypted.pdb /bin/onefox.edav.modules.customauthentication.pdb /bin/onefox.edav.pdb /bin/onefox.edav.util.dll /bin/onefox.edav.util.pdb Het global.asax bestand: /global.asax De configuratie template bestanden: /BasicAuthentication.Web.config.tmpl /UrlBaseAuthentication.Web.config.tmpl /UrlBaseAuthenticationV2.Web.config.tmpl /WindowsAuthentication.Web.config.tmpl 16 / 16