ONTWIKKELAARS- HANDLEIDING MODULE DOCUMENTENSERVICES 3

Transcriptie

1 ONTWIKKELAARS- HANDLEIDING MODULE DOCUMENTENSERVICES 3

2 Versie: 3 Datum: 21 januari

3 Inhoudsopgave 1 Inleiding5 2 DossierManager Endpoints, Service Interfaces, Bindings en proxy Binding instellingen voor IContainer en IDossierService Functie CreateContainer Voorbeeldcode Functie GetContainer Voorbeeldcode Functie RemoveContainer Voorbeeldcode Functie MoveContainer Functie ChangeMetadata Voorbeeldcode Functie GetContainerMetadata Voorbeeldcode Functie GetContainerContent VoorbeeldCode Functie GetContentMetadata Voorbeeldcode SearchContainer Voorbeeldcode Functie SluitDossier Voorbeeldcode 33 3 Documentmanager Endpoints, Service Interfaces, Bindings en proxy Functie AddContent Voorbeeldcode Functie DeleteContent Voorbeeldcode Functie MoveContent Functie UpdateContent Voorbeeldcode Aanroep Updatecontent CheckIn en Checkout 44 2

4 3.5.3 Bijwerken metadata huidige versie Bijwerken metadata nieuwe versie Undo Checkout Functie GetContent Voorbeeldcode Functie GetMetadata Voorbeeldcode Functie Load Voorbeeldcode Functie SaveContentCallBack Voorbeeldcode 55 4 DossierInfo.xml 57 5 Generieke objecten DCMIReference ResultReference ResultResponse Result ListResponse 60 6 Lijst met vaste Metadata 61 7 Aanmaken en opruimen van een WCF proxy Gebruik Use functie Voorbeeld proxy factory Voorbeeld Use Functie Versleutelde Verbindingen Niet streaming Secure Binding Streaming Secure Binding 68 8 Scenario Vertrouwelijkaanduiding Ophalen vertrouwelijkaanduiding van een Zaaktype Ophalen vertrouwelijkaanduiding van een DocumentType Het aanmaken van een dossier met een vertrouwelijkaanduiding Het ophalen van de vertrouwelijkaanduiding van een dossier 74 3

5 8.5 Het toevoegen van een document met vertrouwelijkaanduiding 75 Copyright 2015, Centric Netherlands B.V. Niets uit deze uitgave mag worden verveelvoudigd, opgeslagen in een geautomatiseerd gegevensbestand of openbaar gemaakt, in enige vorm of op enige wijze, hetzij elektronisch, mechanisch, door fotokopieën, opnamen of enige andere manier, zonder schriftelijke toestemming van Centric Netherlands B.V. 4

6 1 Inleiding Voor u ligt de handleiding van module Documentenservices 3. Module Documentenservices is binnen de Suite4Documentmanagement verantwoordelijk voor de communicatie tussen de verschillende onderdelen van de Suite4Documentmanagement en eventuele procesapplicaties enerzijds, en het DMS anderzijds. Dit betreft het aanmaken, verplaatsen en verwijderen van dossiers en documenten, eventueel versie-gerelateerde functies zoals inchecken en uitchecken van documenten en het updaten van metadata. De services van module Documentenservices zijn gebaseerd op Windows Communication Foundation en.net Framework 3.5. Er bestaan twee services binnen module Documentenservices namelijk de DossierManager en de DocumentManager. De DossierManager verzorgt de dossiergerelateerde functies, de DocumentManager alle document-gerelateerde functies. In hoofdstuk 2 en 3 worden de functies van resp. de DossierManager en de DocumentManager beschreven. In hoofdstuk 5 worden gedeelde objecten beschreven. 5

7 2 DossierManager De DossierManager is de ingang voor alle dossier-gerelateerde functies zoals het aanmaken en verwijderen van dossiers en, indien het DMS hierin voorziet, het aanmaken en wijzigen van dossiermetadata. Binnen de DossierManager bevinden zich weer twee services, de Container service voor alle algemene dossier-gerelateerde functies, en de Dossier service, specifiek voor het sluiten van een dossier. Met de DossierManager is het ook mogelijk om te zoeken naar Dossiers. 2.1 Endpoints, Service Interfaces, Bindings en proxy De Dossiermanager ondersteunt twee webservice interfaces. IContainer IDossierService Omschrijving Generieke CRUD en zoekfunctionaliteit Specifieke functionaliteit. Op dit moment alleen SluitDossier. Binding WSHttpBinding WSHttpBinding Endpoint Proxy genereerbaar DossierManager.svc Ja Tabel 1 Overzicht DossierManager services DossierManager.svc Ja In de Datacontracts dll zit een Bindings class waarmee de bindings met de juiste settings aangemaakt kunnen worden. Deze wordt ook in de voorbeeldcode gebruikt Binding instellingen voor IContainer en IDossierService De binding voor de IDossierService kan in code als volgt worden ingesteld:... private static WSHttpBinding WSHttpDefaultBinding() var binding = new WSHttpBinding(); binding.opentimeout = new TimeSpan(0, 1, 0); binding.closetimeout = new TimeSpan(0, 1, 0); binding.receivetimeout = new TimeSpan(0, 10, 0); binding.sendtimeout = new TimeSpan(0, 1, 0); binding.bypassproxyonlocal = false; 6

8 ... binding.usedefaultwebproxy = true; binding.maxbufferpoolsize = ; binding.maxreceivedmessagesize = 65536; binding.transactionflow = false; binding.allowcookies = false; binding.hostnamecomparisonmode = HostNameComparisonMode.StrongWildcard; binding.messageencoding = WSMessageEncoding.Text; binding.textencoding = Encoding.UTF8; SetDefaultReaderQuotas(binding.ReaderQuotas); binding.reliablesession.ordered = true; binding.reliablesession.inactivitytimeout = new TimeSpan(0, 10, 0); binding.reliablesession.enabled = false; binding.security.mode = SecurityMode.None; binding.security.transport.clientcredentialtype = HttpClientCredentialType.Windows; binding.security.transport.proxycredentialtype = HttpProxyCredentialType.None; binding.security.message.clientcredentialtype = MessageCredentialType.Windows; binding.security.message.negotiateservicecredential = true; binding.security.message.algorithmsuite = SecurityAlgorithmSuite.Default; return binding; Functie CreateContainer Met de functie CreateContainer kan een container in het DMS aangemaakt worden. Een container staat voor een verzameling documenten zoals bijvoorbeeld een zaak. Een container kan afhankelijk van het onderliggende DMS meer of minder eigen metadata hebben. Deze functie kan bijvoorbeeld worden aangeroepen om een zaak aan te maken in Key2Documenten. Accepteert: Retourneert: Foutsituatie: NewContainerRequest met daarin verplicht de zaaktypecode voor het bepalen van de opslagomgeving en locatie binnen de opslagomgeving. Optioneel Metadata. ResultReference met daarin een DCMIReference welke het dossier beschrijft. Resultcode bevat de waarde OK. Indien het dossier niet aangemaakt kan worden zal Reference leeg zijn en ResultCode de waarde Critical hebben. ResultValue geeft een tekstuele omschrijving van het probleem. In tabel 2 beschrijven we de noodzakelijke vulling van het NewContainerRequest om met CreateContainer een dossier aan te maken. In de geretourneerde DCMIReference worden alleen Dossier en zaak gerelateerde velden gevuld, o.a. DossierID, zaaktype en locatie in het DMS,In geval van een zaak het ZaakID zullen gevuld zijn. 7

9 Parameter Type Beschrijving verplicht MetaData NameValueCollection NameValueCollection met in geval van een zaak een NameValue met: Name: ZaakID Value: waarde van het zaakid uit het zakenmagazijn. Dit zaakid mag maar voor 1 dossier gebruikt worden. M.a.w. er zal een 1:1 relatie zijn tusser DossierID en zaakid. Type: String Category ZaakInformatie. Overige metadata kan meegegeven worden mits : De category ZaakInformatie of DossierInformatie is. De category overeenkomt met de zaaktypecode. Dit is de zogenaamde variabele metadata bij een zaaktype. 1 TypeCode String Zaaktype code(ook voor niet zaken) is de code voor het zaaktype zoals is ingericht in de module Document- en Procesinformatie. Hiermee kan de module Documentenservices de juiste opslagomgeving(het te gebruiken DMS) bepalen en de locatie binnen de opslagomgeving. Identity Credentials Credentials met voldoende rechten om de dossiergegevens op te halen, bijvoorbeeld een serviceaccount. Dit wordt meestal gezet met een LogOnData object wat een subclass van Credentials is. Tabel 2 Request NewContainerRequest Voorbeeldcode Onderstaande voorbeeld maakt een dossier aan voor een zaak van het gegeven type en het gegeven zaakid. private static ResultReference CreateContainer(ContainerClient svc, string zaakid, string zaaktypecode) ResultReference retval;... var zaakidnv = new NameValue() Name = "ZaakID", Value = zaakid, 1 Bij zaken is ZaakID verplicht. Mogelijk zijn andere velden verplicht gesteld in de inrichting via de module Document- en Procesinformatie. 8

10 ... TypeName = "String", Category = "ZaakInformatie" ; var metadata = new NameValueCollection(); metadata.add(zaakidnv); var cred = new LogOnData() UserName = "user", Domain = "domain", Password = "*****", LogOnType = LogOnType.Windows ; var createcontainerrequest = new NewContainerRequest() Metadata = metadata, TypeCode = zaaktypecode, //b.v. B0056 voor een evenementenvergunning. Identity = cred ; retval = svc.createcontainer(createcontainerrequest); Console.WriteLine("Code:[0]", retval.resultcode); Console.WriteLine("Value:[0]", retval.resultvalue); Console.WriteLine(); DcmiReference reference = retval.reference; Console.WriteLine("ApplicationCode:[0]", reference.applicationcode); Console.WriteLine("ApplicationReference:[0]", reference.applicationreference); Console.WriteLine("ContentIdentifier:[0]", reference.contentidentifier); Console.WriteLine("DcIdentifier:[0]", reference.dcidentifier); Console.WriteLine("DcmiType:[0]", reference.dcmitype); Console.WriteLine("DossierId:[0]", reference.dossierid); Console.WriteLine("FolderIdentifier:[0]", reference.folderidentifier); Console.WriteLine("RecordId:[0]", reference.recordid); Console.WriteLine("Repository:[0]", reference.repository); Console.WriteLine("ZaakId:[0]", reference.zaakid); Console.WriteLine("ZaaktypeCode:[0]", reference.zaaktypecode); Console.WriteLine(); return retval; 9

11 Figuur 1 Resultaat van aanmaken Dossier 10

12 2.2 Functie GetContainer Met de functie GetContainer kan gegeven beperkte metadata een basisset aan metadata worden opgehaald van een dossier. Deze functie kan bijvoorbeeld worden aangeroepen om de locatie van een dossier te achterhalen op Accepteert: Retourneert: Foutsituatie: ContainerCommandRequest met daarin een DCMIReference welke voldoende uniek is om het het dossier te kunnen vinden. ResultReference met daarin een DCMIReference welke het dossier beschrijft. Resultcode bevat de waarde OK. Indien het dossier niet gevonden wordt zal Reference leeg zijn en ResultCode de waarde Critical hebben. ResultValue geeft een tekstuele omschrijving van het probleem. In tabel 3 beschrijven we de noodzakelijke vulling van het ContainerCommandRequest om met GetContainer metadata van een dossier op te halen. Parameter Type Beschrijving verplicht Command CommandOption Altijd Commandoption.Find Reference DCMIReference 2 Dossier referentie Er kan gezocht worden op: DcIdentifier (meest uniek) DossierId ZaakId Het meegeven van de zaaktypecode kan het zoeken versnellen omdat hiermee meteen de juiste opslagomgeving bepaald kan worden. Identity Credentials Credentials met voldoende rechten om de dossiergegevens op te halen, bijvoorbeeld een serviceaccount. Dit wordt meestal gezet met een LogOnData object wat een subclass van Credentials is. Tabel 3 Request ContainerCommandRequest 2 Zie omschrijving DCMI Reference 11

13 2.2.1 Voorbeeldcode Onderstaande voorbeeld haalt een dossier op met behulp van het zaakid. private static ResultReference GetContainer(ContainerClient svc, string zaakid) ResultReference retval; var dossierreference = new DcmiReference() ZaakId = zaakid ; var cred = new LogOnData() UserName = "user", Domain = "domain", Password = "*****", LogOnType = LogOnType.Windows ; var getcontainerrequest = new ContainerCommandRequest() Command = CommandOption.Find, Reference = dossierreference, Identity = cred ; retval = svc.getcontainer(getcontainerrequest); Console.WriteLine("Code:[0]", retval.resultcode); Console.WriteLine("Value:[0]", retval.resultvalue); Console.WriteLine(); DcmiReference reference = retval.reference; Console.WriteLine("ApplicationCode:[0]", reference.applicationcode); Console.WriteLine("ApplicationReference:[0]", reference.applicationreference); Console.WriteLine("ContentIdentifier:[0]", reference.contentidentifier); Console.WriteLine("DcIdentifier:[0]", reference.dcidentifier); Console.WriteLine("DcmiType:[0]", reference.dcmitype); Console.WriteLine("DossierId:[0]", reference.dossierid); Console.WriteLine("FolderIdentifier:[0]", reference.folderidentifier); Console.WriteLine("RecordId:[0]", reference.recordid); Console.WriteLine("Repository:[0]", reference.repository); Console.WriteLine("ZaakId:[0]", reference.zaakid); Console.WriteLine("ZaaktypeCode:[0]", reference.zaaktypecode); Console.WriteLine(); return retval; 12

14 Figuur 2 Resultaat ophalen bestaand dossier 13

15 2.3 Functie RemoveContainer Met de functie RemoveContainer kan een bestaande container in het DMS verwijderd worden. Deze functie kan bijvoorbeeld worden aangeroepen om een zaak aan te maken in Key2Documenten. Accepteert: Retourneert: Foutsituatie: ContainerCommandRequest welke uniek identificerend is voor het te verwijderen dossier 3. ResultResponse. ResultCode bevat de waarde OK. Indien het dossier niet verwijderd kan worden zal ResultCode de waarde Critical bevatten. In tabel 4 beschrijven we de noodzakelijke vulling van het ContainerCommandRequest om met RemoveContainer een dossier te verwijderen. Parameter Type Beschrijving verplicht Command CommandOption Altijd Commandoption.Destroy Reference DCMIReference 4 Dossier referentie Er kan gezocht worden op: DcIdentifier (meest uniek) DossierId ZaakId Het meegeven van de zaaktypecode kan het zoeken versnellen omdat hiermee meteen de juiste opslagomgeving bepaald kan worden. Identity Credentials Credentials met voldoende rechten om de dossiergegevens op te halen, bijvoorbeeld een serviceaccount. Dit wordt meestal gezet met een LogOnData object wat een subclass van Credentials is. Tabel 4 Request ContainerCommandRequest 3 Bijvoorbeeld verkregen door eerst een GetContainer te doen. 4 Zie omschrijving DCMI Reference 14

16 2.3.1 Voorbeeldcode private static ResultResponse RemoveContainer(ContainerClient svc, DcmiReference dossierreference) ResultResponse retval; var cred = new LogOnData() UserName = "user", Domain = "domain", Password = "*****", LogOnType = LogOnType.Windows ; var removecontainerrequest = new ContainerCommandRequest() Command = CommandOption.Destroy, Reference = dossierreference, Identity = cred ; retval = svc.removecontainer(removecontainerrequest); Console.WriteLine("code:[0],value:[1]", retval.resultcode, retval.resultvalue); Console.WriteLine("Description:[0]", retval.description); Console.WriteLine("Details:[0]", retval.details, retval); return retval; Figuur 3 Het verwijderen van een eerder aangemaakt dossier 15

17 2.4 Functie MoveContainer Deze functie wordt gebruikt voor de module Documentendistributie en is niet bedoeld voor publiek gebruik. Deze functie wordt voorlopig niet verder beschreven. 16

18 2.5 Functie ChangeMetadata Met de functie ChangeMetadata kan metadata worden gewijzigd of worden toegevoegd. Het is niet mogelijk om metadatavelden te verwijderen. Deze functie kan bijvoorbeeld gebruikt worden om een omschrijving van een zaak te wijzigen. Accepteert: Retourneert: Foutsituatie: ChangeMetadataRequest met daarin een DCMIReference welke voldoende uniek is om het het dossier te kunnen vinden plus de te wijzigen of toe te voegen metadata. ResultReference met daarin een DCMIReference welke het dossier beschrijft. Resultcode bevat de waarde OK. Indien het dossier niet gevonden wordt of indien de wijziging faalt,zal Reference leeg zijn en ResultCode de waarde Critical hebben. ResultValue geeft een tekstuele omschrijving van het probleem. In tabel 5 beschrijven we de noodzakelijke vulling van het ChangeMetadataRequest om met GetContainer metadata van een dossier op te halen. Parameter Type Beschrijving verplicht Command CommandOption CommandOption.Update Reference DCMIReference 5 Dossier referentie Er kan gezocht worden op: DcIdentifier (meest uniek) DossierId ZaakId Het meegeven van de zaaktypecode kan het zoeken versnellen omdat hiermee meteen de juiste opslagomgeving bepaald kan worden. Identity NameValueCollection Te wijzigen of toe te voegen metadata Tabel 5 Request ChangeMetadataRequest Voorbeeldcode private static ResultReference ChangeMetadata(ContainerClient svc, DcmiReference dossierreference) ResultReference retval;... var cred = new LogOnData() UserName = "user", Domain = "domein", Password = "*****", LogOnType = LogOnType.Windows ; 5 Zie omschrijving DCMI Reference 17

19 ... var metadata = new NameValueCollection(); var examplenamevalue = new NameValue() Name = "Example", Value = "Hello World!", TypeName = "String", Category = "DossierInformatie" ; metadata.add(examplenamevalue); var changemetadatarequest = new MetadataRequest() Metadata = CommandOption.Update Metadata = metadata, Reference = dossierreference, Identity = cred ; retval = svc.changemetadata(changemetadatarequest); Console.WriteLine("Code:[0]", retval.resultcode); Console.WriteLine("Value:[0]", retval.resultvalue); Console.WriteLine(); DcmiReference reference = retval.reference; Console.WriteLine("ApplicationCode:[0]", reference.applicationcode); Console.WriteLine("ApplicationReference:[0]", reference.applicationreference); Console.WriteLine("ContentIdentifier:[0]", reference.contentidentifier); Console.WriteLine("DcIdentifier:[0]", reference.dcidentifier); Console.WriteLine("DcmiType:[0]", reference.dcmitype); Console.WriteLine("DossierId:[0]", reference.dossierid); Console.WriteLine("FolderIdentifier:[0]", reference.folderidentifier); Console.WriteLine("RecordId:[0]", reference.recordid); Console.WriteLine("Repository:[0]", reference.repository); Console.WriteLine("ZaakId:[0]", reference.zaakid); Console.WriteLine("ZaaktypeCode:[0]", reference.zaaktypecode); Console.WriteLine(); return retval; 18

20 Figuur 4 Resultaat ChangeMetadata 19

21 2.6 Functie GetContainerMetadata Met de functie GetContainerMetadata kan gegeven beperkte metadata, de metadata van een dossier opgehaald worden welke niet met GetContainer opgehaald kan worden. Deze functie kan bijvoorbeeld worden aangeroepen om de locatie van een dossier te achterhalen op. Accepteert: Retourneert: Foutsituatie: ContainerCommandRequest met daarin een DCMIReference welke voldoende uniek is om het het dossier te kunnen vinden. ListResponse met daarin een NameValueCollection welke de overige metadata van een dossier bevat. De lijst kan leeg zijn. Resultcode bevat de waarde OK. Indien het dossier niet gevonden wordt zal NameValueCollection nothing zijn en ResultCode de waarde Critical hebben. ResultValue geeft een tekstuele omschrijving van het probleem. In Detail kan eventueel meer informatie gevonden worden. In tabel 6 beschrijven we de noodzakelijke vulling van het GetContainerMetadata om met GetContainerMetadata metadata van een dossier op te halen. Parameter Type Beschrijving verplicht Command CommandOption Altijd Commandoption.Find Reference DCMIReference 6 Dossier referentie Er kan gezocht worden op: DcIdentifier (meest uniek) DossierId ZaakId Het meegeven van de zaaktypecode kan het zoeken versnellen omdat hiermee meteen de juiste opslagomgeving bepaald kan worden. Identity Credentials Credentials met voldoende rechten om de dossiergegevens op te halen, bijvoorbeeld een serviceaccount. Dit wordt meestal gezet met een LogOnData object wat een subclass van Credentials is. Tabel 6 Request ContainerCommandRequest In tabel 7 beschrijven we het resultaat van de aanroep. Tenslotte volgt er nog een voorbeeld. 6 Zie omschrijving DCMI Reference 20

22 Parameter Type Beschrijving ResultCode ResultCode Ok of Information als het request geslaagd is, Critical of Warning bij een fout. List NameValueCollection 7 Overige metadata van een dossier. ResultValue String Tekstuele beschrijving van het succes of failure van de aanroep. Tabel 7 Response ListResponse Voorbeeldcode... private static ListResponse GetDossierMetaData(ContainerClient svc, string zaakid) ListResponse retval; var dossierreference = new DcmiReference() ZaakId = zaakid ; var cred = new LogOnData() UserName = "user", Domain = "domain", Password = "*****", LogOnType = LogOnType.Windows ; var getcontainermetadatarequest = new ContainerCommandRequest() Command = CommandOption.Find, Reference = dossierreference, Identity = cred ; retval = svc.getcontainermetadata(getcontainermetadatarequest); Console.WriteLine("Code:[0],value:[1], details:,[2]", retval.resultcode, retval.resultvalue, retval.details); if (retval.list!= null) Console.WriteLine("aantal extra metadatavelden: 0", retval.list.count); foreach (NameValue nv in retval.list) 7 Een NameValueCollection bevat Naam/Waarde paren met als extra attribuut een Type en Category. 21

23 ... Console.WriteLine("name:[0],value:[1],typecode:[2]:category:[3]", nv.name, nv.value, nv.typename, nv.category); return retval; 22

24 2.7 Functie GetContainerContent Met de functie GetContainerContent kan een lijstje met de documenten in de container opgehaald kan worden. Deze kan gegevens kunnen b.v. gebruikt worden om de gegevens of inhoud van een document op te halen. Accepteert: Retourneert: ContainerCommandRequest met daarin een DCMIReference welke voldoende uniek is om het het dossier te kunnen vinden. ListResponse met daarin een NameValueCollection welke een lijstje van bestanden bevat. De lijst kan leeg zijn maar zal typisch een verwijzing naar Dossierinfo.xml, zie hoofdstuk 4, bevatten. Foutsituatie: Resultcode bevat de waarde OK. Indien het dossier niet gevonden wordt zal NameValueCollection null zijn en ResultCode de waarde Critical hebben. ResultValue geeft een tekstuele omschrijving van het probleem. In Detail kan eventueel meer informatie gevonden worden. In tabel 8 beschrijven we de noodzakelijke vulling van het ContainerCommandRequest om met GetContainerContent een overzicht van alle documenten in een dossier op te halen. Parameter Type Beschrijving verplicht Command CommandOption Altijd Commandoption.Find Reference DCMIReference 8 Dossier referentie Er kan gezocht worden op: DcIdentifier (meest uniek) DossierId ZaakId Het meegeven van de zaaktypecode kan het zoeken versnellen omdat hiermee meteen de juiste opslagomgeving bepaald kan worden. Identity Credentials Credentials met voldoende rechten om de dossiergegevens op te halen, bijvoorbeeld een serviceaccount. Dit wordt meestal gezet met een LogOnData object wat een subclass van Credentials is. Tabel 8 Request ContainerCommandRequest 8 Zie omschrijving DCMI Reference 23

25 2.7.1 VoorbeeldCode private static ListResponse GetContainerContent(ContainerClient svc, DcmiReference dossierreference) ListResponse retval; var cred = new LogOnData() UserName = "user", Domain = "domein", Password = "*****", LogOnType = LogOnType.Windows ; var getcontainercontentrequest = new ContainerCommandRequest() Command = CommandOption.Find, Reference = dossierreference, Identity = cred ; retval = svc.getcontainercontent(getcontainercontentrequest); Console.WriteLine("Code:[0],value:[1], details:,[2]", retval.resultcode, retval.resultvalue, retval.details); if (retval.list!= null) Console.WriteLine("aantal documenten: 0", retval.list.count); foreach (NameValue nv in retval.list) Console.WriteLine("name:[0],value:[1],typecode:[2]:category:[3]", nv.name, nv.value, nv.typename, nv.category); return retval; 24

26 Figuur 5 Inhoud van een Dossier. Er is altijd een Dossierinfo.xml met de extra metadata van het dossier 25

27 2.8 Functie GetContentMetadata Sinds versie 3 is het mogelijk om een grotere hoeveelheid metadata van alle documenten van een dossier op te halen. Hiervoor is de functie GetContentMetadata toegevoegd. Accepteert: Retourneert: Foutsituatie: ContainerCommandRequest met daarin een DCMIReference welke voldoende uniek is om het het dossier te kunnen vinden. ListDcmiResponse daarin een lijst van DCMIReference objecten welke de metadata van de documenten in het gevonden dossier bevatten.. De lijst kan leeg zijn maar zal typisch een verwijzing naar Dossierinfo.xml, zie hoofdstuk 4, bevatten. Resultcode bevat de waarde OK. Indien het dossier niet gevonden wordt zal de lijst van DcmiReference objecten null zijn en ResultCode de waarde Critical hebben. ResultValue geeft een tekstuele omschrijving van het probleem. In Detail kan eventueel meer informatie gevonden worden. In tabel 9 beschrijven we de noodzakelijke vulling van het ContainerCommandRequest om met GetContentDCMIReferences de DCMIReferences van alle documenten op te halen Parameter Type Beschrijving verplicht Command CommandOption Altijd Commandoption.Find Reference DCMIReference 9 Dossier referentie Er kan gezocht worden op: DcIdentifier (meest uniek) DossierId ZaakId Het meegeven van de zaaktypecode kan het zoeken versnellen omdat hiermee meteen de juiste opslagomgeving bepaald kan worden. Identity Credentials Credentials met voldoende rechten om de metadata op te halen, bijvoorbeeld een serviceaccount. Dit wordt meestal gezet met een LogOnData object wat een subclass van Credentials is. Tabel 9 Request ContainerCommandRequest 9 Zie omschrijving DCMI Reference 26

28 2.8.1 Voorbeeldcode private static ListDcmiResponse GetContainerContentMetadata(ContainerClient svc, DcmiReference dossierreference) ListDcmiResponse retval=null; var cred = new LogOnData() UserName = "user", Domain = "domein", Password = "*****", LogOnType = LogOnType.Windows ; var getcontainercontentmetadatarequest = new ContainerCommandRequest() Command = CommandOption.Find, Reference = dossierreference, Identity = cred ; retval = svc.getcontainercontentmetadata(getcontainercontentmetadatarequest); Console.WriteLine("Code:[0],value:[1], details:,[2]", retval.resultcode, retval.resultvalue, retval.details); if (retval.list!= null) Console.WriteLine("aantal documenten: 0", retval.list.count); foreach (DcmiReference doc in retval.list) Console.WriteLine("DocumentId:[0],FileName:[1]", doc.documentid, doc.filename); return retval; 27

29 2.9 SearchContainer Met de functie SearchContainer kan naar dossiers gezocht worden. Accepteert: Retourneert: Foutsituatie: SearchRequest met daarin een lijst met zoektermen. SearchResult met daarin een lijst van gevonden dossiers. Resultcode bevat de waarde OK. De lijst met documenten en dossiers is null. ResultCode zal de waarde Critical hebben. ResultValue geeft een tekstuele omschrijving van het probleem. In Detail kan eventueel meer informatie gevonden worden. In tabel 10 beschrijven we de mogelijke zoekopdrachten. Parameter Type Beschrijving verplicht SearchField String Metadataveld waarop gezocht kan worden. Bijvoorbeeld DossierNummer of Zaakid. In geval van Key2Documenten kan er alleen gezocht worden op vaste en variabele indexen van een dossier. Op Metadata welke in de DossierInfo.xml terecht komt kan niet gezocht worden. SearchOperator SearchOperator Mogelijke zoekoperaties: EqualTo Gelijk aan NotEqualTo Niet gelijk aan LargerThan Groter dan LargerThanOrEqualTo Groter dan of gelijk aan SmallerThan Kleiner dan SmallerThanOrEqualTo Kleiner dan of gelijk aan Contains Bevat DoesNotContain Bevat niet Tabel 10 SearchObject In tabel 11 beschrijven we de vulling van het SearchRequest om met SearchContainers te zoeken. 28

30 Parameter Type Beschrijving verplicht RepositoryName String Naam van de repository waar binnen gezocht moet worden. Dit is ingericht door middel van de module Document- en Procesinformatie. De waarde is bijvoorbeeld: Key2Documenten SearchCommand Array van SearchObject Bevat een aantal zoektermen. Dit wordt geinterpreteerd als een EN query. M.a.w. Aan alle zoektermen moet voldaan worden voordat een element in de resultaatset komt. Page PageOptions Paginering. Op welk record starten we en hoeveel elementen zitten er in het record dat teruggegeven wordt. Sort Sorting Op welk criterium wordt gesorteerd en wat is de sorteerrichting, Ascending, of Descending. Identity Credentials Credentials met voldoende rechten om de te zoeken, bijvoorbeeld een serviceaccount. Dit wordt meestal gezet met een LogOnData object wat een subclass van Credentials is. - Tabel 11 Request SearchRequest In tabel 12 beschrijven we het resultaat van de aanroep. Tenslotte volgt er nog een voorbeeld. Parameter Type Beschrijving ResultCode ResultCode Ok of Information als het request geslaagd is, Critical of Warning bij een fout. DocumentList Array van DocumentInformation Lijst met gevonden documenten in geval van DossierManager is deze lijst altijd null. DossierList Array van DossierInformation Lijst met gevonden dossiers. Description String Omschrijving van het resultaat ResultValue String Tekstuele beschrijving van het succes of failure van de aanroep. Details String Detail omschrijving van het succes of failure van de aanroep. Tabel 12 Response SearchResponse 10 Indien geen repository is opgegegeven, wordt in alle repositories gezocht. 29

31 2.9.1 Voorbeeldcode private static SearchResult SearchContainers(ContainerClient svc) SearchResult retval; var cred = new LogOnData() UserName = "user", Domain = "domain", Password = "*****", LogOnType = LogOnType.Windows ; var pageoptions = new PageOptions() RecordsPerPage = 10, StartAtRecord = 0 ; var sort = new Sorting() SortBy = "ZaakID", SortDirection = SortDirection.Asc ; var searchstatements = new List<SearchObject>(); var searchstatement = new SearchObject SearchField = "ZaakId", SearchOperator = SearchOperator.Contains, SearchText = "1" ; searchstatements.add(searchstatement); var searchcontainersrequest = new SearchRequest() RepositoryName = "Key2Documenten", SearchCommand = searchstatements.toarray(), Page = pageoptions, Sort = sort, Identity = cred ; retval = svc.searchcontainers(searchcontainersrequest); Console.WriteLine("Description:[0]", retval.description); Console.WriteLine("Code:[0],value:[1], details:,[2]", retval.resultcode, retval.resultvalue, retval.details);... if (retval.dossierlist == null) Console.WriteLine("Geen Dossiers gevonden"); 30