'you have mail' Anhang Konfiguration

Die Konfiguration der Anhänge wird direkt mit einem XML-Editor gemacht. Bitte vergewissern Sie sich, dass ein solcher auf dem Computer installiert und mit der Dateiendung .xml verknüpft ist, auf dem Sie diese Konfiguration bearbeiten möchten. Wenn Sie die Schaltfläche "..." beim Eingabefeld Anhänge betätigen, wird direkt ein XML-Editor mit der aktuellen Konfiguration aufgerufen. Passen Sie diese an und speichern Sie die Datei, diese wird automatisch wieder der Message hinzugefügt.

Spezifikation XML für Anhänge

Im folgenden werden die Struktur der Konfiguration im Gesamten und pro Anhangtyp erklärt. Bitte achten Sie darauf, dass Sie das XML-Dokument korrekt und wellformed erfassen. Die XML-Struktur verfügt über ein Root-Element, und innerhalb des Rootelementes für jede Anhangdefintion ein wiederholendes Element.

Wenn innerhalb eines Attributes oder der Daten eines Elementes das Sonderzeichen < oder > vorkommt, müssen Sie dieses wie in HTML auch speziell darstellen, damit diese nicht als XML-Steuerzeichen interpretiert wird.
Für das Zeichen < verwenden Sie &lt;
Für das Zeichen > verwenden Sie &gt;

 

<Attachments>

<Attachment .......>

......

</Attachment>

</Attachments>

 

Nachfolgend werden die 4 möglichen Anhangstypen beschrieben. Alle haben gemeinsame Elemente und zum Teil spezifische Attribute. Zusätzlich ist das Element "Naming" speziell, da dieses aus Fixen Variablen und Datenvariablen zusammengesetzt sein kann. Wichtig ist, dass für jeden Anhang eine zusätzliche Definition mit der Gruppe <Attachment> gemacht werden muss, also wenn z.B. 2 CxReporte oder 3 Native Files angehängt werden, dann muss das Element <Attachment> jeweils pro Report und pro Native File gemacht werden. Bitte beachten Sie die Datentypen, die wie folgt verwendet werden:

 

Datentyp Beschreibung
Integer Das ist eine Ganzzahl im Bereich von -2'147'483'648 bis 2'147'483'647.
Boolean Das ist ein Flag, wahr oder falsch. Die mögliche Eingabe ist "0" oder "false" für Falsch, und "1" oder "true" für Wahr.
GUID Das ist eine Globally Unique Identifier, also eine weltweit eindeutige mehrstellige ID. Eine nähere Beschreibung finden Sie unter Wikipedia. Die GUID wird ohne die geschweiften Klammern { und  } dargestellt.
String Das ist ein beliebiger Alphanumerischer Text.

Anhang CxReport

Hierbei handelt es sich um einen CxReport, also einen Report des CodX PostOffice Systems, welcher im Hintergrund aufgerufen wird und aus den ihm übergebenen Daten einen Report im PDF-Format generiert, welcher dann als Anhang verwendet wird.

 

<Attachment Type="1" Summarizing="true">

<CxReport GUID="7A3D1830-C17B-4494-9CF2-01C6E4AB70CF"/>

<Naming>Anhang_&lt;%SBB.strUPOC%&gt;.pdf</Naming>

<Param Name="lID">&lt;%lID%&gt;<Param>

<Param Name="UPOC">&lt;%strUPOC%&gt;</Param>

</Attachment>

 

Element Attribut Datentyp Beschreibung
Attachment Type Integer Diese Variable definiert den Typ des Anhanges,entsprechend dem gewisse Elemente vorhanden sein müssen. Mögliche Anhangtypen sind:
1 = CxReport
2 = Native File
3 = Sendungsbild
4 = Document
Attachment Summarizing Boolean Dieses Attribut definiert, ob die Daten summiert an den CxReport übergeben werden oder aber einzeln. Summiert heisst, dass der CxReport einmal aufgerufen wird mit allen vorhandenen Datenelementen die gefunden wurden.
CxReport GUID UID Hier handelt es sich um die UID des Reports der aufgerufen werden soll. Dieser Report wird im Hintergrund ausgeführt und sollte als Ergebnis eine Datei liefern.
Naming     Dieses Element enhält im Datenteil die Definition des Dateinamens, wie sie der Anhang bekommt und wie er dem EMail angehängt wird. Dieser Name kann mit Ersetzungsvariablen erweitert werden, die detailierte Beschreibung siehe unten.
Param Name String Dieses Element kann wiederholend sein und definiert die Parameter, welche an den Report übergeben werden. Wenn das Element "Summarizing" true ist, dann wird dieser Parameter so of an den Report übergeben wie es Anzahl Daten für die Message gibt.
Param     Das Datenteil des Elementes "Param" enthält den Wert für die Variable welche mit "Name" an den Report übergeben wird.

 

Anhang Native Datei

Hierbei handelt es sich um eine oder mehrere beliebige Dateien aus dem Dateisystem des Computers der das 'you have mail' System ausführt und die Messages generiert. Bitte beachten Sie, dass dies in der Regel der Computer mit dem CodX PostOffice Aplikationsserver ist. Also müssen diese Dateien auf diesem Computer erreichbar sein, oder aber sie verwenden als Pfad einene Netzwerkpfad, der vom Aplikationsserver aus erreichbar ist.

 

<Attachment Type="2" Summarizing="true">

<NativFile FileName="" Path="" FileMask="" Recursive="false" ZIPFileName=""/>

<Naming>&lt;%orgfilename%&gt;_&lt;%datetime%&gt;.&lt;%orgextension%&gt;</Naming>

</Attachment>

 

Element Attribut Datentyp Beschreibung
Attachment Type Integer Diese Variable definiert den Typ des Anhanges,entsprechend dem gewisse Elemente vorhanden sein müssen. Mögliche Anhangtypen sind:
1 = CxReport
2 = Native File
3 = Sendungsbild
4 = Document
Attachment Summarizing Boolean Dieses Attribut definiert, ob die Daten summiert an den CxReport übergeben werden oder aber einzeln. Summiert heisst, dass der CxReport einmal aufgerufen wird mit allen vorhandenen Datenelementen die gefunden wurden.
NativeFile FileName String In diesem Attribut können Sie direkt den kompletten Pfad und Dateinamen angeben, wenn Sie direkt eine Einzelen Datei mit bekannten Speicherort als Anhang verwenden möchten
NativeFile Path String Wenn Sie eine oder mehrere Dateien anhängen möchten, die in einem bekannten Pfad liegen, können Sie diese 3 Attribute kombiniert verwenden, dabei haben diese folgende Bedeutung:
Path = Der Pfad in dem der gewünschte Anhang liegt
FileMask = Die Suchmaske, mit der die Datei gesucht werden soll (z.B. *.pdf)
Rekursiv = Soll auch in Verzeichnissen innerhalb des Pfades rekursiv gesucht werden

Aus dieser Kombination kann es natürlich sein, dass mehrere Dateien gefunden werden, welche auf die Suchmaske passen. In diesem Fall werden alle gefundenen Dateien als Anhang verwendet.
NativeFile FileMask String
NativeFile Recursive String
NativeFile ZIPFileName String Wenn Sie die gefundenen Dateien in einer einzelnen komprimierten Datei als Anhang senden möchten, geben Sie hier einen Dateinamen an und die gefundenen Dateien werden komprimiert und im ZIP-Format ein eine Datei zusammengefasst.
Naming     Dieses Element enhält im Datenteil die Definition des Dateinamens, wie sie der Anhang bekommt und wie er dem EMail angehängt wird. Dieser Name kann mit Ersetzungsvariablen erweitert werden, die detailierte Beschreibung siehe unten.

Anhang Sendungsbild

Bei diesem Anhangtyp handelt es sich um alle Bilder vom gewünschten Typ, die einer Sendung hinterlegt sind. Es werden alle Sendungsbildtypen unterstützt. Diese Bilder werden mit dem gleichen Dateityp wie sie gespeichert wurden als Anhang gespeichert.

 

<Attachment Type="3" Summarizing="false">

<Image Type="9" PDF="true"/>

<Naming>&lt;%strUPOC%&gt;_&lt;%counter%&gt;.&lt;%orgextension%&gt;</Naming>

</Attachment>

 

Element Attribut Datentyp Beschreibung
Attachment Type Integer Diese Variable definiert den Typ des Anhanges,entsprechend dem gewisse Elemente vorhanden sein müssen. Mögliche Anhangtypen sind:
1 = CxReport
2 = Native File
3 = Sendungsbild
4 = Document
Attachment Summarizing Boolean Dieses Attribut definiert, ob die Daten summiert an den CxReport übergeben werden oder aber einzeln. Summiert heisst, dass der CxReport einmal aufgerufen wird mit allen vorhandenen Datenelementen die gefunden wurden.
Image Type Integer Hier wird der gewünschte Sendungsbildtyp angegeben. Es werden alle Sendungsbilder von diesem Typ auf der Sendung welche in der Message ermittelt wurde, als Anhang gespeichert. Folgende Sendungstypen sind möglich:

0 = Sendungs-Image von Sorter (Sortiermaschine), Bild von Combo-Kamera
1 = Zustellliste
2 = Rückschein
3 = Sendungsbild von OCR/Adress-Kamera
4 = Sendungsbild von Format-Kamera
5 = Reklamation
6 = cans mit Kunden UPOC
7 = Sendungsbild von Bilderfassung / Foto-Kamera
8 = Offizielles Dokumant für DIEPOST (Einlieferbeleg Barcode (Einschreiben), Paket-
     Aufgabeverzeichnis, Swiss-Express Aufgabeverzeichnis)
9 = gescannter / fotografierter Inhalt einer Sendung
10 = Signatur/Unterschrift, z.B. dokumentierte Zustellung
11 = Bild aus Wareneingang (Scanner oder Kamera)
12 = Sendungslabel, z.B. von KEP
13 = Zolldokument, z.B. von KEP
14 = Sendungsinhalt Original
  PDF Boolean Dieses Attribut besagt, dass das Bild eine PDF-Datei ist, welche ein Bild enthält.
Naming     Dieses Element enhält im Datenteil die Definition des Dateinamens, wie sie der Anhang bekommt und wie er dem EMail angehängt wird. Dieser Name kann mit Ersetzungsvariablen erweitert werden, die detailierte Beschreibung siehe unten.

Anhang DM Dokument

Bei diesem Anhang handelt es sich um ein Dokument aus dem Dokumentenmanagementsystem von CodX PostOffice. Das können unterschiedliche Dokumente aus verschiedensten Modulen sein, z.B. ein Reklamationsanhang oder ein Dokument aus dem DM usw.

 

<Attachment Type="4" Summarizing="true">

<Document UPOC="" ReferenceUPOC=""/>

<Naming>Dokument_&lt;%datetime%&gt;.&lt;%orgextension%&gt;</Naming>

</Attachment>

 

Element Attribut Datentyp Beschreibung
Attachment Type Integer Diese Variable definiert den Typ des Anhanges,entsprechend dem gewisse Elemente vorhanden sein müssen. Mögliche Anhangtypen sind:
1 = CxReport
2 = Native File
3 = Sendungsbild
4 = Document
Attachment Summarizing Boolean Dieses Attribut definiert, ob die Daten summiert an den CxReport übergeben werden oder aber einzeln. Summiert heisst, dass der CxReport einmal aufgerufen wird mit allen vorhandenen Datenelementen die gefunden wurden.
  UPOC String Hier handelt es sich um einen Dokumenten-UPOC, der ein Dokument aus dem Dokumentenmanagementsystem als Anhang ermittelt.
Document ReferenceUPOC String Hier verwenden Sie den Referenz-UPOC des Dokuments welches Sie als Anhang verwendent möchten. Jedes Dokument das im CodX PostOffice Dokumentenmanagement gespeichert ist, verfügt über einen UPOC. Dieser kann auch als Datenfeld mit <%xxxxxx%> aus den vorhandenen Daten übernommen werden.
Naming     Dieses Element enhält im Datenteil die Definition des Dateinamens, wie sie der Anhang bekommt und wie er dem EMail angehängt wird. Dieser Name kann mit Ersetzungsvariablen erweitert werden, die detailierte Beschreibung siehe unten.

Naming

In diesem Element werden die Namen der Anhänge definiert. Diese können entweder direkt als Text eingegeben werden, oder sie können mittels ersetzungszeichen zusammengesetzt werden. Diese Ersetzungen können beliebig und gemischt mit Text verwendet werden. Wir unterscheiden zwischen vordefinierten Ersetzungszeichen und Datenersetzungszeichen. Diese können auch in allen anderen Elementen verwendet werden, sie werden zur Laufzeit durch die gefundenen Daten des Trigger- und Daten-Querys ersetzt. Folgende vordefinierte Ersetzungszeichen gibt es:

 

Variable Beschreibung
<%date%> Wird ersetzt mit dem Datum im Format dd.mm.yyyy
<%time%> Wird ersetzt mit der Zeit im Format HH:MM:SS
<%datetime%> Wird ersetzt mit dem Datum und der Zeit im Format dd.mm.yyyy HH:MM:SS
<%counter%> Wird ersetzt mit einem fortlaufenen Zähler für die vorhandenen Datensätze einer Message
<%count%> Wird ersetzt mit dem Total der vorhandenen Datensätze einer Message
<%orgdrive%> Wird ersetzt mit dem Originallaufwerksbuchstaben eines Anhanges für Native Files
<%orgpath%> Wird ersetzt mit dem Originalpfadnamen eines Anhanges für Native Files
<%orgfilename%> Wird ersetzt mit dem Originaldateinamen eines Anhanges für Native Files
<%orgextension%> Wird ersetzt mit dem Originaldateierweiterung eines Anhanges für Native Files
%POSTOFFICETEMP% Diese Variable wird mit dem Pfadnamen von CodX PostOffice Temporärer Pfad ersetzt, also zum Beispiel mit
\C:\Program Files (x86)\CodX PostOffice\Temp
%POSTOFFICE% Diese Variable wird mit dem Installations-Pfadnamen von CodX PostOffice ersetzt, also zum Beispiel mit
\C:\Program Files (x86)\CodX PostOffice
%[Pfadersetzungen]% Sie können alle von Windows unterstützten Ersetzungen für Pfade verwenden, wie z.B. %TEMP%, %PROGDATA% usw.

 

Zusätzlich zu den vordefinierten Ersetzungszeichen gibt es noch die Datenersetzungszeichen, welche nichts anderes sind als die Datenbankattributsnamen die im Datenquery selektioniert werden. Diese müssen also im Daten-Query geliefert werden, und können dann zusammen mit den Steuerzeichen als Ersetzungszeichen verwendet werden, wie z.B. der SendungsUPOC, also <%strSBBUPOC%>.

 

Beispiele:

Dokument_&lt;%datetime%&gt;.&lt;%orgextension%&gt; = Dokument_01.02.2021 14:09:32.pdf

&lt;%strUPOC%&gt;_&lt;%counter%&gt;.&lt;%orgextension%&gt; = 019998501316_1.bmp

Siehe auch:

CodX Software CodX Software AG
Sinserstrasse 47
6330 Cham
Switzerland		 Support
http://support.codx.ch 		CxSpickel