you have mail' attachment configuration
The configuration of the attachments is done directly with an
XML editor. Please make sure that such an
is installed on the computer and linked to the .xml file extension
file extension on the computer where you want to edit this configuration. When you click
the button "..." at the input field Attachments, an XML editor with the file extension
an XML editor with the current configuration is called up directly.
Adjust this and save the file, this will be automatically
automatically added to the message.
Specification XML for attachments
In the following, the structure of the configuration
as a whole and per attachment type is explained below. Please make sure that
you enter the XML document correctly and wellformed. The XML structure has a root element, and
within the root element for each attachment definition a
repeating element.
If the special character < or > occurs within an attribute or the data of an
element contains the special character < or >, you have to display this character as
in HTML, so that it is not interpreted as an
XML control character.
For the character <
use <
For the character >
use >
<attachments>
<attachment .......>
......
</attachment>
</attachments>
The 4 possible attachment types are described below.
are described. All of them have common elements and partly specific
attributes. In addition, the element "Naming" is special, as it can be composed
can be composed of fixed variables and data variables.
It is important to note that for each attachment an additional definition with
the <attachment> group must be made, so if, for example, 2
CxReporte or 3 Native Files are attached, then the
element <attachment> must be made per report and per native file.
be made. Please note the data types which are as follows.
used:
Data type |
Description |
Integer |
This is an integer in the range -2'147'483'648 to
2'147'483'647. |
Boolean |
This is a flag, true or false. The possible input
is "0" or "false" for false, and "1" or "true" for
True. |
GUID |
This is a Globally Unique Identifier.
globally unique multi-digit ID. A more detailed
description can be found under
Wikipedia. The GUID is represented without the curly brackets
{ and }. |
String |
This is any alphanumeric text. |
Appendix CxReport
This is a CxReport, which is a report of the
report of the CodX PostOffice system, which is called up in the background and
in the background and generates a report in PDF format from the data
PDF format, which is then used as an attachment.
<Attachment Type="1"
Summarizing="true">
<CxReport GUID="7A3D1830-C17B-4494-9CF2-01C6E4AB70CF"/>
<Naming>Appendix_<%SBB.strUPOC%>.pdf</Naming>
<Param Name="lID"><%lID%><Param>
<param name="UPOC"><%strUPOC%></param>
</attachment>
Item |
Attribute |
Data type |
Description |
Attachment |
Type |
Integer |
This variable defines the type of
according to which certain elements must be present.
must be present. Possible attachment types are:
1 = CxReport
2 = Native File
3 = Broadcast image
4 = Document |
Attachment |
Summarizing |
Boolean |
This attribute defines whether the data are transferred to the
CxReport or individually. Summed
means that the CxReport is called up once with all the
existing data elements that were found. |
CxReport |
GUID |
UID |
This is the UID of the report that is to be called up.
is to be called. This report is executed in the background
and should return a file as the result. |
Naming |
|
|
This element contains the definition of the file name in the data part,
how the attachment gets it and how it is attached to the EMail.
to the e-mail. This name can be extended with replacement variables.
see below for a detailed description. |
Param |
Name |
String |
This element can be repetitive and defines the
parameters that are passed to the report. If the
element "Summarizing" is true, then this parameter is passed to the report
is passed to the report as often as there is number of data for the
message. |
Param |
|
|
The data part of the element "Param" contains the value for
the variable which is passed to the report with "Name". |
Appendix Native File
This is one or more arbitrary files from the
files from the file system of the computer that is running the 'you
have mail' system and generates the messages. Please
note that this is usually the computer running the CodX
PostOffice application server. So these files must be
be accessible on this computer, or you can use as path a network path
a network path that is accessible from the application server.
<attachment
Type="2"
Summarizing="true">
<NativeFile
FileName=""
Path=""
FileMask=""
Recursive="false"
ZIPFileName=""/>
<naming><%orgfilename%>_<%datetime%>.<%orgextension%></naming>
</attachment>
Item |
Attribute |
Data type |
Description |
Attachment |
Type |
Integer |
This variable defines the type of
according to which certain elements must be present.
must be present. Possible attachment types are:
1 = CxReport
2 = Native File
3 = Broadcast image
4 = Document |
Attachment |
Summarizing |
Boolean |
This attribute defines whether the data are transferred to the
CxReport or individually. Summed
means that the CxReport is called up once with all the
existing data elements that were found. |
NativeFile |
FileName |
String |
In this attribute you can directly specify the complete path
and file name, if you want to directly use a single file
with a known location as an attachment |
NativeFile |
Path |
String |
If you want to attach one or more files
files that are located in a known path, you can use these
these 3 attributes in combination, they have the following meaning
have the following meaning:
Path = The path in which the desired attachment is located.
FileMask = The search mask, with which the file is to be searched for
(e.g. *.pdf)
Recursive = Should also be searched in directories within the path
recursively
From this combination it can be naturally that several files are found
files are found which match the search mask. In
case all found files are used as attachment
will be used. |
NativeFile |
FileMask |
String |
NativeFile |
Recursive |
String |
NativeFile |
ZIPFileName |
String |
If you want to send the found files in a single
file as an attachment, enter a file name here and the files found
a file name here and the files found will be compressed and
compressed and combined into one file in ZIP format.
combined. |
Naming |
|
|
This element contains the definition of the file name in the data part,
how the attachment gets it and how it is attached to the EMail.
to the e-mail. This name can be extended with replacement variables.
see below for a detailed description. |
Attachment broadcast image
This attachment type is all the images of the desired type
of the desired type, which are deposited to a transmission. All
all broadcast image types are supported. These images are saved as attachments with the
the same file type as they were saved as an attachment.
<attachment
Type="3"
Summarizing="false">
<image
Type="9"
PDF="true"/>
<naming><%strUPOC%>_<%counter%>.<%orgextension%></naming>
</attachment>
Item |
Attribute |
Data type |
Description |
Attachment |
Type |
Integer |
This variable defines the type of
according to which certain elements must be present.
must be present. Possible attachment types are:
1 = CxReport
2 = Native File
3 = Broadcast image
4 = Document |
Attachment |
Summarizing |
Boolean |
This attribute defines whether the data are transferred to the
CxReport or individually. Summed
means that the CxReport is called up once with all the
existing data elements that were found. |
Image |
Type |
Integer |
Here you specify the desired
transmission image type is specified here. All transmission images of
this type on the transmission which was determined in the message
is saved as an attachment. The following transmission types are
possible:
0 = Shipment image from sorter (sorting machine), image from
Combo camera
1 = Delivery list
2 = Return receipt
3 = Shipment image from OCR/address camera
4 = Shipment image from format camera
5 = Complaint
6 = cans with customer UPOC
7 = Shipment image from image capture / photo camera
8 = Official documant for DIEPOST (posting receipt barcode
(registered mail), parcel
dispatch list, Swiss-Express dispatch list)
9 = scanned / photographed contents of an item
10 = Signature / signature, e.g. documented delivery
11 = Image from goods receipt (scanner or camera)
12 = Shipment label, e.g. from CEP
13 = Customs document, e.g. from CEP
14 = Shipment content original |
|
PDF |
Boolean |
This attribute indicates that the
image is a PDF file that contains an image. |
Naming |
|
|
This element contains the definition of the file name in the data part,
how the attachment gets it and how it is attached to the EMail.
to the e-mail. This name can be extended with replacement variables.
see below for a detailed description. |
Annex DM Document
This attachment is a document
from the CodX PostOffice document management system. This can be
different documents from different modules, e.g.
a complaint attachment or a document from the DM etc.
<attachment
Type="4"
Summarizing="true">
<Document
UPOC="" ReferenceUPOC=""/>
<naming>document_<%datetime%>.<%orgextension%></naming>
</attachment>
Item |
Attribute |
Data type |
Description |
Attachment |
Type |
Integer |
This variable defines the type of
according to which certain elements must be present.
must be present. Possible attachment types are:
1 = CxReport
2 = Native File
3 = Broadcast image
4 = Document |
Attachment |
Summarizing |
Boolean |
This attribute defines whether the data are transferred to the
CxReport or individually. Summed
means that the CxReport is called up once with all the
existing data elements that were found. |
|
UPOC |
String |
This is a document UPOC that contains a document from the
document from the document management system as an
determined. |
Document |
ReferenceUPOC |
String |
Here you use the reference UPOC of the document
which you want to use as an attachment. Any document
that is stored in CodX PostOffice Document Management
has a UPOC. This can also be used as a data field with
<%xxxxxx%> from the existing data. |
Naming |
|
|
This element contains the definition of the file name in the data part,
how the attachment gets it and how it is attached to the EMail.
to the e-mail. This name can be extended with replacement variables.
see below for a detailed description. |
Naming
In this element the names of the attachments
are defined. These can either be entered directly as text,
or they can be composed using substitution characters.
These substitutions can be used arbitrarily and mixed with text.
text.
We distinguish between predefined replacement characters and
data replacement characters. These can also be used in all other elements
elements, they are replaced at runtime by the data found in the
of the trigger and data query at runtime. The following predefined replacement characters exist:
Variable |
Description |
<%date%> |
Is replaced with the date in the format dd.mm.yyyy |
<%time%> |
Replaced with the time in the format HH:MM:SS |
<%datetime%> |
Replaced with the date and time in the format
dd.mm.yyyy HH:MM:SS |
<%counter%> |
Is replaced with a continuous counter for the
existing data records of a message |
<%count%> |
Is replaced with the total of existing records
of a message |
<%orgdrive%> |
Will be replaced with the original drive letter of a
attachment for native files |
<%orgpath%> |
Replaced with the original path name of an attachment
for native files |
<%orgfilename%> |
Replaced with the original filename of an attachment
for native files |
<%orgextension%> |
Replaced with the original file extension of a
attachment for native files |
%POSTOFFICETEMP% |
This variable is replaced with the path name of CodX
PostOffice Temporary Path, for example with
\C:\Program Files (x86)\CodX PostOffice\Temp |
%POSTOFFICE% |
This variable is replaced with the installation path name of
CodX PostOffice, for example with
\C:\Program Files (x86)\CodX PostOffice |
%[path substitutions]% |
You can use all the path substitutions supported by Windows
for paths, such as %TEMP%, %PROGDATA%, and so on. |
In addition to the predefined replacement characters
there are also the data substitution characters, which are nothing more
than the database attribute names that are selected in the data query.
in the data query. These must therefore be supplied in the data query, and
can then be used together with the control characters as substitution characters
such as the consignmentUPOC, that is <%strSBBUPOC%>.
Examples:
Document_<%datetime%>.<%orgextension%>
= document_01.02.2021
14:09:32.pdf
<%strUPOC%>_<%counter%>.<%orgextension%>
= 019998501316_1.bmp
See also:
|