Fichier de configuration du canal de communication LetterShop
Ce fichier de configuration contient des paramètres
qui sont attribués à un canal de communication spécifique. La présente
spécification décrit la structure d'un fichier de configuration de tâche LS. Ce fichier
fichier de configuration des tâches LS contient tous les paramètres d'une tâche LS.
Veuillez noter que l'ordre des
éléments avec l'ordre de la définition du schéma.
doit être respecté. Facultatif signifie que l'élément correspondant ne doit pas être présent dans le schéma.
XML peut manquer.
Élément XML |
Type de champ |
En option |
Description |
Emploi LS |
ELEMENT |
Non |
Chaque fichier de configuration de tâche LS contient exactement un élément de type
type LS-Job.
S'il existe plusieurs éléments, seul le premier est utilisé.
est utilisé. |
LS-Job-Config |
ELEMENT |
Non |
Cet élément contient tous les
paramètres d'un job LS |
Nom |
chaîne de caractères |
Oui |
Nom de la configuration |
Mode |
chaîne de caractères |
Oui |
Mode de traitement Les valeurs possibles sont
Test
Production |
Mode LS |
chaîne de caractères |
Oui |
Ce paramètre permet de contrôler le mode de traitement de
Lettershop est contrôlé, indépendamment de la licence.
est remplacée et n'est utilisée que si cet attribut manque.
Les réglages suivants sont possibles
AZD = l'adresse est utilisée au moyen de SortTreeReader pour la
recherche de district.
IHS = la personne est utilisée pour la recherche de district au moyen d'IHS.
est utilisée.
Si cet attribut n'est pas présent, le mode IHS est activé.
est activé par une licence IHS existante, sinon le mode
le mode AZD est activé. |
Structure du districtUPOC |
chaîne de caractères |
Oui |
UPOC de la structure du district. Si elle n'existe pas, la
Structure de district par défaut utilisée. |
AddTimeStampToOrder |
booléen |
Oui |
Identifier l'ordre avec la date / l'heure du
Compléter le traitement (true/false) |
AddressProcessing |
chaîne de caractères |
Oui |
Type de recherche d'adresse. Si non spécifié, exact.
Les valeurs possibles sont :
Imprécis
Précis |
AddressCorrection |
booléen |
Oui |
Utiliser la correction d'adresse
(vrai/faux). En cas de correction de l'adresse, l'adresse corrigée est
adresse est écrite dans le fichier de sortie. Si non
indiqué, alors true |
DelPreviousItems |
booléen |
Oui |
Supprimer les envois du même job LS (true/false).
Le client et l'identifiant de l'ordre doivent être identiques et les envois ne doivent pas être
ne pas être facturés.
Si non indiqué, alors true. |
InputTransformationRule |
GUID |
Oui |
GUID de la règle de transformation à utiliser pour le fichier
Fichier d'entrée |
OutputTransformationRule |
GUID |
Oui |
GUID de la règle de transformation à utiliser pour le fichier
Fichier de sortie |
Nom de l'InputScript |
chaîne de caractères |
Oui |
Nom du script d'entrée. Si ce n'est pas le cas
est indiqué, aucun script n'est exécuté. |
Nom de ValidateScript |
chaîne de caractères |
Oui |
Nom du script de validation. S'il n'est pas indiqué,
aucun script n'est exécuté. |
Nom du ProcessScript |
chaîne de caractères |
Oui |
Nom du script de processus. Si ce n'est pas le cas
est indiqué, aucun script n'est exécuté. |
Nom du GroupingScript |
chaîne de caractères |
Oui |
Nom du script de regroupement. S'il n'est pas indiqué,
aucun script n'est exécuté. |
Nom du bundlingScript |
chaîne de caractères |
Oui |
Nom du script de regroupement. Si
n'est pas indiqué, aucun script n'est exécuté. |
Nom de l'OutputScript |
chaîne de caractères |
Oui |
Nom du script de sortie. Si non spécifié, aucun script n'est
script est exécuté. |
Nom du DeliverScript |
chaîne de caractères |
Oui |
Nom du script d'envoi. Si ce n'est pas le cas
est indiqué, aucun script n'est exécuté. |
Nom du script final |
chaîne de caractères |
Oui |
Nom du script de clôture. Si non spécifié, le script est exécuté
aucun script n'est exécuté. |
ManualCheck |
booléen |
Oui |
Contrôle manuel / traitement
activer (true/false). Si non spécifié, alors false |
DeliveryDocumentReportName |
chaîne de caractères |
Oui |
Nom de profil du rapport pour les documents d'expédition.
Il est possible de définir plusieurs noms de profil. Les rapports
sont appelés individuellement.
Si non spécifié, aucun document d'expédition n'est
ne sont pas édités. |
GroupConfig |
ELEMENT |
Oui |
Cet élément contient tous les
les paramètres de regroupement des envois au sein d'un même
d'un job LS |
Nom |
chaîne de caractères |
Oui |
Nom du groupe |
GroupingAttribute |
chaîne de caractères |
Oui |
Attribut pour le regroupement |
SortingAttribute |
chaîne de caractères |
Oui |
attribut pour le tri. Si
l'attribut est vide, le tri par défaut est effectué par
numéro de ligne par ordre croissant.
Les attributs de tri doivent être utilisés de la même manière que la règle ORDER BY d'une requête SQL.
SQL (la syntaxe est conforme à la syntaxe Microsoft
SQL à partir de SQL Server V2008), il est possible d'utiliser au maximum les
attributs utilisés dans le Metalayer de Lettershop.
sont utilisés, à savoir les suivants :
strUPOC
strUserID
strAdresse
strPays
strPLZ
strOrt
strRue
strMaisonN°
strNom
lKKSID
strKKSUPOC
lPerformanceID
strPrestationUPOC
lPoids
eFormat
fCreateSBB
strIdentificateur de tâche
dtOrdre
dtPlanzaustellung
dtProduction
lDisponibilité anticipée
lExternePartnerID
lID de la structure du district
lID de district
strBezirkUPOC
strDLZoneUPOC
lHausID
strSortInfo
strZustellInfo
lArtikelID
strArtikelUPOC
curPorto
strEventHint
strPrestataireUPOC
strCode cible
strSIx
lErrorCode
strError
eStatus
strInputLine
strOrdersplit
strFileName
Exemple :
strNom de la commande ASC,
dtProduction DESC |
SortOrder |
chaîne de caractères |
Non |
Ordre de tri (croissant /
par ordre décroissant). Cette option n'est pas utilisée actuellement, mais doit être
mais doit être remplie. Les valeurs possibles sont :
asc
desc |
Splitting |
chaîne de caractères |
Oui |
Fichiers de sortie propres pour ce
Créer un groupe (true/false). Si non spécifié, alors
false |
SplittingFileName |
chaîne de caractères |
Oui |
Définition des noms de fichiers des
Fichiers de sortie, s'ils sont divisés. Si non spécifié, alors
un numéro consécutif est ajouté. |
BundlingConfig |
ELEMENT |
Oui |
Cet élément contient tous les
les paramètres de regroupement des envois au sein d'un même
d'un job LS |
Nom |
chaîne de caractères |
Oui |
Désignation de la liasse |
Critères |
chaîne de caractères |
Oui |
Critère qui doit être rempli
doit être rempli pour que les paramètres de regroupement soient appliqués.
Si aucun critère n'est indiqué, les réglages sont appliqués
Les paramètres de regroupement sont toujours appliqués. |
BundlingAttribute |
chaîne de caractères |
Oui |
Attribut pour le regroupement. |
minQuantity |
entier |
Oui |
Quantité minimale pour les bottes. Si
non spécifiée, alors 0 |
maxQuantity |
entier |
Oui |
Quantité maximale pour les liasses. Si
non indiqué, alors illimité |
maxWeight |
entier |
Oui |
Poids maximal pour les liasses en kg.
Si non indiqué, illimité |
AddSeparationRecord |
booléen |
Oui |
Créer un enregistrement pour la lettre de séparation
(true/false. Si non spécifié, alors false |
SeparationRecord |
chaîne de caractères |
Oui |
Définition pour l'enregistrement de la lettre de séparation. |
Ci-dessous, la définition du schéma XML :
<xs:schema elementFormDefault="qualifié"
xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:annotation>
<xs:documentation>
Cette spécification décrit la structure d'un fichier de configuration de tâche LS.
Ce fichier LS-Job-Config contient tous les paramètres pour
un job LS.
</xs:documentation>
</xs:annotation>
<xs:element name="LS-job">
<xs:annotation>
<xs:documentation>
Chaque fichier de configuration de tâche LS contient exactement un élément de type tâche LS.
S'il y a plusieurs éléments, seul le premier est utilisé.
est utilisé.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence minOccurs="1" maxOccurs="1">
<xs:element name="LS-Job-Config">
<xs:annotation>
<xs:documentation>Cet élément contient tous les réglages pour
un job LS</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence minOccurs="1" maxOccurs="1">
<!-- Paramètres de la tâche LS -->
<xs:element name="Nom" type="xs:string" minOccurs="0"
maxOccurs="1">
<xs:annotation>
<xs:documentation>Désignation optionnelle de la
configuration</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Mode" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>Mode de traitement</xs:documentation>.
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="Test"/>
<xs:énumération value="Production"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="LS-mode" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>Mode lettershop</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="AZD"/>
<xs:enumeration value="IHS"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="Structure de districtUPOC" type="UPOCType" minOccurs="0"
maxOccurs="1">
<xs:annotation>
<xs:documentation>UPOC optionnel de la structure de district. Si elle n'est pas
disponible, la structure de district par défaut est
est utilisée.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="AddTimeStampToOrder" type="BoolType" minOccurs="0"
maxOccurs="1">
<xs:annotation>
<xs:documentation>Indice d'ordre avec date / heure de traitement
compléter (true/false)</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="AddressProcessing" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>Type de recherche d'adresse. Si non spécifié, alors
exact</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="Précis"/>
<xs:énumération value="Imprécis"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="AddressCorrection" type="BoolType" minOccurs="0"
maxOccurs="1">
<xs:annotation>
<xs:documentation>Utiliser la correction d'adresse (true/false). Si
correction d'adresse, l'adresse corrigée est inscrite dans le fichier de sortie
est écrite dans le fichier d'adresse. Si non spécifié, true</xs:documentation>.
</xs:annotation>
</xs:element>
<xs:element name="DelPreviousItems" type="BoolType" minOccurs="0"
maxOccurs="1">
<xs:annotation>
<xs:documentation>
Supprimer les envois du même job LS (true/false).
Le client et l'identifiant de l'ordre doivent être identiques et les envois ne doivent pas être
être compensés.
Si non indiqué, alors true.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="InputTransformationRule" type="GUIDType"
minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>GUID de la transformation-rule à utiliser pour
le fichier d'entrée</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="OutputTransformationRule" type="GUIDType"
minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>GUID de la transformation-rule à utiliser pour
le fichier de sortie</xs:documentation>.
</xs:annotation>
</xs:element>
<xs:element name="InputScriptName" type="xs:string" minOccurs="0"
maxOccurs="1">
<xs:annotation>
<xs:documentation>Nom du script d'entrée. Si non spécifié, le script est
aucun script n'est exécuté.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="ValidateScriptName" type="xs:string" minOccurs="0"
maxOccurs="1">
<xs:annotation>
<xs:documentation>Nom du script de validation. Si ce n'est pas le cas
indiqué, aucun script ne sera exécuté.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="NomProcessScript" type="xs:string" minOccurs="0"
maxOccurs="1">
<xs:annotation>
<xs:documentation>Nom du script de processus. Si non spécifié,
aucun script n'est exécuté.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="GroupingScriptName" type="xs:string" minOccurs="0"
maxOccurs="1">
<xs:annotation>
<xs:documentation>Nom du script de regroupement. Si ce n'est pas le cas
indiqué, aucun script ne sera exécuté.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="BundlingScriptName" type="xs:string" minOccurs="0"
maxOccurs="1">
<xs:annotation>
<xs:documentation>Nom du script de bundling. Si non spécifié,
aucun script n'est exécuté.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="OutputScriptName" type="xs:string" minOccurs="0"
maxOccurs="1">
<xs:annotation>
<xs:documentation>Nom du script de sortie. Si non spécifié,
aucun script n'est exécuté.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="DeliverScriptName" type="xs:string" minOccurs="0"
maxOccurs="1">
<xs:annotation>
<xs:documentation>Nom du script d'envoi. Si non spécifié,
aucun script n'est exécuté.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="EndScriptName" type="xs:string" minOccurs="0"
maxOccurs="1">
<xs:annotation>
<xs:documentation>Nom du script de fin. Si non spécifié,
aucun script ne sera exécuté.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="ManualCheck" type="BoolType" minOccurs="0"
maxOccurs="1">
<xs:annotation>
<xs:documentation>Activer le contrôle manuel / l'édition
(true/false). Si non spécifié, false</xs:documentation>.
</xs:annotation>
</xs:element>
<xs:element name="DeliveryDocumentReportName" type="xs:string"
minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>
Nom de profil du rapport pour les documents d'expédition.
Il est possible de définir plusieurs noms de profil. Les rapports sont
sont appelés individuellement.
Si cela n'est pas indiqué, aucun document d'expédition n'est édité.
</xs:documentation>
</xs:annotation>
</xs:element>
<!-- Paramètres de regroupement -->
<xs:sequence minOccurs="0" maxOccurs="1">
<xs:element name="GroupConfig">
<xs:annotation>
<xs:documentation>Cet élément contient tous les paramètres de
regroupement des envois au sein d'un job LS</xs:documentation>.
</xs:annotation>
<xs:complexType>
<xs:sequence minOccurs="1" maxOccurs="unbounded">
<xs:element name="Nom" type="xs:string" minOccurs="0"
maxOccurs="1">
<xs:annotation>
<xs:documentation>Nom optionnel du groupe
groupe</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="GroupingAttribute" type="xs:string" minOccurs="1"
maxOccurs="1">
<xs:annotation>
<xs:documentation>Attribut de regroupement</xs:documentation>.
</xs:annotation>
</xs:element>
<xs:element name="SortingAttribute" type="xs:string" minOccurs="0"
maxOccurs="1">
<xs:annotation>
<xs:documentation>Attribut pour le tri. Si vide, pas de
Tri</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="SortOrder" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>Ordre de tri (croissant / décroissant).
Si non spécifié, ordre croissant. </xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="asc"/>
<xs:énumération value="desc"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="Fractionnement" type="BoolType" minOccurs="0"
maxOccurs="1">
<xs:annotation>
<xs:documentation>Créer des fichiers de sortie propres à ce groupe.
(true/false). Si non spécifié, false</xs:documentation>.
</xs:annotation>
</xs:element>
<xs:element name="SplittingFileName" type="xs:string" minOccurs="0"
maxOccurs="1">
<xs:annotation>
<xs:documentation>Définition des noms de fichier des fichiers de sortie, si
fractionnés. Si non spécifié, un numéro séquentiel
</xs:documentation>.
</xs:annotation>
</xs:element>
<!-- Paramètres de regroupement -->
<xs:element name="BundlingConfig"> Les paramètres de bundling sont les suivants
<xs:annotation>
<xs:documentation>Cet élément contient tous les paramètres de
regroupement d'envois au sein d'un job LS</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence minOccurs="0" maxOccurs="1">
<xs:element name="Nom" type="xs:string" minOccurs="0"
maxOccurs="1">
<xs:annotation>
<xs:documentation>Désignation optionnelle de la
regroupement</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Critères" type="xs:string" minOccurs="0"
maxOccurs="1">
<xs:annotation>
<xs:documentation>
Critère qui doit être rempli pour que les paramètres de regroupement soient
sont appliqués.
Si aucun critère n'est indiqué, les paramètres de regroupement sont
sont toujours appliqués.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="BundlingAttribute" type="xs:string" minOccurs="0"
maxOccurs="1">
<xs:annotation>
<xs:documentation>Attribut de regroupement.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="minQuantity" type="xs:integer" minOccurs="0"
maxOccurs="1">
<xs:annotation>
<xs:documentation>Quantité minimale pour les liasses. Si non spécifié,
alors 0</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="maxQuantity" type="xs:integer" minOccurs="0"
maxOccurs="1">
<xs:annotation>
<xs:documentation>Quantité maximale pour les liasses. Si non spécifié,
alors illimité</xs:documentation>.
</xs:annotation>
</xs:element>
<xs:element name="maxWeight" type="xs:integer" minOccurs="0"
maxOccurs="1">
<xs:annotation>
<xs:documentation>Poids maximal pour les liasses en kg. Si non
indiqué, il est illimité</xs:documentation>.
</xs:annotation>
</xs:element>
<xs:element name="AddSeparationRecord" type="BoolType" minOccurs="0"
maxOccurs="1">
<xs:annotation>
<xs:documentation>Créer un enregistrement pour la lettre de séparation (true/false. Si
non spécifié, alors false</xs:documentation>.
</xs:annotation>
</xs:element>
<xs:element name="SeparationRecord" type="xs:string" minOccurs="0"
maxOccurs="1">
<xs:annotation>
<xs:documentation>Définition pour
enregistrement de la lettre de séparation.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<!-- Types -->
<xs:simpleType name="BoolType">
<xs:annotation>
<xs:documentation>Typedef for boolean</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:string">
<xs:énumération value="true"/>
<xs:énumération value="false"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="UPOCType">
<xs:annotation>
<xs:documentation>Typedef pour UPOC</xs:documentation>.
</xs:annotation>
<xs:restriction base="xs:string">
<xs:minLength value="9"></xs:minLength>
<xs:maxLength value="16"></xs:maxLength>.
<xs:pattern value="[0-9]{9,16}"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="GUIDType">
<xs:annotation>
<xs:documentation>Typedef pour GUID</xs:documentation>.
</xs:annotation>
<xs:restriction base="xs:string">
<xs:minLength value="36"></xs:minLength>
<xs:maxLength value="36"></xs:maxLength>.
<xs:pattern
value="[0-9,A-F,a-f]{8}-[0-9,A-F,a-f]{4}-[0-9,A-F,a-f]{4}-[0-9,A-F,a-f]{4}-[0-9,A-F,a-f]{12}"/>
</xs:restriction>
</xs:simpleType>
</xs:schéma>
|