Upload-Modul integrieren

In diesem Topic finden Sie neben der aktuellen Integrationsbeschreibung auch Hinweise zur früheren Version des Upload-Moduls.

Integration

Schritt 1: Freischaltung/Aktivierung und Festlegungen

Setzen Sie sich mit der WEBSALE AG in Verbindung und lassen Sie das Upload-Modul für Ihren Shop freischalten. Teilen Sie in diesem Zusammenhang mit, ob folgende Funktionen gewünscht sind:

Upload von Dateien mit einer Dateigröße über 512 MB

optionale Virenprüfung für jeden Upload

einzelner Abschluss des Daten-Uploads für jede Bestellposition durch den Käufer

Erfragen Sie dabei die Adresse für den SFTP-Bereich, aus dem Sie die Upload-Dateien downloaden können. Testen Sie den Zugriff auf den SFTP-Bereich und legen Sie fest, wo die Upload-Dateien Ihrer Kunden in Ihrem internen System für die weitere Auftragsbearbeitung gespeichert werden sollen.


Hinweis:

Verwenden Sie das WEBSALE Upload-Template der aktuellen Version, wenn Ihre Kunden Dateien von mehr als 512 MB Größe hochladen können sollen. Informieren Sie darüber bitte auch Ihren WEBSALE-Ansprechpartner.
Die aktuelle Version ermöglicht Ihren Kunden außerdem das gleichzeitige Hochladen mehrerer Dateien.

Schritt 2: Upload-Produkte kennzeichnen

Kennzeichnen Sie die Upload-Produkte im WSPManager bzw. in Ihrem Warenwirtschaftssystem.

Nähere Informationen hierzu entnehmen Sie bitte der Schnittstellen-Dokumentation für Produktdaten unter https://doku.websale.de/schnittstellen.

Schritt 3: Abschnitt in der Shopkonfiguration shop.config ergänzen

Fügen Sie in der Shopkonfiguration shop.config folgenden Abschnitt und Parameter ein, falls noch nicht vorhanden:

<Upload> 
   Allow = yes
</Upload> 

Referenz: Abschnitt Upload

Schritt 4: Upload-Konfigurationsdatei anlegen

Legen Sie im Online-Servicebereich im Dienst "Konfigurationen" für den betreffenden Subshop eine neue Konfiguration mit dem Namen wsupload und der Erweiterung config an. Diese Konfiguration ist für Status-und Fehlermeldungen, Upload-Einstellungen sowie die Einträge für eine optionale Dropdown-Liste auf dem Upload-Formular vorgesehen. Außerdem kann hier die Prüfung der MIME-Types der hochgeladenen Dateien konfiguriert werden. Eine Vorlage dieser Upload-Konfiguration mit Beschreibungen der Parameter finden Sie hier:

Referenz: wsupload.config

Setzen Sie den Inhalt per Kopieren und Einfügen in die leere Datei ein, die Sie soeben neu erstellt haben. Speichern und aktivieren Sie die neue Upload-Konfiguration.

Schritt 5: MIME-Type-Prüfung konfigurieren (optional)

Sie können die Prüfung des MIME-Types (auch "Internet Media Type") der hochgeladenen Dateien nach Ihren Vorgaben konfigurieren. Stimmt der MIME-Type nicht mit der Dateiendung überein oder schlägt die Prüfung fehl, so wird die Datei wie ein Virus behandelt und in den Quarantäne-Ordner verschoben bzw. gar nicht erst gespeichert. Im <Settings>-Abschnitt der Upload-Konfiguration wsupload.config können Sie einstellen, ob der Shopkunde im Ablehnungsfall der hochgeladenen Datei eine Fehlermeldung erhält oder nicht.

Beispiel:

<Settings>
    ...
    ShowErrorOnMimeTypeMismatch = yes
    ShowErrorOnVirusDetection   = yes
    ...
</Settings>

Referenz: wsupload.config

Lädt der Kunde eine Datei hoch, deren MIME-Type nicht mit der Dateiendung übereinstimmt, nicht in der Upload-Konfiguration (wsupload.config) in der Liste der akzeptierten Dateien enthalten ist oder Schadsoftware enthält, wird diese

gar nicht gespeichert, wenn der Parameter ShowErrorOnMimeTypeMismatch auf yes steht,

in einem Quarantäne-Verzeichnis abgelegt, wenn der Parameter ShowErrorOnMimeTypeMismatch auf no steht.

Schritt 6: Template für den Datei-Upload integrieren

Neues Template zuweisen

Tragen Sie in der Shopkonfiguration shop.config im Abschnitt <Templates> für das Upload-Template folgende Zeile ein: Upload = ws_upload.htm

<Templates>
  ...
  Upload = ws_upload.htm
  ...
</Templates>

Referenz: Abschnitt Templates

Neues Template anlegen und speichern

Legen Sie ein neues Template an und speichern Sie es unter dem Namen ws_upload.htm in Ihrem Template-Verzeichnis, z. B. benutzer/templates/translation.

Zur einfacheren Integration dieser Shopseite stellt Ihnen WEBSALE ein Template und weitere Materialien zur Verfügung. Das Template enthält bereits alle grundlegenden funktionalen Elemente – Sie müssen es nur noch anpassen und einbinden:

Materialien: Materialien zum Upload-Modul

Referenz: Tags zum Upload-Modul


Hinweise:

Unter "Materialien" stellen wir Ihnen auch ein Template für die frühere Version des Upload-Moduls zur Verfügung.

Bitte beachten Sie, dass auf diesem speziellen Template ausschließlich die Tags für das Upload-Modul verwendet werden dürfen.

In der aktuellen Version des Upload-Moduls wurden einige Tags der früheren Version ersetzt. Bitte beachten Sie die Hinweise bei den jeweiligen Tag-Beschreibungen.

Schritt 7: Fehlermeldungen der MIME-Type-Prüfung auf dem Template ergänzen (optional, nur bei früherer Version des Upload-Templates nötig)

Falls Sie die Prüfung des MIME-Types aktiviert haben und die Ausgabe einer Meldung im Fehlerfall konfiguriert haben (siehe Schritt 5), ergänzen Sie bitte die gewünschten Fehlermeldungen auf dem Template ws_upload.htm.


Hinweis:

Dieser Schritt ist nur bei der früheren Version des Upload-Templates nötig, wenn die MIME-Type-Prüfung gewünscht ist.

Das aktuelle Upload-Template liefert die Fehlermeldungen bei aktivierter MIME-Type-Prüfung automatisch aus.

Beispiel:

...
{MimeTypeMismatch} 
  Der MimeType ~MimeType~ der Datei ~FailedFile~ passt nicht zur Dateiendung ~FileExtension~.
  Bitte verwenden Sie eine andere Datei und versuchen Sie es erneut.
{/MimeTypeMismatch}
 
{VirusDetected}
  Die Datei ~FailedFile~ kann nicht verarbeitet werden.
  Bitte verwenden Sie eine andere Datei und versuchen Sie es erneut.
{/VirusDetected}
...

Referenz: MimeTypeMismatch

Referenz: MimeType

Referenz: FailedFile

Referenz: FileExtension

Referenz: VirusDetected

Schritt 8: Links zum Starten des Upload-Moduls integrieren

Ergänzen Sie folgenden Code auf der HTML-Bestelleingangsbestätigungsseite (ws_confirm.htm) und evtl. auf der Bestelleingangsbestätigungs-E-Mail (mail_customer_order.htm):

...
{WS-UploadID}
   <a href="~WS-OrderUploadLink~">Zum Upload</a>
{/WS-UploadID}
...

Referenz: WS-UploadID

Referenz: WS-OrderUploadLink

Außerdem können Sie einen Menüpunkt im Shop integrieren, um dem Käufer einen Datei-Upload auch zu einem späteren Zeitpunkt zu ermöglichen.

Beispiel:

...
<a href="~WS-UploadLinkWithoutID~">Datenupload</a>
...

Referenz: WS-UploadLinkWithoutID

Haben Sie alle Schritte durchgeführt, ist das Upload-Modul erfolgreich in Ihrem Shop integriert und aktiv.

Möchten Sie Ihren Kunden eine Möglichkeit bieten, das Upload-Modul nach abgeschlossener Bestellung über einen gesicherten Link aufzurufen, finden Sie eine Integrationsanleitung für dieses Feature unter

Wegweiser: Upload-Modul mit gesichertem Link aufrufen