BHB MOA-ZS. Benutzerhandbuch. Dokumentinformation. Benutzerhandbuch BHB MOA-ZS. Handbuch

Transkript

1 1 2 BHB MOA-ZS 3 Benutzerhandbuch 4 Dokumentinformation Bezeichnung Kurzbezeichnung Benutzerhandbuch BHB MOA-ZS Version 0.4 Datum Dokumentenklasse Handbuch Dokumentenstadium Interner Entwurf Kurzbeschreibung Autoren Arbeitsgruppe Dieses Dokument beschreibt die Web Oberfläche von MOA-ZS. Diese Oberfläche dient dem Testen der Anwendung. Anatol Heinrich, Rainer Treutlein, Andreas Erlacher Anatol Heinrich, Nikolaus Gradwohl, Rainer Treutlein, Andreas Erlacher

2 Inhalt Dokumentinformation...1 Inhalt Einleitung Anwender Änderungen zu vorhergehenden Versionen Struktur des Dokumentes Arbeiten mit der MOA-ZS Testanwendung Funktionen der MOA-ZS Testanwendung Absender Empfänger Metadaten XML Dokument Anhang Anforderung senden Häufig gestellte Fragen FAQs Fehlermeldungen...27 Referenzen...28 Historie Anhang Begriffe und Abkürzungen Tabellenverzeichnis Abbildungsverzeichnis BHB MOA-ZS Seite 2/31

3 Einleitung Das vorliegende Benutzerhandbuch beschreibt die Benutzung der Testoberfläche zu MOA-ZS. Das Dokument liefert einen Überblick über die verschiedenen Funktionen, die Benutzerführung und die Einsatzmöglichkeiten. Das Handbuch gilt bis zur Auslieferung einer neuen Version der Anwendung. 1.1 Anwender Die Zielgruppen dieses Benutzerhandbuches sind alle Personen, die zu Testzwecken elektronische Informationen mittels MOA-ZS versenden wollen. 1.2 Änderungen zu vorhergehenden Versionen Dieses Handbuch beschreibt die erste Release der Testoberfläche. Es gibt daher keine Änderungen zu vorhergehenden Versionen. 1.3 Struktur des Dokumentes Nach einer kurzen Einleitung mit allgemeinen Informationen wird die Testanwendung anhand grundlegender Eigenschaften und der einzelnen Seiten beschrieben. Seite Kapitel Referenz JSP Hauptseite 2 Arbeiten mit der MOA-ZS Testanwendung moazs_start.jsp Erfassung der Absenderdaten 3.1 Absender moazs_sender.jsp Erfassung der Empfängerdaten 3.2 Empfänger moazs_receiver.jsp Erfassung der Metadaten 3.3 Metadaten moazs_meta.jsp Erfassung der Daten des XML- Dokuments 3.4 XML Dokument moazs_xmldoc.jsp Erfassung der Anhänge 3.5 Anhang moazs_payload.jsp Senden der Anforderung 3.6 Anforderung senden moazs_send.jsp Tabelle 1-1 Web Seiten der Anwendung und zugehörige Kapitel BHB MOA-ZS Seite 3/31

4 Arbeiten mit der MOA-ZS Testanwendung Die MOA-ZS Testanwendung dient der Versendung elektronischer Informationen. Die Startseite wird mit der entsprechend vom Administrator definierten Internetadresse (URL) aufgerufen Abbildung 2-1 Startseite der Testanwendung Es können folgende Einstellungen mittels Angaben der entsprechenden Daten verändert werden: Absender Empfänger Metadaten XML Dokument Anhang Die Anforderung kann mit den getroffenen Einstellungen mittels dem Link <Anforderung absenden> an MOA-ZS gesendet werden. Alle Daten können mittels dem Link <Eingegebene Daten löschen> zurückgesetzt werden BHB MOA-ZS Seite 4/31

5 63 64 Damit die eingegebenen Daten ordnungsgemäß übernommen werden, wurde bewusst auf eine Menüführung auf den Folgeseiten verzichtet Abbildung 2-2 Beispiel für Schaltflächen Mittels der Schaltfläche <Übernehmen> gelangt der Benutzer wieder zu Startseite und die getroffenen Einstellungen werden für die weitere Verarbeitung übernommen. Mittels der Schaltfläche <Abbrechen> gelangt der Benutzer wieder zu Startseite und die getroffenen Einstellungen werden nicht übernommen. Diese Funktion ist äquivalent zur Aktion <Back> des Browserfensters. Mittels der Schaltfläche <Zurücksetzen> werden alle Eingabefelder geleert bzw. Auswahlfelder nehmen ihren Standardwert an. Dieses Verhalten ist für alle Folgeseiten der Startseite identisch. Bei Dialogen zur Auswahl von Dateien (Eingabefeld mit Schaltfläche <Durchsuchen>) ist zu beachten, dass die Pfad- und Dateiangaben korrekt sein müssen, ansonsten kann keine Übernahme erfolgen und das Betätigen der Schaltfläche <Übernehmen> auf der entsprechenden Seite bewirkt keine Aktion. Dies ist eine Restriktion der Browser. Die Anwendung kann nicht bereits erfasste Datei- und Pfadangaben bei Wiederaufruf der entsprechenden Seite automatisch in die dafür vorgesehenen Felder eintragen (vorbefüllen). Dies wird von modernen Browsern aus Sicherheitsgründen nicht mehr unterstützt BHB MOA-ZS Seite 5/31

6 Funktionen der MOA-ZS Testanwendung In diesem Kapitel werden alle Navigationsmöglichkeiten der Anwendung detailliert beschrieben. 3.1 Absender Die Seite wird mittels dem Link <Absender> der Startseite aufgerufen. Es können die Daten des Absenders festgelegt werden Abbildung 3-1 Erfassungsmaske für die Absenderdaten Folgende Felder können befüllt werden: Nr Feldname Zweck, Bedeutung 1 Absenderprofil Die Identifikationsnummer vordefinierter Absenderdaten. Kann mittels der Administrationsoberfläche (Referenz[1]) erstellt werden. 2 Schlüsselname MOA-SS Name des Schlüssels zur Signatur, der von MOA-SS verwendet wird Tabelle 3-1 Felder der Erfassungsmaske für Absenderdaten Die getroffenen Einstellungen werden mittels der Schaltfläche <Übernehmen> übernommen. Der Benutzer gelangt wieder zur Startseite BHB MOA-ZS Seite 6/31

7 Empfänger Die Seite wird mittels dem Link <Empfänger> der Startseite aufgerufen. Es können die Daten des Empfängers festgelegt werden Abbildung 3-2 Erfassungsmaske für die Empfängerdaten Es können verschiedene Daten entsprechend der Art des Empfängers erfasst werden: Natürliche Person Juristische Person Diese Einstellungen sind entweder-oder; wenn beide Personen vollständig angegeben werden, so wird die juristische Person verworfen. Die Eingabefelder für die natürliche Person sind: Nr Feldname Zweck, Bedeutung 1 Vorname Vorname des Empfängers 2 Nachname Nachname des Empfängers 3 Geburtsdatum Geburtsdatum des Empfängers Tabelle 3-2 Felder der Erfassungsmaske für Empfängerdaten / natürliche Person BHB MOA-ZS Seite 7/31

8 Die Eingabefelder für die juristische Person sind: Nr Feldname Zweck, Bedeutung 1 Firmenname Name des Empfängers 2 Organisation Organisation des Empfängers Tabelle 3-3 Felder der Erfassungsmaske für Empfängerdaten / juristische Person Durch Betätigen des Links <Adresse hinzufügen> wird die Erfassungsmaske für die Adresse geöffnet Abbildung 3-3 Erfassungsmaske für die Adresse des Empfängers Die Eingabefelder für die Adresse sind: Nr Feldname Zweck, Bedeutung 1 Straße Vollständiger Straßenname 2 Hausnummer Nummer der Liegenschaft 3 PLZ Postleitzahl, numerisch 4 Ort Name des Ortes Tabelle 3-4 Felder der Erfassungsmaske für Adresse des Empfängers BHB MOA-ZS Seite 8/31

9 121 Falls nicht alle Felder ausgefüllt werden, wird eine entsprechende Fehlermeldung angezeigt Abbildung 3-4 Fehlermeldung bei unvollständiger Adresse nach Übernahmeversuch Diese Überprüfung findet für alle Eingabefelder bei der Betätigung der Schaltfläche <Übernehmen> statt. Bei der Schaltfläche <Abbrechen> entfällt diese Prüfung BHB MOA-ZS Seite 9/31

10 Mittels der Schaltfläche <Übernehmen> gelangt der Benutzer wieder auf die Seite zur Eingabe der Empfängerdaten Abbildung 3-5 Erfassungsmaske für Empfänger mit Adresse Die eingegebene Adresse wird angezeigt und kann mittels der darunter befindlichen Aktion <entfernen> wieder gelöscht werden BHB MOA-ZS Seite 10/31

11 Durch Betätigen des Links < -Adresse hinzufügen> wird die Erfassungsmaske für die Adresse geöffnet Abbildung 3-6 Erfassungsmaske für die des Empfängers Die Eingabefelder für die adresse sind: Nr Feldname Zweck, Bedeutung 1 Vollständiger adresse Tabelle 3-5 Felder der Erfassungsmaske für des Empfängers Dieses Eingabefeld wird auch bei Übernahme auf Befüllung geprüft BHB MOA-ZS Seite 11/31

12 Mittels der Schaltfläche <Übernehmen> gelangt der Benutzer wieder auf die Seite zur Eingabe der Empfängerdaten Abbildung 3-7 Erfassungsmaske für Empfänger mit adresse Die eingegebene adresse wird angezeigt und kann mittels der darunter befindlichen Aktion <entfernen> wieder gelöscht werden BHB MOA-ZS Seite 12/31

13 Durch Betätigen des Links <Telefonnummer hinzufügen> wird die Erfassungsmaske für die Adresse geöffnet Abbildung 3-8 Erfassungsmaske für die Telefonnummer des Empfängers Die Eingabefelder für die adresse sind: Nr Feldname Zweck, Bedeutung 1 Telefon Vollständiger Telefonnummer Tabelle 3-6 Felder der Erfassungsmaske für die Telefonnummer des Empfängers Dieses Eingabefeld wird auch bei Übernahme auf Befüllung geprüft BHB MOA-ZS Seite 13/31

14 Mittels der Schaltfläche <Übernehmen> gelangt der Benutzer wieder auf die Seite zur Eingabe der Empfängerdaten Abbildung 3-9 Erfassungsmaske für Empfänger mit Telefonnummer Die eingegebene Telefonnummer wird angezeigt und kann mittels der darunter befindlichen Aktion <entfernen> wieder gelöscht werden. Sind alle Einstellungen getroffen worden, kann mit einer der <Übernehmen> Schaltflächen wieder auf die Startseite zurückgekehrt werden BHB MOA-ZS Seite 14/31

15 Metadaten Die Seite wird mittels dem Link <Metadaten> der Startseite aufgerufen. Es können die Metadaten festgelegt werden Abbildung 3-10 Erfassungsmaske für die Metadaten Die Eingabe- bzw. Auswahlfelder sind: Nr Feldname Zweck, Bedeutung 1 Absenderkennung des Zustellstücks Eindeutige Kennung, die von der Absenderapplikation vergeben wird, um das Zustellstück eindeutig zu identifizieren. 2 Übertragung als RSa Gibt an, ob eine RSa-Zustellung erfolgen soll. Standardeinstellung: deaktiviert (nein) 3 Verschlüsselung notwendig Gibt an, ob für die Zustellung eine Verschlüsselung notwendig ist. Standardeinstellung: deaktiviert (nein) Tabelle 3-7 Felder der Erfassungsmaske für die Metadaten Sind alle Einstellungen getroffen worden, kann mit der Schaltfläche <Übernehmen> wieder auf die Startseite zurückgekehrt werden BHB MOA-ZS Seite 15/31

16 XML Dokument Die Seite wird mittels dem Link <XML Dokument> der Startseite aufgerufen. Es können die Daten für das zu versendende XML-Dokument festgelegt werden Abbildung 3-11 Erfassungsmaske für das XML Dokument Die Blöcke XML Profil XML Metadaten sind exklusiv-oder; d.h. es wird nur eine als Einstellung herangezogen. Werden beide ausgefüllt, so wird vom System der Block XML Profil herangezogen BHB MOA-ZS Seite 16/31

17 Die Eingabefelder sind: Nr Feldname Zweck, Bedeutung 1 XML-Datei Zu versendende XML-Datei. Durch Betätigen der Schaltfläche <Durchsuchen> kann eine Datei von einem lokalen Verzeichnis angegeben werden. 2 Profilname Es kann ein gespeichertes Profil aufgerufen werden. Dieses muss zuvor mittels der Administrationsoberfläche angelegt worden sein; dabei wurde es in der XML-Konfigurationsdatei von MOA-ZS abgelegt. 3 Dateiname Name der Datei am Client 4 MIME Typ MIME Typ vom Dokument selbst 5 MIME Typ der Vorschau MIME Typ vom Dokument in der Vorschau 6 XSLT zur Signaturerstellung Stylesheet für etwaige Transformationen vor der Bearbeitung der Embedded Signature. Durch Betätigen der Schaltfläche <Durchsuchen> kann eine Datei von einem lokalen Verzeichnis angegeben werden. 7 Elternknoten der Signatur Definiert den Elternknoten der Embedded Signature im XML-Dokument. 8 Position der Signatur (Index) Definiert die Position als Index aller Kindknoten des Elternknoten. 9 XSLT zur Vorschauerstellung Durch Betätigen der Schaltfläche <Durchsuchen> kann eine Datei von einem lokalen Verzeichnis angegeben werden. 10 Name des Vorschau-XSLT XSLT zur Erstellung der Vorschau Tabelle 3-8 Felder der Erfassungsmaske für das XML Dokument Sind alle Einstellungen getroffen worden, kann mit der Schaltfläche <Übernehmen> wieder auf die Startseite zurückgekehrt werden BHB MOA-ZS Seite 17/31

18 Die getroffenen Einstellungen sind nach nochmaliger Betätigung des Links <XML Dokument> in der Eingabemaske ersichtlich Abbildung 3-12 Wiederbefüllte Erfassungsmaske für das XML Dokument mit zuvor übernommenen Daten BHB MOA-ZS Seite 18/31

19 Anhang Die Seite wird mittels dem Link <Anhang> der Startseite aufgerufen. Es können mehrere zu versendende Anhänge festgelegt werden Abbildung 3-13 Erfassungsmaske für Anhänge Mittels der Aktion <Binäres Dokument hinzufügen> kann ein binäres Dokument hinzugefügt werden Abbildung 3-14 Erfassungsmaske für ein binäres Dokument Die Datei muss am Client physikalisch vorhanden sein, ansonsten wird die Übernahme vom System nicht akzeptiert BHB MOA-ZS Seite 19/31

20 Die Eingabefelder sind: Nr Feldname Zweck, Bedeutung 1 Datei Anzuhängende binäre Datei. Durch Betätigen der Schaltfläche <Durchsuchen> kann eine Datei von einem lokalen Verzeichnis angegeben werden. 2 Dateiname Name der Datei am Client 3 MIME Typ MIME Typ vom Dokument selbst Tabelle 3-9 Felder der Erfassungsmaske für einen binären Anhang Mittels der Schaltfläche <Übernehmen> gelangt der Benutzer wieder auf die Seite zur Eingabe der Anhänge Abbildung 3-15 Erfassungsmaske für Anhänge mit binärem Dokument Der definierte Anhang wird angezeigt und kann mittels der daneben befindlichen Aktion <entfernen> wieder gelöscht werden BHB MOA-ZS Seite 20/31

21 Mittels der Aktion <Dokumentenreferenz hinzufügen> kann ein mittels Internetadresse (URL) referenziertes Dokument hinzugefügt werden Abbildung 3-16 Erfassungsmaske für eine Referenz Die Eingabefelder sind: Nr Feldname Zweck, Bedeutung 1 Datei Anzuhängende binäre Datei. Durch Betätigen der Schaltfläche <Durchsuchen> kann eine Datei von einem lokalen Verzeichnis angegeben werden. 2 Dateiname Name der Datei am Client 3 MIME Typ MIME Typ vom Dokument selbst 4 MD5 Prüfsumme Die Prüfsumme zum Dokument im MD5-Format Tabelle 3-10 Felder der Erfassungsmaske für einen binären Anhang BHB MOA-ZS Seite 21/31

22 Mittels der Schaltfläche <Übernehmen> gelangt der Benutzer wieder auf die Seite zur Eingabe der Anhänge Abbildung 3-17 Erfassungsmaske für Anhänge mit binärem Dokument und Referenz Der definierte Anhang wird angezeigt und kann mittels der daneben befindlichen Aktion <entfernen> wieder gelöscht werden. Sind alle Einstellungen getroffen worden, kann mit der Schaltfläche <Übernehmen> wieder auf die Startseite zurückgekehrt werden BHB MOA-ZS Seite 22/31

23 Anforderung senden Wird auf der Startseite der Link <Anforderung senden> aufgerufen, werden alle getätigten Einstellungen nochmals angezeigt Abbildung 3-18 Verifikation der Einstellungen (Angabe eines XML-Dokuments mit Profil) BHB MOA-ZS Seite 23/31

24 Die Verifikationsmaske ist bei Angabe eines XML-Dokumentes ohne Profil etwas umfangreicher Abbildung 3-19 Verifikation der Einstellungen (Angabe eines XML-Dokumentes ohne Profil) Diese Anforderung kann nach Verifikation mittels <Absenden> an MOA-ZS gesendet werden. Durch die Schaltfläche <Abbrechen> gelangt der Benutzer zur Startseite BHB MOA-ZS Seite 24/31

25 Konnte die Anforderung erfolgreich an MOA-ZS übermittelt werden, wird eine entsprechende Meldung angezeigt Abbildung 3-20 Erfolgreiche Anforderungsübertragung Im Fehlerfall wird der Fehlercode und -text angeführt Abbildung 3-21 Fehler bei Anforderungsübertragung BHB MOA-ZS Seite 25/31

26 Häufig gestellte Fragen FAQs Nr Frage 1 Ich habe auf der Seite zur Eingabe der Einstellungen für das XML-Dokument die Felder XML Datei und Profilname ausgefüllt und <Übernehmen> gedrückt. Nichts ist passiert, die Seite wird nach wie vor angezeigt Warum? 2 Ich habe auf der Seite zur Eingabe der Einstellungen für das XML-Dokument alle Felder ausgefüllt und <Übernehmen> gedrückt. Wenn ich nun auf der Startseite den Link <XML Dokument> betätige, sehe ich keine Werte in den Feldern zum Hochladen von Dateien. 3 Ich habe auf der Seite zur Eingabe der Absenderdaten eine natürliche und juristische Person angegeben. Es werden aber nur die Daten der natürlichen Person verwendet. 4 Ich habe auf der Seite zur Eingabe der Einstellungen für das XML-Dokument die Daten in alle Felder eingetragen. Auf der Seite zur Verifikation der Einstellungen vor Absenden wird aber nur das XML Profil angezeigt. Antwort Wenn im Feld XML Datei ein Pfad mit Datei angeben ist, die ungültig sind, kann dies nicht übernommen werden. Dies ist eine Restriktion der Browser (Referenz[2]). Die Anwendung kann nicht bereits erfasste Datei- und Pfadangaben bei Wiederaufruf der entsprechenden Seite automatisch in die dafür vorgesehenen Felder eintragen (vorbefüllen). Dies wird von modernen Browsern aus Sicherheitsgründen nicht mehr unterstützt (Referenz[2]). Diese Einstellungen sind entweder-oder; wenn beide Personen vollständig angegeben werden, so wird die juristische Person verworfen. Die Blöcke XML Profil XML Metadaten sind entweder-oder; d.h. es wird nur eine als Einstellung herangezogen. Werden beide ausgefüllt, so wird vom System der Block XML Profil herangezogen. 263 Tabelle 4-1 FAQ BHB MOA-ZS Seite 26/31

27 Fehlermeldungen Nr Fehlermeldung Bedeutung 404 Kann MOA-ZS Server nicht kontaktieren Verbindungsaufbau zu MOA-ZS Server ist fehlgeschlagen 265 Tabelle 5-1 Fehlermeldungen BHB MOA-ZS Seite 27/31

28 Referenzen Administratorhandbuch [1] AHB-Administrationshandbuch_MOA-ZS.doc Informationen zu HTML [2] BHB MOA-ZS Seite 28/31

29 274 Historie Version 0.1 Ersteller Erlacher Version 0.2 Ersteller Erlacher Version 0.3 Datum Datum Datum Kommentar Erstellung Kommentar Erweiterung Kommentar Review Ersteller Heinrich, Treutlein Version 0.4 Ersteller Erlacher Datum Kommentar Einarbeitung Reviewergebnisse BHB MOA-ZS Seite 29/31

30 Anhang Begriffe und Abkürzungen Begriff, Abkürzung MD5 MIME MOA-SS MOA-ZS XML XSLT Beschreibung Message Digest 5 (Algorithm) Multipurpose Internet Mail Extensions MOA Signaturservice MOA Zustellservice Extendible Markup Language Extendible Stylesheet Language Transformation 278 Tabelle 6-1 Begriffe und Abkürzungen Tabellenverzeichnis Tabelle 1-1 Web Seiten der Anwendung und zugehörige Kapitel... 3 Tabelle 3-1 Felder der Erfassungsmaske für Absenderdaten... 6 Tabelle 3-2 Felder der Erfassungsmaske für Empfängerdaten / natürliche Person... 7 Tabelle 3-3 Felder der Erfassungsmaske für Empfängerdaten / juristische Person... 8 Tabelle 3-4 Felder der Erfassungsmaske für Adresse des Empfängers... 8 Tabelle 3-5 Felder der Erfassungsmaske für des Empfängers Tabelle 3-6 Felder der Erfassungsmaske für die Telefonnummer des Empfängers Tabelle 3-7 Felder der Erfassungsmaske für die Metadaten Tabelle 3-8 Felder der Erfassungsmaske für das XML Dokument Tabelle 3-9 Felder der Erfassungsmaske für einen binären Anhang Tabelle 3-10 Felder der Erfassungsmaske für einen binären Anhang Tabelle 4-1 FAQ Tabelle 5-1 Fehlermeldungen Tabelle 6-1 Begriffe und Abkürzungen Abbildungsverzeichnis Abbildung 2-1 Startseite der Testanwendung... 4 Abbildung 2-2 Beispiel für Schaltflächen... 5 Abbildung 3-1 Erfassungsmaske für die Absenderdaten... 6 Abbildung 3-2 Erfassungsmaske für die Empfängerdaten... 7 Abbildung 3-3 Erfassungsmaske für die Adresse des Empfängers... 8 Abbildung 3-4 Fehlermeldung bei unvollständiger Adresse nach Übernahmeversuch... 9 Abbildung 3-5 Erfassungsmaske für Empfänger mit Adresse Abbildung 3-6 Erfassungsmaske für die des Empfängers Abbildung 3-7 Erfassungsmaske für Empfänger mit adresse Abbildung 3-8 Erfassungsmaske für die Telefonnummer des Empfängers Abbildung 3-9 Erfassungsmaske für Empfänger mit Telefonnummer Abbildung 3-10 Erfassungsmaske für die Metadaten Abbildung 3-11 Erfassungsmaske für das XML Dokument Abbildung 3-12 Wiederbefüllte Erfassungsmaske für das XML Dokument mit zuvor übernommenen Daten BHB MOA-ZS Seite 30/31

31 Abbildung 3-13 Erfassungsmaske für Anhänge Abbildung 3-14 Erfassungsmaske für ein binäres Dokument Abbildung 3-15 Erfassungsmaske für Anhänge mit binärem Dokument Abbildung 3-16 Erfassungsmaske für eine Referenz Abbildung 3-17 Erfassungsmaske für Anhänge mit binärem Dokument und Referenz Abbildung 3-18 Verifikation der Einstellungen (Angabe eines XML-Dokuments mit Profil) Abbildung 3-19 Verifikation der Einstellungen (Angabe eines XML-Dokumentes ohne Profil) Abbildung 3-20 Erfolgreiche Anforderungsübertragung Abbildung 3-21 Fehler bei Anforderungsübertragung BHB MOA-ZS Seite 31/31