Digikoppeling Gateway 2.0 Gebruikershandleiding Versie 1.3
Datum
6 januari 2010
| Digikoppeling Gateway 2.0 Gebruikershandleiding | 6 januari 2010
Colofon
Projectnaam Versienummer Organisatie
Digikoppeling Definitief Servicecentrum Logius Postbus 96810 | 2509 JE Den Haag T 0900 555 4555
[email protected]
Bijlage(n)
0
Pagina 2 van 39
| Digikoppeling Gateway 2.0 Gebruikershandleiding | 6 januari 2010
Inhoud
Colofon ...................................................................................................................2 Inleiding................................................................................................................5 1.1
Uitgangspunten ......................................................................................5
1.2
Aanlevering software............................................................................5
1.3 Systeemeisen ..........................................................................................5 1.3.1 Linux....................................................................................................5 1.3.2 Windows.............................................................................................5 2
Installatie......................................................................................................6 2.1 Prerequisites ............................................................................................6 2.1.1 Linux....................................................................................................6 2.1.2 Windows.............................................................................................7 2.2 Installatie Digikoppeling gateway ...................................................9 2.2.1 Linux....................................................................................................9 2.2.2 Windows.............................................................................................9 2.3 Starten Digikoppeling Gateway........................................................9 2.3.1 Linux....................................................................................................9 2.3.2 Windows.............................................................................................9 2.4 Stoppen Digikoppeling Gateway ......................................................9 2.4.1 Linux....................................................................................................9 2.4.2 Windows.............................................................................................9 2.5 Testen Digikoppeling Gateway Installatie ..................................10 2.5.1 Testen van het Gateway Dashboard .....................................10 2.5.2 Testen van het Digikoppeling berichtenverkeer ...............10 2.5.3 Linux..................................................................................................10 2.5.4 Windows...........................................................................................11
3
Configuratie ...............................................................................................12 3.1 Configuratie endpoints.......................................................................12 3.1.1 Gateway Configurator.................................................................12
4
3.2
Configuratie notificatie mail.............................................................14
3.3
Configuratie JMS Broker en-/of JNDI Register .........................15
3.4
Configuratie database locatie..........................................................16
3.5
Configuratie voor grote berichten .................................................16
3.6
Aanpassen Corvus gebruiker en wachtwoord ...........................16
3.7
Aanpassen Tomcat HTTP header ...................................................17
3.8
Verwijderen van de Tomcat ROOT-applicatie ...........................17
3.9
Configuratie Archive folder ..............................................................17
Aanmaken van keystores...................................................................19 4.1
Aanmaken truststore..........................................................................19 Pagina 3 van 39
| Digikoppeling Gateway 2.0 Gebruikershandleiding | 6 januari 2010
5
4.2
Aanmaken client keystore ................................................................19
4.3
Aanmaken keystore voor de ebMS server .................................20
4.4
Aanmaken keystores voor de WUS server.................................20
Digikoppeling Gateway Dashboard ..............................................21 5.1 Beginpagina ...........................................................................................21 5.1.1 In- en uitloggen ............................................................................21 5.2 Digikoppeling.........................................................................................23 5.2.1 Digikoppeling ebMS CPA importeren.....................................23 5.2.2 Opnieuw importeren van een Digikoppeling ebMS CPA.25 5.2.3 Digikoppeling WUS WSDL importeren..................................26 5.2.4 Digikoppeling Services beheren..............................................27 5.2.5 Digikoppeling Certificaten beheren........................................27 5.3 Beheer......................................................................................................29 5.3.1 Adapters beheren .........................................................................29 5.3.2 Adapter instellingen inzien........................................................30 5.3.3 Notificatie instellingen beheren...............................................31 5.3.4 Gebruikers beheren .....................................................................32 5.4 Monitoring...............................................................................................35 5.4.1 Berichten inzien.............................................................................35 5.4.2 Logbestanden inzien....................................................................36 5.4.3 Incidenten inzien ..........................................................................37 5.4.4 Inzien & Verwijderen...................................................................37 5.5 Hermes 2 Corvus Dashboard ..........................................................38 5.5.1 Startscherm ....................................................................................38 5.5.2 Message History............................................................................39
Pagina 4 van 39
| Digikoppeling Gateway 2.0 Gebruikershandleiding | 6 januari 2010
Inleiding
Dit document beschrijft de installatie, configuratie (op Linux en Windows), het gebruik en het beheer van de gateway 2.0. 1.1
Uitgangspunten De gateway wordt ondersteund op zowel Linux als Windows, maar beide alleen in 32 bits. In beide gevallen is minimaal 500MB vrije schijfruimte vereist. We nemen aan dat degene die de installatie uitvoert, bekend is met het platform waarop geïnstalleerd wordt. Daarom lichten we niet alle stappen en commando's tot in detail toe en gaan we ervan uit dat deze bekend zijn. Voor Linux is kennis van de commandline en bijbehorende commando's noodzakelijk. Tot slot is er een extra machine aanwezig, waarop Java 6 is geïnstalleerd. Deze wordt gebruikt voor het converteren van p12 bestanden naar keystores. Dit kan zowel een Linux als een Windows machine zijn. Alle binnen dit document genoemde bestanden (xml en properties) zijn te openen met een texteditor (bijvoorbeeld wordpad of vi). Specifiek voor Windows geld er dat directory-namen worden gescheiden door middel van een slash (/). Zowel Linux als Java (dus ook-Java bestanden op Windows) maken gebruik van backslashes (\). Let hier dus op als er paden binnen Java-bestanden op Windows moeten worden aangepast!
1.2
Aanlevering software De software is als package te downloaden van de website. De inhoud van het package staat omschreven in de release notes.
1.3
Systeemeisen De exacte inrichting van de systemen is sterk afhankelijk van de omgeving waarin zij geplaatst zijn. Hierom wordt het aantal eigenschappen tot een minimum beperkt.
1.3.1
Linux Voor installatie op Linux gaan we uit van de volgende systeemeigenschappen: • Red Hat Linux (bijvoorkeur versie 4.6) is geïnstalleerd (Debian 3.1 voldoet ook, al zullen niet alle in dit document gebruikte commando's werken). • De server beschikt over minimaal 2 netwerk interfaces. • Er is minimaal kernel 2.4.27-2 geïnstalleerd (een 2.6 kernel is sterk aan te raden). • Er is minimaal 4GB geheugen beschikbaar. • Inloggen als root-user is mogelijk.
1.3.2
Windows Voor installatie op Windows gaan we uit van de volgende systeemeigenschappen: • Minimaal Windows 2003 Server. • Er is minimaal 4GB intern geheugen beschikbaar. • De server beschikt over minimaal 2 netwerk interfaces. • Inloggen met administrator rechten is mogelijk. Pagina 5 van 39
| Digikoppeling Gateway 2.0 Gebruikershandleiding | 6 januari 2010
2
Installatie
Dit hoofdstuk legt de installatiestappen uit die uitgevoerd moeten worden om de gateway te installeren. Deze handleiding beschrijft een “Clean Install”. De geschatte tijdsduur voor de installatie van de applicatie is twee uur. Hierbij is de installatie van het operating system zelf uiteraard niet inbegrepen. 2.1
Prerequisites • • •
2.1.1
Java 1.5.16 is geïnstalleerd. JCE policy files 1.4.2 zijn geïnstalleerd. PostgreSQL 8.x is geïnstalleerd.
Linux Java 1.5.16 Java wordt geleverd in een groot bestand dat zichzelf kan uitpakken en installeren. Maak dit bestand eerst uitvoerbaar (executable). Daarna kan de daadwerkelijke installatie beginnen: # # # # #
mv linux/jdk-1_5_0_16-linux-i586.bin /usr cd /usr chmod 755 jdk-1_5_0_16-linux-i586.bin ./jdk-1_5_0_16-linux-i586.bin rm -rf /usr/jdk-1_5_0_16-linux-i586.bin
De installatie start nu met een gebruikersovereenkomst. Druk op de spatiebalk om hier doorheen te scrollen en sluit af met het ingeven van 'yes' om de overeenkomst te accepteren. Om Java makkelijker aanroepbaar te maken, plaatsen we een symlink: # ln -s /usr/jdk1.5.0_16/ /usr/java JCE policy files 1.4.2 Het archief met JCE moet deels over de zojuist geïnstalleerde versie van Java worden gekopieerd: # unzip generiek/jce_policy-1_4_2 # cd jce # cp local_policy.jar US_export_policy.jar /usr/java/jre/lib/security Als er gevraagd wordt bestanden te overschrijven, doe dit dan. PostgreSQL 8.x De omgeving zal gaan draaien op een PostgreSQL 8 database. Red Hat 4 werkt met PostgreSQL 7, dus zal er een andere versie moeten worden geïnstalleerd. Controleer eerst of PostgreSQL aanwezig is op het systeem: # rpm -aq | grep postgresql Verwachte output: Pagina 6 van 39
| Digikoppeling Gateway 2.0 Gebruikershandleiding | 6 januari 2010
postgresql-server-7.4.19-1.el4_6.1 postgresql-7.4.19-1.el4_6.1 postgresql-libs-7.4.19-1.el4_6.1 Als PostgreSQL 7 aanwezig is moet deze, indien nodig, worden gestopt: # service postgresql stop En verwijder deze versie: # rpm -e postgresql-server postgresql postgresql-libs Het is mogelijk dat het bovenstaande commando fout gaat omdat er afhankelijkheden dreigen te worden verbroken. In dat geval worden de commando's: # cd Linux # rpm -e postgresql-server-7.4.19-1.el4_6.1 postgresql7.4.19-1.el4_6.1 postgresql-libs-7.4.19-1.el4_6.1 cyrussasl-sql-2.1.19-14.i386 php-pgsql-4.3.9-3.22.9.i386 Installeer vervolgens de juiste versie van PostgreSQL en start het: # rpm -Uvh postgresql-8.3.3-1PGDG.rhel4.i386.rpm postgresql-server-8.3.3-1PGDG.rhel4.i386.rpm postgresqllibs-8.3.3-1PGDG.rhel4.i386.rpm # service postgresql initdb De configuratie van PostgreSQL moet worden aangepast zodat PostgreSQL ook externe connecties accepteert. Open het bestand pg_hba.conf in /var/lib/pgsql/data # vi /var/lib/pgsql/data/pg_hba.conf Pas het volgende aan: # TYPE DATABASE USER CIDR-ADDRESS METHOD # "local" is for Unix domain socket connections only #local all all ident sameuser local all all trust host all all 127.0.0.1/32 md5 # IPv4 local connections: #host all all 127.0.0.1/32 ident sameuser # IPv6 local connections: #host all all ::1/128 ident sameuser Start de database: # service postgresql start Tot slot zorgt het volgende commando ervoor dat PostgreSQL automatisch wordt gestart als het systeem start: # chkconfig postgresql on 2.1.2
Windows Windows heeft geen ondersteuning voor het uitpakken van .tar.gz bestanden. Neem 7-zip (http://www.7-zip.org/ ) om deze bestanden toch te kunnen gebruiken.
Pagina 7 van 39
| Digikoppeling Gateway 2.0 Gebruikershandleiding | 6 januari 2010
Java 1.5.16 Java (windows/JDK 1.5.0_16) wordt geleverd in een bekend installatiepakket. Dubbelklik het installatiepakket en doorloop de procedure om Java te installeren. Ook Java moet aan het path van het systeem worden toegevoegd, en JAVA_HOME moet worden ingesteld: JAVA_HOME = C:\Program Files\Java\jdk1.5.0_16 JCE policy files 1.4.2 De inhoud van generiek/jce_policy-1_4_2.zip moet over de zojuist geïnstalleerde versie van Java worden geïnstalleerd. Het zip-bestand bevat onder andere local_policy.jar en US_export_policy.jar. Pak deze uit naar C:\Program Files\Java\jdk1.5.0_16\jre\lib\security.
Pagina 8 van 39
| Digikoppeling Gateway 2.0 Gebruikershandleiding | 6 januari 2010
PostgreSQL 8.x Ook PostgreSQL wordt geleverd in een installatiepakket. Dubbelklik op windows/postgresql-8.3.msi om de installer te starten en doorloop de procedure. Na de installatie de folder [installatie folder]\PostgreSQL\8.3\bin toevoegen aan de Windows PATH omgevingsvariabele. 2.2
Installatie Digikoppeling gateway
2.2.1
Linux • • • • •
2.2.2
Creëer een gateway installatie folder. Pak het bestand Gateway-2.0.x.tar.gz uit naar de folder. Initialiseer de gateway database door het bestand conf/db/installdb.sh uit te voeren. De gateway is geïnstalleerd en kan gestart worden. (Zie Starten gateway). De gateway is gestart en kan getest worden. (Zie Testen gateway.)
Windows • • • • •
Creëer een gateway installatie folder. Pak het bestand osbgateway-2.0.x.tar.gz uit naar de folder. Initialiseer de gateway database door het bestand conf/db/installdb.bat uit te voeren. De gateway is geïnstalleerd en kan gestart worden. (Zie Starten gateway.) De gateway is gestart en kan getest worden. (Zie Testen gateway.)
2.3
Starten Digikoppeling Gateway
2.3.1
Linux •
Start de gateway door het bestand bin/startGateway.sh uit te voeren. Dit script start de vier processen (ApacheDS, Joram(JMS), Tomcat en de Gateway Core) waaruit de gateway bestaat.
2.3.2
Windows • Start de gateway door het bestand bin/startGateway.bat uit te voeren. Dit script start de vier processen(ApacheDS, Joram(JMS), Tomcat en de Gateway Core) waaruit de gateway bestaat.
2.4
Stoppen Digikoppeling Gateway
2.4.1
Linux • Stop de gateway door het bestand bin/stopGateway.sh uit te voeren. Let op! Dit script beëindigt alle Java-processen op de machine waarop de gateway draait. Als deze methode niet wenselijk is, kunnen de vier processen waaruit de gateway bestaat handmatig gestopt worden.
2.4.2
Windows • Stop de gateway door het bestand bin/stopGateway.bat uit te voeren. Let op! Dit script beëindigt alle Java-processen op de machine waarop de gateway draait. Als deze methode niet wenselijk is, kunnen de vier processen waaruit de gateway bestaat handmatig gestopt worden.
Pagina 9 van 39
| Digikoppeling Gateway 2.0 Gebruikershandleiding | 6 januari 2010
2.5
Testen Digikoppeling Gateway Installatie De gateway is standaard met een localhost configuratie geconfigureerd. Hierdoor is het mogelijk om de gateway en zijn koppelvlakken direct vanaf localhost te starten en te testen. Het is aan te raden om eerst met deze default configuratie de gateway 2.0 te testen alvorens met de configuratie te beginnen.
2.5.1
Testen van het Gateway Dashboard Het Dashboard van de gateway moet nu toegankelijk zijn met een webbrowser via http://localhost:8080/dashboard. Inloggen kan met: 1. Username: osbgateway 2. Password: osbgateway Het is sterk aan te raden als eerste een nieuwe admin-gebruiker toe te voegen en vervolgens de reeds bestaande gebruiker te verwijderen. Dit kan via het menu Beheer/Gebruikers beheren.
2.5.2
Testen van het Digikoppeling berichtenverkeer In de gateway zijn standaard twee loopback services geconfigureerd welke op localhost beschikbaar zijn. Het gaat om de volgende services: • EbMSLoopbackService:1:0: Dit is een loopback service waarmee het ebMS koppelvlak op localhost getest kan worden. Deze service is via het JMS koppelvlak van de gateway benaderbaar. • WUSLoopbackService_1_0: Met deze service kan het WUS koppelvlak getest worden. Deze service is via het JMS koppelvlak van de gateway benaderbaar. De details van de twee loopback services kunnen bekeken worden via de dashboard functie Digikoppeling Services beheren. De gateway levert standaard een JMS client mee waarmee berichten via het JMS Koppelvlak van de gateway kunnen worden uitgewisseld. Met behulp van deze tool kunnen we nu de loopback services testen.
2.5.3
Linux • Run de JMS Client door het bestand tools/jms-client/run-jms-client.sh uit te voeren. • Test het ebMS endpoint door het bestand example/jms/EbMSLoopbackService_1_0_Loopback.properties naar directory tools/jms-client/testcases/JORAM_LOCALHOST te kopiëren. • Controleer nu in de gateway of het verzonden bericht (JMS-ebMS en ebMS-JMS) goed ontvangen is bij Berichten inzien (Zie Berichten inzien). • Test het WUS endpoint door het bestand example/jms/ WUSLoopbackService_1_0_LoopbackRequest.propertiesnaar directory tools/jms-client/testcases/JORAM_LOCALHOST te kopiëren. • Controleer nu in de gateway of het verzonden bericht (JMS-WUS) goed verzonden en ontvangen is bij Berichten inzien (Zie Berichten inzien). • Indien een ebMS of WUS bericht niet goed verzonden is, kan via de functies Incidenten inzien en Logbestanden inzien van het dashboard de oorzaak van de fout worden achterhaald.
Pagina 10 van 39
| Digikoppeling Gateway 2.0 Gebruikershandleiding | 6 januari 2010
2.5.4
Windows • Run de JMS Client door het bestand tools/jms-client/run-jms-client.bat uit te voeren. • Test het ebMS endpoint door het bestand example/jms/ EbMSLoopbackService_1_0_Loopback.properties naar directory tools/jms-client/testcases/JORAM_LOCALHOST te kopiëren. • Controleer nu in de gateway of het verzonden bericht (JMS-ebMS en ebMS-JMS) goed ontvangen is bij Berichten inzien. (Zie Berichten inzien.) • Test het WUS endpoint door het bestand example/jms/ WUSLoopbackService_1_0_LoopbackRequest.propertiesnaar directory tools/jms-client/testcases/JORAM_LOCALHOST te kopiëren. • Controleer nu in de gateway of het verzonden bericht (JMS-WUS) goed verzonden en ontvangen is bij Berichten inzien. (Zie Berichten inzien.) Indien een ebMS of WUS bericht niet goed verzonden is, kan via de dashboard functies Incidenten inzien en Logbestanden inzien de oorzaak van de fout worden achterhaald.
Pagina 11 van 39
| Digikoppeling Gateway 2.0 Gebruikershandleiding | 6 januari 2010
3
Configuratie
De gateway is met een standaard configuratie geconfigureerd. Hierdoor is het mogelijk om de gateway en zijn koppelvlakken direct vanaf localhost te starten en te testen. Voor het installeren in een geïntegreerde omgeving moet een aantal zaken geconfigureerd worden. Het configureren hiervan wordt in dit hoofdstuk beschreven. 3.1
Configuratie endpoints Default staan alle http endpoints op localhost. In een geïntegreerde omgeving moeten deze endpoints omgezet worden naar de hostnamen/domeinnamen en ip-adressen van die geïntegreerde omgeving. Hieronder wordt per koppelvlak adapter van de gateway beschreven hoe deze endpoints geconfigureerd kunnen worden. De endpoints kunnen worden aangepast door middel van een met de gateway meegeleverde configurator.
3.1.1
Gateway Configurator Om het configureren van het gateway 2.0 te vereenvoudigen is er een configurator beschikbaar. Hierdoor is het alleen nog maar nodig om het configuratie bestand conf/configurator/osbgateway.params in te vullen en daarna het bestand conf/configurator/configurator.(bat)(sh) aan te roepen. Hieronder een uitleg van de configuratie parameters in het conf/configurator/osbgateway.params bestand.
Parameter
Beschrijving
Voorbeeld waarde
EBMS_PARTYID
Het partyID van de gateway ebMS adapter. Dit ID wordt
000000000000001
ter identificatie gebruikt in de communicatie met de ebMS adapters van andere organisaties. Het partyID is gelijk aan het OverheidsIdentificatieNummer(OIN) dat wordt verstrekt bij het aanmelden bij Digikoppeling: http://www.logius.nl/digikoppeling
IP_WUS
De hostnaam/domeinnaam van het WUS Koppelvlak van
gateway_adres_w.nl
de gateway.
PORT_WUS
De poort van het WUS Koppelvlak van de gateway.
443
Dit moet een poort zijn die vanaf een extern netwerk beschikbaar is.
WUS_IS_SSL
Gebruik wel of niet SSL op het WUS Koppelvlak van de
true
gateway (true of false).
IP_EBMS
De hostnaam/domeinnaam van het ebMS Koppelvlak van
gateway_adres_e.nl
de gateway. Let erop dat dit een ander hostnaam/domeinnaam moet zijn dan het IP_WUS, indien deze op dezelfde poort draaien.
PORT_EBMS
De Poort van het ebMS Koppelvlak van de gateway.
443 Pagina 12 van 39
| Digikoppeling Gateway 2.0 Gebruikershandleiding | 6 januari 2010
Dit moet een poort zijn dat vanaf een extern netwerk beschikbaar is.
EBMS_IS_SSL
Gebruik wel of niet SSL op het ebMS Koppelvlak van de
true
gateway (true of false).
IP_WUSLITE
De hostnaam/domeinnaam van het WUS-lite Koppelvlak
gateway_adres_wl.nl
van de gateway. Met deze hostnaam spreekt een applicatie in het interne domein de gateway aan.
IP_JMS
De hostnaam/domeinnaam waarop het JMS Koppelvlak van gateway_adres_jms.nl de gateway beschikbaar is. Met deze hostnaam spreekt een applicatie in het interne domein de gateway aan.
IP_DASHBOARD
De hostnaam/domeinnaam van de dashboard web
gateway_adres.nl
interface van de gateway.
PORT_DASHBOARD
De port waarop het dashboard draait.
8080
PORT_WUSLITE
De port waarop WUS-lite draait.
80
PORT_HERMES
De port waarop Hermes2 draait.
8080
!LET OP: In versie 2.0.11 is het alleen mogelijk om Hermes op poort 8080 te configureren met de configurator. De Hermes poort kan echter wel met de hand worden aangepast door in het bestand apps/osbgatewayApp/osbgatewayassembly/project_resource/gateway.override.properties de naam van de parameter hermes_client_baseurl te wijzigen in hermes.client.baseurl. Vervolgens moet in het bijbehorende adres de poort aangepast worden naar de gewenste poort.
TRUSTSTORE_FILE
De bestandsnaam van het JKS bestand waarin certificaten
truststore.jks
zijn opgenomen die de gateway vertrouwt. Hierin staan in ieder geval de drie PKIoverheid-rootcertificaten.
TRUSTSTORE_PASSWORD
Het wachtwoord om de truststore mee te openen.
password
CLIENT_KEYSTORE_FILE
De bestandsnaam van het JKS bestand waarin certificaten
clientkeystore.jks
zijn opgenomen die de gateway vertrouwt. Hierin staan in ieder geval de drie PKIoverheid-rootcertificaten.
CLIENT_KEYSTORE_PASSWORD Het wachtwoord om de client keystore mee te openen.
password
EBMS_SERVER_KEYSTORE_FIL
De bestandsnaam van het JKS bestand waarin de private
ebmsserver.jks
E
key van het PKIoverheid-ebMS servercertificaat is opgenomen.
EBMS_SERVER_KEYSTORE_PAS
Het wachtwoord om de keystore mee te openen.
password
De alias waaronder het PKIoverheid-clientcertificaat is
gateway_client_key
SWORD
EBMS_CLIENT_KEY_ALIAS
Pagina 13 van 39
| Digikoppeling Gateway 2.0 Gebruikershandleiding | 6 januari 2010
opgenomen in de ebMS client keystore, die wordt gebruikt voor de contracttransformatie naar een ebMS servicespecificatie. Deze waarde is ook bekend als het OIN van een organisatie.
EBMS_SERVER_KEY_ALIAS
De alias waaronder het PKIoverheid-ebMS servercertificaat
gateway_server_key
is opgenomen in de ebMS server keystore.
WUS_SERVER_KEYSTORE
De bestandsnaam van het JKS bestand waarin de private
wusserver.jks
key van het PKIoverheid-WUS servercertificaat is opgenomen. In het bestand mag maar één certificaat aanwezig zijn.
WUS_SERVER_KEYSTORE_PAS
Het wachtwoord om de keystore mee te openen.
password
De gebruiker waarmee toegang is te krijgen tot de
osb
SWORD
TOMCAT_USER
Hermes2 webinterface.
TOMCAT_PASSWORD
Het password waarmee toegang is te krijgen tot de
Password
Hermes2 webinterface.
3.2
Configuratie notificatie mail In het bestand apps/osbgatewayApp/osbgatewayassembly/project_resources/gateway.default.properties kunnen de volgende instellingen gedaan worden met betrekking tot het verzenden van de notificaties. Instelling
Omschrijving
Default Waarde
notification.mail.send.cronExpression
De interval tussen het verzenden
0 0 12 ? * MON-FRI
van openstaande notificaties. Dit
(Ieder werkdag om 12 uur
is een Cron expressie.
in de middag)
Het adres dat in het From veld
FROM_ADDRESS
notification.mailer.from.address
van een e-mail komt te staan.
notification.mailer.replyto.address
Het adres waarnaartoe een reply
REPLY_TOADDRESS
gestuurd moet worden.
mailer.host
De hostnaam van de server
localhost
waarop de mail server is geïnstalleerd.
mailer.port
De poort waarop de mail server
25
beschikbaar is.
mail.smtp.auth
Geeft aan of de mail server
false
verwacht dat de gateway zich authenticeerd.
mailer.username
De gebruikersnaam waarmee de gateway toegang tot de mail server kan verkrijgen.
Pagina 14 van 39
| Digikoppeling Gateway 2.0 Gebruikershandleiding | 6 januari 2010
mailer.password
Het wachtwoord waarmee de gateway zich bij de mail server kan authenticeren.
mailer.protocol
Het mail protocol.
smtp
mail.transport.protocol
Het mail protocol.
smtp
mail.smtp.socketFactory.port
mail.smtp.socketFactory.class
3.3
mail.smtp.socketFactory.fallback
false
mail.smtp.starttls.enable
false
mail.debug
false
Configuratie JMS Broker en-/of JNDI Register Default worden de queues van het JMS Koppelvlak van de gateway gehost op Joram JMS broker. Daarnaast zijn de gateway JMS queues via de Joram JNDI server opvraagbaar. De gateway JMS queues kunnen ook op een andere JMS broker geconfigureerd worden. Voorwaarde is dat de JMS object via een JNDI register opvraagbaar zijn. Configuratie van een andere JMS Broker en/of JNDI register kan gedaan worden door de volgende settings in het bestand apps/osbgatewayApp/osbgatewayassembly/project_resources/gateway.default.properties aan te passen. Instelling
Omschrijving
Default Waarde
adapter.jms.setting.gateway.in.queue
De JNDI naam van de queue
jms.osb.gateway.in
waarop de gateway berichten ontvangt vanuit de interne applicaties.
adapter.jms.setting.gateway.out.queue
De JNDI naam van de queue
jms.osb.gateway.out
waarop de gateway berichten verstuurd naar de interne applicaties.
adapter.jms.setting.gateway.retval.queu
De JNDI naam van de interne
e
return value queu van de
jms.osb.gateway.retval
gateway. Deze queu gebruikt de gateway alleen voor interne doeleinden.
jms.adapter.sender.port
Dit is de poort waarop het
16400
JNDI register benaderbaar is.
jms.adapter.sender.hostname
De naam is wat verwarrend,
Root
maar deze setting geeft de gebruikersnaam aan waarmee de gateway zich bij het JNDI register authenticeerd.
Pagina 15 van 39
| Digikoppeling Gateway 2.0 Gebruikershandleiding | 6 januari 2010
jms.adapter.sender.host
De host waarop het JNDI
Localhost
register staat.
jms.adapter.sender.password
Het wachtwoord waarmee de
Root
gateway zich bij het JNDI register authenticeerd.
jms.adapter.sender.initialcontextfactory
De context factory.
fr.dyade.aaa.jndi2.client.Nami ngContextFactory
jms.adapter.sender.connectionfactory
De JNDI naam van de
Cf
connection factory.
Naast het zetten van deze instellingen moeten ook de client libraries van de gebruikte JMS broker en JNDI register bij de gateway bekend gemaakt worden. Dit kan door de client libraries in de folder apps/osbgatewayApp/osbgateway-assembly/01_lib/ te plaatsen. Start de gateway vervolgens opnieuw op. 3.4
Configuratie database locatie Het is mogelijk om de PostgreSQL database waarvan de gateway gebruik maakt op een andere server te zetten dan de gateway applicatie. Hiervoor moeten de volgende twee configuratiestappen uitgevoerd worden: 1. Pas in de hieronder genoemde bestanden alle db adressen(jdbc:postgresql.....) aan: • • • •
apps/apache-tomcat-5.5.25/webapps/corvus/WEB-INF/web.xml. apps/apache-tomcat-5.5.25/webapps/corvus/WEBINF/classes/adapter.client.osbgateway.override.properties. apps/hermes2/plugins/hk.hku.cecid.ebms/conf/hk/hku/cecid/ebms/sp a/conf/ebms.module.xml. apps/osbgatewayApp/osbgatewayassembly/project_resources/gateway.default.properties.
2. Daarnaast moet aan het bestand apps/osbgatewayApp/osbgatewayassembly/project_resources/gateway.default.properties deze setting toegevoegd worden: • adapter.client.hibernate.ds.url=jdbc:postgresql://
:<portdbserver>/gateway. Start de gateway vervolgens opnieuw op. 3.5
Configuratie voor grote berichten Om de gateway grote berichten te laten accepteren moet de applicatie worden voorzien van meer geheugen. Dit gebreurt door apps/apachetomcat-5.5.25/bin/catalina.sh aan te passen. In de eerste regels na het commentaar aan het begin van het bestand moeten de volgende regels worden toegevoegd: CATALINA_OPTS="$CATALINA_OPTS -Xmx1024m" JAVA_OPTS="$JAVA_OPTS -Xmx1024m"
3.6
Aanpassen Corvus gebruiker en wachtwoord Het aanpassen van de Corvus gebruiker kan plaatsvinden via de gateway Configurator via de parameters TOMCAT_USER en TOMCAT_PASSWORD. Pagina 16 van 39
| Digikoppeling Gateway 2.0 Gebruikershandleiding | 6 januari 2010
Dit kan ook rechstreeks worden gedaan voor het volgende bestand aan te passen: apps/apache-tomcat-5.5.25/conf/tomcat-users.xml. Dit bestand moet de volgende inhoud hebben: <user username="TOMCAT_USER" password="TOMCAT_PASSWORD" roles="admin"/>
Aanpassen Tomcat HTTP header De HTTP-header van Tomcat kan zo worden aangepast zodat deze geen versie informatie weergeeft. In het bestand apps/apache-tomcat5.5.25/conf/server.xml staan de connectoren gedefinieerd waar Tomcat gebruik van maakt. Bij de gateway zijn dit er standaard drie (EBMS, Dashboard en Corvus interface). De externe interfaces zijn uiteraard het meest relevant om aan te passen. Een voorbeeld van een connector is hieronder weergegeven: De betreffende parameter is vet weergegeven.
3.8
Verwijderen van de Tomcat ROOT-applicatie Standaard is Tomcat uitgerust met een applicatie die het managen van de Applicatie-server vereenvoudigt en wat opties toevoegt. Deze mogelijkheden zijn binnen de gateway niet van toepassing, dus kan deze applicatie in zijn geheel worden verwijderd. Dit gebeurd door de volgende folder te verwijderen: apps/apache-tomcat5.5.25/webapp/ROOT
3.9
Configuratie Archive folder De gateway archiveert de message id's van alle berichten in een een specifieke folder. De locatie van de folder kan geconfigureerd worden door de volgende setting in het bestand apps/osbgatewayApp/osbgatewayassembly/project_resource/gateway.override.properties aan te passen of toe te voegen. Instelling
Omschrijving
Default Waarde
message.service.storagelocation
De locatie waar
/work/archive/messageservicestorage
de gateway alle Pagina 17 van 39
| Digikoppeling Gateway 2.0 Gebruikershandleiding | 6 januari 2010
message id's archiveert.
Pagina 18 van 39
| Digikoppeling Gateway 2.0 Gebruikershandleiding | 6 januari 2010
4
Aanmaken van keystores
Voer de volgende acties uit op een machine waarop Java 6 is geïnstalleerd: De gateway maakt gebruik van vier keystores die kunnen worden gemaakt uit p12 bestanden. P12 bestanden zijn bestanden met een combinatie van een privatekey en een certificaat. Het maken van de keystores kan zowel op Linux als op Windows gebeuren en gebruikmakend van een Java-tool genaamd 'keytool'. Bij de volgende paragrafen wordt er vanuit gegaan dat de volgende certificaten aanwezig zijn. Het is mogelijk dat de aangeleverde certificaten een andere naam hebben, zorg er dan eerst voor dat de namen overeenkomen met de onderstaande opsomming: • Digikoppeling PKIoverheid-rootcertificaaat (ROOTcert.cer). • Digikoppeling PKIoverheid-domeincertificaat (domeinCAcert.cer). • Het Digikoppeling PKIoverheid-CSP certificaat (cspCAcert.cer). • Certificaat en privatekey voor de ebMS server in p12 formaat (ebms.p12). • Certificaat en privatekey voor de WUS server in p12 formaat (wus.p12). • Certificaat en privatekey voor de client in p12 formaat (client.p12). Dit zijn testcertificaten verstrekt door RENOIR. Productie Digikoppeling PKI Overheidscetificaten kunnen eveneens worden gebruikt, maar zoals hierboven vermeld is, moeten ze dan worden “renamed” naar bovenstaande namen. 4.1
Aanmaken truststore De truststore zal alle certificaten bevatten waar geen privatekey van aanwezig is. Deze certificaten vormen samen een 'pad' naar het rootcertificaat. Dit maakt het mogelijk om de totale certificate chain te controleren. # keytool -import -alias rootcert -keystore TRUSTSTORE_LOCATION/TRUSTSTORE -storepass "TRUSTSTORE_PASSWORD" -file ROOTcert.cer # keytool -import -alias domeincacert -keystore TRUSTSTORE_LOCATION/TRUSTSTORE -storepass "TRUSTSTORE_PASSWORD" -file domeinCAcert.cer # keytool -import -alias cspcacert -keystore TRUSTSTORE_LOCATION/TRUSTSTORE -storepass "TRUSTSTORE_PASSWORD" -file cspCAcert.cer
4.2
Aanmaken client keystore In de client keystore staan de private key en het certificaat die gebruikt worden als de gateway verbindt met een extern endpoint. Als de gateway geïnstalleerd is, kan deze keystore worden beheerd via de webinterface van het dashboard. Bij onderstaand commando gaan we ervan uit dat het aanwezige p12-bestand 'client.p12' heet en dat de alias voor de key 'osb_ebms_client' is. Mocht dit niet het geval zijn, pas dan eerst óf de bestaande p12 aan óf onderstaand commando. # keytool -import -alias rootcert -keystore CLIENT_KEYSTORE_LOCATION/CLIENT_KEYSTORE -storepass Pagina 19 van 39
| Digikoppeling Gateway 2.0 Gebruikershandleiding | 6 januari 2010
"CLIENT_KEYSTORE_PASSWORD" -file ROOTcert.cer # keytool -import -alias domeincacert -keystore CLIENT_KEYSTORE_LOCATION/CLIENT_KEYSTORE -storepass "CLIENT_KEYSTORE_PASSWORD" -file domeinCAcert.cer # keytool -import -alias cspcacert -keystore CLIENT_KEYSTORE_LOCATION/CLIENT_KEYSTORE -storepass "CLIENT_KEYSTORE_PASSWORD" -file cspCAcert.cer # keytool -importkeystore -srckeystore client.p12 srcstoretype pkcs12 -srcalias osb_ebms_client destkeystore CLIENT_KEYSTORE_LOCATION/CLIENT_KEYSTORE deststoretype jks -destalias EBMS_CLIENT_KEY_ALIAS deststorepass CLIENT_KEYSTORE_PASSWORD -destkeypass CLIENT_KEYSTORE_PASSWORD 4.3
Aanmaken keystore voor de ebMS server In de ebMS keystore staan de private key en het certificaat die de ebMS adapter gebruikt bij de communicatie met andere endpoints. Bij onderstaand commando gaan we ervan uit dat het aanwezige p12bestand 'ebms.p12' heet en dat de alias voor de key 'osb_test_cert' is. Mocht dit niet het geval zijn, pas dan eerst óf de bestaande p12 aan óf onderstaand commando. # keytool -importkeystore -srckeystore ebms.p12 srcstoretype pkcs12 -srcalias osb_test_cert destkeystore EBMS_SERVER_KEYSTORE_LOCATION/EBMS_SERVER_KEYSTORE deststoretype jks -destalias EBMS_SERVER_KEY_ALIAS deststorepass EBMS_SERVER_KEYSTORE_PASSWORD -destkeypass EBMS_SERVER_KEYSTORE_PASSWORD Deze keystore kan later beheerd worden via de webinterface van het dashboard.
4.4
Aanmaken keystores voor de WUS server In die WUS keystore staan de private key en het certificaat die de WUS adapter gebruikt bij de communicatie met andere endpoints. Bij onderstaand commando gaan we ervan uit dat het aanwezige p12bestand 'wus.p12' heet en dat de alias voor de key 'osb_test_cert' is. Mocht dit niet het geval zijn, pas dan eerst óf de bestaande p12 aan óf onderstaand commando. # keytool -importkeystore -srckeystore wus.p12 srcstoretype pkcs12 -srcalias osb_test_cert destkeystore WUS_SERVER_KEYSTORE_LOCATION/WUS_SERVER_KEYSTORE deststoretype jks -destalias wuskey -deststorepass WUS_SERVER_KEYSTORE_PASSWORD -destkeypass WUS_SERVER_KEYSTORE_PASSWORD
Pagina 20 van 39
| Digikoppeling Gateway 2.0 Gebruikershandleiding | 6 januari 2010
5
Digikoppeling Gateway Dashboard
Het dashboard van de gateway bestaat uit vier menu’s: • Beginpagina. • Digikoppeling. • Beheer. • Monitoring. Beginpagina Hieronder bevindt zich de beginpagina waarop je kan inloggen. Digikoppeling Onder dit menu vind je Digikoppeling gerelateerde activiteiten: • Digikoppeling ebMS CPA importeren. • Digikoppeling WUS WSDL importeren. • Digikoppeling Services beheren. • Digikoppeling Certificaten beheren. Beheer Onder dit menu vallen alle beheer activiteiten: • Adapters beheren. • Adapter instellingen inzien. • Notificatie instellingen beheren. • Gebruikers beheren. Monitoring Via dit menu kun je alle berichtenverkeer inde gateway monitoren: • Berichten inzien. • Logbestanden inzien. • Incidenten inzien. 5.1
Beginpagina
5.1.1
In- en uitloggen Het dashboard van de gateway is toegankelijk op het adres: http://:/dashboard U moet inloggen om de gateway te gebruiken. Het inlogscherm verschijnt automatisch als u naar bovenstaande locatie gaat.
Pagina 21 van 39
| Digikoppeling Gateway 2.0 Gebruikershandleiding | 6 januari 2010
Figuur 7 s Het inlogscherm Vul uw accountgegevens in (default gebruikersnaam en wachtwoord zijn respectievelijk ‘osbgateway’, ‘osbgateway’) en klik op ‘Log in’. U ziet een bevestiging.
Figuur 7 t Bevestiging van login Zijn uw gegevens fout, dan krijgt u een foutmelding:
Figuur 7 u Melding bij foute gegevens Klik om uit te loggen bovenin het scherm op ‘Afmelden’.
Pagina 22 van 39
| Digikoppeling Gateway 2.0 Gebruikershandleiding | 6 januari 2010
Figuur 7 v De knop 'Afmelden' U gaat automatisch terug naar het inlogscherm. 5.2
Digikoppeling Met dit menu kunnen alle Digikoppeling gerelateerde acties worden uitgevoerd.
5.2.1
Digikoppeling ebMS CPA importeren CPA's (Collaborative Protocol Agreements) vormen het contract tussen de partijen die met elkaar willen communiceren over het Digikoppeling ebMS Koppelvlak. De gateway kan op basis van een CPA geconfigureerd worden voor Digikoppeling ebMS berichtenverkeer. Hiervoor biedt het dashboard de functie “Digikoppeling ebMS CPA importeren” aan.
Hieronder volgt een beschrijving van de attributen op het importeren scherm.
Attribuut
Omschrijving
CPA bestand
De te importeren CPA (XML-bestand). De gateway bepaalt zijn rol in de CPA op basis van het in het hoofdstuk Configuratie gezette EBMS_PARTYID. Dit is het OIN van uw organisatie. Daarnaast moet het client certificaat in de CPA, indien aanwezig, reeds geïmporteerd zijn via de functie Digikoppeling Certificaten beheren.
Rol informatie
Na het selecteren van het CPA zal hier de Rol informatie getoond worden. Hierin wordt onderscheid gemaakt tussen de rol van de gateway en de partij waarmee de service wordt gedeeld. Daarnaast wordt getoond of de gateway berichten op te importeren ebMS
Pagina 23 van 39
| Digikoppeling Gateway 2.0 Gebruikershandleiding | 6 januari 2010
service kan ontvangen (canReceive in CPA) en/of verzenden (canSend in CPA).
Kies koppelvlak Organisatie Domein
Het koppelvlak met het Organisatie domein. Er kan gekozen worden tussen JMS en WUSLITE.
URL WUS-lite service
Indien als intern Koppelvlak WUS-lite wordt gekozen en in de CPA staat geconfigureerd dat de gateway berichten kan ontvangen (canReceive), kan in dit veld de URL ingevoerd worden waarop de WUS lite service beschikbaar is voor het ontvangen van de berichten.
Suffix actienamen verzenden
De suffix die aan de actienamen van Digikoppeling Service moet worden toegevoegd in het interne contract. Hiermee kan in de actienaam worden aangeduid van welke partij de service wordt geconsumeerd. Indien dit veld wordt leeg gemaakt, worden de actienamen uit Digikoppeling Service overgenomen in het interne contract. Default is deze waarde ingevuld met de volgende waardes uit de CPA <Servicenaam>-<PartyID>.
Opslaan client certificaat andere partij
Geeft aan of het client certificaat van de andere partij uit het CPA bestand opgeslagen dient te worden in de truststore. Let op: indien geactiveerd, dient na het importeren de gateway opnieuw gestart te worden om het certificaat te activeren. Tomcat leest namelijk de truststore alleen bij het opstarten.
Na het succesvol importeren van een ebMS CPA zal het volgende scherm getoond worden:
Op dit scherm wordt de Service naam getoond met de bijbehorende action(s). Verder is er een link Details waarmee meer detail informatie over de Service opgevraagd kan worden:
Pagina 24 van 39
| Digikoppeling Gateway 2.0 Gebruikershandleiding | 6 januari 2010
In het detailscherm worden alle organisaties waarmee de service wordt uitgewisseld, opgesomd. Per organisatie kan de CPA en het interne contract (JMS Specificatie / WUS-lite WSDL) worden bekeken. Een organisatie kan ook weer verwijderd worden uit de lijst met organisaties. Uitwisseling met die organisatie voor de betreffende service is dan niet meer mogelijk.
5.2.2
Opnieuw importeren van een Digikoppeling ebMS CPA Het is mogelijk om een bestaand ebMS service in de gateway te vervangen. Hiervoor moet de CPA waarin de service staat gedefinieerd opnieuw worden geïmporteerd. Bij het importeren van de CPA verschijnt dan een waarschuwing dat deze reeds geconfigureerd is. Indien er gekozen wordt om door te gaan met de import, zal de bestaande service overschreven worden.
Pagina 25 van 39
| Digikoppeling Gateway 2.0 Gebruikershandleiding | 6 januari 2010
5.2.3
Digikoppeling WUS WSDL importeren Via deze functie kunnen Digikoppeling WUS WSDL’s worden geïmporteerd in de gateway.
Hieronder volgt een beschrijving van de attributen op het importeren scherm.
Attribuut
Omschrijving
WSDL bestand
Een zip-bestand dat een WSDL en bijbehorende xsd’s bevat. Deze zal typisch uit het Digikoppeling Service Register gedownload kunnen worden.
Kies Rol
De rol die de gateway gaat vervullen; gaat de gateway de service die beschreven staat consumeren of aanbieden?
Kies koppelvlak Organisatie Domein
Het koppelvlak met het Organisatie Domein. Er kan gekozen worden tussen JMS en WUSLITE.
Gebruik SSL
Geef aan of op Digikoppeling gebruikgemaakt moet worden gemaakt van SSL..
WUS client certificaat
Het certificaat waarmee de SSL verbinding moet worden opgezet. De lijst met certificaten kan beheerd worden met de functie Digikoppeling Certificaten beheren.
URL WUS-lite service
Indien als intern koppelvlak WUS-lite wordt gekozen en de WUS service kan worden aangeboden, kan in dit veld de URL ingevoerd worden waarop de WUS lite service beschikbaar is voor het ontvangen van de berichten.
Suffix actienamen
De suffix die aan de actienamen van Digikoppeling Service moet worden toegevoegd in het interne contract. Hiermee kan in de actienaam worden aangeduid van welke partij de service wordt geconsumeerd. Indien dit veld wordt leeg gemaakt, worden de actienamen uit Digikoppeling Service overgenomen in het interne contract. Default is deze waarde ingevuld met de volgende waardes uit de WSLD /<Servicenaam>.
Pagina 26 van 39
| Digikoppeling Gateway 2.0 Gebruikershandleiding | 6 januari 2010
Na het succesvol importeren van een WUS WSDL wordt het volgende scherm getoond:
Op dit scherm word de Service naam getoond met de bijbehorende action(s) en het Digikoppeling WUS endpoint adres. Verder is er een link “Digikoppeling WUS WSDL inzien” waarmee de bron WSDL opgevraagd kan worden. Daarnaast kan het interne contract (JMS Specificatie / WUSlite WSDL) worden gedownload. 5.2.4
Digikoppeling Services beheren Via deze functie kunnen alle, middels de CPA en WSDL import functie, in de gateway geconfigureerde Digikoppeling Service worden beheerd. De volgende functies zijn beschikbaar waarbij onderscheid wordt gemaakt tussen WUS service en ebMS services: Functies Digikoppeling ebMS Service: • Inzien Digikoppeling ebMS Services. • Inzien Partij informatie. • Downloaden CPA. • Downloaden Interne Specificatie (JMS Specificatie/WUS-lite WSDL). • Verwijderen Digikoppeling ebMS Service voor alle partijen. • Verwijderen partij uit Digikoppeling ebMS Service. • Functies Digikoppeling WUS Service: • Inzien Digikoppeling WUS Services. • Downloaden Digikoppeling WUS WSDL. • Downloaden Interne Specificatie(JMS Specificatie/WUS-lite WSDL). • Verwijderen Digikoppeling WUS Service. • Vervangen Digikoppeling WUS Service.
5.2.5
Digikoppeling Certificaten beheren Certificaten leggen de afspraken vast op basis waarvan overheidsorganisaties met de gateway communiceren. Clientcertificaten worden gebruikt voor uitgaande berichtstromen. Om deze client certificaten te beheren, klikt u in het menu, bovenin het scherm, op ‘Digikoppeling’ en vervolgens op ‘Certificaten beheren’.
Pagina 27 van 39
| Digikoppeling Gateway 2.0 Gebruikershandleiding | 6 januari 2010
Figuur 4 f Menu Certificaten beheren Het volgende scherm verschijnt:
Figuur 4 g Overzicht certificaten In dit scherm kunt u certificaten: 1. Toevoegen. 2. Bewerken. Pagina 28 van 39
| Digikoppeling Gateway 2.0 Gebruikershandleiding | 6 januari 2010
3. Verwijderen. Klik hiervoor op de respectievelijke links achter de certificaatgegevens. Wordt een certificaat voor een berichtstroom gebruikt, dan kunt u dit certificaat niet verwijderen. Wel kunt u een nieuw certificaat koppelen aan deze berichtenstroom. Inactieve certificaten herkent u aan het zwarte pictogram. 5.2.5.1
Nieuw certificaat U kunt ook nieuwe (PKCS12-)certificaten toevoegen.
Figuur 4 h Nieuw certificaat toevoegen Vul alias, bestand en wachtwoord voor het nieuwe certificaat in en klik op ‘Toevoegen’. Het certificaatbestand wordt geüpload. 5.3
Beheer
5.3.1
Adapters beheren De gateway is beschikbaar via ebMS, WUS, WUS-lite en JMS. Deze vier koppelvlakken worden in de gateway geïmplementeerd via apart te configureren ‘adapters’. U leest hierna hoe u deze adapters beheert. Om een adapter te beheren, klikt u in het menu, boven in het scherm, op ‘Beheer’ en vervolgens op ‘Adapters beheren’.
Pagina 29 van 39
| Digikoppeling Gateway 2.0 Gebruikershandleiding | 6 januari 2010
Figuur 3 a Menu Adapters beheren Het volgende scherm verschijnt:
Figuur 3 b Overzicht adapters In dit scherm kunt u adapters: • Aanzetten Klik op ‘Starten’ om de betreffende adapter aan te zetten. • Uitzetten Klik op ‘Stoppen’ om de betreffende adapter uit te zetten. Communicatie via deze adapter is dan niet meer mogelijk. • Herstarten Klik op ‘Herstarten’ om de betreffende adapter te herstarten. • Deregistreren Klik op het pictogram ‘Deregistreren’ om de betreffende adapter uit te schakelen in het systeem. Hiermee wordt het protocol dat de adapter implementeert niet meer getoond bij onder andere contracttransformaties. U moet een adapter eerst stoppen voordat u hem kunt deregistreren. 5.3.2
Adapter instellingen inzien Om de instellingen van adapters te verifiëren, klikt u in het menu, bovenin het scherm, op ‘Beheer’ en vervolgens op ‘Adapter instellingen’.
Pagina 30 van 39
| Digikoppeling Gateway 2.0 Gebruikershandleiding | 6 januari 2010
Figuur 3 c Menu Adapterinstellingen Kies in het scherm dat verschijnt een protocol:
Figuur 3 d Protocol kiezen Klik op ‘Bekijken’ om de adapterinstellingen van het betreffende protocol te bekijken. Het volgende scherm verschijnt:
Figuur 3 e Adapterinstellingen Kies eventueel een ander protocol en klik op ‘Bekijken’ om de instellingen van een andere adapter te bekijken. 5.3.3
Notificatie instellingen beheren Verschillende beheerders kunnen notificaties ontvangen van (openstaande) fouten en incidenten. U bepaalt zelf welke beheerders dit Pagina 31 van 39
| Digikoppeling Gateway 2.0 Gebruikershandleiding | 6 januari 2010
zijn. Klik om beheerders toe te voegen in het menu, bovenin het scherm, op ‘Beheer’ en vervolgens ‘Notificatie instellingen beheren’. De configuratie van de mailserver gegevens staat beschreven in het hoofdstuk Configuratie.
Figuur 7 x Menu Notificatie-instellingen beheren Het volgende scherm verschijnt:
Figuur 7 y Notificatie-instellingen: e-mailadressen toevoegen Vul de e-mailadressen in van de beheerders die notificaties van berichten willen/moeten ontvangen. Scheid verschillende adressen met een komma [,]. Klik als u klaar bent op ‘Opslaan’. 5.3.4
Gebruikers beheren U kunt als beheerder verschillende gebruikers — andere beheerders van de gateway —aanmaken, bewerken en verwijderen. Klik om naar gebruikersbeheer te gaan in het menu, bovenin het scherm, op ‘Beheer’ en vervolgens op ‘Gebruikers beheren’. Pagina 32 van 39
| Digikoppeling Gateway 2.0 Gebruikershandleiding | 6 januari 2010
Figuur 7 ff Menu Gebruikers beheren 5.3.4.1
Aanmaken Klik om een gebruiker aan te maken op het pictogram met het blauwe figuurtje.
Figuur 7 gg Pictogram om nieuwe gebruiker aan te maken Het volgende scherm verschijnt:
Figuur 7 hh Een nieuwe gebruiker aanmaken Vul de verschillende gegevens in: Pagina 33 van 39
| Digikoppeling Gateway 2.0 Gebruikershandleiding | 6 januari 2010
• Gebruikersnaam, hiermee logt de nieuwe beheerder in. • Naam — voor- en achternaam. • E-mailadres. • Wachtwoord — twee maal, één maal ter bevestiging. Kies vervolgens welke rol(len) de nieuwe gebruiker heeft door ze van het rechter vak naar het linker te verplaatsen (of terug) met de pijl(en) tussen de vakken. Klik op ‘Opslaan’ om de nieuwe gebruiker op te slaan. 5.3.4.2
Rollen Rol
Bevoegdheden
Functioneel beheer
Digikoppeling specificities importeren Adapterinstellingen Incidenten ontvangen en bekijken Berichten bekijken Digikoppeling Services beheren
Technisch beheer
Adapterinstellingen Adapters starten, stoppen en deregistreren Incidenten ontvangen en bekijken Logbestanden bekijken Berichten bekijken Digikoppeling Services beheren Notificatie-instellingen
Admin
5.3.4.3
Gebruikers aanmaken, wijzigen en verwijderen
Bewerken Klik om een gebruiker te bewerken in het menu op ‘Beheer’ en ‘Gebruikers beheren’, waarna u klikt op het mapje ‘Gebruikers’.
Figuur 7 ii Pictogram om gebruiker te beheren Vervolgens verschijnt een overzicht met gebruikers. Klik op één van de gebruikers om die te bewerken. Het volgende scherm verschijnt:
Pagina 34 van 39
| Digikoppeling Gateway 2.0 Gebruikershandleiding | 6 januari 2010
Figuur 7 jj Gebruiker bewerken Wijzig de betreffende gegevens en klik op ‘Opslaan’ om de wijzigingen op te slaan. 5.3.4.4
Verwijderen Om een gebruiker te verwijderen, herhaalt u de stappen uit hoofdstuk 7.5.2, maar nu klikt u onderaan het scherm op ‘Gebruiker verwijderen’. Er verschijnt een bevestigingsscherm:
Figuur 7 kk Bevestiging gebruiker verwijderen Klik op ‘Verwijderen’ om de gebruiker definitief te verwijderen of op ‘Annuleren’ om terug te gaan naar het vorige scherm. 5.4
Monitoring
5.4.1
Berichten inzien Kies om berichten te bekijken eerst een bron- en doelprotocol en een datumbereik. Klik vervolgens op ‘Zoeken’.
Pagina 35 van 39
| Digikoppeling Gateway 2.0 Gebruikershandleiding | 6 januari 2010
Figuur 7 dd Berichten bekijken Het volgende scherm verschijnt:
Figuur 7 ee Berichtenoverzicht Houd uw muis over het berichtnummer, links, voor meer informatie over het bericht. Klik onderaan het overzicht op de pijltjes [»»] of paginanummers [2] voor meer berichten. In de kolom ‘Status’ kunnen de volgende statussen voorkomen: Status
Omschrijving
New
Een nieuw bericht is door Digikoppeling ontvangen, maar nog niet doorgestuurd.
Send
Het bericht is door Digikoppeling ontvangen en doorgestuurd.
Process error
Er is iets fout gegaan. Via de functies Incidenten inzien en Logbestanden inzien van het dashboard kan de oorzaak van de fout worden achterhaald.
5.4.2
Logbestanden inzien Kies om logbestanden te bekijken eerst een groep en eventueel een datum. Klik vervolgens op ‘Logbestand bekijken’.
Figuur 7 bb Logbestanden inzien: groep kiezen
Pagina 36 van 39
| Digikoppeling Gateway 2.0 Gebruikershandleiding | 6 januari 2010
Het volgende scherm verschijnt:
Figuur 7 cc Gedetailleerd logbestand Klik om het gedetailleerde logbestand te downloaden op ‘Logbestand downloaden’. 5.4.3
Incidenten inzien Via het menu Beheer>Notificatie instellingen beheren kunnen emailadressen door komma's gesepareerd opgegeven worden. Naar de opgegeven adressen worden periodiek alle in de gateway openstaande notificaties gestuurd.
5.4.4
Inzien & Verwijderen Via het menu Monitoring>Incidenten inzien kunnen alle in de gateway openstaande notificaties worden weergegeven. Deze worden periodiek verstuurd naar de door u ingestelde e-mailadressen. Het instellen van de e-mailadressen staat beschreven in paragraaf Notificatie instellingen beheren. LET OP! De notificatie die op dit scherm openstaan worden altijd verzonden naar de opgegeven e-mailadressen, ook als ze al eens eerder zijn verzonden. Het is daarom aan te bevelen om, zodra er actie op een notificatie is ondernomen, deze te verwijderen uit het incidenten scherm. Via het kruisje achter een notificatie kan de betreffende notificatie worden verwijderd. De details van een notificatie kunnen worden geraadpleegd door op de link van het component waarin het incident is opgetreden te klikken.
Pagina 37 van 39
| Digikoppeling Gateway 2.0 Gebruikershandleiding | 6 januari 2010
5.5
Hermes 2 Corvus Dashboard
5.5.1
Startscherm De ebMS adapter van de gateway heeft een eigen dashboard. Hierin kan de status van alle ebMS berichten die door de gateway zijn verstuurd worden gevolgd. Dit dashboard is beschikbaar op het volgende adres: http://:/corvus/admin/home U moet inloggen om de Corvus Dashboard te gebruiken. Het inlogscherm verschijnt automatisch als u naar bovenstaande locatie gaat.
Figuur 7 s Het inlogscherm Vul uw accountgegevens (default user name en wachtwoord zijn respectievelijk ‘osb’ en ‘password’) in en klik op ‘Log in’. U ziet het startscherm.
Pagina 38 van 39
| Digikoppeling Gateway 2.0 Gebruikershandleiding | 6 januari 2010
5.5.2
Message History Message history toont een overzicht van de verzonden en ontvangen ebMS berichten. Default worden alle berichten getoond. Door middel van gebruik van de velden bovenaan het scherm kunnen de berichten gefilterd worden.
Pagina 39 van 39