Konfiguration wsupload.config - WEBSALE Dokumentation

Die Konfiguration wsupload.config enthält alle Parameter des Upload-Moduls. Diese Seite zeigt eine vollständige Musterkonfiguration, die Sie als Ausgangspunkt übernehmen können, und erklärt jeden Abschnitt. Einige Werte, beispielsweise Meldungstexte und Verwendungszwecke, legen Sie frei fest. Andere Werte, etwa die Größenbegrenzungen, schaltet die WEBSALE AG für Ihren Shop frei.

Dies ist eine Musterkonfiguration. Hochgeladen werden können nur Dateien mit den Dateiformaten, die im Abschnitt Mime-Type aufgeführt sind.Wenn Sie weitere Dateiformate zulassen wollen, ergänzen Sie den Abschnitt entsprechend. Je Dateiendung dürfen Sie mehrere MIME-Typen kommasepariert angeben.

Wegweiser: Upload-Modul verwenden, Upload-Modul integrieren · Grundlagen: Grundlagen zu Konfigurationen

Wo die Datei liegt

Die Datei legen Sie im Online-Servicebereich im Dienst “Konfigurationen” für den betreffenden Subshop an, unter dem Namen wsupload mit der Erweiterung config. Sie liegt damit im Konfigurationsverzeichnis des Subshops:

konfiguration/<Subshop-ID>/wsupload.config

Alle Abschnitte dieser Datei sind optional. Fehlt ein Abschnitt, gelten für seinen Bereich die eingebauten Standardwerte des Moduls. Nur die Datei selbst muss vorhanden sein, sonst protokolliert das Modul einen Fehler und arbeitet nicht.

Die Abschnitte im Überblick

Abschnitt	Inhalt
`UploadMessages-Txt`	alle Melde- und Protokolltexte des Moduls
`Settings`	Datums- und Zeitformat, erlaubte Dateiendungen, Verhalten bei abgelehnten Dateien
`+FileInfo`	je Abschnitt ein Eintrag der Auswahlliste für den Verwendungszweck
`Mime-Type`	je Dateiendung die zulässigen MIME-Typen
`Templates`	ein abweichendes Upload-Template für den Anfrage-Modus

`UploadMessages-Txt`

In diesem Abschnitt überschreiben Sie die Texte des Moduls. Jeder Eintrag besteht aus einem festen Schlüssel und Ihrem Text.

Der Schlüssel entscheidet, welcher Text überschrieben wird. Ein Tippfehler im Schlüssel führt nicht zu einer Fehlermeldung, sondern dazu, dass Ihr Text nirgends erscheint und der Standardtext stehen bleibt.

Fehler in der Einrichtung

Diese drei Texte sieht der Käufer nur, wenn die Integration unvollständig ist.

Schlüssel	Anlass	Platzhalter
`TemplSectionMissing`	In der `shop.config` fehlt der Abschnitt `Templates`
`UploadTemplMissing`	Im Abschnitt `Templates` der `shop.config` fehlt ein Wert für `Upload`
`UploadTemplFileMiss`	Die hinterlegte Template-Datei existiert nicht	`%s` wird durch den Dateinamen ersetzt

Upload-ID und Bestellung

Schlüssel	Anlass	Platzhalter
`EmptyUplId`	Der Käufer hat keine Upload-ID eingegeben
`InvalidUplId`	Die eingegebene Upload-ID existiert nicht
`InvalidOrdernumber`	Zur Auftragsnummer existiert keine Bestellung, oder für deren Produkte ist kein Upload vorgesehen

Überschrittene Grenzwerte

Schlüssel	Anlass	Platzhalter
`FileSizeExceeded`	Die maximale Größe einer einzelnen Datei ist überschritten	`%d` wird durch das freigeschaltete Limit in MB ersetzt
`PosQuotaExceeded`	Die maximale Datenmenge je Bestellposition ist überschritten	`%d` wird durch das freigeschaltete Limit in MB ersetzt
`PosCountExceeded`	Die maximale Anzahl Dateien je Bestellposition ist überschritten	`%d` wird durch das freigeschaltete Limit ersetzt

Speicherplatz

Schlüssel	Anlass	Platzhalter
`LowDiskSpace`	Meldung an den Käufer, dass kein Speicherplatz mehr frei ist
`LowDiskSpaceSubj`	Betreff der Mail an die konfigurierte Administrator-Adresse
`LowDiskSpaceMail`	Text dieser Mail	`%d` wird durch die noch freie Menge in MB ersetzt

Dateiprüfung

Schlüssel	Anlass	Platzhalter
`InvalidExt`	Die Dateiendung ist nicht zugelassen	`~validexts~` wird durch die erlaubten Dateiendungen ersetzt
`DupFile`	Die Datei wurde bereits hochgeladen	`~filename~` wird durch den Dateinamen ersetzt

Bedienhinweise

Schlüssel	Anlass
`SafariHint`	besonderer Hinweis für Safari-Nutzer zum Ablauf der Übertragung
`TransferRunning`	eine Übertragung läuft bereits
`DelConfirm`	Rückfrage vor dem Löschen markierter Dateien
`Files`	Beschriftung für die Anzahl der Dateien

Texte der Protokolltabelle

Diese Texte erscheinen im Protokoll, das das Modul je Upload-Vorgang führt.

Schlüssel	Bedeutung
`LogType_upload`	Datei hochgeladen
`LogType_delete`	Datei gelöscht
`LogType_uploaddupfile`	Datei war bereits vorhanden
`LogType_finished`	Uploads abgeschlossen
`LogType_unlocked`	Abschluss wieder aufgehoben
`LogType_filelimit`	maximale Größe je Datei überschritten
`LogType_limitmb`	maximale Größe je Bestellposition überschritten
`LogType_poslimitcount`	maximale Anzahl Dateien je Bestellposition überschritten
`LogType_uploaderror`	unvollständiger Datenupload

`Settings`

Parameter	Zweck	Werte
`DateFormat`	Format der Datumsangaben im Modul	Formatzeichen der C-Funktion `strftime`, beispielsweise `%d.%m.%Y`
`TimeFormat`	Format der Zeitangaben	Formatzeichen der C-Funktion `strftime`, beispielsweise `%H:%M`
`Extensions`	zulässige Dateiendungen als kommagetrennte Liste	beispielsweise `JPG,PDF,ZIP`. Ohne Angabe sind alle Endungen zulässig
`VS4UploadWorkaround`	Übertragungs-Workaround für ältere Virenscanner-Anbindungen	`yes`, `no`. Standard: `no`
`ShowErrorOnMimeTypeMismatch`	ob der Käufer eine Fehlermeldung sieht, wenn der MIME-Typ nicht passt	`yes`, `no`. Standard: `no`
`ShowErrorOnVirusDetection`	ob der Käufer eine Fehlermeldung sieht, wenn die Virenprüfung anschlägt	`yes`, `no`. Standard: `no`

Bei den drei Schaltern gilt jeder Wert außer yes als no. Ein Tippfehler schaltet die Funktion also stillschweigend ab.Extensions ist eine Positivliste und arbeitet unabhängig von der MIME-Prüfung. Denken Sie an beide Schreibweisen gebräuchlicher Endungen, beispielsweise TIF und TIFF.

Wegweiser: Upload-Modul integrieren, Schritt 5 erklärt das Zusammenspiel der beiden Fehlerschalter

`+FileInfo`

Optional kann der Käufer je Datei einen Verwendungszweck aus einer Auswahlliste angeben. Jeder Abschnitt +FileInfo ist ein Eintrag dieser Liste.

Parameter	Zweck
`Caption`	die Beschriftung, die der Käufer sieht
`Code`	der Wert, der mit der Datei gespeichert wird

Die Reihenfolge der Abschnitte in der Datei ist die Reihenfolge in der Auswahlliste. Legen Sie den neutralen Eintrag deshalb nach oben.

`Mime-Type`

Hier tragen Sie Paare aus Dateiendung und erwartetem MIME-Typ ein. Je Dateiendung dürfen mehrere Typen kommasepariert stehen.

Dateiformate, die hier nicht aufgeführt sind, können nicht hochgeladen werden. Eine unvollständige Liste blockiert also legitime Dateien.

Den tatsächlichen MIME-Typ ermittelt das Modul aus dem Dateiinhalt, nicht aus der Angabe des Browsers. Deshalb fällt eine umbenannte Datei auf.Die Prüfung läuft nur, wenn der Abschnitt überhaupt Einträge enthält. Ein leerer oder fehlender Abschnitt schaltet sie ab. Groß- und Kleinschreibung spielt beim Vergleich keine Rolle, und Leerzeichen um die kommaseparierten Typen werden entfernt.

`Templates`

Parameter	Zweck
`Upload`	Name des Upload-Templates für den Anfrage-Modus

Dieser Abschnitt fehlt in der Musterkonfiguration, wird vom Modul aber ausgewertet. Sie brauchen ihn nur, wenn Sie das Upload-Modul in einem Formular mit dem Anfragemodul einsetzen. Für den Upload zu Bestellungen steht das Template im Abschnitt Templates der shop.config. Wegweiser: Upload-Modul für Formulare mit Inquiry

Musterkonfiguration

Kopieren Sie den folgenden Inhalt in Ihre Konfigurationsdatei und passen Sie ihn an. Die Kommentare hinter dem # erklären jeweils den Eintrag und dürfen stehen bleiben.

###############################################################################
# Fehlermeldungs-Texte und Texte der Logging-Tabelle
###############################################################################

<UploadMessages-Txt>
TemplSectionMissing   = In der shop.config fehlt der Abschnitt <Templates>
UploadTemplMissing    = In der shop.config ist kein Wert für den Tag Upload im Abschnitt <Templates> eingetragen
UploadTemplFileMiss   = Die Template-Datei '%s' ist nicht vorhanden
EmptyUplId            = Sie haben keine Upload-ID eingegeben. Diese benötigen wir, um den Datenupload Ihrer Bestellung zuordnen zu können. Ihre Upload-ID finden Sie in der Bestellbestätigung, die wir Ihnen per E-Mail zugesandt haben.
InvalidUplId          = Diese Upload-ID konnte leider nicht gefunden werden. Bitte überprüfen Sie Ihre Eingabe. Ihre Upload-ID finden Sie in der Bestellbestätigung, die wir Ihnen per E-Mail zugesandt haben.
InvalidOrdernumber    = Für die angegebene Ordernumber existiert keine Bestellung oder für die Produkte der Bestellung ist kein Upload vorgesehen
FileSizeExceeded      = Es können nur Dateien bis zu einer Größe von %d MB hochgeladen werden
PosQuotaExceeded      = Für eine Bestellposition kann nicht mehr als %d MB hochgeladen werden
PosCountExceeded      = Für eine Position können nicht mehr als %d Dateien hochgeladen werden
LowDiskSpace          = Auf dem Ziellaufwerk ist nicht mehr genügend Speicherplatz vorhanden. Bitte setzen Sie sich mit dem Shopbetreiber in Verbindung oder versuchen Sie den Upload später nochmal.
LowDiskSpaceSubj      = Upload-Funktion deaktiviert
LowDiskSpaceMail      = Auf dem Ziellaufwerk für die Upload-Dateien sind weniger als %d MB frei, weitere Uploads sind deshalb nicht möglich. Bitte löschen Sie vorhandene Upload-Dateien oder setzen Sie sich mit der WEBSALE-AG in Verbindung.
InvalidExt            = Ungültige Dateiendung: (erlaubt sind: ~validexts~)
DupFile               = Die Datei '~filename~' wurde bereits hochgeladen. Falls sie die bereits existierende Datei überschreiben möchten, löschen Sie sie bitte vorher heraus.
SafariHint            = HINWEIS FÜR SAFARI-NUTZER: Die Übertragung wird gestartet, nachdem Sie auf "OK" geklickt haben. Bitte warten Sie anschließend, bis in der Liste der bereits übertragenen Dateien der Dateiname angezeigt wird.
TransferRunning       = Übertragung läuft bereits
DelConfirm            = Wollen Sie die markierten Dateien wirklich löschen?
Files                 = Datei(en)
LogType_delete        = Datei gelöscht
LogType_upload        = Datei hochgeladen
LogType_uploaddupfile = Datei bereits vorhanden
LogType_finished      = Uploads abgeschlossen
LogType_unlocked      = Abschluss aufgehoben
LogType_filelimit     = Maximale Größe je Datei überschritten
LogType_poslimitcount = Maximale Anzahl von Dateien je Bestellposition überschritten
LogType_limitmb       = Maximale Größe je Bestellposition überschritten
LogType_uploaderror   = Unvollständiger Datenupload
</UploadMessages-Txt>

###############################################################################
# Upload-Einstellungen
###############################################################################

<Settings>
DateFormat                  = %d.%m.%Y                        # Datums-Format (Format siehe C-Funktion "strftime")
TimeFormat                  = %H:%M                           # Zeit-Format (Format siehe C-Funktion "strftime")
Extensions                  = JPG,JPEG,TIFF,PDF,ZIP,RAR,TXT,TIF   # Zulässige Dateiendungen (kommagetrennt). Ohne Angabe sind alle Formate zulässig
VS4UploadWorkaround         = no
ShowErrorOnMimeTypeMismatch = no                              # yes|no, Standard: no
ShowErrorOnVirusDetection   = no                              # yes|no, Standard: no
</Settings>

###############################################################################
# Verwendungszweck
# Optional kann für jede Datei ein Verwendungszweck übermittelt werden,
# der aus einer Auswahlliste gewählt wird.
###############################################################################

<+FileInfo>
Caption = Bitte wählen Sie
Code    = 0
</+FileInfo>

<+FileInfo>
Caption = Alles in einem Dokument
Code    = 1
</+FileInfo>

<+FileInfo>
Caption = Vorderseite
Code    = 2
</+FileInfo>

<+FileInfo>
Caption = Rückseite
Code    = 3
</+FileInfo>

###############################################################################
# MIME-Types
# Eingetragen werden Paare aus Dateiendung und erwartetem MIME-Type.
# Je Dateiendung können mehrere MIME-Types kommasepariert eingetragen werden.
# Achtung: Dateiformate, die hier nicht aufgeführt werden,
# können nicht hochgeladen werden.
###############################################################################

<Mime-Type>
JPG  = image/jpeg
JPEG = image/jpeg
eps  = image/x-eps
png  = image/png
TIF  = image/tiff
TIFF = image/tiff
PDF  = application/pdf
doc  = application/msword
docx = application/vnd.openxmlformats-officedocument.wordprocessingml, application/msword
odt  = application/vnd.oasis.opendocument.text
xls  = application/vnd.ms-excel
pub  = application/x-mspublisher
ppt  = application/vnd.ms-powerpoint
TXT  = text/plain

# Archive
ZIP = application/zip
RAR = application/rar
</Mime-Type>

Die Musterkonfiguration führt im Abschnitt Settings mehr Dateiendungen auf, als der Abschnitt Mime-Type abdeckt, beispielsweise JPEG gegenüber eps, png und den Office-Formaten. Gleichen Sie beide Listen aneinander an, bevor Sie die Konfiguration produktiv setzen.

​Wo die Datei liegt

​Die Abschnitte im Überblick

​UploadMessages-Txt

​Fehler in der Einrichtung

​Upload-ID und Bestellung

​Überschrittene Grenzwerte

​Speicherplatz

​Dateiprüfung

​Bedienhinweise

​Texte der Protokolltabelle

​Settings

​+FileInfo

​Mime-Type

​Templates

​Musterkonfiguration

Wo die Datei liegt

Die Abschnitte im Überblick

`UploadMessages-Txt`

Fehler in der Einrichtung

Upload-ID und Bestellung

Überschrittene Grenzwerte

Speicherplatz

Dateiprüfung

Bedienhinweise

Texte der Protokolltabelle

`Settings`

`+FileInfo`

`Mime-Type`

`Templates`

Musterkonfiguration