Dictionnaire des données du PES Aller

Ce chapitre fournit une présentation progressive, par domaine fonctionnel, des entités utilisées dans le cadre du Protocole d'Echange, indépendamment des modalités de transmission les concernant.

Pour visualiser le détail des types simples élémentaires du PES aller, cliquez sur le bouton :

Représentation des données élémentaires

Le paragraphe qui suit est applicable à la modélisation des données du PES Aller (espaces de noms "propriétaires" et ne concerne pas les données associées à l'utilisation des schémas normalisés (XML Signature, XADES, Encryption).

Généralités

Les données élémentaires représentent les structures atomiques à partir desquelles les structures plus complexes (classes, messages) sont construites.

Ces données élémentaires sont représentées sous forme d'éléments vides XML accompagnés d'un attribut de nom V dont le contenu est la valeur de la donnée.

Exemple : <CodePostal V="75001"/>

Les types XML de données correspondant sont construits sous forme de types complexes XML dont le rôle est de déclarer l'attribut V. Cet attribut est lui-même un type simple XML construit à partir des types préconstruit XML auxquels peuvent s'appliquer des contraintes (facettes).

Le tableau suivant présente dans ce cadre les correspondances suivantes :


Type de données Définition Type préconstruit XML Facettes Nom du type XML
Alphanumérique Chaîne de nombre et de lettres de taille maximale = X et de taille minimale = 1.

Les caractères autorisés sont uniquement :
  • les lettres de a à z (minuscule et majuscule),
  • les chiffres de 0 à 9.

Le champ :
  • ne peut pas contenir la valeur «nc», «0», «n fois 0»,
  • ne peut pas être vide.
string - maxlength
- minLength
- pattern
Base_AlphanumX



Alphanumérique Libre Chaîne de nombre et de lettres de taille maximale = X.

Les caractères autorisés sont uniquement :
  • les lettres de a à z (minuscule et majuscule),
  • les chiffres de 0 à 9.

Le champ :
  • peut être vide.
string - maxLength
- pattern
Base_AlphanumX_Light



Numérique Positif Entier de taille maximale = X et strictement positif (supérieur strict à 0).

Les 0 à gauche sont non significatifs et non comptabilisés dans la taille.

Par exemple,
  • 00015 a une taille = 2.
  • 15 a une taille = 2.
  • 150 a une taille = 3.
decimal - totalDigits
- minExclusive
- fractionDigits
Base_NumX



Numérique Entier de taille maximale = X, sous forme de chaine de caractères.

Les 0 à gauche sont significatifs et comptabilisés dans la taille.

Par exemple,
  • 00015 a une taille = 5.
  • 15 a une taille = 2.
  • 150 a une taille = 3.
string - maxLength
- pattern
Base_NumX_Light



Décimal Montant Libre Nombre décimal comportant au maximum 14 chiffres dont 2 chiffres après la virgule.

Les 0 à gauche sont non significatifs et non comptabilisés dans la taille.
decimal - totalDigits
- fractionDigits
Base_Montant_Light



Décimal Montant Nombre décimal strictement positif (strictement supérieur à 0) comportant au maximum 14 chiffres dont 2 chiffres après la virgule.

Les 0 à gauche sont non significatifs et non comptabilisés dans la taille.
decimal - totalDigits
- fractionDigits
- minExclusive
Base_Montant



Décimal Taux Nombre décimal strictement positif (strictement supérieur à 0) comportant au maximum 5 chiffres dont 2 chiffres après la virgule.

Les 0 à gauche sont non significatifs et non comptabilisés dans la taille.
decimal - totalDigits
- fractionDigits
- minExclusive
Base_Taux



Décimal Taux Libre Nombre décimal positif (supérieur ou égal à 0) comportant au maximum 5 chiffres dont 2 chiffres après la virgule.

Les 0 à gauche sont non significatifs et non comptabilisés dans la taille.
decimal - totalDigits
- fractionDigits
- minExclusive
Base_Taux_Light



Texte Chaîne de lettres et de nombres de taille maximale = X et de taille minimale = 1.

Le champ :
  • ne peut pas contenir la valeur «nc», «0», «n fois 0»,
  • ne peut pas être vide.
string - maxlength
- minLength
- pattern
Base_TexteX



Texte SEPA Chaîne de lettres et de nombres de taille maximale = X et de taille minimale = 1.

Les caractères autorisés sont :
  • les lettes de a à z (majuscule et minuscules),
  • les chiffres de 0 à 9
  • les caractères suivants : / ? : ( ) . , - + '
  • et le caractère «espace».
string - maxlength
- minLength
- pattern
Base_TexteXSEPA



Nom PJ Chaîne de caractères de taille maximale = 100, composée de :
  • 1 (ou plusieurs) caractères
  • suivi de «.» (point)
  • suivi de 2 à 4 caractères alphanumériques (lettres de a à z (majuscules et minuscules) et chiffres de 0 à 9).
string - maxlength
- pattern
Base_NomPJ



Alphanumérique Tiers Chaîne de nombre et de lettres de taille maximale = 15 et de taille minimale = 9.

Les caractères autorisés sont uniquement :
  • les lettres de a à z (minuscule et majuscule),
  • les chiffres de 0 à 9.

Le champ :
  • ne peut pas contenir la valeur «nc», «0», «n fois 0»,
  • ne peut pas être vide.
string - maxLength
- minLength
- pattern
Base_Texte9_15



Alphanumérique CP Chaîne de nombre et de lettres de taille = 5.

Les caractères autorisés sont uniquement :
  • les lettres de a à z (minuscule et majuscule),
  • les chiffres de 0 à 9.

Le champ :
  • ne peut pas contenir la valeur «nc», «0», «n fois 0»,
  • ne peut pas être vide.
string - maxLength
- minLength
- pattern
Base_Texte5_Longueur5



Id Ligne Orig Entier de taille comprise entre 1 et 6.

Les 0 à gauche sont significatifs et comptabilisés dans la taille.
string - maxLength
- minLength
- pattern
Base_Num6_NonVide



Année Année au format AAAA gyear   Base_Annee



Booléen Choix de quatre valeurs possibles (0, 1, TRUE ou FALSE) boolean   Base_Booleen



Date Date au format AAAA-MM-JJ date   Base_Date



Bloc de déclaration des types élémentaires

Nous précisons dans les paragraphes suivants les blocs de déclarations associés à ces types élémentaires.

Ces derniers sont regroupés dans un même schéma XML "simple_type.xsd". Ce schéma est lui même incorporé inclus (directive "xsd:include") dans la classe Class_SchemasCommuns (cf. ici) associée à l'espace de noms d'URI "http://www.minefi.gouv.fr/cp/commun"

Types de données de base

Base String

Ce type simple V_BaseString est défini pour interdire les saisies de chaines «.», « », «nc». La modélisation XML est la suivante :

<xs:simpleType name="V_BaseString">
  <xs:restriction base="xs:string">
    <xs:pattern value="[^ \.]|n[^c]|[^n]c|[^n][^c]|...+"/>
  </xs:restriction>
</xs:simpleType>

Base Alphanum

Ce type simple V_BaseAlphanum est défini pour interdire les chaines avec que des 0 en plus des chaines «.», « », «nc». En outre la chaine doit avoir au moins un caractère. La modélisation XML est la suivante :

<xs:simpleType name="V_BaseAlphanum">
  <xs:restriction base="V_BaseString">
    <xs:pattern value=".*[^0]+.*"/>
  </xs:restriction>
</xs:simpleType>

Types de données

Variable de type alphanumérique

Exemple : <IdPost V="1234AB"/>

La modélisation XML d'une chaîne alphanumérique de longueur maximale max se fait comme suit :

<xs:complexType name="Base_Alphanummax">
  <xs:attribute name="V" type="V_Alphanummax" use="required"/>
</xs:complexType">
<xs:simpleType name="V_Alphanummax">
  <xs:restriction base="V_BaseAlphanum">
    <xs:maxLength value="max"/>
    <xs:minLength value="1"/>
    <xs:pattern value="[0-9a-zA-Z]*"/>
  </xs:restriction">
</xs:simpleType">

Variable de type alphanumérique libre

Exemple : <CodBudBen V="A0"/>

La modélisation XML d'une chaîne alphanumérique de longueur maximale max se fait comme suit :

<xs:complexType name="Base_Alphanummax_Light">
  <xs:attribute name="V" type="V_Alphanummax_Light" use="required"/>
</xs:complexType">
<xs:simpleType name="V_Alphanummax_Light">
  <xs:restriction base="xs:string">
    <xs:maxLength value="max"/>
    <xs:pattern value="[0-9a-zA-Z]*"/>
  </xs:restriction">
</xs:simpleType">

Variable de type numérique positif

Exemple : <FinGeo V="12345687"/>

La modélisation XML d'une chaîne numérique de longueur maximale max se fait comme suit :

<xs:complexType name="Base_Nummax">
  <xs:attribute name="V" type="V_Nummax" use="required"/>
</xs:complexType>
<xs:simpleType name="V_Nummax">
  <xs:restriction base="xs:int">
    <xs:totalDigits value="max"/>
    <xs:minExclusive value="0"/>
  </xs:restriction>
</xs:simpleType>

Variable de type numérique

Exemple : <CleRib V="00"/>

La modélisation XML d'une chaîne numérique de longueur maximale max se fait comme suit :

<xs:complexType name="Base_Nummax_Light">
  <xs:attribute name="V" type="V_Nummax_Light" use="required"/>
</xs:complexType>
<xs:simpleType name="V_Nummax_Light">
  <xs:restriction base="xs:string">
    <xs:maxLength value="max"/>
    <xs:pattern value="[0-9]*"/>
  </xs:restriction>
</xs:simpleType>

Variable de type décimal montant

Exemple : <MtPayTot V="1254.67"/>

Ce type de variable est défini dans comme décimal avec 14 chiffres maximum, dont deux après la virgule et strictement positif.

La modélisation XML se présente comme suit :

<xs:complexType name="Base_Montant">
  <xs:attribute name="V" type="V_Montant" use="required"/>
</xs:complexType">
<xs:simpleType name="V_Montant">
  <xs:restriction base="xs:decimal">
    <xs:totalDigits value="14"/>
    <xs:fractionDigits value="2"/>
    <xs:minExclusive value="0"/>
  </xs:restriction>
</xs:simpleType>

Variable de type décimal montant libre

Exemple : <MtHT V="0"/>

Ce type de variable est défini dans comme décimal avec 14 chiffres maximum, dont deux après la virgule.

La modélisation XML se présente comme suit :

<xs:complexType name="Base_Montant_Light">
  <xs:attribute name="V" type="V_Montant_Light" use="required"/>
</xs:complexType">
<xs:simpleType name="V_Montant_Light">
  <xs:restriction base="xs:decimal">
    <xs:totalDigits value="14"/>
    <xs:fractionDigits value="2"/>
  </xs:restriction>
</xs:simpleType>

Variable de type décimal taux

Exemple : <TxIntMor V="07.34"/>

Ce type de variable est défini comme décimal avec 5 chiffres maximum, dont deux après la virgule.

La modélisation XML se présente comme suit :

<xs:complexType name="Base_Taux"/>
  <xs:attribute name="V" type="V_Taux" use="required"/>
<xs:simpleType name="V_Taux">
  <xs:restriction base="xs:decimal">
    <xs:totalDigits value="5"/>
    <xs:fractionDigits value="2"/>
    <xs:minExclusive value="0"/>
  </xs:restriction>
</xs:simpleType>

Variable de type décimal taux libre

Exemple : <TauxTVA V="0"/>

Ce type de variable est défini comme décimal avec 5 chiffres maximum, dont deux après la virgule.

La modélisation XML se présente comme suit :

<xs:complexType name="Base_Taux_Light"/>
  <xs:attribute name="V" type="V_Taux_Light" use="required"/>
<xs:simpleType name="V_Taux_Light">
  <xs:restriction base="xs:decimal">
    <xs:totalDigits value="5"/>
    <xs:fractionDigits value="2"/>
    <xs:minInclusive value="0"/>
  </xs:restriction>
</xs:simpleType>

Variable de type texte

Exemple : <Objet V="Ceci est un texte"/>

La modélisation XML d'une variable de type texte avec une longueur maximale max se fait comme suit :

<xs:complexType name="Base_Textemax">
  <xs:attribute name="V" type="V_Textemax" use="required"/>
</xs:complexType">
<xs:simpleType name="V_Textemax">
  <xs:restriction base="V_BaseAlphanum">
    <xs:maxLength value="max"/>
    <xs:minLength value="1"/>
  </xs:restriction>
</xs:simpleType>

Variable de type texte SEPA

Exemple : <LibPrel V="Ceci est un libelle de prelevement"/>

La modélisation XML d'une variable de type texte SEPA avec une longueur maximale max se fait comme suit :

<xs:complexType name="Base_TextemaxSEPA">
  <xs:attribute name="V" type="V_TextemaxSEPA" use="required"/>
</xs:complexType">
<xs:simpleType name="V_TextemaxSEPA">
  <xs:restriction base="V_BaseAlphanum">
    <xs:maxLength value="max"/>
    <xs:minLength value="1"/>
    <xs:pattern value="[0-9a-zA-Z/?:()\., \-+']*"/>
  </xs:restriction>
</xs:simpleType>

Variable de type Nom PJ

Exemple : <NomPJ V="Nom PJ.pdf"/>

La modélisation XML d'une variable de type texte Nom PJ se fait comme suit :

<xs:complexType name="Base_NomPJ">
  <xs:attribute name="V" type="V_Base_NomPJ" use="required"/>
</xs:complexType">
<xs:simpleType name="V_Base_NomPJ">
  <xs:restriction base="V_BaseString">
    <xs:maxLength value="100"/>
    <xs:pattern value=".+\.[A-Za-z0-9]{2,4}"/>
  </xs:restriction>
</xs:simpleType>

Variable de type Alphanumérique Tiers

Exemple : <IdTiers V="123456789"/>

La modélisation XML d'une variable de type Alphanumérique Tiers se fait comme suit :

<xs:complexType name="Base_Texte9_15">
  <xs:attribute name="V" type="V_Texte9_15" use="required"/>
</xs:complexType">
<xs:simpleType name="V_Texte9_15">
  <xs:restriction base="V_BaseAlphanum">
    <xs:maxLength value="15"/>
    <xs:minLength value="9"/>
  </xs:restriction>
</xs:simpleType>

Variable de type Alphanumérique CP

Exemple : <CP V="93130"/>

La modélisation XML d'une variable de type Alphanumérique CP se fait comme suit :

<xs:complexType name="Base_Texte5_Longueur5">
  <xs:attribute name="V" type="V_Texte5_Longueur5" use="required"/>
</xs:complexType">
<xs:simpleType name="V_Texte5_Longueur5">
  <xs:restriction base="V_BaseAlphanum">
    <xs:maxLength value="5"/>
    <xs:minLength value="5"/>
  </xs:restriction>
</xs:simpleType>

Variable de type Id Ligne Orig

Exemple : <IdLigneOrig V="1"/>

La modélisation XML d'une chaîne numérique de longueur maximale max se fait comme suit :

<xs:complexType name="Base_Num6_NonVide">
  <xs:attribute name="V" type="V_Num6_NonVide" use="required"/>
</xs:complexType>
<xs:simpleType name="V_Num6_NonVide">
  <xs:restriction base="xs:string">
    <xs:maxLength value="6"/>
    <xs:minLength value="1"/>
    <xs:pattern value="[0-9]*"/>
  </xs:restriction>
</xs:simpleType>

Variable Année

Exemple : <Exercice V="2013"/>

Ce type de variable est défini comme Date au format AAAA.

La modélisation XML se présente comme suit :

<xs:complexType name="Base_Annee"/>
  <xs:attribute name="V" type="V_Annee" use="required"/>
</xs:complexType"/>
<xs:simpleType name="V_Annee"/>
  <xs:restriction base="xs:gYear"/>
</xs:simpleType"/>

Variable booléen

Exemple : <MarAlim V="1"/>

La modélisation XML se présente comme suit :

<xs:complexType name="Base_Booleen"/>
  <xs:attribute name="V" type="V_Booleen" use="required"/>
</xs:complexType"/>
<xs:simpleType name="V_Booleen"/>
  <xs:restriction base="xs:boolean"/>
</xs:simpleType"/>

Variable Date

Exemple : <DtePcePEC V="2013-12-04"/>

Ce type de variable est défini comme Date au format AAAA-MM-JJ.

La modélisation XML se présente comme suit :

<xs:complexType name="Base_Date"/>
  <xs:attribute name="V" type="V_Date" use="required"/>
</xs:complexType"/>
<xs:simpleType name="V_Date"/>
  <xs:restriction base="xs:date"/>
</xs:simpleType"/>