In-Export von CSV-Dateien
In-Export von CSV-Dateien über Website mit Datenkbank und Dokumentgenerierung
1. Inhaltsverzeichnis
1. Inhaltsverzeichnis 2
2. Anforderung 3
2.1. Grundlage 3
2.1.1. Kurzübersicht 3
2.1.2. Übersicht 3
2.2. Zielsetzung 4
2.3. Beschreibung der Anforderung 4
2.3.1. Bestellprozess 4
2.3.2. Logistikprozess-Bestellungen 5
2.3.3. Logistikprozess-Sendungsverfolgung 6
2.3.4. Logistikprozess-Retouren 6
2.3.5. Abrechnungsprozess / Dokumentenerstellung 7
2.4. Prozessablauf 8
2.4.1. Bestellprozess 8
2.4.2. Dokumentenprozess 8
2.5. Anforderungsglossar (Begriffsklärung) 9
3. Umsetzung 10
3.1. Voraussetzungen 10
3.1.1. Technische Voraussetzungen 10
3.1.2. Organisatorische Voraussetzungen 10
3.2. Beschreibung 10
3.2.1. Oberfläche 10
3.2.2. Grafik 11
2. Anforderung
2.1. Grundlage
2.1.1. Kurzübersicht
– Datenabruf / Webschnittstelle über HTTPS
– In- und Export von CSV-Dateien über die Webschnittstelle
– Erstellung einer MySQL Datenbank zum Speichern
– Erstellung eines Webinterfaces zum Suchen und abrufen
– Generierung von CSV Dateien
– Generierung von Dokumenten in Abhängigkeiten der gespeicherten Daten auf der Datenbank
– Kurzes Zeitfenster – deadline 1.12.2018
2.1.2. Übersicht
Das vorliegende Pflichtenheft basiert auf teilweise vorgegebenen Anforderungen – siehe Dokument „Technisches Handbuch“
2.2. Zielsetzung
„Tool/Webinterface“ = Gewünschtes Produkt
„Portal“ = dem Auftraggeber zur Verfügung gestelltes Portal
Das Ziel des Projektes soll es sein, dass ein „Tool/Webinterface“ erschaffen wird, in dem .csv Dateien, die von einem uns zur Verfügung gestelltem Portal, importiert, sowie zum Portal exportiert werden können. Dieses Portal steht dem Auftraggeber bereit. Der Im- und Export mancher Prozesse soll automatisch in Zeitintervallen über die bereitgestellte Schnittstelle fungieren. Bedingungen sind in Punkt 2.3 zu finden. Die importierten Datensätze müssen in einer lokalen Datenbank gespeichert werden um später im „Tool/Webinterface“ nach Kunden, Seriennummer Sendungsverfolgungsnummer und anderen Attributen suchen und einsehen zu können. Beim Übermitteln der .csv Dateien an das Portal sollen zudem E-Mails generiert und versendet werden. Eine Übersicht in der wir sehen können, ob E-Mails generiert und versendet wurden wird auch benötigt. Eine weitere Möglichkeit die geschaffen werden muss ist, dass aus dem „Tool/Webinterface“ Dokumente wie Rechnungen und Lieferscheine generiert werden können. Die Dokumente müssen bestimmte Inhalte abbilden die in 2.3 genauer erläutert sind.
Für den Prozess Retouren, genaueres unter 2.3, soll es eine Auswahlmöglichkeit im „Tool/Webinterface“ geben, dass es erlaubt für markierte Datensätze Dokumente zu generieren.
2.3. Beschreibung der Anforderung
2.3.1. Bestellprozess
Dem Auftraggeber steht ein Portal bereit. Siehe technisches Handbuch Anlage Seite 2/10.
Alle .csv Strukturen aus dem Portal sind in der Anlage auf Seite 5-7 erläutert.
Aus diesem Portal werden die Bestellungen als .csv-Datei exportiert.
Hierzu werden dem Auftraggeber zwei Möglichkeiten bereitgestellt. Manueller Abruf oder automatischer Abruf mittels Webinterface (HTTPS) Schnittstelle. Es soll ein automatischer Abruf erfolgen. Alle 10min. Die vom Portal automatisch exportierten Daten sollen in einem „Tool/Webinterface“ importiert und auch dargestellt werden.
Nach erfolgreichem Export der orderTransfer.csv aus dem Portal muss eine orderConfirmation.csv generiert werden, die an das Portal gesendet wird. In dieser orderConfirmation.csv wird bestätigt, dass die einzelnen Bestellungen innerhalb der orderTransfer.csv enthalten sind. Das wird folgend „Quittiert“ genannt. Dieser Prozess soll vollautomatisiert geschehen ohne jegliche Interaktion eines Mitarbeiters. In dem Tool/Webinterface soll erkenntlich sein, ob die Bestellungen „quittiert“ worden sind oder nicht.
2.3.2. Logistikprozess-Bestellungen
Die vorhandenen im Tool/Webinterface quittierten Bestellungen, müssen per .csv, nachdem Sie automatisch quittiert wurden, in ein vom Auftraggeber vordefiniertes Laufwerk abgelegt werden. Diese .csv soll folgende vorgaben im Dateinamen erhalten:
BS + Datum + Uhrzeit mit sekunden.csv
BS + 26.09.2018 + 09:26:14 Uhr
Ergebnis:
BS[OBSCURED]14.csv
Im folgenden Text wird die Datei BS*.csv genannt.
Zusätzlich muss in der generierten „BS*.csv“ für die Logistik ein weiteres Attribut „Gewicht“ hinzugefügt werden. Das Gewicht bezieht sich auf das Attribut „name(Artikeltext/-name) aus der orderTransfer.csv bzw Datenbank. Das Gewicht beträgt für den aktuellen Artikel welches im „name(Artikeltext/-name) angegeben wird 21,42 KG. Für das Attribut „name(Artikeltext/-name) wird der Name vom Auftraggeber mitgeteilt, sobald dieser bekannt ist bzw. dieser in der orderTransfer.csv korrekt mitgegeben wird.
Bedingung für die Generierung der BS*.csv ist, dass im Vorfeld die passenden Lieferscheine generiert, gedruckt und im „Tool/Webinterface“ erkenntlich gemacht werden. Die Generierung der Lieferscheine soll über das Webinterface ermöglicht werden. Eine Vorlage der Lieferscheine wird zur Verfügung gestellt.
Auch hier werden die benötigten dynamischen Felder aus den Informationen der .csv-Dateien / Datenbank entnommen. Es muss die Möglichkeit bestehen alle noch nicht generierten Lieferscheine auf einmal auszudrucken. Im Falle eines nicht korrekten oder gar keinen Ausdruck, muss die Möglichkeit bestehen, einzelne Lieferscheine nach zu drucken. Zudem wird eine ausdruckbare Liste der Lieferscheine benötigt um eine Übersicht zu erhalten.
2.3.3. Logistikprozess-Sendungsverfolgung
Die Logistik vom Auftraggeber exportiert eine Sendungsverfolgungsnummer .csv – Datei, kurz SVN.csv aus einem schon vorhandenen Programm. Eine Beispieldatei steht zur Verfügung.
Diese SVN.csv wird an einem vom Auftraggeber benannten Netzlaufwerk abgelegt.
Die Logistik muss in dem „Tool/Webinterface“ die Möglichkeit haben, diese oben beschriebene und generierte SVN.csv manuell zu importieren, da kein fester Zeitpunkt definiert werden kann um einen Automatismus zu generieren. Sobald die SVN.csv erfolgreich importiert wurde, muss automatisch jeder Kunde aus der SVN.csv eine E-Mail mit angehängtem Dokument „retourenschein.pdf“ erhalten. Eine Vorlage der E-Mail wird als Anlage mitgegeben. Das Dokument „retourenschein.pdf“ muss generiert werden. Die Felder Name, Straße, PLZ, Ort, Artikelname, Bestellnummer, Auftragsdatum und Artikelnummer müssen aus der orderTransfer.csv/Datenbank bezogen werden. Es muss allerdings beachtet werden, dass in der Automatischen E-Mail der korrekte Sendungsverfolgungslink mitgegeben wird.
In der SVN.csv wird die jeweils NUR die korrekte Sendungsverfolgungsnummer mitgegeben und muss gegen SENDUNGSVERFOLGUNGSNUMMER für den Link ersetz werden.
Der passende Sendungsverfolgungslink soll über das „Tool/Webinterface“ passend zum Kunden aufrufbar sein. One Click.
Anschließend muss von dem „Tool/Webinterface“ eine orderDispatched.csv für das Portal generiert werden um den Versand zu bestätigen. Die Vorgaben für die orderDispatched.csv werden im Technisches Handbuch auf Seite 6 unter Punkt 4.3 definiert.
2.3.4. Logistikprozess-Retouren
Es muss eine orderReturned.csv im „Portal“ importiert werden, in der die Retoure protokolliert wird. Siehe Technisches Handbuch Seite 7 Punkt 4.4. Diese orderReturned.csv soll über eine Auswahlmöglichkeit im „Tool/Webinterface“ generiert werden und nach Fertigstellung automatisch versendet werden können. Um eine Fehlsendung zu vermeiden, soll dieser Schritt mit einer extra Bestätigung genehmigt werden.
2.3.5. Abrechnungsprozess / Dokumentenerstellung
Der Auftraggeber wird für mehrere Regionen (30) und je 3 verschiedene Abrechnungen abrechnen. Diese Abrechnungen soll aus dem „Tool/Webinterface“ generiert werden. Vorlagen für die Dokumente sind im Anhang zu finden. Die Adressdaten für Alle Regionen werden beigefügt.
Für die Generierung sind folgende Bedingungen nötig:
– Es muss eine einzelne sowie eine komplette Auswahl der 30 Regionen geben um eine der 3 Abrechnungen zu generieren
o Abrechnung (Rechnung_Vorlage.doc)
o Abrechnung EKP Retouren ( Korrektur EKP_Vorlage.doc )
o Abrechnung VKP Retouren ( Korrektur VKP_Vorlage.doc )
– Zudem müssen 3 flexible Felder, vor der Erstellung der oben genannten Dokumente generiert werden die der Enduser eingeben soll
o Artikelnummer ( Für alle 3 Abrechnungen )
o Leistungszeitraum ( Für Abrechnung )
o EKP in Euro ( Für Abrechnung EKP Retouren )
– Weitere benötigte Attribute für die Dokumente sind im Vorfeld importiert worden. Siehe Anlage Technisches Handbuch.
– Sobald Bestellungen einmal abgerechnet wurden, dürfen diese beim nächsten Abrechnen nicht nochmals verwendet werden.
2.4. Prozessablauf
2.4.1. Bestellprozess
1. Abruf der orderTransfer.csv automatisiert aus dem Portal – Alle 10min
2. Automatisierte Quittierung der Datensätze aus der orderTransfer.csv zum Webportal – orderConfirmation.csv – sofort, spätestens nach 4 Stunden
3. Lieferscheine werden über das „Tool/Webinterface“ gedruckt/erstellt
4. BS*.csv werden in das vorgegebene Verzeichnis exportiert
5. SVN.csv wird ins „Tool/Webinterface“ hochgeladen
6. Kunde erhält die E-Mail mit retourenschein.pdf
7. Das Portal erhält die generierte orderDispatched.csv
2.4.2. Dokumentenprozess
1. Die 30 Rechnungen werden sporadisch generiert, solange müssen alle nicht abgerechneten Bestellungen vorgehalten werden, das kann durch ein Flag in der Datenbank realisiert werden
2. Nachdem abgerechnet wurde und weiterhin neue Bestellungen erzeugt werden, muss eine neuer „Flag“ für die Abrechnung erstellt werden, damit nicht doppelt abgerechnet wird – dasselbe gilt für EKP und VKP.
2.5. Anforderungsglossar (Begriffsklärung)
Tool Webinterface – Programm welches für den Auftraggeber programmiert werden muss
Portal – Ein Webportal welches dem Auftraggeber zur Verfügung gestellt wird um .csv zu importieren/exportieren
EKP = Einkaufspreis
VKP = Verkaufspreis
3. Umsetzung
3.1. Voraussetzungen
Das Projekt muss bis zum 30.11.2018 umgesetzt sein. Eine Testphase muss zum 1.11.2018 beginnen. Eine Verzögerung ist nicht vertretbar, da der Auftraggeber Fristen gegenüber anderen einzuhalten hat. Zum Tag der Inbetriebnahme wird ein Entwickler für die den Auftraggeber vorgehalten um mögliche technische Probleme schnell zu lösen.
3.1.1. Technische Voraussetzungen
Der Auftraggeber stellt die benötigte Hardware und Software bereit. Der Bedarf an Hard & Software wird zwischen Auftragnehmer und Auftraggeber im Vorfeld definiert. Genauso wie die Programmiersprache(n) in der das „Tool/Webinterface“ programmiert wird. Der Auftraggeber stellt dem Auftragnehmer einen Zugang – VPN sowie den E-Mailserver bzw. die benötigten Informationen um E-Mails zu versenden bereit. Das Endprodukt wird vom Auftraggeber gehostet.
Aktuelle Softwareunterstützung:
PHP 7.2
MySQL 5
HTML, CSS, Javascript
Quelloffene Programmierung, Quellcode muss jederzeit anpassbar sein, also: keine Verschlüsselung oder Minifizierung von Quelltexten
Frameworks möglich, unter vorheriger Rücksprache
Javascript unverschlüsselt, Drittbibliotheken dürfen minifiziert vorliegen, bspw. jQuery
3.1.2. Organisatorische Voraussetzungen
Der Auftragnehmer erstellt eine Zusammenfassung benötigter Informationen. Der Auftraggeber ist verpflichtet die Informationen asap zu liefern.
3.2. Beschreibung
3.2.1. Oberfläche
Die Oberfläche soll in einem Webinterface dargestellt werden. Die Oberfläche muss Enduser konform programmiert werden.
1. Seite – Login
Benötigte Eingabeelemente:
Benutzername, Passwort, Loginbutton
2. Seite – Startseite
Allgemeine Bestellübersicht
Suchfunktion mit Ergebnisvorschau und Sendungsverfolgungslink
3. Seite – Übersicht der Bestellungen sowie Quittierten Bestellungen am Tag
4. Seite – Lieferscheine
Generierung der noch nicht erstellten Lieferscheine per button
Generierung der Lieferscheinübersichtsliste per button
Erstellung der BS*.csv per button
5. Seite – In- und Export der SVN.csv
6. Seite – Export der orderDispatched.csv
7. Seite – E-Mail Übersicht (log) Erfolgreich, nicht Erfolgreich
8. Seite – Retourenübermittlung
Suchfunktion + Auswahl für die retoure + button um die orderReturned.csv zu generieren
Für Fragen, kontaktieren Sie mich gerne!