Trustedbird Client Wiki - Contributions de l’utilisateur [fr]

XIMF XML tags/fr

2011-06-30T08:44:24Z

Anthonyjuge : /* Fichier headers */

== Introduction ==
Ce document propose un modèle de description, via eXtensible Markup Language (XML), d’entêtes de messages électroniques respectant la norme XIMF. Ce document a deux objectifs :
# Décrire les éléments et attributs de représentation XML pour construire des entêtes de messages électroniques de format XIMF.
# Fournir un modèle de représentation XIMF/XML.

<u>Rappel :</u>
* Un "élément" fait référence à tous les caractères situés entre une balise de départ et un balise de fin, e.g.,
<exemple> texte et/ou éléments fils </exemple>
* Un "attribut" est une composante d’un élément. Il est positionné dans la balise de départ, e.g.,
<exemple nom='value'>

Tous les éléments décrits dans cette documentation paragraphe sont validés dans l’espace de nom "ximf".

<pre>
xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://eads.org/ximf/ximf.xsd"
</pre>

== Description détaillée des balises XML ==
Voici, par ordre d'apparition et en fonction des fichiers, les balises génériques associées aux différents fichiers XML.

=== Fichier ximfmail-profile ===
Un fichier xpi peut contenir plusieurs instances XIMF, celles-ci sont alors regroupées dans une même catégorie. Le fichier ximfmail-profile contient des informations sur toutes les instances contenues dans le xpi, notamment leur nom, leur chemin d'accès, ainsi que les noms des fichiers associés à chaque instance.

==== Element instance ====
L’élément "instance" identifie l’ensemble des entêtes à décrire selon la norme XIMF. C’est le conteneur principal d’une instance XIMF/XML. Cinq attributs précisent la balise "instance" : "ximfVersion", "version", "author", "creation", "name", e.g.,
<ximf:instance name="myInstance" version="1.0" ximfVersion="2.0" >

* Détails sur les attributs de l'élément "instance" :
** L’attribut "name" définit le nom de l’instance décrite. Cet attribut est obligatoire.
** L’attribut "ximfVersion" définit le numéro de version des entêtes XIMF utilisés pour cette représentation. Cet attribut est obligatoire.
** L’attribut "version" définit le numéro de version de l’instance décrite. Cet attribut est obligatoire.
** L’attribut "author" renseigne sur le nom de l’auteur de cette instance.
** L’attribut "creationDate" précise la date de création de cette instance.

L’élément "instance" peut contenir un ou plusieurs éléments "schema", un ou plusieurs éléments "rule", un élément "ihm" et un élément "dictionary".

==== Element dictionary ====
L'élément dictionary contient le chemin vers le fichier spécifiant les données d'internationalisation (Cf. [[#Fichier_dictionary|Fichier dictionary]]).

==== Element schema ====
L'élément shema contient le chemin vers le fichier spécifiant les entêtes XIMF (Cf. [[#Fichier_headers|Fichier headers]]).

==== Element ihm ====
L'élément ihm contient le chemin vers le fichier spécifiant la disposition de l'interface des formulaires XIMF (Cf. [[#Fichier_ihm|Fichier ihm]]). Un seul élément ihm est chargé par instance.

==== Element rule ====
L'élément rule contient le chemin vers le fichier spécifiant les règles associées aux valeurs des champs XIMF (Cf. [[#Fichier_rules|Fichier rules]]).

=== Fichier dictionary ===
Le fichier dictionnary permet de mettre en œuvre l’internationalisation d’une instance XIMF. Il défini des dictionnaires qui servent à traduire les éléments de l'instance XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient un élément "ximf:dictionnary".

==== Element dictionary ====
<ximf:dictionary>
<ximf:locale lang="fr-FR" />
<ximf:locale lang="en-US" />
</ximf:dictionary>

==== Element locale ====
L’élément "locale" contient toutes les informations pour un pays et/ou langue désignée.
L’élément "locale" contient un ou plusieurs mêmes éléments "ilk", e.g.,

<ximf:locale lang="fr-FR" >
<ximf:ilk entity="a"/>
<ximf:ilk entity="b"/>
</ximf:locale>

* Détails sur les attributs de la balise "locale" :
** L’attribut "lang" définit le code pays de ce conteneur. Il devrai être construit selon le format défini par la RFC1766 (fr, en, ja, es, …).

==== Element ilk ====
L’élément "ilk" contient une unique information correspondant à une donnée traduite selon le code pays de l’élément père. Cette information est au format chaîne de caractère. Un attribut obligatoire précise la balise "ilk".

<ximf:ilk entity="ilk-lang-ihm">langue</ximf:ilk>

* Détails sur les attributs de la balise "ilk" :
** L’attribut "entity" définit la référence d’entrée pour récupérer le contenu de l’élément selon le code pays souhaité.

Finalement, le fichier "dictionary" pourra contenir :
<ximf:instance name="Whirlpool">
<ximf:dictionary>
<ximf:locale lang="fr-FR" >
<ximf:ilk entity="ilk-lang-ihm">Français</ximf:ilk>
<ximf:ilk entity="ilk-exemple-general">Général</ximf:ilk>
</ximf:locale>
<ximf:locale lang="en-US" >
<ximf:ilk entity="ilk-lang-ihm">English (US)</ximf:ilk>
<ximf:ilk entity="ilk-exemple-general">General</ximf:ilk>
</ximf:locale>
</ximf:dictionary>
</ximf:instance>

=== Fichier ihm ===
Le fichier ihm spécifie l'agencement de l'interface des formulaires XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient un élément "ximf:ihm".

==== Element ihm ====
L'élément "ihm" contient un ou plusieurs éléments "panel" et un élément "treeRcv".

==== Element panel ====
Un élément ximf:panel correspond à un onglet du formulaire XIMF construit.
Deux attributs précisent la balise "panel" : "id" et "ilk", eg.
<ximf:panel id="pane_security" ilk="ilk-priority-panel" />

* Détails sur les attributs de l'élément "panel" :
** L’attribut "id" définit le nom de l'onglet, il doit être unique pour chaque élément "ximf:panel" et est formaté selon la syntaxe "pane-xxx". Cet attribut est obligatoire.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.

L'élément "ximf:panel" contient au moins un éléments "ximf:groupbox".

==== Element groupbox ====
Un élément groupbox correspond à une sous catégorie d'un onglet du formulaire XIMF.
La structure "groupbox" détaille l’ordre d’affichage des entêtes dans un message.
Deux attributs précisent la balise "ximf:groupbox" : "id" et "ilk", eg.
<ximf:groupbox id="group-classification" ilk="ilk-secu-box" />

* Détails sur les attributs de l'élément "groupbox" :
** L’attribut "id" définit le nom de l'onglet, il doit être unique pour chaque élément "ximf:panel" et est formaté selon la syntaxe "pane-xxx". Cet attribut est obligatoire.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.

L'élément "groupbox" contient au moins un éléments "headerRef".

==== Element treeRcv ====
L'élément "treeRcv" permet de spécifier quelles sont les colonnes susceptibles d'être ajoutées dans le panneau principal du client de messagerie qui contient la liste des messages d’un dossier.

L'élément "treeRcv" peut contenir des éléments "headerRef".

==== Element headerRef ====
L'élément headerRef spécifie les champs associés à chaque sous-groupe d'onglet de formulaire ou les champs qu'il est possible d'afficher dans la liste des messages.
Aucun attribut ne vient compléter la balise "headerRef", eg.
<ximf:headerRef>header-classification</ximf:headerRef>

Finalement, le fichier "ihm" pourra contenir :
<pre>
<ximf:instance name="Amoco">
<ximf:ihm>
<ximf:panel id="pane_security" ilk="ilk-priority-panel">
<ximf:groupbox id="group-classification" ilk="ilk-secu-box">
<ximf:headerRef>header-correspondance-type</ximf:headerRef>
<ximf:headerRef>header-classification</ximf:headerRef>
</ximf:groupbox>
</ximf:panel>
<ximf:treeRcv>
<ximf:headerRef>header-classification</ximf:headerRef>
</ximf:treeRcv>
</ximf:ihm>
</ximf:instance>
</pre>

=== Fichier headers ===
Le fichier headers spécifie les types des champs de l'interface des formulaires XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient des éléments "header".

==== Element header ====
Chaque élément "header" décrit un entête de message de format XIMF.
Huit attributs précisent la balise "header" : "headerName", "id", "technicalHeaderName", "type", "technicalType", "isMandatory", "ilk", "description", e.g.,

<ximf:header id="header-primary-precedence"
headerName="X-XIMF-Primary-Precedence"
ilk="ilk-primary-precedence"
isMandatory="true"
description="entête d’urgence"
type="string" />

* Détails sur les attributs de l'élément "header" :
** L’attribut "headerName" définit le nom du champ XIMF. Cet attribut est obligatoire.
** L’attribut "id" définit un identifiant de champ, il doit être unique pour chaque élément "header" et est formaté selon la syntaxe "header-xxx". Cet attribut est obligatoire.
** L’attribut "isMandatory" précise si ce champ doit être obligatoirement présent dans le message intégrant les entêtes selon cette description.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.
** L’attribut "type" précise le format des données associées à cet élément. Ce format peut être une date, une chaîne, une adresse mail, un O.I.D.
** L’attribut "technicalHeaderName" permet de compléter l’entête décrit par un autre entête.
** L’attribut "technicalType" précise le format des données associées à l’élément technicalHeaderName.
** L’attribut "description" permet d’ajouter une information sur cet élément.

L’élément "header" contient obligatoirement un élément "set", "multiset", "string", ou "compstring", e.g.,

<ximf:header id="header-reply-by"
headerName="X-XIMF-Reply-By"
ilk="ilk-reply-by"
isMandatory="false" >
<ximf:string id="value-reply-by" editable="true" />
</ximf:header>

Note : Il est possible de spécifier un champ d'en-tête XIMF avec une valeur prédéfinie. L'utilisateur ne peut pas modifier la valeur de ce champ, aucun élément de l'interface ne sera ajouté. Pour ce faire, il faut spécifier un élément ximf:header ne contenant pas d'attribut "ilk" et proposant un choix unique de valeur (l’élément fils est ximf:string). Dans ce cas, le moteur XIMF prend le header en compte comme une valeur technique à envoyer directement, sans la présenter à l'utilisateur.

==== Element string ====
L’élément "string" précise le contenu d’une ressource de type chaîne de caractères imprimables (a-z, A-Z, 1-9,…)
Quinze attributs complètent l’élément "string" : "id", "ref", "ilk", "aclLevel", "index", "description", "editable", "content", "technicalContent","maxItem", "minItem", "maxLength", "minLength", "separator", "technicalSeparator", e.g.,

<ximf:string ilk="ilk-france" content="FRA" />

* Détails sur les attributs de l'élément "string" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "string".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role| élément role]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut " description " permet d’associer un commentaire sur cette donnée.
** L’attribut "editable" définit une valeur de saisie (champ libre). Cet attribut est de type booléen.
** L’attribut "content" représente la valeur effective de la donnée. C’est cette donnée qui sera associée au champ XIMF créé.
** L’attribut "technicalContent" représente la valeur effective de la donnée technique. C’est cette donnée qui sera associée au champ technique XIMF créé (cf. attribut technicalHeaderName de l’élément "header".
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.

L’élément "string" peut contenir plusieurs éléments "linkedValue".

<ximf:string ilk="ilk-non-protege" content="NON PROTEGE" technicalContent="1" >
<ximf:linkedValue ref="value-non-protege-france " />
</ximf:string>

==== Element compstring ====
L’élément "compstring" décrit un conteneur de concaténation des éléments fils. Il permet notamment de créer des valeurs d’entêtes composées.
Dix-sept attributs complètent l’élément "compstring" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", "content", "technicalContent", "contentPositionEnd", "contentFactorise", "technicalPositionEnd", e.g.,

<ximf:compstring
ilk="ilk-special"
content="SPECIAL"
technicalContent="1.3.4"
separator=" "
technicalSeparator=".">

* Détails sur les attributs de l'élément "compstring" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "compstring".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (cf. [[#Element_role| élément "role"]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut " description " permet d’associer un commentaire sur cette donnée.
** L’attribut "content" représente la valeur effective de la donnée. C’est cette donnée qui sera associée au champ XIMF créé.
** L’attribut "technicalContent" représente la valeur effective de la donnée technique. C’est cette donnée qui sera associée au champ technique XIMF créé (cf. attribut technicalHeaderName de l’élément "header".
** L’attribut "separator" définit le caractère de séparation entre deux valeurs.
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "contentPositionEnd" impose de positionner le contenu de l’élément "compstring" après les valeurs des éléments fils : valuefils1,valuefils2 : valuecompstring.
** L’attribut "technicalPositionEnd" impose de positionner le contenu de l’élément "compstring" après les valeurs des éléments fils.
** L’attribut "contentFactorise" impose d’utiliser le contenu de l’élément "compstring" comme facteur des éléments fils : valuecompstring(valuefils1,valuefils2).

L’élément "compstring" peut contenir un élément "string" ou "set" ou "multiset" ou plusieurs éléments "compstring".

<ximf:compstring
ilk="ilk-special"
content="SPECIAL"
technicalContent="1.3.4"
separator=" "
technicalSeparator=".">
<ximf:set id="ilk-special-op " maxItem="64">
<ximf:string ilk="ilk-special-op1" content="OP1" technicalContent="1" />
<ximf:string ilk="ilk-special-op2" content="OP2" technicalContent="2" />
<ximf:string ilk="ilk-special-op3" content="OP3" technicalContent="3" />
</ximf:set>
</ximf:compstring>

==== Element set ====
L’élément "set" décrit un conteneur de ressources de même type. Cet élément autorise la sélection de plusieurs ressources mais chaque ressource est sélectionnée une seule fois.
Douze attributs précisent la description de la balise "set" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", e.g.,

<ximf:set id="value-categories" ref="value-mentions" maxItem="64" separator=";" />

* Détails sur les attributs de l'élément "set" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "ximf:set".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role|élément rôle]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut "description" permet d’associer un commentaire sur cette donnée.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs

L’élément "set" peut contenir un ou plusieurs éléments "string" ou un ou plusieurs éléments "compstring".

<ximf:set id="value-categories" minItem="1" maxItem="64" separator=";">
<ximf:string ilk="ilk-releasable-to" content="RELEASABLE TO " />
<ximf:string ilk="ilk-eyes-only" content=" EYES ONLY"/>
<ximf:string ilk="ilk-use-only" content=" USE ONLY"/>
</ximf:set>

==== Element multiset ====
L’élément "multiset" décrit un conteneur de ressources de même type. Cet élément autorise la sélection de plusieurs ressources et chaque ressource peut être sélectionnée plusieurs fois.
Douze attributs précisent la description de la balise "multiset" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", e.g.,

<ximf:multiset
id="value-restricted"
ilk=" ilk-value-restricted"
maxItem="64"
separator=";" />

* Détails sur les attributs de l'élément "multiset" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "multiset".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role|élément rôle]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut "description" permet d’associer un commentaire sur cette donnée.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs

L’élément "multiset" peut contenir un ou plusieurs éléments "string" ou un ou plusieurs éléments "compstring".

<ximf:multiset id="value-restricted-example-categories" minItem="1" maxItem="64" separator=";" >
<ximf:string ilk="ilk-releasable-to" content="RELEASABLE TO "/>
<ximf:string ilk="ilk-eyes-only" content=" EYES ONLY"/>
<ximf:string ilk="ilk-use-only" content=" USE ONLY"/>
</ximf:multiset>

==== Element linkedValue ====
L’élément "linkedValue" définit une référence sur une ressource de type conteneur ("set", "multiset") ou "string". Cette ressource devrait être utilisée si la ressource contenant "linkedValue" (noeud parent) est sélectionnée.
Un attribut précise la balise "linkvalue" : "ref", e.g.,

<ximf:linkedValue ref="value-restricted-example-classification-id" />

* Détails sur les attributs de l'élément "linkedValue" :
** L’attribut "ref" précise la valeur de l’attribut "id" de la ressource cible. Cet attribut est obligatoire.

=== Fichier rules ===
Le fichier rules définit les règles de contrôles d’entêtes XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui peut contenir des éléments "ximf:rule".

==== Element rule ====
L’élément "rule" est le conteneur principal de description d’un comportement particulier à appliquer sur un ensemble d’entêtes XIMF.
Trois attributs précisent la balise "rule" : "id", "agent", "description", e.g.,
<ximf:rule id="compatibility-rule" description="Règle sur la compatibilité X-SMTP / XIMF" >

* Détails sur les attributs de l'élément "rule" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "rule". Cet attribut est obligatoire.
** L’attribut "agent" indique l’équipement cible devant analyser et appliquer le contenu de cet élément.
** L’attribut "description" autorise l’auteur d’ajouter un commentaire sur cet élément.

L’élément "rule" contient un ou plusieurs mêmes éléments de spécialisation de la règle "contraint", "assignement", "processing", "compatibility", "accessibility", "custom",…, e.g.,

<ximf:rule id="precedence-rule" agent="mua" description="Règle sur les priorités">
<ximf:constraint
left="header-primary-precedence"
operator="equalOrGreaterThan"
right="header-copy-precedence" />
</ximf:rule>

==== Element aliasHeader ====
L’élément "aliasHeader" permet de définir le nom de l’entête sur lequel la règle précisée est appliquée
Deux attributs précisent la balise "aliasHeader" : "headerName" et "headerRef", e.g.,

<ximf:aliasHeader headerName ="X-P772-Version" headerRef="X-XIMF-VERSION" />

* Détails sur les attributs de l'élément "aliasHeader" :
* L’attribut "headerName" définit le nom XIMF de l’entête modifié par la règle. Cet attribut est obligatoire.
* L’attribut "headerRef" définit le nom d’un entête XIMF de référence qui est le point d’entrée de l’application de la règle sur l’entête définit par "headerName". Cela permet de lier deux entêtes de messages où l’utilisation de l’un des entêtes influe sur le comportement de l’autre.

L’élément "aliasHeader" peut contenir des éléments "aliasValue",e.g ,

<ximf:aliasHeader headerName="X-P772-Version" />
<ximf:aliasValue vame="1.0"/>
<ximf:aliasHeader>

==== Element aliasValue ====
L’élément "aliasValue" contient une valeur à associer à l’entête XIMF contrôlé par la règle. Il est utile lorsque deux entêtes sont liées (utilisation de l’attribut headerRef dans l’élément aliasHeader) et que les valeurs de l’entêtes de référence permettent de préciser celles de l’entête contrôlé.
Deux attributs précisent la balise "aliasValue" : "valueName", "valueRef", e.g.,

<ximf:aliasValue valueName="2" valueRef="flash" />

* Détails sur les attributs de l'élément "aliasValue" :
** L’attribut "valueName" définit la valeur de l’entête à créer. Cet attribut est obligatoire.
** L’attribut "valueRef" définit la valeur de l’entête XIMF de référence pour utiliser valueName.

==== Element compatibility ====
L’élément "compatibility" est utilisé pour associer à un entête respectant la norme XIMF un entête respectant une autre norme que XIMF (XSMTP par exemple).
Deux attributs précisent la balise "compatibility" : "targetName", "targetVersion", e.g.,

<ximf:compatibility targetName="X-SMTP" targetVersion="1.1">
<ximf:aliasValue headerName="X-P772-Version" content="1.1" />
<ximf:aliasValue
headerName="X-P772-Primary-Precedence"
headerRef="header-primary-precedence"
dataRef="data-priority-xsmtp"/>
</ximf:compatibility>

* Détails sur les attributs de l'élément "compatibility" :
** L’attribut "targetName" définit la norme de l’entête à associer à l’entête XIMF. Cet attribut est obligatoire.
** L’attribut "targetVersion" définit le numéro de version de la norme de l’entête à associer à l’entête XIMF. Cet attribut est obligatoire.

L’élément "compatibility" contient au moins un élément "aliasHeader".

<u>Pour illustrer cette règle :</u>
Le format XSMTP est déjà supporté par certains équipements. Afin de rendre ceux-ci inter opérables avec le nouveau format XIMF, cette règle permet d’associer un entête XSMTP contenant les mêmes informations qu’un entête XIMF.

L’élément Association : dépendance entre entêtes
L’élément "association" définie les valeurs autorisées pour un entête XIMF en fonction d’une valeur définie pour un autre entête XIMF.

<ximf:association>
<ximf:aliasHeader
headerName="X-XIMF-Primary-Precedence"
headerRef="X-XIMF-Correspondence-Type">
<ximf:aliasValue valueName="routine" valueRef="private" />
<ximf:aliasValue valueName="routine,priority" valueRef="professional" />
<ximf:aliasValue valueName="routine,priority,immediate,flash" valueRef="operational" />
<ximf:aliasValue valueName="routine,priority,immediate" valueRef="official" />
</ximf:aliasHeader>
</ximf:association>

==== Element secureHeaders ====
L’élément "secureHeaders" définie la liste des entêtes à intégrer dans la signature d’un message. Cette règle s’applique sur les équipements proposant un algorithme de signature des messages.

Un élément "secureHeaders" contient un ou plusieurs éléments "aliasHeaders" où chaque élément décrit un entête à intégrer dans la signature et complété d’un attribut "status".

<ximf:secureHeaders targetName="SecureHeaders">
<ximf:aliasHeader headerName="X-XIMF-Primary-Precedence" status="0" />
<ximf:aliasHeader headerName="X-XIMF-Copy-Precedence" status="0" />
</ximf:secureHeaders>

==== Element securityLabel ====
L’élément "securityLabel" définie la liste des entêtes à intégrer dans la signature d’un message. Cette règle s’applique sur les équipements proposant un algorithme de signature des messages selon la norme RFC.

Un élément "securityLabel" contient un ou plusieurs éléments "aliasHeaders" où chaque élément décrit un entête à intégrer dans la signature et complété d’un attribut "status".

<ximf:securityLabel targetName="SecurityLabel" id="Amoco">
<ximf:aliasHeader
headerName="SecurityPolicyIdentifier"
headerRef="X-XIMF-Security-Policy-Identifier" />
<ximf:aliasHeader
headerName="SecurityClassification"
headerRef="X-XIMF-Security-Classification-Identifier" />
<ximf:aliasHeader
headerName="ESSPrivacyMark"
headerRef="X-XIMF-Privacy-Mark" />
<ximf:aliasHeader
headerName="SecurityCategory"
headerRef="X-XIMF-Security-Categories-Identifier"
type="2" />
</ximf:securityLabel>

==== Element constraint ====
L’élément "constraint" est utilisé pour définir une règle de construction de deux entêtes partageant des "datas" identiques.
Trois attributs précisent la balise "constraint" : "left", "right", "operator", e.g.,

<ximf:constraint
left="header-primary-precedence"
operator="equalOrGreaterThan"
right="header-copy-precedence" />

* Détails sur les attributs de l'élément "constraint" :
** L’attribut "left" désigne le premier élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "right" désigne le deuxième élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "operator" indique la règle de poids à appliquer sur la valeur des deux éléments "header", il peut être de type "greaterThan", "lowerThan", "equalOrGreaterThan", "equalOrLowerThan", "equal". Cet attribut est obligatoire.

* Détails sur les valeurs possibles de l'attribut "type" :
** Le type "greaterThan" signifie que la valeur de l’élément "left" doit être strictement supérieur à la valeur de l’élément "right".
** Le type "lowerThan" signifie que la valeur de l’élément "left" doit être strictement inférieur à la valeur de l’élément "right".
** Le type "equalOrGreaterThan" signifie que la valeur de l’élément "left" doit être supérieur ou égale à la valeur de l’élément "right".
** Le type "equalOrLowerThan" signifie que la valeur de l’élément "left" doit être inférieur ou égale à la valeur de l’élément "right".
** Le type "equal" signifie que la valeur de l’élément "left" et de l’élément "right" doivent être identiques.

==== Element assignment ====
L’élément "assignement" est utilisé pour affecter une valeur créée en fonction d’une règle de comparaison sur les valeurs de deux éléments "header".
Quatre attributs précisent la balise "assignement" : "left", "right", "operator", "result", e.g.,

<ximf:assignment
left="header-primary-precedence"
operator="equal"
right="data-routine-precedence"
result="86400" />

* Détails sur les attributs de l'élément "assignment" :
** L’attribut "left" désigne le premier élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "right" désigne le deuxième élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "operator" indique la règle de comparaison entre les valeurs des deux éléments "header", il peut être de type "greaterThan", "lowerThan", "equalOrGreaterThan", "equalOrLowerThan", "equal". Cet attribut est obligatoire.
** L’attribut "result" représente la valeur à utiliser si la règle de comparaison entre les deux éléments est satisfaite. Cet attribut est obligatoire.

==== Element processing ====
L’élément "processing" regroupe des règles de traitement à effectuer sur des entêtes formatés.
L’attribut "type" précise le type de traitement à effectuer sur ces valeurs. Cet attribut est obligatoire, il est de type : "sign-header-value", "encrypt-header-value", "capitalize-header-value", e.g.,

<ximf:processing type="sign-header-value">
<ximf:refHeader>header-primary-precedence</ximf:refheader>
<ximf:refHeader>header-copy-precedence</ximf:refheader>
<ximf:refHeader>header-echange-type</ximf:refheader>
</ximf:processing>

* Détails sur les valeurs possibles de l'attribut "type" :
** Le type "sign-header-value" définit un traitement de signature des entêtes définis dans la balise.
** Le type "encrypt-header-value" définit un traitement de chiffrement des entêtes définis dans la balise.
** Le type "capitalize-header-value" définit un traitement de capitalisation des entêtes définis dans la balise.

L’élément "processing" contient au moins un élément "refHeader".

==== Element accessibility ====
L’élément "accessibility" définit un ensemble de règles de droit d’accès aux éléments d’une instance pour une cible déterminée (utilisateur, routeur…).
Cet élément contient un ou plusieurs éléments "role".

<ximf:accessibility>
<ximf:role id="role-flash-allowed" aclLevel="100" />
<ximf:role id="role-flash-prohibited" aclLevel="50" />
</ximf:accessibility>

==== Element role ====
L’élément "role" positionne une valeur d’accès à pour une entité définit.
Deux attributs complètent l’élément "role" : "id", "aclLevel", e.g.,

<ximf:role id="role-flash-allowed" aclLevel="100" />

* Détails sur les attributs de l'élément "role" :
** L’attribut "id" précise l’entité accessible en fonction d’une valeur déterminée.
** L’attribut "aclLevel" précise la valeur seuil d’accès à l’entité.

==== Element custom ====
L’élément "custom" permet à l’auteur de créer des nouvelles règles personnalisées.
Trois attributs précisent la balise "custom" : "id", "provider", "description", e.g.,

<ximf:custom
id="custom-display"
provider="EADS"
description="Affichage de la composition du message" >
<node1><node2><node3></node3></node2></node1>
</ximf:custom>

* Détails sur les attributs de l'élément "custom" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "custom" et formaté selon la syntaxe "custom-xxx". Cet attribut est obligatoire.
** L’attribut "provider" identifie l’auteur de la règle. Cet attribut est obligatoire.
** L’attribut "description" permet d’ajouter un commentaire sur cet élément.

L’élément "custom" peut contenir tous les éléments possibles en respectant les standards XML.

Ximfmail/fr

2011-06-29T09:42:38Z

Anthonyjuge :

{{lang|Ximfmail|Ximfmail/fr}}
> [[Documentation/fr|Documentation]] > [[Ximfmail/fr|Module : XIMFMAIL]]
{{DownloadPanel/fr
| title = ximfmail
| compat = Trustedbird 2
| info =
}}

'''XIMFMAIL''' est un module complémentaire pour Trustedbird.<br>
C'est une extension qui permet de générer à la volée des formulaires en émission et réception en fonction d'une '''''extension de définition'''''.<br>
L'extension de définition permet de définir dans un dialecte XML, quels sont les champs facultatifs, obligatoires, devant se retrouver dans l'IHM, dans la signature...<br><br>
Cela permet d'adapter Trustedbird à vos propres besoins en messagerie (associations, entreprises, administrations...).
<br><br>
Les données complémentaires sont véhiculées dans des entêtes MIME en respectant le format XIMF (eXtended Internet Message Format)

[[File:Compose-ximfmail-doc.png]]
== Qu'est-il possible de décrire dans une extension de définition ? ==
L'extension de définition permet de décrire en respectant l'internationalisation les entêtes XIMF et leur valeur.<br>
La valeur d'un entête peut être :
<ul>
<li>facultative</li>
<li>obligatoire</li>
<li>du texte libre</li>
<li>du texte contraint</li>
<ul>
<li>texte contenu dans une liste de choix</li>
<li>texte composé de parties contraintes et de parties libres</li>
<li>valeur contrainte par la valeur d'un autre label</li>
<li>...</li>
</ul>
<li>une date sélectionnée depuis un calendrier</li>
<li>des adresses spécifiques</li>
<li>...</li>
</ul>
<br>
Il est possible de définir des règles sur les données du formulaire :
<ul>
<li>Lister les entêtes à intégrer dans la signature (secure header). Le noyau Trustedbird les insère dans la signature à l'émission et permet de les vérifier et les visualiser en réception</li>
<li>Assurer la compatibilité avec un autre format utilisant les entêtes étendus MIME (exemple : XSMTP)</li>
<li>Afficher en réception la valeur de l'entête avec une image</li>
<li>...</li>

</ul>
<br>
Il est possible d'organiser la présentation des données dans le formulaire de composition d'un message et de définir les entêtes à visualiser dans les colonnes du panneau principal des messages reçus.

Pour plus de détails, cf. [[XIMF/fr|documentation de l'extension de définition XIMF]].

== Comment tester ?==
===Installer===
===Créer un compte ximfmail===

Ximfmail est un générateur d’entêtes XIMF multi-comptes.<br>
La création d’un compte spécifique est nécessaire pour une bonne utilisation de celui-ci.
====nouveau compte====
#Lancer le client Trustedbird
#Ouvrir l’interface de gestion des paramètres des comptes : Menu Outils - Paramètres des comptes…
#Cliquer sur le bouton « Ajouter un compte » : Un assistant de création de compte s’ouvre
#Fenêtre Paramétrage d’un nouveau compte : cocher la case « Compte Courrier électronique », puis cliquer sur « Suivant »
#Fenêtre Identité : saisir le nom et l’adresse de l’utilisateur XIMFMAIL.
#Fenêtre Information sur le serveur, 2 possibilités : <br>
##Cocher la case « pop » et saisir le nom du serveur hébergeant la boite mail de l’utilisateur», puis cliquer sur « Suivant ». '''Décocher la case « utiliser la boîte globale !''' <br>
##Cocher la case « imap »
#Fenêtre nom d’utilisateur : saisir le nom de l’utilisateur XIMFMAIL, puis cliquer sur « Suivant »
#Fenêtre nom du compte : saisir l’adresse internet de l’utilisateur XIMFMAIL, puis cliquer sur « Suivant »
#Fenêtre Félicitations : la création du compte est complète, cliquer sur « Terminer ». l’assistant de création de compte se ferme.
#Fenêtre Paramètres des comptes : cliquer sur le bouton « OK » de la fenêtre des paramètres des comptes
====compte existant====
#Lancer le client Trustedbird
#Ouvrir l’interface de gestion des paramètres des comptes : Menu Outils - Paramètres des comptes…
#Fenêtre Paramètres des comptes : sélectionner le compte XIMFMAIL à modifier et sélectionner « Paramètres du serveur »
#Cliquer sur le bouton « Avancés… »
#Fenêtre Paramètres avancés des comptes : sélectionner le libellé « Courrier entrant de compte », cliquer sur le bouton « OK »
#Fenêtre Paramètres des comptes : la modification du compte est terminée. Cliquer sur le bouton « OK » de la fenêtre des paramètres des comptes
#Fenêtre Paramètres des comptes : Sélectionner le compte XIMFMAIL à modifier. Cliquer sur le nom du compte XIMFMAIL
#Cliquer sur le bouton « Gérer les identitiés »
#Fenêtre Identité : sélectionner l’identité à modifier, cliquer sur le bouton Modifier
#Fenêtre Paramètres de l’identité : cliquer sur l’onglet « Copies et dossiers ». Sélectionner le libellé « Autre » dans les rubriques suivantes et sélectionner le dossier du compte XIMFMAIL:
##Lors de l’envoi de messages, automatiquement, placer une copie dans :
##Brouillons et modèles, Conserver les brouillons dans
##Brouillons et modèles, Conserver les modèles dans
#Cliquer sur le bouton « OK »
#Fenêtre Paramètres des comptes : cliquer sur le bouton « OK » de la fenêtre des paramètres des comptes
===Configurer un compte ximfmail===
Configurer un compte ximfmail revient à choisir une définition d'instances parmi celles enregistrées par le moteur ximfmail et à sélectionner les instances par défaut à utiliser pour la composition et la lecture de messages.

# Lancer le client Trustedbird
# Ouvrir l’interface de gestion des paramètres des comptes : Menu Outils - Paramètres des comptes…
# Fenêtre Paramètres des comptes : sélectionner le compte XIMFMAILà configurer
# Sélectionner la rubrique "XIMF"
# Cocher la case "Utiliser un thème ximfmail pour ce compte" et sélectionner la définition à utiliser dans le menu joint
# Dans la partie Rédaction,
## Sélectionner l'instance par défaut à utiliser lors de la rédaction d'un nouveau message
## Cocher la case "assurer la compatibilité XSMTP" pour dupliquer les champs XIMF au format XSMTP lors de l'envoi de messages
# Dans la partie réception,
## Rubrique "Trier les entêtes de messages", sélectionner l'instance par défaut à utiliser pour afficher des entêtes XIMF dans le panneau principal listant les messages d'un dossier
## Rubrique "Afficher les messages stockés", sélectionner l'instance par défaut à utiliser pour afficher les informations d'un message contenant des entêtes ximf mais dont l'instance n'a pas été identifiée
# Configuration complète, Cliquer sur "OK"

Pour activer la configuration:
* si un seul compte est créé dans le client Trustedbird, redémarrer ce dernier
* si plusieurs comptes sont créés dans le client Trustedbird, sélectionner la boite courrier d'un autre compte puis revenir sur la boite du compte concerné ou redémarrer le client.
<br>
[[File:XimfmailAccountSettings.PNG]]

===Utiliser ximfmail===
[en cours de rédaction...]
<br>
==== Composition d'un message ====
Pour composer un nouveau message avec l'instance définie lors de la configuration du compte :
* Ouvrir le menu "Fichier", sélectionner "nouveau message"
* Dans la barre d'outils, cliquer sur le bouton "Ecrire"

Pour composer un nouveau message avec une instance autre que celle définie lors de la configuration du compte :
* Dans la barre d'outils, cliquer sur le menu associé au bouton "Ecrire", sélectionner l'instance à utiliser

Dans le message de composition, tous les entêtes XIMF modifiables sont regroupés dans le panneau "nom de l'instance" entre l'item "sujet" et le corps du message.<br>
Ce panneau peut être caché ou non :
* Cliquer sur le bouton "+"/"-"
* Double-cliquer sur la barre de titre de l'instance
* Utiliser le raccourci clavier Alt + / Alt -

Pour renseigner un entête de message, cliquer sur l'image du champ associé.<br>
Chaque image correspond à un type d'information:
* [menu] propose de choisir une ou plusieurs données parmi la liste proposée
* [editeur] propose une interface de saisie libre. une ou plusieurs valeurs peuvent être saisies
* [calendar] affiche un calendrier pour définir une date complétée d'une heure
* [address] permet de saisir une address mail. une aide à la saisie des adresses enregistrées est activée
* [extern] affiche dans une boite de sélection des données externes (autres que celles définies dans le fichier de description des entêtes ximfmail)

'''Parmi les informations XIMF affichées, celles dont le libellé est de couleur rouge indique que ce champ doit être obligatoirement renseigné! Tant que ces valeurs obligatoires ne sont pas saisies, le message ne peut être envoyé!'''

== Comment construire mon extension de définition ?==
[en cours de rédaction...]
<br>
=== Definir son instance XIMF en XML ===
Ce paragraphe fait office de tutoriel pour construire une extension d’instances de déifinition ximfmail.

Le moteur ximfmail insère un groupe d’entêtes XIMF de messages à partir d’une description XML.
Construisons l’instance XML de la société Amoco, présente dans l’extension ximfmail_company.

==== Structure du fichier XML ====
Tous les éléments utiles pour le moteur ximfmail sont décris dans le conteneur principal <ximf:instance>.
<br><br>
Un ou plusieurs fichiers peuvent être associés à une instance. Généralement, on définit pour une instance un fichier par type d’éléments de description :
*un fichier XML regroupant les entêtes XIMF,
*un fichier XML contenant des valeurs internationalisées de ces entêtes,
*un fichier XML contenant des règles sur les entêtes (association, compatibilité…)
*un fichier XML détaillant la structure IHM des entêtes à présenter

Le détail du schéma de validation d’une instance XIMF au format XML est accessible.<br>
Les exemples ci-dessous respectent strictement le schéma ximf.xsd
<br>
[[File:ximfmailInstanceStruc.PNG]]

==== Entêtes XIMF du message ====
Amoco souhaiterait que chaque employé puisse préciser dans son courriel quatre informations :
*la classification du message envoyé,
*le niveau d’importance du message envoyé,
*une demande de réponse avant une date précisée,
*des informations de référence complémentaires.

Les informations de classification et du niveau du message doivent être systématiquement intégrées dans les courriels envoyés. <br>
Décrivons ces entêtes dans notre instance :

<br>
[[File:ximfmailHeadersStruc.PNG]]

==== Données internationalisées ====
Afin d’échanger les informations dans un contexte internationalisé, nous allons associer aux entêtes décrites précédemment des traductions des valeurs affichées aux intervenants du message :

<br>
[[File:ximfmailDictionaryStruc.PNG]]

==== Règles sur les entêtes du message ====
Nous souhaitons définir des règles sur les données des entêtes de messages. Par exemple, lorsque la classification du message est du type général, il est inutile d’associer un niveau critique. Pour cela nous allons décrire des règles d’associations entre les entêtes :

<br>
[[File:ximfmailRulesStruc.PNG]]

==== Affichage des entêtes ====
Nous allons maintenant définir l’affichage de ces informations dans le message :

<br>
[[File:ximfmailIhmStruc.PNG]]

La structure <ximf :panel> détaille l’ordre d’affichage des entêtes dans un message. Ainsi, un panneau sera présenté à l’utilisateur dans lequel 1 groupe contiendra les entêtes de classification et niveau du message et un autre groupe contiendra les informations concernant la date de réponse et les références du message.

Aussi, il est intéressant de connaître la valeur d’un entête de message reçu avant d’ouvrir celui-ci. Pour cela, l‘élément d’ihm <treeRcv> permet d’ajouter des colonnes dans le panneau principal Trustedbird qui contient la liste des messages d’un dossier.

=== Packaging Thunderbird ===

==== Structurer les instances dans une extension thunderbird ====
cf. mozilla.org

==== Déclarer les instances de l’extension au moteur ximfmail ====

<br>
[[File:ximfmailProfileStruc.PNG]]

<br><br>
XIMFMAIL a été développé par [[File:Cassidian_logo.png|link=http://www.cassidian.com|150px]]

Instance FullExample

2011-06-29T07:34:57Z

Anthonyjuge :

FullExample est une instance regroupant les fonctionnalités avancées spécifiées par XIMF. Notamment les champs à sélection multiple.

== Champs à sélection multiple ==

Ces champs décrivent une façon de renseigner simplement les valeurs de sous-catégories. Pour ce faire, il suffit de cliquer sur un élément père de façon à ce que les éléments fils deviennent disponibles. Il est nécessaire de spécifier un séparateur servant à la concaténation de la valeur principale de la valeur fille.

Exemple : fichier header-fullexample.xml


<ximf:header id="header-categories"
headerName="X-XIMF-Categories"
type="string"
ilk="ilk-categories"
isMandatory="false" >
<ximf:set id="value-category-general" minItem="1" maxItem="64" separator="," >
<ximf:string ilk="ilk-private-mail" content="CORRESPONDANCE PRIVEE" />
<ximf:string ilk="ilk-mensual-report" content="COMPTE RENDU MENSUEL" />
<ximf:compstring ilk="ilk-announcement" content="ANNONCE" separator=" ">
<ximf:set id="ilk-announcement-type" minItem="1" maxItem="64">
<ximf:string ilk="ilk-announcement-syndicate" content="SYNDICAT" />
<ximf:string ilk="ilk-announcement-department" content="DEPARTEMENT" />
<ximf:string ilk="ilk-announcement-company" content="ENTREPRISE" />
</ximf:set>
</ximf:compstring>
</ximf:set>
<ximf:set id="value-category-confidential" minItem="1" maxItem="64" separator=",">
<ximf:string ilk="ilk-meeting-report" content="COMPTE RENDU DE REUNION" />
<ximf:compstring ilk="ilk-announcement" content="ANNONCE" separator=" ">
<ximf:set ref="ilk-announcement-type" />
</ximf:compstring>
<ximf:compstring ilk="ilk-internal-project" content="PROJET" separator=" : ">
<ximf:string editable="true" />
</ximf:compstring>
</ximf:set>
<ximf:set id="value-category-highly-confidential" separator=",">
<ximf:string ilk="ilk-general" content="GENERAL" />
<ximf:compstring ilk="ilk-special-company-project" content="PROJET SPECIAL" separator=" : ">
<ximf:string editable="true" />
</ximf:compstring>
<ximf:compstring ilk="ilk-internal-project" content="PROJET INTERNE" separator=" : ">
<ximf:string editable="true" />
</ximf:compstring>
</ximf:set>
</ximf:header>

Ce qui produit l'élément de formulaire suivant :

[[Fichier:Trustedbird-affichage_champ_selection_multiple.png|frame|center|Affichage d'un champ à sélection multiple de l'instance XIMF FullExample dans Trustedird]]

== Affichage des labels de sécurité au format SVG ==
Il peut être contraignant de créer autant d'images PNG que de valeur possible de champ. De plus, les données textes contenues dans ces images ne sont pas traduites. Il est possible de personnaliser l'affichage des labels de sécurité grâce à la technologie SVG.

Pour cela, il faut définir un modèle servant de base à l'affichage et il faut aussi spécifier les changements dans les valeurs en fonction des en-tête du message.

Dans un premier temps, il faut ajouter un élément ximf:svg dans l'élément ximf:aliasHeader afin d'indiquer quel modèle SVG utiliser. Ce modèle SVG devra contenir des identifiant sur les éléments que l'on souhaite modifier.

Dans le cas où l'affichage est redondant avec une autre règle d'affichage, il est possible de spécifier l'attribut "overwrite" qui permet de ne pas prendre en compte une autre règle.

A l'intérieur des éléments aliasValue, il est nécessaire d'indiquer les modifications à apporter au modèle SVG utilisé comme base. Pour ce faire, on utilise les identifiants présents dans le modèle de base et on y apporte des modifications d'attributs en SVG.

A la suite de l'élément ximf:aliasValue, il faut spécifier un élément ximf:svgParams qui contient les paramètres à appliquer au SVG modèle.
L'élément ximf:svgParams contient un ou plusieurs éléments ximf:svgElement.
L'élément ximf:svgElement prend en paramètre obligatoire un identifiant qui correspond à l'identifiant d'un élément dans le modèle SVG utilisé. ximf:svgElement contient un ou plusieurs éléments ximf:svgParam.

Un élément svgParam comporte un attribut "name" et un attribut "value" qui correspondent à la propriété SVG à modifier et à la valeur de celle-ci.

L'identifiant __TEXT__ appliqué sur un élément "text", dans le modèle SVG, permet de substituer le contenu par la valeur du champ d'en-tête XIMF.

Exemple : fichier rules-fullexample.xml

<ximf:rule id="label-pictures-rule" description="Label display rule" >
<ximf:classificationPictures targetName="ClassificationPictures">
<ximf:aliasHeader headerName="url" headerRef="X-XIMF-Security-Classification">
<ximf:svg url="chrome://ximf-fullexample/content/FullExample/resource/svglabel_company_urgency.svg"
overwrite="X-XIMF-Security-Classification-Identifier" />
<ximf:aliasValue valueRef="classification-general"
valueName="chrome://ximf-fullexample/content/FullExample/resource/fullexample-G.png">
<ximf:svgParams>
<ximf:svgElement id="rectangle">
<ximf:svgParam name="stroke" value="green" />
<ximf:svgParam name="stroke-width" value="8" />
</ximf:svgElement>
<ximf:svgElement id="__TEXT__">
<ximf:svgParam name="fill" value="green" />
<ximf:svgParam name="font-weight" value="bold" />
</ximf:svgElement>
</ximf:svgParams>
</ximf:aliasValue>

</ximf:aliasHeader>
</ximf:classificationPictures>
</ximf:rule>

Avec, comme modèle SVG :
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<svg
xmlns="http://www.w3.org/2000/svg"
width="100%"
height="100%"
xmlSpace="preserve">
<rect
id="rectangle"
fill="white"
stroke="black"
stroke-width="8"
width="100%"
height="100%"
x="0"
y="0" />
<text
x="30"
y="65%"
font-weight="bold"
id="__TEXT__"
>__TEXT__</text>
</svg>

'''Note : Ceci n'est actuellement pas supporté par le client Trustedbird.'''

Discussion:XIMF XML tags/fr

2011-06-28T14:59:13Z

Anthonyjuge : Ajout des remarques et des réponses concernant la documentation

<div style="color:red;">
* Combien d'éléments ihm sont autorisés dans un élément instance ?
<p style="color:green;">Un seul élément ihm est chargé par instance, il permet de générer la grille des entêtes XIMF en rédaction et lecture de message</p>
* La documentation des fichiers ximfmail-profile.xml n'est pas disponible.
<p style="color:green;">Quel type de documentation (wiki adullact ou .doc) est attendu?</p>
* Quel est le rôle de l'élément "acces" ?
<p style="color:green;">je ne vois pas où j'ai utilisé un élément acces dans un fichier ximfmail-profile.xml</p>
* Quelle est l'utilité des identifiants associés aux éléments instance, shema, ihm, etc.
<p style="color:green;">Les attributs id ne sont pas exploités par le moteur XIMFMAIL sauf l'instance dont l'id "id=smtp". Celui-ci est utilisé par le moteur pour gérer un message smtp standard.</p>
* Quelle est l'utilité de l'attribut name associé aux éléments instance. Y a-t-il une vérification s'assurant que les fichiers utilisés par une instance correspondent bien à l'instance à laquelle ils sont associés ?
<p style="color:green;">l'attribut name est un des attributs permettant de discréminer les instances. Il est effectivement utilisé par le moteur pour afficher, composer les messages d'un compte</p>
</div>

<div style="color:red;">
* Quel est l'intérêt de renseigner un attribut "id" à l'élément "dictionary" (étant donné qu'un seul élément "dictionary est autorisé dans l'élément "instance") ?</div>
<p style="color:green;">cet attribut n'est effectivement pas obligatoire</p>

<div style="color:red">
* Il semble que les fichiers headers définissent des champs d'entête devant être envoyés alors que ces mêmes entêtes ne sont pas spécifiés dans le fichier ihm. Ce comportement est logique, en effet, l'utilisateur n'a pas forcément besoin de savoir tout ce qui est envoyé via le formulaire.

Comment intégrer un header (nommé aussi header technique) dans le message sans qu'il soit affiché dans le formulaire XIMF de l'IHM ?

Par exemple, dans l'instance Amoco, le champ d'entête X-XIMF-Security-Policy-Identifier est automatiquement envoyé alors que les champs d'entête X-XIMF-Primary-Precedence et X-XIMF-Copy-Precedence ne le sont pas. Comment est faite la différence ?

<p style="color:green;">
Si un élément ximf:header ne contient pas d'attribut "ilk" et propose un choix unique de valeur (l’élément fils est ximf:string), alors le moteur "déduit" qu'il s'agit d'une valeur technique à envoyer sans la présenter à l'utilisateur.
</p>
</div>

<div style="color:red;">
* Comment est effectuée la vérification de l'attribut isMandatory et quelles sont les conditions de fonctionnement de celui-ci ? Est-il possible, par exemple, de spécifier l'attribut isMandatory=true d'un élément header si le contenu de celui-ci est un élément « set » qui dispose des attributs minItem et maxItem ? Actuellement, lorsque l'on crée un élément set avec les attributs minItem et maxItem, le champ du formulaire associé ne peux pas être validé : e.g.,
<ximf:set id="value-amoco-classification" minItem="1" maxItem="64" separator=";" technicalSeparator=".">
</div>

<div style="color:red;">
* Quelles sont les contraintes associées à l'attribut type d'un élément header ?
<p style="color:green;">
* L'attribut type d'un élément "ximf:header" ne contraint pas les éléments fils associés.
Dans le cadre de Ximfmail, cet attribut est utilisé pour charger des fonctions graphiques d'aide à la saisie pour l'utilisateur (calendrier, adresse...)
</p>
</div>

<div style="color:red;">
* L'attribut de l'élément « compstring » nommé « contentFactorise » devrait s'appeler « contentFactorize ».
<p style="color:green;">ok</p>
</div>

<div style="color:red;">
* Y a-t-il une définition des fichiers associés aux instances XIMF (e.g, le fichier attribution-list.xml utilisé dans l'instance Caterpillar) ?

<p style="color:green;">non mais la structure du fichier xml doit être celle donnée en exemple </p>

* Comment le moteur XIMF sait qu'un élément est une "attribution-list" ?
<p style="color:green;">
Si un élément "set" contient un attribut "ref" dont la valeur ne permet pas de trouver l'élément associé dans l'instance alors le moteur Ximfmail inspecte le répertoire local où est stocké l'instance et vérifie si le nom d'un fichier xml correspond à la valeur de cet attribut.
</p>
</div>

<div style="color:red">
* Les éléments autorisés dans un élément « rule » ne sont plus à jour. La présente documentation spécifie 12 éléments : AliasHeader, AliasValue, Compatibility, Association, SecureHeaders, SecurityLabel, Constraint, Assignment, Processing, Accessibility, Role et Custom. Le schéma XML fourni avec le mail en spécifie 5 : Constraint, Processing, Compatibility, Policy et Custom et place les autres en tant qu'extentions des 5 éléments cités précédemment.
<p style="color:green">ok</p>
* Les éléments SecureHeaders et SecurityLabel associés à l'élément « rule » ne figurent pas dans la nouvelle version du shéma xml. On les retrouve dans les fichiers rules-*.xml mais les éléments sont commentés, ils sont, de plus, présents dans une autre instance : comment ces éléments sont utilisés dans Trustedbird ?
<p style="color:green">
Ces règles ont été créées après la rédaction du document pour répondre à des besoins spécifiques. Les deux éléments permettent de forcer l'utilisation des mécanismes de sécurité associés. Je les ai commenté car leur utilisation nécessite l'import de certificats et l'extension étant un exemple, je n'ai pas voulu bloquer les interfaces des utilisateurs ne disposant pas de certificats.
</p>
* L'élément ximf:classificationPictures n'est pas documenté. De plus, il serait bon d'avoir des précisions sur la raison qui a motivé l'ajout de cet élément dans les fichiers de règles (alors qu'il semblerait être plus adapté au fichier headers-*.xml).
<p style="color:green">
Un fichier header-*.xml décrit les noms et valeurs d'entêtes XIMF de messages. L'élément ximf:classificationPictures est un moyen d'associer à une valeur d'entête une image. Il m'a donc semblé qu'afficher une image dépend plus d'une règle de gestion de message que de description d'entête de message.
</p>
</div>

<div style="color:red;">
* Comment sont gérées les règles associées aux champs multivaleurs (disposant par exemple des attributs minItem/maxItem ou les champs multiset) ?</div>

<div style="color:red;">
* L'élément assignment n'apparaît pas dans le shéma xml qui avait été envoyé.</div>

<div style="color:red;">
* L'attribut valueRef est-il obligatoire ?
<p style="color:green">
Oui, un élément ximf:aliasValue permet d'associer une valeur définie par l'attribut valuRef à une autre valeur définie par l'attribut valueName.
Par contre, l'élément aliasValue n'est pas obligatoire.
</p>
</div>

<div style="color:red;">
* L'élément refHeader n'est pas documenté, s'agit-il en fait de l'élément headerRef ?</div>

<div style="color:red;">
* L'élément accessibility n'apparaît pas dans le shéma xml qui avait été envoyé.</div>

XIMF XML tags/fr

2011-06-28T14:44:46Z

Anthonyjuge : Passage des commentaires dans la page de discussion

== Introduction ==
Ce document propose un modèle de description, via eXtensible Markup Language (XML), d’entêtes de messages électroniques respectant la norme XIMF. Ce document a deux objectifs :
# Décrire les éléments et attributs de représentation XML pour construire des entêtes de messages électroniques de format XIMF.
# Fournir un modèle de représentation XIMF/XML.

<u>Rappel :</u>
* Un "élément" fait référence à tous les caractères situés entre une balise de départ et un balise de fin, e.g.,
<exemple> texte et/ou éléments fils </exemple>
* Un "attribut" est une composante d’un élément. Il est positionné dans la balise de départ, e.g.,
<exemple nom='value'>

Tous les éléments décrits dans cette documentation paragraphe sont validés dans l’espace de nom "ximf".

<pre>
xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://eads.org/ximf/ximf.xsd"
</pre>

== Description détaillée des balises XML ==
Voici, par ordre d'apparition et en fonction des fichiers, les balises génériques associées aux différents fichiers XML.

=== Fichier ximfmail-profile ===
Un fichier xpi peut contenir plusieurs instances XIMF, celles-ci sont alors regroupées dans une même catégorie. Le fichier ximfmail-profile contient des informations sur toutes les instances contenues dans le xpi, notamment leur nom, leur chemin d'accès, ainsi que les noms des fichiers associés à chaque instance.

==== Element instance ====
L’élément "instance" identifie l’ensemble des entêtes à décrire selon la norme XIMF. C’est le conteneur principal d’une instance XIMF/XML. Cinq attributs précisent la balise "instance" : "ximfVersion", "version", "author", "creation", "name", e.g.,
<ximf:instance name="myInstance" version="1.0" ximfVersion="2.0" >

* Détails sur les attributs de l'élément "instance" :
** L’attribut "name" définit le nom de l’instance décrite. Cet attribut est obligatoire.
** L’attribut "ximfVersion" définit le numéro de version des entêtes XIMF utilisés pour cette représentation. Cet attribut est obligatoire.
** L’attribut "version" définit le numéro de version de l’instance décrite. Cet attribut est obligatoire.
** L’attribut "author" renseigne sur le nom de l’auteur de cette instance.
** L’attribut "creationDate" précise la date de création de cette instance.

L’élément "instance" peut contenir un ou plusieurs éléments "schema", un ou plusieurs éléments "rule", un élément "ihm" et un élément "dictionary".

==== Element dictionary ====
L'élément dictionary contient le chemin vers le fichier spécifiant les données d'internationalisation (Cf. [[#Fichier_dictionary|Fichier dictionary]]).

==== Element schema ====
L'élément shema contient le chemin vers le fichier spécifiant les entêtes XIMF (Cf. [[#Fichier_headers|Fichier headers]]).

==== Element ihm ====
L'élément ihm contient le chemin vers le fichier spécifiant la disposition de l'interface des formulaires XIMF (Cf. [[#Fichier_ihm|Fichier ihm]]). Un seul élément ihm est chargé par instance.

==== Element rule ====
L'élément rule contient le chemin vers le fichier spécifiant les règles associées aux valeurs des champs XIMF (Cf. [[#Fichier_rules|Fichier rules]]).

=== Fichier dictionary ===
Le fichier dictionnary permet de mettre en œuvre l’internationalisation d’une instance XIMF. Il défini des dictionnaires qui servent à traduire les éléments de l'instance XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient un élément "ximf:dictionnary".

==== Element dictionary ====
<ximf:dictionary>
<ximf:locale lang="fr-FR" />
<ximf:locale lang="en-US" />
</ximf:dictionary>

==== Element locale ====
L’élément "locale" contient toutes les informations pour un pays et/ou langue désignée.
L’élément "locale" contient un ou plusieurs mêmes éléments "ilk", e.g.,

<ximf:locale lang="fr-FR" >
<ximf:ilk entity="a"/>
<ximf:ilk entity="b"/>
</ximf:locale>

* Détails sur les attributs de la balise "locale" :
** L’attribut "lang" définit le code pays de ce conteneur. Il devrai être construit selon le format défini par la RFC1766 (fr, en, ja, es, …).

==== Element ilk ====
L’élément "ilk" contient une unique information correspondant à une donnée traduite selon le code pays de l’élément père. Cette information est au format chaîne de caractère. Un attribut obligatoire précise la balise "ilk".

<ximf:ilk entity="ilk-lang-ihm">langue</ximf:ilk>

* Détails sur les attributs de la balise "ilk" :
** L’attribut "entity" définit la référence d’entrée pour récupérer le contenu de l’élément selon le code pays souhaité.

Finalement, le fichier "dictionary" pourra contenir :
<ximf:instance name="Whirlpool">
<ximf:dictionary>
<ximf:locale lang="fr-FR" >
<ximf:ilk entity="ilk-lang-ihm">Français</ximf:ilk>
<ximf:ilk entity="ilk-exemple-general">Général</ximf:ilk>
</ximf:locale>
<ximf:locale lang="en-US" >
<ximf:ilk entity="ilk-lang-ihm">English (US)</ximf:ilk>
<ximf:ilk entity="ilk-exemple-general">General</ximf:ilk>
</ximf:locale>
</ximf:dictionary>
</ximf:instance>

=== Fichier ihm ===
Le fichier ihm spécifie l'agencement de l'interface des formulaires XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient un élément "ximf:ihm".

==== Element ihm ====
L'élément "ihm" contient un ou plusieurs éléments "panel" et un élément "treeRcv".

==== Element panel ====
Un élément ximf:panel correspond à un onglet du formulaire XIMF construit.
Deux attributs précisent la balise "panel" : "id" et "ilk", eg.
<ximf:panel id="pane_security" ilk="ilk-priority-panel" />

* Détails sur les attributs de l'élément "panel" :
** L’attribut "id" définit le nom de l'onglet, il doit être unique pour chaque élément "ximf:panel" et est formaté selon la syntaxe "pane-xxx". Cet attribut est obligatoire.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.

L'élément "ximf:panel" contient au moins un éléments "ximf:groupbox".

==== Element groupbox ====
Un élément groupbox correspond à une sous catégorie d'un onglet du formulaire XIMF.
La structure "groupbox" détaille l’ordre d’affichage des entêtes dans un message.
Deux attributs précisent la balise "ximf:groupbox" : "id" et "ilk", eg.
<ximf:groupbox id="group-classification" ilk="ilk-secu-box" />

* Détails sur les attributs de l'élément "groupbox" :
** L’attribut "id" définit le nom de l'onglet, il doit être unique pour chaque élément "ximf:panel" et est formaté selon la syntaxe "pane-xxx". Cet attribut est obligatoire.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.

L'élément "groupbox" contient au moins un éléments "headerRef".

==== Element treeRcv ====
L'élément "treeRcv" permet de spécifier quelles sont les colonnes susceptibles d'être ajoutées dans le panneau principal du client de messagerie qui contient la liste des messages d’un dossier.

L'élément "treeRcv" peut contenir des éléments "headerRef".

==== Element headerRef ====
L'élément headerRef spécifie les champs associés à chaque sous-groupe d'onglet de formulaire ou les champs qu'il est possible d'afficher dans la liste des messages.
Aucun attribut ne vient compléter la balise "headerRef", eg.
<ximf:headerRef>header-classification</ximf:headerRef>

Finalement, le fichier "ihm" pourra contenir :
<pre>
<ximf:instance name="Amoco">
<ximf:ihm>
<ximf:panel id="pane_security" ilk="ilk-priority-panel">
<ximf:groupbox id="group-classification" ilk="ilk-secu-box">
<ximf:headerRef>header-correspondance-type</ximf:headerRef>
<ximf:headerRef>header-classification</ximf:headerRef>
</ximf:groupbox>
</ximf:panel>
<ximf:treeRcv>
<ximf:headerRef>header-classification</ximf:headerRef>
</ximf:treeRcv>
</ximf:ihm>
</ximf:instance>
</pre>

=== Fichier headers ===
Le fichier headers spécifie les types des champs de l'interface des formulaires XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient des éléments "header".

==== Element header ====
Chaque élément "header" décrit un entête de message de format XIMF.
Huit attributs précisent la balise "header" : "headerName", "id", "technicalHeaderName", "type", "technicalType", "isMandatory", "ilk", "description", e.g.,

<ximf:header id="header-primary-precedence"
headerName="X-XIMF-Primary-Precedence"
ilk="ilk-primary-precedence"
isMandatory="true"
description="entête d’urgence"
type="string" />

* Détails sur les attributs de l'élément "header" :
** L’attribut "headerName" définit le nom du champ XIMF. Cet attribut est obligatoire.
** L’attribut "id" définit un identifiant de champ, il doit être unique pour chaque élément "header" et est formaté selon la syntaxe "header-xxx". Cet attribut est obligatoire.
** L’attribut "isMandatory" précise si ce champ doit être obligatoirement présent dans le message intégrant les entêtes selon cette description.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.
** L’attribut "type" précise le format des données associées à cet élément. Ce format peut être une date, une chaîne, une adresse mail, un O.I.D.
** L’attribut "technicalHeaderName" permet de compléter l’entête décrit par un autre entête.
** L’attribut "technicalType" précise le format des données associées à l’élément technicalHeaderName.
** L’attribut "description" permet d’ajouter une information sur cet élément.

L’élément "header" contient obligatoirement un élément "set", "multiset", "string", ou "compstring", e.g.,

<ximf:header id="header-reply-by"
headerName="X-XIMF-Reply-By"
ilk="ilk-reply-by"
isMandatory="false" >
<ximf:string id="value-reply-by" editable="true" />
</ximf:header>

==== Element string ====
L’élément "string" précise le contenu d’une ressource de type chaîne de caractères imprimables (a-z, A-Z, 1-9,…)
Quinze attributs complètent l’élément "string" : "id", "ref", "ilk", "aclLevel", "index", "description", "editable", "content", "technicalContent","maxItem", "minItem", "maxLength", "minLength", "separator", "technicalSeparator", e.g.,

<ximf:string ilk="ilk-france" content="FRA" />

* Détails sur les attributs de l'élément "string" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "string".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role| élément role]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut " description " permet d’associer un commentaire sur cette donnée.
** L’attribut "editable" définit une valeur de saisie (champ libre). Cet attribut est de type booléen.
** L’attribut "content" représente la valeur effective de la donnée. C’est cette donnée qui sera associée au champ XIMF créé.
** L’attribut "technicalContent" représente la valeur effective de la donnée technique. C’est cette donnée qui sera associée au champ technique XIMF créé (cf. attribut technicalHeaderName de l’élément "header".
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.

L’élément "string" peut contenir plusieurs éléments "linkedValue".

<ximf:string ilk="ilk-non-protege" content="NON PROTEGE" technicalContent="1" >
<ximf:linkedValue ref="value-non-protege-france " />
</ximf:string>

==== Element compstring ====
L’élément "compstring" décrit un conteneur de concaténation des éléments fils. Il permet notamment de créer des valeurs d’entêtes composées.
Dix-sept attributs complètent l’élément "compstring" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", "content", "technicalContent", "contentPositionEnd", "contentFactorise", "technicalPositionEnd", e.g.,

<ximf:compstring
ilk="ilk-special"
content="SPECIAL"
technicalContent="1.3.4"
separator=" "
technicalSeparator=".">

* Détails sur les attributs de l'élément "compstring" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "compstring".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (cf. [[#Element_role| élément "role"]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut " description " permet d’associer un commentaire sur cette donnée.
** L’attribut "content" représente la valeur effective de la donnée. C’est cette donnée qui sera associée au champ XIMF créé.
** L’attribut "technicalContent" représente la valeur effective de la donnée technique. C’est cette donnée qui sera associée au champ technique XIMF créé (cf. attribut technicalHeaderName de l’élément "header".
** L’attribut "separator" définit le caractère de séparation entre deux valeurs.
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "contentPositionEnd" impose de positionner le contenu de l’élément "compstring" après les valeurs des éléments fils : valuefils1,valuefils2 : valuecompstring.
** L’attribut "technicalPositionEnd" impose de positionner le contenu de l’élément "compstring" après les valeurs des éléments fils.
** L’attribut "contentFactorise" impose d’utiliser le contenu de l’élément "compstring" comme facteur des éléments fils : valuecompstring(valuefils1,valuefils2).

L’élément "compstring" peut contenir un élément "string" ou "set" ou "multiset" ou plusieurs éléments "compstring".

<ximf:compstring
ilk="ilk-special"
content="SPECIAL"
technicalContent="1.3.4"
separator=" "
technicalSeparator=".">
<ximf:set id="ilk-special-op " maxItem="64">
<ximf:string ilk="ilk-special-op1" content="OP1" technicalContent="1" />
<ximf:string ilk="ilk-special-op2" content="OP2" technicalContent="2" />
<ximf:string ilk="ilk-special-op3" content="OP3" technicalContent="3" />
</ximf:set>
</ximf:compstring>

==== Element set ====
L’élément "set" décrit un conteneur de ressources de même type. Cet élément autorise la sélection de plusieurs ressources mais chaque ressource est sélectionnée une seule fois.
Douze attributs précisent la description de la balise "set" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", e.g.,

<ximf:set id="value-categories" ref="value-mentions" maxItem="64" separator=";" />

* Détails sur les attributs de l'élément "set" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "ximf:set".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role|élément rôle]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut "description" permet d’associer un commentaire sur cette donnée.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs

L’élément "set" peut contenir un ou plusieurs éléments "string" ou un ou plusieurs éléments "compstring".

<ximf:set id="value-categories" minItem="1" maxItem="64" separator=";">
<ximf:string ilk="ilk-releasable-to" content="RELEASABLE TO " />
<ximf:string ilk="ilk-eyes-only" content=" EYES ONLY"/>
<ximf:string ilk="ilk-use-only" content=" USE ONLY"/>
</ximf:set>

==== Element multiset ====
L’élément "multiset" décrit un conteneur de ressources de même type. Cet élément autorise la sélection de plusieurs ressources et chaque ressource peut être sélectionnée plusieurs fois.
Douze attributs précisent la description de la balise "multiset" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", e.g.,

<ximf:multiset
id="value-restricted"
ilk=" ilk-value-restricted"
maxItem="64"
separator=";" />

* Détails sur les attributs de l'élément "multiset" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "multiset".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role|élément rôle]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut "description" permet d’associer un commentaire sur cette donnée.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs

L’élément "multiset" peut contenir un ou plusieurs éléments "string" ou un ou plusieurs éléments "compstring".

<ximf:multiset id="value-restricted-example-categories" minItem="1" maxItem="64" separator=";" >
<ximf:string ilk="ilk-releasable-to" content="RELEASABLE TO "/>
<ximf:string ilk="ilk-eyes-only" content=" EYES ONLY"/>
<ximf:string ilk="ilk-use-only" content=" USE ONLY"/>
</ximf:multiset>

==== Element linkedValue ====
L’élément "linkedValue" définit une référence sur une ressource de type conteneur ("set", "multiset") ou "string". Cette ressource devrait être utilisée si la ressource contenant "linkedValue" (noeud parent) est sélectionnée.
Un attribut précise la balise "linkvalue" : "ref", e.g.,

<ximf:linkedValue ref="value-restricted-example-classification-id" />

* Détails sur les attributs de l'élément "linkedValue" :
** L’attribut "ref" précise la valeur de l’attribut "id" de la ressource cible. Cet attribut est obligatoire.

=== Fichier rules ===
Le fichier rules définit les règles de contrôles d’entêtes XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui peut contenir des éléments "ximf:rule".

==== Element rule ====
L’élément "rule" est le conteneur principal de description d’un comportement particulier à appliquer sur un ensemble d’entêtes XIMF.
Trois attributs précisent la balise "rule" : "id", "agent", "description", e.g.,
<ximf:rule id="compatibility-rule" description="Règle sur la compatibilité X-SMTP / XIMF" >

* Détails sur les attributs de l'élément "rule" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "rule". Cet attribut est obligatoire.
** L’attribut "agent" indique l’équipement cible devant analyser et appliquer le contenu de cet élément.
** L’attribut "description" autorise l’auteur d’ajouter un commentaire sur cet élément.

L’élément "rule" contient un ou plusieurs mêmes éléments de spécialisation de la règle "contraint", "assignement", "processing", "compatibility", "accessibility", "custom",…, e.g.,

<ximf:rule id="precedence-rule" agent="mua" description="Règle sur les priorités">
<ximf:constraint
left="header-primary-precedence"
operator="equalOrGreaterThan"
right="header-copy-precedence" />
</ximf:rule>

==== Element aliasHeader ====
L’élément "aliasHeader" permet de définir le nom de l’entête sur lequel la règle précisée est appliquée
Deux attributs précisent la balise "aliasHeader" : "headerName" et "headerRef", e.g.,

<ximf:aliasHeader headerName ="X-P772-Version" headerRef="X-XIMF-VERSION" />

* Détails sur les attributs de l'élément "aliasHeader" :
* L’attribut "headerName" définit le nom XIMF de l’entête modifié par la règle. Cet attribut est obligatoire.
* L’attribut "headerRef" définit le nom d’un entête XIMF de référence qui est le point d’entrée de l’application de la règle sur l’entête définit par "headerName". Cela permet de lier deux entêtes de messages où l’utilisation de l’un des entêtes influe sur le comportement de l’autre.

L’élément "aliasHeader" peut contenir des éléments "aliasValue",e.g ,

<ximf:aliasHeader headerName="X-P772-Version" />
<ximf:aliasValue vame="1.0"/>
<ximf:aliasHeader>

==== Element aliasValue ====
L’élément "aliasValue" contient une valeur à associer à l’entête XIMF contrôlé par la règle. Il est utile lorsque deux entêtes sont liées (utilisation de l’attribut headerRef dans l’élément aliasHeader) et que les valeurs de l’entêtes de référence permettent de préciser celles de l’entête contrôlé.
Deux attributs précisent la balise "aliasValue" : "valueName", "valueRef", e.g.,

<ximf:aliasValue valueName="2" valueRef="flash" />

* Détails sur les attributs de l'élément "aliasValue" :
** L’attribut "valueName" définit la valeur de l’entête à créer. Cet attribut est obligatoire.
** L’attribut "valueRef" définit la valeur de l’entête XIMF de référence pour utiliser valueName.

==== Element compatibility ====
L’élément "compatibility" est utilisé pour associer à un entête respectant la norme XIMF un entête respectant une autre norme que XIMF (XSMTP par exemple).
Deux attributs précisent la balise "compatibility" : "targetName", "targetVersion", e.g.,

<ximf:compatibility targetName="X-SMTP" targetVersion="1.1">
<ximf:aliasValue headerName="X-P772-Version" content="1.1" />
<ximf:aliasValue
headerName="X-P772-Primary-Precedence"
headerRef="header-primary-precedence"
dataRef="data-priority-xsmtp"/>
</ximf:compatibility>

* Détails sur les attributs de l'élément "compatibility" :
** L’attribut "targetName" définit la norme de l’entête à associer à l’entête XIMF. Cet attribut est obligatoire.
** L’attribut "targetVersion" définit le numéro de version de la norme de l’entête à associer à l’entête XIMF. Cet attribut est obligatoire.

L’élément "compatibility" contient au moins un élément "aliasHeader".

<u>Pour illustrer cette règle :</u>
Le format XSMTP est déjà supporté par certains équipements. Afin de rendre ceux-ci inter opérables avec le nouveau format XIMF, cette règle permet d’associer un entête XSMTP contenant les mêmes informations qu’un entête XIMF.

L’élément Association : dépendance entre entêtes
L’élément "association" définie les valeurs autorisées pour un entête XIMF en fonction d’une valeur définie pour un autre entête XIMF.

<ximf:association>
<ximf:aliasHeader
headerName="X-XIMF-Primary-Precedence"
headerRef="X-XIMF-Correspondence-Type">
<ximf:aliasValue valueName="routine" valueRef="private" />
<ximf:aliasValue valueName="routine,priority" valueRef="professional" />
<ximf:aliasValue valueName="routine,priority,immediate,flash" valueRef="operational" />
<ximf:aliasValue valueName="routine,priority,immediate" valueRef="official" />
</ximf:aliasHeader>
</ximf:association>

==== Element secureHeaders ====
L’élément "secureHeaders" définie la liste des entêtes à intégrer dans la signature d’un message. Cette règle s’applique sur les équipements proposant un algorithme de signature des messages.

Un élément "secureHeaders" contient un ou plusieurs éléments "aliasHeaders" où chaque élément décrit un entête à intégrer dans la signature et complété d’un attribut "status".

<ximf:secureHeaders targetName="SecureHeaders">
<ximf:aliasHeader headerName="X-XIMF-Primary-Precedence" status="0" />
<ximf:aliasHeader headerName="X-XIMF-Copy-Precedence" status="0" />
</ximf:secureHeaders>

==== Element securityLabel ====
L’élément "securityLabel" définie la liste des entêtes à intégrer dans la signature d’un message. Cette règle s’applique sur les équipements proposant un algorithme de signature des messages selon la norme RFC.

Un élément "securityLabel" contient un ou plusieurs éléments "aliasHeaders" où chaque élément décrit un entête à intégrer dans la signature et complété d’un attribut "status".

<ximf:securityLabel targetName="SecurityLabel" id="Amoco">
<ximf:aliasHeader
headerName="SecurityPolicyIdentifier"
headerRef="X-XIMF-Security-Policy-Identifier" />
<ximf:aliasHeader
headerName="SecurityClassification"
headerRef="X-XIMF-Security-Classification-Identifier" />
<ximf:aliasHeader
headerName="ESSPrivacyMark"
headerRef="X-XIMF-Privacy-Mark" />
<ximf:aliasHeader
headerName="SecurityCategory"
headerRef="X-XIMF-Security-Categories-Identifier"
type="2" />
</ximf:securityLabel>

==== Element constraint ====
L’élément "constraint" est utilisé pour définir une règle de construction de deux entêtes partageant des "datas" identiques.
Trois attributs précisent la balise "constraint" : "left", "right", "operator", e.g.,

<ximf:constraint
left="header-primary-precedence"
operator="equalOrGreaterThan"
right="header-copy-precedence" />

* Détails sur les attributs de l'élément "constraint" :
** L’attribut "left" désigne le premier élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "right" désigne le deuxième élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "operator" indique la règle de poids à appliquer sur la valeur des deux éléments "header", il peut être de type "greaterThan", "lowerThan", "equalOrGreaterThan", "equalOrLowerThan", "equal". Cet attribut est obligatoire.

* Détails sur les valeurs possibles de l'attribut "type" :
** Le type "greaterThan" signifie que la valeur de l’élément "left" doit être strictement supérieur à la valeur de l’élément "right".
** Le type "lowerThan" signifie que la valeur de l’élément "left" doit être strictement inférieur à la valeur de l’élément "right".
** Le type "equalOrGreaterThan" signifie que la valeur de l’élément "left" doit être supérieur ou égale à la valeur de l’élément "right".
** Le type "equalOrLowerThan" signifie que la valeur de l’élément "left" doit être inférieur ou égale à la valeur de l’élément "right".
** Le type "equal" signifie que la valeur de l’élément "left" et de l’élément "right" doivent être identiques.

==== Element assignment ====
L’élément "assignement" est utilisé pour affecter une valeur créée en fonction d’une règle de comparaison sur les valeurs de deux éléments "header".
Quatre attributs précisent la balise "assignement" : "left", "right", "operator", "result", e.g.,

<ximf:assignment
left="header-primary-precedence"
operator="equal"
right="data-routine-precedence"
result="86400" />

* Détails sur les attributs de l'élément "assignment" :
** L’attribut "left" désigne le premier élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "right" désigne le deuxième élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "operator" indique la règle de comparaison entre les valeurs des deux éléments "header", il peut être de type "greaterThan", "lowerThan", "equalOrGreaterThan", "equalOrLowerThan", "equal". Cet attribut est obligatoire.
** L’attribut "result" représente la valeur à utiliser si la règle de comparaison entre les deux éléments est satisfaite. Cet attribut est obligatoire.

==== Element processing ====
L’élément "processing" regroupe des règles de traitement à effectuer sur des entêtes formatés.
L’attribut "type" précise le type de traitement à effectuer sur ces valeurs. Cet attribut est obligatoire, il est de type : "sign-header-value", "encrypt-header-value", "capitalize-header-value", e.g.,

<ximf:processing type="sign-header-value">
<ximf:refHeader>header-primary-precedence</ximf:refheader>
<ximf:refHeader>header-copy-precedence</ximf:refheader>
<ximf:refHeader>header-echange-type</ximf:refheader>
</ximf:processing>

* Détails sur les valeurs possibles de l'attribut "type" :
** Le type "sign-header-value" définit un traitement de signature des entêtes définis dans la balise.
** Le type "encrypt-header-value" définit un traitement de chiffrement des entêtes définis dans la balise.
** Le type "capitalize-header-value" définit un traitement de capitalisation des entêtes définis dans la balise.

L’élément "processing" contient au moins un élément "refHeader".

==== Element accessibility ====
L’élément "accessibility" définit un ensemble de règles de droit d’accès aux éléments d’une instance pour une cible déterminée (utilisateur, routeur…).
Cet élément contient un ou plusieurs éléments "role".

<ximf:accessibility>
<ximf:role id="role-flash-allowed" aclLevel="100" />
<ximf:role id="role-flash-prohibited" aclLevel="50" />
</ximf:accessibility>

==== Element role ====
L’élément "role" positionne une valeur d’accès à pour une entité définit.
Deux attributs complètent l’élément "role" : "id", "aclLevel", e.g.,

<ximf:role id="role-flash-allowed" aclLevel="100" />

* Détails sur les attributs de l'élément "role" :
** L’attribut "id" précise l’entité accessible en fonction d’une valeur déterminée.
** L’attribut "aclLevel" précise la valeur seuil d’accès à l’entité.

==== Element custom ====
L’élément "custom" permet à l’auteur de créer des nouvelles règles personnalisées.
Trois attributs précisent la balise "custom" : "id", "provider", "description", e.g.,

<ximf:custom
id="custom-display"
provider="EADS"
description="Affichage de la composition du message" >
<node1><node2><node3></node3></node2></node1>
</ximf:custom>

* Détails sur les attributs de l'élément "custom" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "custom" et formaté selon la syntaxe "custom-xxx". Cet attribut est obligatoire.
** L’attribut "provider" identifie l’auteur de la règle. Cet attribut est obligatoire.
** L’attribut "description" permet d’ajouter un commentaire sur cet élément.

L’élément "custom" peut contenir tous les éléments possibles en respectant les standards XML.

Instance FullExample

2011-06-24T14:55:18Z

Anthonyjuge : Page créée avec « FullExample est une instance regroupant les fonctionnalités avancées spécifiées par XIMF. Notamment les champs à sélection multiple. == Champs à sélection multiple =… »

Fichier:Trustedbird-affichage champ selection multiple.png

2011-06-24T14:50:52Z

Anthonyjuge :

XIMF guide developpeur/fr

2011-06-24T14:32:02Z

Anthonyjuge : /* Exemples d'instances XIMF */

== Guide développeur ==

Ce guide a pour objectif de décrire la création d'une instance XIMF. Cela passe par la définition des champs d'entête spécifiques, par la description des formulaires de création et de visualisation.

== Identification d'un message XIMF ==

Un message XIMF est un message IMF qui intègre des champs d'entête spécifiques qui peuvent être interprétés par le moteur XIMF.

Le traitement des messages XIMF (en réception) est réalisé par le client Trustedbird dans le cas où les champ d'entête suivants sont présents :

* X-XIMF-Name
* X-XIMF-Version

Dans le cas où un de ces champs d'entête n'est pas présent, le client Trustedbird n'affiche pas le formulaire XIMF à la réception du message.

Ces champs d'entête sont des champs techniques. C'est à dire qu'ils ne sont pas saisis par l'utilisateur mais générés automatiquement lors de l'envoi d'un message.

== Structure de l'instance ==

Une instance XIMF est composée de plusieurs fichiers xml :
* un fichier ihm définissant l'agencement de l'interface
* un ou plusieurs fichiers headers définissant les types des champs de l'interface
* un fichier dictionnaire définissant les données d'internationalisation
* un ou plusieurs fichiers de règles définissant les contraintes spécifiques associées aux champs du formulaire

Les informations concernant les fichiers utilisés par une instance ce situent dans un autre fichier : ximfmail-profile.xml.

== Glossaire des balises XIMF ==

Une [[XIMF_XML_tags/fr| description détaillée des balises XIMF]] est disponible.

== Exemples d'instances XIMF ==

Instance simple : [[Instance_Example1 | Example1]] (un seul champ : type de correspondance)

Instance simple : [[Instance_Amoco | Amoco]] (plusieurs champs aux types variés : nom de l'affaire, label, date limite ...)

Instance simple : [[Instance_Caterpillar | Instance Caterpillar]] (intégration des security label et des listes d'attributions)

Instance intégrant les possibilités avancées de XIMF : [[Instance_FullExample | Instance FullExample]].

== Création d'un add-on XIMF ==

Génération d'un add-on au format XPI. lien vers documentation Mozilla pour les XPI

Instance Caterpillar

2011-06-24T14:27:52Z

Anthonyjuge :

Caterpillar est une autre instance comprise dans le XPI "Company Def". Cette instance montre comment il est possible d'intégrer facilement l'affichage des étiquettes de sécurité ainsi que les listes d'attibution.

== Affichage des étiquettes de sécurité ==

Les étiquettes de sécurité sont une structure de donnée qui définit la sensibilité de l'information à laquelle elle est associée.

L'instance Caterpillar propose l'affichage des étiquettes de sécurité correspondant à l'identifiant de classification.
- classification portant l'identifiant 7 : affichage du logo "Caterpillar Inc" en vert.
- classification portant l'identifiant 8 : affichage du logo "Caterpillar Inc" en jaune.
- classification portant l'identifiant 9 : affichage du logo "Caterpillar Inc" en rouge.

L'ajout de cette fonctionnalité supplémentaire se fait via le fichier de règle des instances XIMF.

Une nouvelle règle y est spécifiée :

<ximf:rule id="label-pictures-rule" description="rule to display pictures on received mails" >
<ximf:classificationPictures targetName="ClassificationPictures">
<ximf:aliasHeader headerName="url" headerRef="X-XIMF-Security-Classification-Identifier" >
<ximf:aliasValue valueRef="7" valueName=
"chrome://ximf-company-def/content/CaterpillarInc/resource/caterpillar-green.png" />
<ximf:aliasValue valueRef="8" valueName=
"chrome://ximf-company-def/content/CaterpillarInc/resource/caterpillar-yellow.png" />
<ximf:aliasValue valueRef="9" valueName=
"chrome://ximf-company-def/content/CaterpillarInc/resource/caterpillar-red.png" />
</ximf:aliasHeader>
</ximf:classificationPictures>
</ximf:rule>

Les images utilisées pour l'affichage sont contenues dans un fichier .jar. Ce fichier est référencé dans le fichier chrome.manifest du plugin Trustedbird.

[[Fichier:Trustedbird-affichage-label.png|frame|center|Affichage d'une l'étiquette de sécurité de l'instance XIMF Caterpillar dans Trustedird]]

== Ajout de listes d'attributions ==

Les listes d'attribution spécifient des mots clés associés à des descriptions que l'utilisateur peut sélectionner de façon à marquer le message.

Les listes d'attributions sont définies dans un fichier séparé, on y retrouve les clés ainsi que les valeurs des éléments :

<?xml version="1.0" encoding="utf-8"?>
<ximf xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ximf:base name="Attribution_List">
<ximf:header>
<ximf:title>Attribution</ximf:title>
<ximf:description>Attribution keys</ximf:description>
<ximf:column>key</ximf:column>
<ximf:column>description</ximf:column>
</ximf:header>
<ximf:tree>
<ximf:description>
<ximf:data>HUMAN RESOURCE</ximf:data>
<ximf:data>Message for human resource only</ximf:data>
</ximf:description>
<ximf:description>

</ximf:description>
</ximf:tree>
</ximf:base>
</ximf>

La définition de l'élément attribution-list se fait dans le fichier de définition des headers :

<ximf:header id="header-akw"
headerName="X-XIMF-Attribution-Key-Word" ilk="ilk-akw" type="string">
<ximf:set ref="attribution-list.xml" separator=";" maxItem="2"/>
</ximf:header>

Cela nous permet d'obtenir l'affichage suivant dans Trustedbird :

[[Fichier:Trustedbird-attribution_list.png|frame|center|Affichage de la liste d'attribution de l'instance XIMF Caterpillar dans Trustedird]]

Fichier:Trustedbird-affichage-label.png

2011-06-24T14:25:46Z

Anthonyjuge : Affichage d'une étiquette de sécurité via le plugin XIMF de Trustedbird

Affichage d'une étiquette de sécurité via le plugin XIMF de Trustedbird

Fichier:Trustedbird-attribution list.png

2011-06-24T14:20:14Z

Anthonyjuge : Exemple d'affichage d'une liste d'attribution via le plugin XIMF de Trustedbird.

Exemple d'affichage d'une liste d'attribution via le plugin XIMF de Trustedbird.

Instance Caterpillar

2011-06-24T14:07:05Z

Anthonyjuge : /* Affichage des étiquettes de sécurité */

Caterpillar est une autre instance comprise dans le XPI "Company Def". Cette instance montre comment il est possible d'intégrer facilement l'affichage des étiquettes de sécurité ainsi que les listes d'attibution.

== Affichage des étiquettes de sécurité ==

Les étiquettes de sécurité sont une structure de donnée qui définit la sensibilité de l'information à laquelle elle est associée.

L'instance Caterpillar propose l'affichage des étiquettes de sécurité correspondant à l'identifiant de classification.
- classification portant l'identifiant 7 : affichage du logo "Caterpillar Inc" en vert.
- classification portant l'identifiant 8 : affichage du logo "Caterpillar Inc" en jaune.
- classification portant l'identifiant 9 : affichage du logo "Caterpillar Inc" en rouge.

L'ajout de cette fonctionnalité supplémentaire se fait via le fichier de règle des instances XIMF.

Une nouvelle règle y est spécifiée :

<ximf:rule id="label-pictures-rule" description="rule to display pictures on received mails" >
<ximf:classificationPictures targetName="ClassificationPictures">
<ximf:aliasHeader headerName="url" headerRef="X-XIMF-Security-Classification-Identifier" >
<ximf:aliasValue valueRef="7" valueName=
"chrome://ximf-company-def/content/CaterpillarInc/resource/caterpillar-green.png" />
<ximf:aliasValue valueRef="8" valueName=
"chrome://ximf-company-def/content/CaterpillarInc/resource/caterpillar-yellow.png" />
<ximf:aliasValue valueRef="9" valueName=
"chrome://ximf-company-def/content/CaterpillarInc/resource/caterpillar-red.png" />
</ximf:aliasHeader>
</ximf:classificationPictures>
</ximf:rule>

Les images utilisées pour l'affichage sont contenues dans un fichier .jar. Ce fichier est référencé dans le fichier chrome.manifest du plugin Trustedbird.

== Ajout de listes d'attributions ==

Les listes d'attribution spécifient des mots clés associés à des descriptions que l'utilisateur peut sélectionner de façon à marquer le message.

Les listes d'attributions sont définies dans un fichier séparé, on y retrouve les clés ainsi que les valeurs des éléments :

<?xml version="1.0" encoding="utf-8"?>
<ximf xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ximf:base name="Attribution_List">
<ximf:header>
<ximf:title>Attribution</ximf:title>
<ximf:description>Attribution keys</ximf:description>
<ximf:column>key</ximf:column>
<ximf:column>description</ximf:column>
</ximf:header>
<ximf:tree>
<ximf:description>
<ximf:data>HUMAN RESOURCE</ximf:data>
<ximf:data>Message for human resource only</ximf:data>
</ximf:description>
<ximf:description>

</ximf:description>
</ximf:tree>
</ximf:base>
</ximf>

Instance Caterpillar

2011-06-24T14:06:12Z

Anthonyjuge : /* Instance Caterpillar */

Caterpillar est une autre instance comprise dans le XPI "Company Def". Cette instance montre comment il est possible d'intégrer facilement l'affichage des étiquettes de sécurité ainsi que les listes d'attibution.

== Affichage des étiquettes de sécurité ==

Les étiquettes de sécurité sont une structure de donnée qui définit la sensibilité de l'information à laquelle elle est associée.

L'instance Caterpillar propose l'affichage des étiquettes de sécurité correspondant à l'identifiant de classification.
- classification portant l'identifiant 7 : affichage du logo "Caterpillar Inc" en vert.
- classification portant l'identifiant 8 : affichage du logo "Caterpillar Inc" en jaune.
- classification portant l'identifiant 9 : affichage du logo "Caterpillar Inc" en rouge.

L'ajout de cette fonctionnalité supplémentaire se fait via le fichier de règle des instances XIMF.

Une nouvelle règle y est spécifiée :

<ximf:rule id="label-pictures-rule" description="rule to display pictures on received mails" >
<ximf:classificationPictures targetName="ClassificationPictures">
<ximf:aliasHeader headerName="url" headerRef="X-XIMF-Security-Classification-Identifier" >
<ximf:aliasValue valueRef="7" valueName=
"chrome://ximf-conpany-def/content/CaterpillarInc/resource/caterpillar-green.png" />
<ximf:aliasValue valueRef="8" valueName=
"chrome://ximf-conpany-def/content/CaterpillarInc/resource/caterpillar-yellow.png" />
<ximf:aliasValue valueRef="9" valueName=
"chrome://ximf-conpany-def/content/CaterpillarInc/resource/caterpillar-red.png" />
</ximf:aliasHeader>
</ximf:classificationPictures>
</ximf:rule>

Les images utilisées pour l'affichage sont contenues dans un fichier .jar. Ce fichier est référencé dans le fichier chrome.manifest du plugin Trustedbird.

== Ajout de listes d'attributions ==

Les listes d'attribution spécifient des mots clés associés à des descriptions que l'utilisateur peut sélectionner de façon à marquer le message.

Les listes d'attributions sont définies dans un fichier séparé, on y retrouve les clés ainsi que les valeurs des éléments :

<?xml version="1.0" encoding="utf-8"?>
<ximf xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ximf:base name="Attribution_List">
<ximf:header>
<ximf:title>Attribution</ximf:title>
<ximf:description>Attribution keys</ximf:description>
<ximf:column>key</ximf:column>
<ximf:column>description</ximf:column>
</ximf:header>
<ximf:tree>
<ximf:description>
<ximf:data>HUMAN RESOURCE</ximf:data>
<ximf:data>Message for human resource only</ximf:data>
</ximf:description>
<ximf:description>

</ximf:description>
</ximf:tree>
</ximf:base>
</ximf>

Instance Caterpillar

2011-06-24T14:05:54Z

Anthonyjuge : Page créée avec « === Instance Caterpillar === Caterpillar est une autre instance comprise dans le XPI "Company Def". Cette instance montre comment il est possible d'intégrer facilement l'af… »

=== Instance Caterpillar ===

Caterpillar est une autre instance comprise dans le XPI "Company Def". Cette instance montre comment il est possible d'intégrer facilement l'affichage des étiquettes de sécurité ainsi que les listes d'attibution.

== Affichage des étiquettes de sécurité ==

Les étiquettes de sécurité sont une structure de donnée qui définit la sensibilité de l'information à laquelle elle est associée.

L'instance Caterpillar propose l'affichage des étiquettes de sécurité correspondant à l'identifiant de classification.
- classification portant l'identifiant 7 : affichage du logo "Caterpillar Inc" en vert.
- classification portant l'identifiant 8 : affichage du logo "Caterpillar Inc" en jaune.
- classification portant l'identifiant 9 : affichage du logo "Caterpillar Inc" en rouge.

L'ajout de cette fonctionnalité supplémentaire se fait via le fichier de règle des instances XIMF.

Une nouvelle règle y est spécifiée :

<ximf:rule id="label-pictures-rule" description="rule to display pictures on received mails" >
<ximf:classificationPictures targetName="ClassificationPictures">
<ximf:aliasHeader headerName="url" headerRef="X-XIMF-Security-Classification-Identifier" >
<ximf:aliasValue valueRef="7" valueName=
"chrome://ximf-conpany-def/content/CaterpillarInc/resource/caterpillar-green.png" />
<ximf:aliasValue valueRef="8" valueName=
"chrome://ximf-conpany-def/content/CaterpillarInc/resource/caterpillar-yellow.png" />
<ximf:aliasValue valueRef="9" valueName=
"chrome://ximf-conpany-def/content/CaterpillarInc/resource/caterpillar-red.png" />
</ximf:aliasHeader>
</ximf:classificationPictures>
</ximf:rule>

Les images utilisées pour l'affichage sont contenues dans un fichier .jar. Ce fichier est référencé dans le fichier chrome.manifest du plugin Trustedbird.

== Ajout de listes d'attributions ==

Les listes d'attribution spécifient des mots clés associés à des descriptions que l'utilisateur peut sélectionner de façon à marquer le message.

Les listes d'attributions sont définies dans un fichier séparé, on y retrouve les clés ainsi que les valeurs des éléments :

<?xml version="1.0" encoding="utf-8"?>
<ximf xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ximf:base name="Attribution_List">
<ximf:header>
<ximf:title>Attribution</ximf:title>
<ximf:description>Attribution keys</ximf:description>
<ximf:column>key</ximf:column>
<ximf:column>description</ximf:column>
</ximf:header>
<ximf:tree>
<ximf:description>
<ximf:data>HUMAN RESOURCE</ximf:data>
<ximf:data>Message for human resource only</ximf:data>
</ximf:description>
<ximf:description>

</ximf:description>
</ximf:tree>
</ximf:base>
</ximf>

XIMF guide developpeur/fr

2011-06-24T13:35:54Z

Anthonyjuge : /* Exemples d'instances XIMF */

== Guide développeur ==

Ce guide a pour objectif de décrire la création d'une instance XIMF. Cela passe par la définition des champs d'entête spécifiques, par la description des formulaires de création et de visualisation.

== Identification d'un message XIMF ==

Un message XIMF est un message IMF qui intègre des champs d'entête spécifiques qui peuvent être interprétés par le moteur XIMF.

Le traitement des messages XIMF (en réception) est réalisé par le client Trustedbird dans le cas où les champ d'entête suivants sont présents :

* X-XIMF-Name
* X-XIMF-Version

Dans le cas où un de ces champs d'entête n'est pas présent, le client Trustedbird n'affiche pas le formulaire XIMF à la réception du message.

Ces champs d'entête sont des champs techniques. C'est à dire qu'ils ne sont pas saisis par l'utilisateur mais générés automatiquement lors de l'envoi d'un message.

== Structure de l'instance ==

Une instance XIMF est composée de plusieurs fichiers xml :
* un fichier ihm définissant l'agencement de l'interface
* un ou plusieurs fichiers headers définissant les types des champs de l'interface
* un fichier dictionnaire définissant les données d'internationalisation
* un ou plusieurs fichiers de règles définissant les contraintes spécifiques associées aux champs du formulaire

Les informations concernant les fichiers utilisés par une instance ce situent dans un autre fichier : ximfmail-profile.xml.

== Glossaire des balises XIMF ==

Une [[XIMF_XML_tags/fr| description détaillée des balises XIMF]] est disponible.

== Exemples d'instances XIMF ==

Instance simple : [[Instance_Example1 | Example1]] (un seul champ : type de correspondance)

Instance simple : [[Instance_Amoco | Amoco]] (plusieurs champs aux types variés : nom de l'affaire, label, date limite ...)

Instance simple : [[Instance_Caterpillar | Instance Caterpillar]] (intégration des security label)

Instance intégrant les possibilités avancées de XIMF : [[Instance_FullExample | Instance FullExample]].

== Création d'un add-on XIMF ==

Génération d'un add-on au format XPI. lien vers documentation Mozilla pour les XPI

XIMF guide developpeur/fr

2011-06-24T13:29:49Z

Anthonyjuge : /* Exemples d'instances XIMF */

== Guide développeur ==

Ce guide a pour objectif de décrire la création d'une instance XIMF. Cela passe par la définition des champs d'entête spécifiques, par la description des formulaires de création et de visualisation.

== Identification d'un message XIMF ==

Un message XIMF est un message IMF qui intègre des champs d'entête spécifiques qui peuvent être interprétés par le moteur XIMF.

Le traitement des messages XIMF (en réception) est réalisé par le client Trustedbird dans le cas où les champ d'entête suivants sont présents :

* X-XIMF-Name
* X-XIMF-Version

Dans le cas où un de ces champs d'entête n'est pas présent, le client Trustedbird n'affiche pas le formulaire XIMF à la réception du message.

Ces champs d'entête sont des champs techniques. C'est à dire qu'ils ne sont pas saisis par l'utilisateur mais générés automatiquement lors de l'envoi d'un message.

== Structure de l'instance ==

Une instance XIMF est composée de plusieurs fichiers xml :
* un fichier ihm définissant l'agencement de l'interface
* un ou plusieurs fichiers headers définissant les types des champs de l'interface
* un fichier dictionnaire définissant les données d'internationalisation
* un ou plusieurs fichiers de règles définissant les contraintes spécifiques associées aux champs du formulaire

Les informations concernant les fichiers utilisés par une instance ce situent dans un autre fichier : ximfmail-profile.xml.

== Glossaire des balises XIMF ==

Une [[XIMF_XML_tags/fr| description détaillée des balises XIMF]] est disponible.

== Exemples d'instances XIMF ==

Instance simple : [[Instance_Example1 | Example1]] (un seul champ : type de correspondance)

Instance simple : [[Instance_Amoco | Amoco]] (plusieurs champs aux types variés : nom de l'affaire, label, date limite ...)

Instance simple : [[Instance_Company | Instance Company]] (intégration des security label)

Instance intégrant les possibilités avancées de XIMF : [[Instance_FullExample | Instance FullExample]].

== Création d'un add-on XIMF ==

Génération d'un add-on au format XPI. lien vers documentation Mozilla pour les XPI

XIMF guide developpeur/fr

2011-06-24T13:23:35Z

Anthonyjuge : /* Exemples d'instances XIMF */

== Guide développeur ==

Ce guide a pour objectif de décrire la création d'une instance XIMF. Cela passe par la définition des champs d'entête spécifiques, par la description des formulaires de création et de visualisation.

== Identification d'un message XIMF ==

Un message XIMF est un message IMF qui intègre des champs d'entête spécifiques qui peuvent être interprétés par le moteur XIMF.

Le traitement des messages XIMF (en réception) est réalisé par le client Trustedbird dans le cas où les champ d'entête suivants sont présents :

* X-XIMF-Name
* X-XIMF-Version

Dans le cas où un de ces champs d'entête n'est pas présent, le client Trustedbird n'affiche pas le formulaire XIMF à la réception du message.

Ces champs d'entête sont des champs techniques. C'est à dire qu'ils ne sont pas saisis par l'utilisateur mais générés automatiquement lors de l'envoi d'un message.

== Structure de l'instance ==

Une instance XIMF est composée de plusieurs fichiers xml :
* un fichier ihm définissant l'agencement de l'interface
* un ou plusieurs fichiers headers définissant les types des champs de l'interface
* un fichier dictionnaire définissant les données d'internationalisation
* un ou plusieurs fichiers de règles définissant les contraintes spécifiques associées aux champs du formulaire

Les informations concernant les fichiers utilisés par une instance ce situent dans un autre fichier : ximfmail-profile.xml.

== Glossaire des balises XIMF ==

Une [[XIMF_XML_tags/fr| description détaillée des balises XIMF]] est disponible.

== Exemples d'instances XIMF ==

Instance simple : [[Instance_Example1 | Example1]] (un seul champ : type de correspondance)

Instance simple : [[Instance_Amoco | Amoco]] (plusieurs champs aux types variés : nom de l'affaire, label, date limite ...)

Instance simple : [Instnace_Company | Instance Company] (intégration des security label)

Instance intégrant les possibilités avancées de XIMF : [Instance_FullExample | Instance FullExample].

== Création d'un add-on XIMF ==

Génération d'un add-on au format XPI. lien vers documentation Mozilla pour les XPI

Instance Amoco

2011-06-24T10:52:53Z

Anthonyjuge : /* Instance Amoco */

== Instance Amoco ==

Cette instance comporte un onglet contenant des sous-groupes disposant de champs aux types variés :
* deux listes déroulantes
* un champ texte
* un champ date

De plus, une contrainte est appliquée entre les deux listes déroulantes du premier onglet : certaines valeurs de la seconde liste ne sont pas disponible en fonction de la valeur sélectionnée sur la première liste.

[[Fichier:Instance_amoco.png|frame|center|''Affichage final de l'instance dans la langue : en-US.'']]

[[Fichier:Instance_amoco_selection.png|frame|center|''Règle XIMF de contrainte entre deux listes déroulante : certains éléments de la deuxième liste sont grisés en fonction de la valeur de la première liste.'']]

Voici les fichiers qui la définissent.

=== Fichier ximfmail-profile ===
Le fichier ximfmail-profile.xml devra contenir les renseignements sur les chemins vers les fichiers associés à l'instance.

<?xml version="1.0" encoding="utf-8"?>
<profile>
<theme name="Company Def"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="D:\DOC\DOC_THUN_INTRACED\ximf_profile.xsd">
<instance id="idExampleDefinition"
ximfVersion="2.0"
version="1.0"
name="Amoco"
directory="/chemin/vers/instance/Amoco/" author="Ximfmail">
<schema name="amoco">headers-Amoco.xml</schema>
<dictionary>dictionary-moco.xml</dictionary>
<ihm>ihm-amoco.xml</ihm>
<rule>rules-amoco.xml</rule>
</instance>
</theme>
</profile>

=== Fichier dictionary-amoco ===
Le fichier dictionary-amoco.xml contient des renseignement de toutes les données d'internationalisation pour les langues : fr-FR et en-US.

<?xml version="1.0" encoding="UTF-8"?>
<ximf:instance
name="Amoco"
version="1.0"
ximfVersion="2.0"
xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://eads.org/ximf/ ximf.xsd">
<ximf:dictionary id="OneDico">
<ximf:locale lang="fr-FR">
<ximf:ilk entity="ilk-info-box">Information</ximf:ilk>
<ximf:ilk entity="ilk-security-panel">Securité</ximf:ilk>
<ximf:ilk entity="ilk-originator-reference">Réferences d'origine</ximf:ilk>
<ximf:ilk entity="ilk-reply-before">Répondre avant</ximf:ilk>
<ximf:ilk entity="ilk-classification-panel">Classification</ximf:ilk>
<ximf:ilk entity="ilk-classification">Classification de sécurité</ximf:ilk>
<ximf:ilk entity="ilk-privacy-mark">Marque privée</ximf:ilk>
<ximf:ilk entity="ilk-general">Général</ximf:ilk>
<ximf:ilk entity="ilk-confidential">Confidentiel</ximf:ilk>
<ximf:ilk entity="ilk-highly-confidential">Très confidentiel</ximf:ilk>
<ximf:ilk entity="ilk-minimum">Minimum</ximf:ilk>
<ximf:ilk entity="ilk-medium">Moyen</ximf:ilk>
<ximf:ilk entity="ilk-maximum">Maximum</ximf:ilk>
<ximf:ilk entity="ilk-critical">Critique</ximf:ilk>
</ximf:locale>
<ximf:locale lang="en-US">
<ximf:ilk entity="ilk-info-box">Information</ximf:ilk>
<ximf:ilk entity="ilk-security-panel">Security</ximf:ilk>
<ximf:ilk entity="ilk-reply-before">Reply before</ximf:ilk>
<ximf:ilk entity="ilk-originator-reference">Origin references</ximf:ilk>
<ximf:ilk entity="ilk-classification-panel">Classification</ximf:ilk>
<ximf:ilk entity="ilk-classification">Security classification</ximf:ilk>
<ximf:ilk entity="ilk-privacy-mark">Privacy mark</ximf:ilk>
<ximf:ilk entity="ilk-general">General</ximf:ilk>
<ximf:ilk entity="ilk-confidential">Confidential</ximf:ilk>
<ximf:ilk entity="ilk-highly-confidential">Highly Confidential</ximf:ilk>
<ximf:ilk entity="ilk-minimum">Minimum</ximf:ilk>
<ximf:ilk entity="ilk-medium">Medium</ximf:ilk>
<ximf:ilk entity="ilk-maximum">Maximum</ximf:ilk>
<ximf:ilk entity="ilk-critical">Critical</ximf:ilk>
</ximf:locale>
</ximf:dictionary>
</ximf:instance>

=== Fichier ihm-amoco ===
* Le fichier ihm-amoco.xml contient des renseignements sur l'agencement du formulaire : un onglet "pane_security" contient deux sous-catégories "group-classification" et "group-info".
** La sous-catégorie "group-classification" contient les champs "header-classification" et "header-privacy-mark" décrits dans le fichier headers-amoco.xml.
** La sous-catégorie "group-info" contient les champs "header-originator-reference" et "header-reply-before" décrits dans le fichier headers-amoco.xml.
* Le champ "header-classification" et "header-privacy-mark" pourront être ajouté dans l'affichage des e-mails dans le client associé.

<?xml version="1.0" encoding="UTF-8"?>
<ximf:instance
name="Amoco"
version="1.0"
ximfVersion="2.0"
xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://eads.org/ximf/ ximf.xsd">
<ximf:ihm xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ximf:panel id="pane_security" ilk="ilk-classification-panel">
<ximf:groupbox id="group-classification" ilk="ilk-security-panel">
<ximf:headerRef>header-classification</ximf:headerRef>
<ximf:headerRef>header-privacy-mark</ximf:headerRef>
</ximf:groupbox>
<ximf:groupbox id="group-info" ilk="ilk-info-box">
<ximf:headerRef>header-originator-reference</ximf:headerRef>
<ximf:headerRef>header-reply-before</ximf:headerRef>
</ximf:groupbox>
</ximf:panel>
<ximf:treeRcv>
<ximf:headerRef>header-classification</ximf:headerRef>
<ximf:headerRef>header-privacy-mark</ximf:headerRef>
</ximf:treeRcv>
</ximf:ihm>
</ximf:instance>

=== Fichier headers-amoco ===
Le fichier headers-amoco.xml contient des renseignements sur les types de champs de l'instance XIMF et la façon dont les entêtes envoyées devront être formatées.
* Le header portant l'identifiant "header-classification" est une liste déroulante qui comporte trois choix. Cet élément comporte un attribut "technicalHeaderName" ce qui signifie que la valeur réellement envoyé dans les entêtes XIMF n'est pas celle qui est affichée à l'utilisateur.
* Le header portant l'identifiant "header-privacy-mark" est une liste déroulante qui comporte quatre choix.
* Le header portant l'identifiant "header-reply-before" est une date, lorsque le champs est sélectionné, un calendrier apparaît pour permettre la sélection de la date et de l'heure voulue.
* Le header portant l'identifiant "header-originator-reference" est un simple champ texte qui devra être rempli manuellement.

<u>Note :</u> Il est possible de spécifier des headers qui ne seront pas affichés dans le formulaire XIMF (e.g. OID Amoco).

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="ximftoxul.xsl"?>
<ximf:instance
name="Amoco"
version="1.0"
ximfVersion="2.0"
xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://eads.org/ximf/ ximf.xsd">


<ximf:header id="header-policy-identifier" headerName="X-XIMF-Security-Policy-Identifier" >
<ximf:string content="1.2.840.113549.1.9.16.7.1"/>
</ximf:header>
<ximf:header id="header-classification"
headerName="X-XIMF-Security-Classification"
technicalHeaderName="X-XIMF-Security-Classification-Identifier"
type="string"
technicalType="oid"
ilk="ilk-classification"
isMandatory="true">
<ximf:set id="value-amoco-classification" separator=";" technicalSeparator=".">
<ximf:string
ilk="ilk-general"
content="amoco-general"
technicalContent="6" />
<ximf:string
ilk="ilk-confidential"
content="amoco-confidential"
technicalContent="7" />
<ximf:string
ilk="ilk-highly-confidential"
content="amoco-highly-confidential"
technicalContent="8" />
</ximf:set>
</ximf:header>
<ximf:header
id="header-privacy-mark"
headerName="X-XIMF-Privacy-Mark"
ilk="ilk-privacy-mark"
isMandatory="true">
<ximf:set id="value-privacy-mark">
<ximf:string ilk="ilk-minimum" content="amoco-minimum" />
<ximf:string ilk="ilk-medium" content="amoco-medium" />
<ximf:string ilk="ilk-maximum" content="amoco-maximum" />
<ximf:string ilk="ilk-critical" content="amoco-critical" />
</ximf:set>
</ximf:header>
<ximf:header
id="header-reply-before"
headerName="X-XIMF-Reply-Before"
ilk="ilk-reply-before"
isMandatory="false"
type="date">
<ximf:string id="value-reply-before" editable="true" />
</ximf:header>
<ximf:header
id="header-originator-reference"
headerName="X-XIMF-Originator-Reference"
ilk="ilk-originator-reference"
isMandatory="false"
type="string">
<ximf:string id="value-originator-reference" maxItem="5" editable="true" separator=";"/>
</ximf:header>
</ximf:instance>

=== Fichier rules-amoco ===
Le fichier rules-amoco.xml contient une règle d'association entre les deux listes déroulantes.
* Lorsque la valeur "amoco-general" est sélectionnée dans la première liste, les valeurs possibles pour la deuxième liste sont : "amoco-minimum" et "amoco-medium".
* Lorsque la valeur "amoco-confidential" est sélectionnée dans la première liste, les valeurs possibles pour la deuxième liste sont : "amoco-minimum", "amoco-medium" et "amoco-maximum".
* Lorsque la valeur "amoco-highly-confidential" est sélectionnée dans la première liste, les valeurs possibles pour la deuxième liste sont : "amoco-minimum", "amoco-medium", "amoco-maximum" et "amoco-critical".

<?xml version="1.0" encoding="UTF-8"?>
<ximf:instance
name="Amoco"
version="1.0"
ximfVersion="2.0"
xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://eads.org/ximf/ ximf.xsd">
<ximf:rule id="association-rule" description="Règle d'associations de valeurs" >
<ximf:association>
<ximf:aliasHeader
headerName="X-XIMF-Privacy-Mark"
headerRef="X-XIMF-Security-Classification">
<ximf:aliasValue
valueName="amoco-minimum,amoco-medium"
valueRef="amoco-general" />
<ximf:aliasValue
valueName="amoco-minimum,amoco-medium,amoco-maximum"
valueRef="amoco-confidential" />
<ximf:aliasValue
valueName="amoco-minimum,amoco-medium,amoco-maximum,amoco-critical"
valueRef="amoco-highly-confidential" />
</ximf:aliasHeader>
</ximf:association>
</ximf:rule>
</ximf:instance>

XIMF XML tags/fr

2011-04-06T13:42:54Z

Anthonyjuge : /* Element linkedValue */

== Introduction ==
Ce document propose un modèle de description, via eXtensible Markup Language (XML), d’entêtes de messages électroniques respectant la norme XIMF. Ce document a deux objectifs :
# Décrire les éléments et attributs de représentation XML pour construire des entêtes de messages électroniques de format XIMF.
# Fournir un modèle de représentation XIMF/XML.

<u>Rappel :</u>
* Un "élément" fait référence à tous les caractères situés entre une balise de départ et un balise de fin, e.g.,
<exemple> texte et/ou éléments fils </exemple>
* Un "attribut" est une composante d’un élément. Il est positionné dans la balise de départ, e.g.,
<exemple nom='value'>

Tous les éléments décrits dans cette documentation paragraphe sont validés dans l’espace de nom "ximf".

<pre>
xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://eads.org/ximf/ximf.xsd"
</pre>

== Description détaillée des balises XML ==

Voici, par ordre d'apparition et en fonction des fichiers, les balises génériques associées aux différents fichiers XML.

=== Fichier ximfmail-profile ===

<div style="color:red;">'''TODO''' :
* Combien d'éléments ihm sont autorisés dans un élément instance ?
* La documentation des fichiers ximfmail-profile.xml n'est pas disponible.
* Quel est le rôle de l'élément "acces" ?
* Quelle est l'utilité des identifiants associés aux éléments instance, shema, ihm, etc.
* Quelle est l'utilité de l'attribut name associé aux éléments instance. Y a-t-il une vérification s'assurant que les fichiers utilisés par une instance correspondent bien à l'instance à laquelle ils sont associés ?
</div>

Un fichier xpi peut contenir plusieurs instances XIMF, celles-ci sont alors regroupées dans une même catégorie. Le fichier ximfmail-profile contient des informations sur toutes les instances contenues dans le xpi, notamment leur nom, leur chemin d'accès, ainsi que les noms des fichiers associés à chaque instance.

==== Element instance ====
L’élément "instance" identifie l’ensemble des entêtes à décrire selon la norme XIMF. C’est le conteneur principal d’une instance XIMF/XML. Cinq attributs précisent la balise "instance" : "ximfVersion", "version", "author", "creation", "name", e.g.,
<ximf:instance name="myInstance" version="1.0" ximfVersion="2.0" >

* Détails sur les attributs de l'élément "instance" :
** L’attribut "name" définit le nom de l’instance décrite. Cet attribut est obligatoire.
** L’attribut "ximfVersion" définit le numéro de version des entêtes XIMF utilisés pour cette représentation. Cet attribut est obligatoire.
** L’attribut "version" définit le numéro de version de l’instance décrite. Cet attribut est obligatoire.
** L’attribut "author" renseigne sur le nom de l’auteur de cette instance.
** L’attribut "creationDate" précise la date de création de cette instance.

L’élément "instance" peut contenir un ou plusieurs éléments "schema", un ou plusieurs éléments "rule", un élément "ihm" et un élément "dictionary".

==== Element dictionary ====
L'élément dictionary contient le chemin vers le fichier spécifiant les données d'internationalisation (Cf. [[#Fichier_dictionary|Fichier dictionary]]).

==== Element schema ====
L'élément shema contient le chemin vers le fichier spécifiant les entêtes XIMF (Cf. [[#Fichier_headers|Fichier headers]]).

==== Element ihm ====
L'élément ihm contient le chemin vers le fichier spécifiant la disposition de l'interface des formulaires XIMF (Cf. [[#Fichier_ihm|Fichier ihm]]).

==== Element rule ====
L'élément rule contient le chemin vers le fichier spécifiant les règles associées aux valeurs des champs XIMF (Cf. [[#Fichier_rules|Fichier rules]]).

=== Fichier dictionary ===
Le fichier dictionnary permet de mettre en œuvre l’internationalisation d’une instance XIMF. Il défini des dictionnaires qui servent à traduire les éléments de l'instance XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient un élément "ximf:dictionnary".

==== Element dictionary ====
<div style="color:red;">'''TODO''' :
* Quel est l'intérêt de renseigner un attribut "id" à l'élément "dictionary" (étant donné qu'un seul élément "dictionary est autorisé dans l'élément "instance") ?</div>

L’élément "dictionary" contient toutes les informations devant être interprétées selon le pays d’utilisation.
L’élément "dictionary" contient un ou plusieurs mêmes éléments "locale", e.g.,

<ximf:dictionary>
<ximf:locale lang="fr-FR" />
<ximf:locale lang="en-US" />
</ximf:dictionary>

==== Element locale ====
L’élément "locale" contient toutes les informations pour un pays et/ou langue désignée.
L’élément "locale" contient un ou plusieurs mêmes éléments "ilk", e.g.,

<ximf:locale lang="fr-FR" >
<ximf:ilk entity="a"/>
<ximf:ilk entity="b"/>
</ximf:locale>

* Détails sur les attributs de la balise "locale" :
** L’attribut "lang" définit le code pays de ce conteneur. Il devrai être construit selon le format défini par la RFC1766 (fr, en, ja, es, …).

==== Element ilk ====
L’élément "ilk" contient une unique information correspondant à une donnée traduite selon le code pays de l’élément père. Cette information est au format chaîne de caractère. Un attribut obligatoire précise la balise "ilk".

<ximf:ilk entity="ilk-lang-ihm">langue</ximf:ilk>

* Détails sur les attributs de la balise "ilk" :
** L’attribut "entity" définit la référence d’entrée pour récupérer le contenu de l’élément selon le code pays souhaité.

Finalement, le fichier "dictionary" pourra contenir :
<ximf:instance name="Whirlpool">
<ximf:dictionary>
<ximf:locale lang="fr-FR" >
<ximf:ilk entity="ilk-lang-ihm">Français</ximf:ilk>
<ximf:ilk entity="ilk-exemple-general">Général</ximf:ilk>
</ximf:locale>
<ximf:locale lang="en-US" >
<ximf:ilk entity="ilk-lang-ihm">English (US)</ximf:ilk>
<ximf:ilk entity="ilk-exemple-general">General</ximf:ilk>
</ximf:locale>
</ximf:dictionary>
</ximf:instance>

=== Fichier ihm ===
<span style="color:red;">'''TODO''' : La documentation originale ne décrit pas le fichier ihm, les informations ci-dessous ont seulement été présumées. Merci de les vérifier/compléter.
</span>

Le fichier ihm spécifie l'agencement de l'interface des formulaires XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient un élément "ximf:ihm".

==== Element ihm ====
L'élément "ihm" contient un ou plusieurs éléments "panel" et un élément "treeRcv".

==== Element panel ====
Un élément ximf:panel correspond à un onglet du formulaire XIMF construit.
Deux attributs précisent la balise "panel" : "id" et "ilk", eg.
<ximf:panel id="pane_security" ilk="ilk-priority-panel" />

* Détails sur les attributs de l'élément "panel" :
** L’attribut "id" définit le nom de l'onglet, il doit être unique pour chaque élément "ximf:panel" et est formaté selon la syntaxe "pane-xxx". Cet attribut est obligatoire.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.

L'élément "ximf:panel" contient au moins un éléments "ximf:groupbox".

==== Element groupbox ====
Un élément groupbox correspond à une sous catégorie d'un onglet du formulaire XIMF.
La structure "groupbox" détaille l’ordre d’affichage des entêtes dans un message.
Deux attributs précisent la balise "ximf:groupbox" : "id" et "ilk", eg.
<ximf:groupbox id="group-classification" ilk="ilk-secu-box" />

* Détails sur les attributs de l'élément "groupbox" :
** L’attribut "id" définit le nom de l'onglet, il doit être unique pour chaque élément "ximf:panel" et est formaté selon la syntaxe "pane-xxx". Cet attribut est obligatoire.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.

L'élément "groupbox" contient au moins un éléments "headerRef".

==== Element treeRcv ====
L'élément "treeRcv" permet de spécifier quelles sont les colonnes susceptibles d'être ajoutées dans le panneau principal du client de messagerie qui contient la liste des messages d’un dossier.

L'élément "treeRcv" peut contenir des éléments "headerRef".

==== Element headerRef ====
L'élément headerRef spécifie les champs associés à chaque sous-groupe d'onglet de formulaire ou les champs qu'il est possible d'afficher dans la liste des messages.
Aucun attribut ne vient compléter la balise "headerRef", eg.
<ximf:headerRef>header-classification</ximf:headerRef>

Finalement, le fichier "ihm" pourra contenir :
<pre>
<ximf:instance name="Amoco">
<ximf:ihm>
<ximf:panel id="pane_security" ilk="ilk-priority-panel">
<ximf:groupbox id="group-classification" ilk="ilk-secu-box">
<ximf:headerRef>header-correspondance-type</ximf:headerRef>
<ximf:headerRef>header-classification</ximf:headerRef>
</ximf:groupbox>
</ximf:panel>
<ximf:treeRcv>
<ximf:headerRef>header-classification</ximf:headerRef>
</ximf:treeRcv>
</ximf:ihm>
</ximf:instance>
</pre>

=== Fichier headers ===
Le fichier headers spécifie les types des champs de l'interface des formulaires XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient des éléments "header".

<div style="color:red">'''TODO :'''
Il semble que les fichiers headers définissent des champs d'entête devant être envoyés alors que ces mêmes entêtes ne sont pas spécifiés dans le fichier ihm. Ce comportement est logique, en effet, l'utilisateur n'a pas forcément besoin de savoir tout ce qui est envoyé via le formulaire.

Comment intégrer un header (nommé aussi header technique) dans le message sans qu'il soit affiché dans le formulaire XIMF de l'IHM ?

Par exemple, dans l'instance Amoco, le champ d'entête X-XIMF-Security-Policy-Identifier est automatiquement envoyé alors que les champs d'entête X-XIMF-Primary-Precedence et X-XIMF-Copy-Precedence ne le sont pas. Comment est faite la différence ?
</div>

==== Element header ====
Chaque élément "header" décrit un entête de message de format XIMF.
Huit attributs précisent la balise "header" : "headerName", "id", "technicalHeaderName", "type", "technicalType", "isMandatory", "ilk", "description", e.g.,

<div style="color:red;">'''TODO :'''
Comment est effectuée la vérification de l'attribut isMandatory et quelles sont les conditions de fonctionnement de celui-ci ? Est-il possible, par exemple, de spécifier l'attribut isMandatory=true d'un élément header si le contenu de celui-ci est un élément « set » qui dispose des attributs minItem et maxItem ? Actuellement, lorsque l'on crée un élément set avec les attributs minItem et maxItem, le champ du formulaire associé ne peux pas être validé : e.g.,
<ximf:set id="value-amoco-classification" minItem="1" maxItem="64" separator=";" technicalSeparator=".">
</div>

<ximf:header id="header-primary-precedence"
headerName="X-XIMF-Primary-Precedence"
ilk="ilk-primary-precedence"
isMandatory="true"
description="entête d’urgence"
type="string" />

* Détails sur les attributs de l'élément "header" :
** L’attribut "headerName" définit le nom du champ XIMF. Cet attribut est obligatoire.
** L’attribut "id" définit un identifiant de champ, il doit être unique pour chaque élément "header" et est formaté selon la syntaxe "header-xxx". Cet attribut est obligatoire.
** L’attribut "isMandatory" précise si ce champ doit être obligatoirement présent dans le message intégrant les entêtes selon cette description.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.
** L’attribut "type" précise le format des données associées à cet élément. Ce format peut être une date, une chaîne, une adresse mail, un O.I.D.
** L’attribut "technicalHeaderName" permet de compléter l’entête décrit par un autre entête.
** L’attribut "technicalType" précise le format des données associées à l’élément technicalHeaderName.
** L’attribut "description" permet d’ajouter une information sur cet élément.

L’élément "header" contient obligatoirement un élément "set", "multiset", "string", ou "compstring", e.g.,

<ximf:header id="header-reply-by"
headerName="X-XIMF-Reply-By"
ilk="ilk-reply-by"
isMandatory="false" >
<ximf:string id="value-reply-by" editable="true" />
</ximf:header>

<div style="color:red;">
'''TODO :''' Quelles sont les contraintes associées à l'attribut type d'un élément header ?
</div>

==== Element string ====
L’élément "string" précise le contenu d’une ressource de type chaîne de caractères imprimables (a-z, A-Z, 1-9,…)
Quinze attributs complètent l’élément "string" : "id", "ref", "ilk", "aclLevel", "index", "description", "editable", "content", "technicalContent","maxItem", "minItem", "maxLength", "minLength", "separator", "technicalSeparator", e.g.,

<ximf:string ilk="ilk-france" content="FRA" />

* Détails sur les attributs de l'élément "string" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "string".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role| élément role]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut " description " permet d’associer un commentaire sur cette donnée.
** L’attribut "editable" définit une valeur de saisie (champ libre). Cet attribut est de type booléen.
** L’attribut "content" représente la valeur effective de la donnée. C’est cette donnée qui sera associée au champ XIMF créé.
** L’attribut "technicalContent" représente la valeur effective de la donnée technique. C’est cette donnée qui sera associée au champ technique XIMF créé (cf. attribut technicalHeaderName de l’élément "header".
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.

L’élément "string" peut contenir plusieurs éléments "linkedValue".

<ximf:string ilk="ilk-non-protege" content="NON PROTEGE" technicalContent="1" >
<ximf:linkedValue ref="value-non-protege-france " />
</ximf:string>

==== Element compstring ====
<div style="color:red;">
'''TODO :''' L'attribut de l'élément « compstring » nommé « contentFactorise » devrait s'appeler « contentFactorize ».
</div>
L’élément "compstring" décrit un conteneur de concaténation des éléments fils. Il permet notamment de créer des valeurs d’entêtes composées.
Dix-sept attributs complètent l’élément "compstring" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", "content", "technicalContent", "contentPositionEnd", "contentFactorise", "technicalPositionEnd", e.g.,

<ximf:compstring
ilk="ilk-special"
content="SPECIAL"
technicalContent="1.3.4"
separator=" "
technicalSeparator=".">

* Détails sur les attributs de l'élément "compstring" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "compstring".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (cf. [[#Element_role| élément "role"]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut " description " permet d’associer un commentaire sur cette donnée.
** L’attribut "content" représente la valeur effective de la donnée. C’est cette donnée qui sera associée au champ XIMF créé.
** L’attribut "technicalContent" représente la valeur effective de la donnée technique. C’est cette donnée qui sera associée au champ technique XIMF créé (cf. attribut technicalHeaderName de l’élément "header".
** L’attribut "separator" définit le caractère de séparation entre deux valeurs.
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "contentPositionEnd" impose de positionner le contenu de l’élément "compstring" après les valeurs des éléments fils : valuefils1,valuefils2 : valuecompstring.
** L’attribut "technicalPositionEnd" impose de positionner le contenu de l’élément "compstring" après les valeurs des éléments fils.
** L’attribut "contentFactorise" impose d’utiliser le contenu de l’élément "compstring" comme facteur des éléments fils : valuecompstring(valuefils1,valuefils2).

L’élément "compstring" peut contenir un élément "string" ou "set" ou "multiset" ou plusieurs éléments "compstring".

<ximf:compstring
ilk="ilk-special"
content="SPECIAL"
technicalContent="1.3.4"
separator=" "
technicalSeparator=".">
<ximf:set id="ilk-special-op " maxItem="64">
<ximf:string ilk="ilk-special-op1" content="OP1" technicalContent="1" />
<ximf:string ilk="ilk-special-op2" content="OP2" technicalContent="2" />
<ximf:string ilk="ilk-special-op3" content="OP3" technicalContent="3" />
</ximf:set>
</ximf:compstring>

==== Element set ====
L’élément "set" décrit un conteneur de ressources de même type. Cet élément autorise la sélection de plusieurs ressources mais chaque ressource est sélectionnée une seule fois.
Douze attributs précisent la description de la balise "set" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", e.g.,

<ximf:set id="value-categories" ref="value-mentions" maxItem="64" separator=";" />

* Détails sur les attributs de l'élément "set" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "ximf:set".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role|élément rôle]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut "description" permet d’associer un commentaire sur cette donnée.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs

L’élément "set" peut contenir un ou plusieurs éléments "string" ou un ou plusieurs éléments "compstring".

<ximf:set id="value-categories" minItem="1" maxItem="64" separator=";">
<ximf:string ilk="ilk-releasable-to" content="RELEASABLE TO " />
<ximf:string ilk="ilk-eyes-only" content=" EYES ONLY"/>
<ximf:string ilk="ilk-use-only" content=" USE ONLY"/>
</ximf:set>

<div style="color:red;">'''TODO :'''
* Y a-t-il une définition des fichiers associés aux instances XIMF (e.g, le fichier attribution-list.xml utilisé dans l'instance Caterpillar) ?
* Comment le moteur XIMF sait qu'un élément est une "attribution-list" ?
</div>

==== Element multiset ====
L’élément "multiset" décrit un conteneur de ressources de même type. Cet élément autorise la sélection de plusieurs ressources et chaque ressource peut être sélectionnée plusieurs fois.
Douze attributs précisent la description de la balise "multiset" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", e.g.,

<ximf:multiset
id="value-restricted"
ilk=" ilk-value-restricted"
maxItem="64"
separator=";" />

* Détails sur les attributs de l'élément "multiset" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "multiset".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role|élément rôle]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut "description" permet d’associer un commentaire sur cette donnée.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs

L’élément "multiset" peut contenir un ou plusieurs éléments "string" ou un ou plusieurs éléments "compstring".

<ximf:multiset id="value-restricted-example-categories" minItem="1" maxItem="64" separator=";" >
<ximf:string ilk="ilk-releasable-to" content="RELEASABLE TO "/>
<ximf:string ilk="ilk-eyes-only" content=" EYES ONLY"/>
<ximf:string ilk="ilk-use-only" content=" USE ONLY"/>
</ximf:multiset>

<span style="color:red;">'''TODO ''': Comment sont gérées les règles associées aux champs multivaleurs (disposant par exemple des attributs minItem/maxItem ou les champs multiset) ?</span>

==== Element linkedValue ====
L’élément "linkedValue" définit une référence sur une ressource de type conteneur ("set", "multiset") ou "string". Cette ressource devrait être utilisée si la ressource contenant "linkedValue" (noeud parent) est sélectionnée.
Un attribut précise la balise "linkvalue" : "ref", e.g.,

<ximf:linkedValue ref="value-restricted-example-classification-id" />

* Détails sur les attributs de l'élément "linkedValue" :
** L’attribut "ref" précise la valeur de l’attribut "id" de la ressource cible. Cet attribut est obligatoire.

=== Fichier rules ===
Le fichier rules définit les règles de contrôles d’entêtes XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui peut contenir des éléments "ximf:rule".

==== Element rule ====
<div style="color:red">
'''TODO :''' Mettre à jour la documentation :
* Les éléments autorisés dans un élément « rule » ne sont plus à jour. La présente documentation spécifie 12 éléments : AliasHeader, AliasValue, Compatibility, Association, SecureHeaders, SecurityLabel, Constraint, Assignment, Processing, Accessibility, Role et Custom. Le schéma XML fourni avec le mail en spécifie 5 : Constraint, Processing, Compatibility, Policy et Custom et place les autres en tant qu'extentions des 5 éléments cités précédemment.
* Les éléments SecureHeaders et SecurityLabel associés à l'élément « rule » ne figurent pas dans la nouvelle version du shéma xml. On les retrouve dans les fichiers rules-*.xml mais les éléments sont commentés, ils sont, de plus, présents dans une autre instance : comment ces éléments sont utilisés dans Trustedbird ?
* L'élément ximf:classificationPictures n'est pas documenté. De plus, il serait bon d'avoir des précisions sur la raison qui a motivé l'ajout de cet élément dans les fichiers de règles (alors qu'il semblerait être plus adapté au fichier headers-*.xml).
</div>
L’élément "rule" est le conteneur principal de description d’un comportement particulier à appliquer sur un ensemble d’entêtes XIMF.
Trois attributs précisent la balise "rule" : "id", "agent", "description", e.g.,
<ximf:rule id="compatibility-rule" description="Règle sur la compatibilité X-SMTP / XIMF" >

* Détails sur les attributs de l'élément "rule" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "rule". Cet attribut est obligatoire.
** L’attribut "agent" indique l’équipement cible devant analyser et appliquer le contenu de cet élément.
** L’attribut "description" autorise l’auteur d’ajouter un commentaire sur cet élément.

L’élément "rule" contient un ou plusieurs mêmes éléments de spécialisation de la règle "contraint", "assignement", "processing", "compatibility", "accessibility", "custom",…, e.g.,

<ximf:rule id="precedence-rule" agent="mua" description="Règle sur les priorités">
<ximf:constraint
left="header-primary-precedence"
operator="equalOrGreaterThan"
right="header-copy-precedence" />
</ximf:rule>

==== Element aliasHeader ====
L’élément "aliasHeader" permet de définir le nom de l’entête sur lequel la règle précisée est appliquée
Deux attributs précisent la balise "aliasHeader" : "headerName" et "headerRef", e.g.,

<ximf:aliasHeader headerName ="X-P772-Version" headerRef="X-XIMF-VERSION" />

* Détails sur les attributs de l'élément "aliasHeader" :
* L’attribut "headerName" définit le nom XIMF de l’entête modifié par la règle. Cet attribut est obligatoire.
* L’attribut "headerRef" définit le nom d’un entête XIMF de référence qui est le point d’entrée de l’application de la règle sur l’entête définit par "headerName". Cela permet de lier deux entêtes de messages où l’utilisation de l’un des entêtes influe sur le comportement de l’autre.

L’élément "aliasHeader" peut contenir des éléments "aliasValue",e.g ,

<ximf:aliasHeader headerName="X-P772-Version" />
<ximf:aliasValue vame="1.0"/>
<ximf:aliasHeader>

==== Element aliasValue ====
L’élément "aliasValue" contient une valeur à associer à l’entête XIMF contrôlé par la règle. Il est utile lorsque deux entêtes sont liées (utilisation de l’attribut headerRef dans l’élément aliasHeader) et que les valeurs de l’entêtes de référence permettent de préciser celles de l’entête contrôlé.
Deux attributs précisent la balise "aliasValue" : "valueName", "valueRef", e.g.,

<ximf:aliasValue valueName="2" valueRef="flash" />

* Détails sur les attributs de l'élément "aliasValue" :
** L’attribut "valueName" définit la valeur de l’entête à créer. Cet attribut est obligatoire.
** L’attribut "valueRef" définit la valeur de l’entête XIMF de référence pour utiliser valueName.
<span style="color:red;">'''TODO :''' L'attribut valueRef est-il obligatoire ?</span>

==== Element compatibility ====
L’élément "compatibility" est utilisé pour associer à un entête respectant la norme XIMF un entête respectant une autre norme que XIMF (XSMTP par exemple).
Deux attributs précisent la balise "compatibility" : "targetName", "targetVersion", e.g.,

<ximf:compatibility targetName="X-SMTP" targetVersion="1.1">
<ximf:aliasValue headerName="X-P772-Version" content="1.1" />
<ximf:aliasValue
headerName="X-P772-Primary-Precedence"
headerRef="header-primary-precedence"
dataRef="data-priority-xsmtp"/>
</ximf:compatibility>

* Détails sur les attributs de l'élément "compatibility" :
** L’attribut "targetName" définit la norme de l’entête à associer à l’entête XIMF. Cet attribut est obligatoire.
** L’attribut "targetVersion" définit le numéro de version de la norme de l’entête à associer à l’entête XIMF. Cet attribut est obligatoire.

L’élément "compatibility" contient au moins un élément "aliasHeader".

<u>Pour illustrer cette règle :</u>
Le format XSMTP est déjà supporté par certains équipements. Afin de rendre ceux-ci inter opérables avec le nouveau format XIMF, cette règle permet d’associer un entête XSMTP contenant les mêmes informations qu’un entête XIMF.

L’élément Association : dépendance entre entêtes
L’élément "association" définie les valeurs autorisées pour un entête XIMF en fonction d’une valeur définie pour un autre entête XIMF.

<ximf:association>
<ximf:aliasHeader
headerName="X-XIMF-Primary-Precedence"
headerRef="X-XIMF-Correspondence-Type">
<ximf:aliasValue valueName="routine" valueRef="private" />
<ximf:aliasValue valueName="routine,priority" valueRef="professional" />
<ximf:aliasValue valueName="routine,priority,immediate,flash" valueRef="operational" />
<ximf:aliasValue valueName="routine,priority,immediate" valueRef="official" />
</ximf:aliasHeader>
</ximf:association>

==== Element secureHeaders ====
L’élément "secureHeaders" définie la liste des entêtes à intégrer dans la signature d’un message. Cette règle s’applique sur les équipements proposant un algorithme de signature des messages.

Un élément "secureHeaders" contient un ou plusieurs éléments "aliasHeaders" où chaque élément décrit un entête à intégrer dans la signature et complété d’un attribut "status".

<ximf:secureHeaders targetName="SecureHeaders">
<ximf:aliasHeader headerName="X-XIMF-Primary-Precedence" status="0" />
<ximf:aliasHeader headerName="X-XIMF-Copy-Precedence" status="0" />
</ximf:secureHeaders>

==== Element securityLabel ====
L’élément "securityLabel" définie la liste des entêtes à intégrer dans la signature d’un message. Cette règle s’applique sur les équipements proposant un algorithme de signature des messages selon la norme RFC.

Un élément "securityLabel" contient un ou plusieurs éléments "aliasHeaders" où chaque élément décrit un entête à intégrer dans la signature et complété d’un attribut "status".

<ximf:securityLabel targetName="SecurityLabel" id="Amoco">
<ximf:aliasHeader
headerName="SecurityPolicyIdentifier"
headerRef="X-XIMF-Security-Policy-Identifier" />
<ximf:aliasHeader
headerName="SecurityClassification"
headerRef="X-XIMF-Security-Classification-Identifier" />
<ximf:aliasHeader
headerName="ESSPrivacyMark"
headerRef="X-XIMF-Privacy-Mark" />
<ximf:aliasHeader
headerName="SecurityCategory"
headerRef="X-XIMF-Security-Categories-Identifier"
type="2" />
</ximf:securityLabel>

==== Element constraint ====
L’élément "constraint" est utilisé pour définir une règle de construction de deux entêtes partageant des "datas" identiques.
Trois attributs précisent la balise "constraint" : "left", "right", "operator", e.g.,

<ximf:constraint
left="header-primary-precedence"
operator="equalOrGreaterThan"
right="header-copy-precedence" />

* Détails sur les attributs de l'élément "constraint" :
** L’attribut "left" désigne le premier élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "right" désigne le deuxième élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "operator" indique la règle de poids à appliquer sur la valeur des deux éléments "header", il peut être de type "greaterThan", "lowerThan", "equalOrGreaterThan", "equalOrLowerThan", "equal". Cet attribut est obligatoire.

* Détails sur les valeurs possibles de l'attribut "type" :
** Le type "greaterThan" signifie que la valeur de l’élément "left" doit être strictement supérieur à la valeur de l’élément "right".
** Le type "lowerThan" signifie que la valeur de l’élément "left" doit être strictement inférieur à la valeur de l’élément "right".
** Le type "equalOrGreaterThan" signifie que la valeur de l’élément "left" doit être supérieur ou égale à la valeur de l’élément "right".
** Le type "equalOrLowerThan" signifie que la valeur de l’élément "left" doit être inférieur ou égale à la valeur de l’élément "right".
** Le type "equal" signifie que la valeur de l’élément "left" et de l’élément "right" doivent être identiques.

==== Element assignment ====
<div style="color:red;">'''TODO :''' L'élément assignment n'apparaît pas dans le shéma xml qui avait été envoyé.</div>

L’élément "assignement" est utilisé pour affecter une valeur créée en fonction d’une règle de comparaison sur les valeurs de deux éléments "header".
Quatre attributs précisent la balise "assignement" : "left", "right", "operator", "result", e.g.,

<ximf:assignment
left="header-primary-precedence"
operator="equal"
right="data-routine-precedence"
result="86400" />

* Détails sur les attributs de l'élément "assignment" :
** L’attribut "left" désigne le premier élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "right" désigne le deuxième élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "operator" indique la règle de comparaison entre les valeurs des deux éléments "header", il peut être de type "greaterThan", "lowerThan", "equalOrGreaterThan", "equalOrLowerThan", "equal". Cet attribut est obligatoire.
** L’attribut "result" représente la valeur à utiliser si la règle de comparaison entre les deux éléments est satisfaite. Cet attribut est obligatoire.

==== Element processing ====
L’élément "processing" regroupe des règles de traitement à effectuer sur des entêtes formatés.
L’attribut "type" précise le type de traitement à effectuer sur ces valeurs. Cet attribut est obligatoire, il est de type : "sign-header-value", "encrypt-header-value", "capitalize-header-value", e.g.,

<ximf:processing type="sign-header-value">
<ximf:refHeader>header-primary-precedence</ximf:refheader>
<ximf:refHeader>header-copy-precedence</ximf:refheader>
<ximf:refHeader>header-echange-type</ximf:refheader>
</ximf:processing>

* Détails sur les valeurs possibles de l'attribut "type" :
** Le type "sign-header-value" définit un traitement de signature des entêtes définis dans la balise.
** Le type "encrypt-header-value" définit un traitement de chiffrement des entêtes définis dans la balise.
** Le type "capitalize-header-value" définit un traitement de capitalisation des entêtes définis dans la balise.

L’élément "processing" contient au moins un élément "refHeader".
<div style="color:red;">'''TODO :'''L'élément refHeader n'est pas documenté, s'agit-il en fait de l'élément headerRef ?</div>

==== Element accessibility ====
<div style="color:red;">'''TODO :''' L'élément accessibility n'apparaît pas dans le shéma xml qui avait été envoyé.</div>
L’élément "accessibility" définit un ensemble de règles de droit d’accès aux éléments d’une instance pour une cible déterminée (utilisateur, routeur…).
Cet élément contient un ou plusieurs éléments "role".

<ximf:accessibility>
<ximf:role id="role-flash-allowed" aclLevel="100" />
<ximf:role id="role-flash-prohibited" aclLevel="50" />
</ximf:accessibility>

==== Element role ====
L’élément "role" positionne une valeur d’accès à pour une entité définit.
Deux attributs complètent l’élément "role" : "id", "aclLevel", e.g.,

<ximf:role id="role-flash-allowed" aclLevel="100" />

* Détails sur les attributs de l'élément "role" :
** L’attribut "id" précise l’entité accessible en fonction d’une valeur déterminée.
** L’attribut "aclLevel" précise la valeur seuil d’accès à l’entité.

==== Element custom ====
L’élément "custom" permet à l’auteur de créer des nouvelles règles personnalisées.
Trois attributs précisent la balise "custom" : "id", "provider", "description", e.g.,

<ximf:custom
id="custom-display"
provider="EADS"
description="Affichage de la composition du message" >
<node1><node2><node3></node3></node2></node1>
</ximf:custom>

* Détails sur les attributs de l'élément "custom" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "custom" et formaté selon la syntaxe "custom-xxx". Cet attribut est obligatoire.
** L’attribut "provider" identifie l’auteur de la règle. Cet attribut est obligatoire.
** L’attribut "description" permet d’ajouter un commentaire sur cet élément.

L’élément "custom" peut contenir tous les éléments possibles en respectant les standards XML.

XIMF XML tags/fr

2011-04-06T13:42:28Z

Anthonyjuge : /* Element multiset */

== Introduction ==
Ce document propose un modèle de description, via eXtensible Markup Language (XML), d’entêtes de messages électroniques respectant la norme XIMF. Ce document a deux objectifs :
# Décrire les éléments et attributs de représentation XML pour construire des entêtes de messages électroniques de format XIMF.
# Fournir un modèle de représentation XIMF/XML.

<u>Rappel :</u>
* Un "élément" fait référence à tous les caractères situés entre une balise de départ et un balise de fin, e.g.,
<exemple> texte et/ou éléments fils </exemple>
* Un "attribut" est une composante d’un élément. Il est positionné dans la balise de départ, e.g.,
<exemple nom='value'>

Tous les éléments décrits dans cette documentation paragraphe sont validés dans l’espace de nom "ximf".

<pre>
xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://eads.org/ximf/ximf.xsd"
</pre>

== Description détaillée des balises XML ==

Voici, par ordre d'apparition et en fonction des fichiers, les balises génériques associées aux différents fichiers XML.

=== Fichier ximfmail-profile ===

<div style="color:red;">'''TODO''' :
* Combien d'éléments ihm sont autorisés dans un élément instance ?
* La documentation des fichiers ximfmail-profile.xml n'est pas disponible.
* Quel est le rôle de l'élément "acces" ?
* Quelle est l'utilité des identifiants associés aux éléments instance, shema, ihm, etc.
* Quelle est l'utilité de l'attribut name associé aux éléments instance. Y a-t-il une vérification s'assurant que les fichiers utilisés par une instance correspondent bien à l'instance à laquelle ils sont associés ?
</div>

Un fichier xpi peut contenir plusieurs instances XIMF, celles-ci sont alors regroupées dans une même catégorie. Le fichier ximfmail-profile contient des informations sur toutes les instances contenues dans le xpi, notamment leur nom, leur chemin d'accès, ainsi que les noms des fichiers associés à chaque instance.

==== Element instance ====
L’élément "instance" identifie l’ensemble des entêtes à décrire selon la norme XIMF. C’est le conteneur principal d’une instance XIMF/XML. Cinq attributs précisent la balise "instance" : "ximfVersion", "version", "author", "creation", "name", e.g.,
<ximf:instance name="myInstance" version="1.0" ximfVersion="2.0" >

* Détails sur les attributs de l'élément "instance" :
** L’attribut "name" définit le nom de l’instance décrite. Cet attribut est obligatoire.
** L’attribut "ximfVersion" définit le numéro de version des entêtes XIMF utilisés pour cette représentation. Cet attribut est obligatoire.
** L’attribut "version" définit le numéro de version de l’instance décrite. Cet attribut est obligatoire.
** L’attribut "author" renseigne sur le nom de l’auteur de cette instance.
** L’attribut "creationDate" précise la date de création de cette instance.

L’élément "instance" peut contenir un ou plusieurs éléments "schema", un ou plusieurs éléments "rule", un élément "ihm" et un élément "dictionary".

==== Element dictionary ====
L'élément dictionary contient le chemin vers le fichier spécifiant les données d'internationalisation (Cf. [[#Fichier_dictionary|Fichier dictionary]]).

==== Element schema ====
L'élément shema contient le chemin vers le fichier spécifiant les entêtes XIMF (Cf. [[#Fichier_headers|Fichier headers]]).

==== Element ihm ====
L'élément ihm contient le chemin vers le fichier spécifiant la disposition de l'interface des formulaires XIMF (Cf. [[#Fichier_ihm|Fichier ihm]]).

==== Element rule ====
L'élément rule contient le chemin vers le fichier spécifiant les règles associées aux valeurs des champs XIMF (Cf. [[#Fichier_rules|Fichier rules]]).

=== Fichier dictionary ===
Le fichier dictionnary permet de mettre en œuvre l’internationalisation d’une instance XIMF. Il défini des dictionnaires qui servent à traduire les éléments de l'instance XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient un élément "ximf:dictionnary".

==== Element dictionary ====
<div style="color:red;">'''TODO''' :
* Quel est l'intérêt de renseigner un attribut "id" à l'élément "dictionary" (étant donné qu'un seul élément "dictionary est autorisé dans l'élément "instance") ?</div>

L’élément "dictionary" contient toutes les informations devant être interprétées selon le pays d’utilisation.
L’élément "dictionary" contient un ou plusieurs mêmes éléments "locale", e.g.,

<ximf:dictionary>
<ximf:locale lang="fr-FR" />
<ximf:locale lang="en-US" />
</ximf:dictionary>

==== Element locale ====
L’élément "locale" contient toutes les informations pour un pays et/ou langue désignée.
L’élément "locale" contient un ou plusieurs mêmes éléments "ilk", e.g.,

<ximf:locale lang="fr-FR" >
<ximf:ilk entity="a"/>
<ximf:ilk entity="b"/>
</ximf:locale>

* Détails sur les attributs de la balise "locale" :
** L’attribut "lang" définit le code pays de ce conteneur. Il devrai être construit selon le format défini par la RFC1766 (fr, en, ja, es, …).

==== Element ilk ====
L’élément "ilk" contient une unique information correspondant à une donnée traduite selon le code pays de l’élément père. Cette information est au format chaîne de caractère. Un attribut obligatoire précise la balise "ilk".

<ximf:ilk entity="ilk-lang-ihm">langue</ximf:ilk>

* Détails sur les attributs de la balise "ilk" :
** L’attribut "entity" définit la référence d’entrée pour récupérer le contenu de l’élément selon le code pays souhaité.

Finalement, le fichier "dictionary" pourra contenir :
<ximf:instance name="Whirlpool">
<ximf:dictionary>
<ximf:locale lang="fr-FR" >
<ximf:ilk entity="ilk-lang-ihm">Français</ximf:ilk>
<ximf:ilk entity="ilk-exemple-general">Général</ximf:ilk>
</ximf:locale>
<ximf:locale lang="en-US" >
<ximf:ilk entity="ilk-lang-ihm">English (US)</ximf:ilk>
<ximf:ilk entity="ilk-exemple-general">General</ximf:ilk>
</ximf:locale>
</ximf:dictionary>
</ximf:instance>

=== Fichier ihm ===
<span style="color:red;">'''TODO''' : La documentation originale ne décrit pas le fichier ihm, les informations ci-dessous ont seulement été présumées. Merci de les vérifier/compléter.
</span>

Le fichier ihm spécifie l'agencement de l'interface des formulaires XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient un élément "ximf:ihm".

==== Element ihm ====
L'élément "ihm" contient un ou plusieurs éléments "panel" et un élément "treeRcv".

==== Element panel ====
Un élément ximf:panel correspond à un onglet du formulaire XIMF construit.
Deux attributs précisent la balise "panel" : "id" et "ilk", eg.
<ximf:panel id="pane_security" ilk="ilk-priority-panel" />

* Détails sur les attributs de l'élément "panel" :
** L’attribut "id" définit le nom de l'onglet, il doit être unique pour chaque élément "ximf:panel" et est formaté selon la syntaxe "pane-xxx". Cet attribut est obligatoire.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.

L'élément "ximf:panel" contient au moins un éléments "ximf:groupbox".

==== Element groupbox ====
Un élément groupbox correspond à une sous catégorie d'un onglet du formulaire XIMF.
La structure "groupbox" détaille l’ordre d’affichage des entêtes dans un message.
Deux attributs précisent la balise "ximf:groupbox" : "id" et "ilk", eg.
<ximf:groupbox id="group-classification" ilk="ilk-secu-box" />

* Détails sur les attributs de l'élément "groupbox" :
** L’attribut "id" définit le nom de l'onglet, il doit être unique pour chaque élément "ximf:panel" et est formaté selon la syntaxe "pane-xxx". Cet attribut est obligatoire.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.

L'élément "groupbox" contient au moins un éléments "headerRef".

==== Element treeRcv ====
L'élément "treeRcv" permet de spécifier quelles sont les colonnes susceptibles d'être ajoutées dans le panneau principal du client de messagerie qui contient la liste des messages d’un dossier.

L'élément "treeRcv" peut contenir des éléments "headerRef".

==== Element headerRef ====
L'élément headerRef spécifie les champs associés à chaque sous-groupe d'onglet de formulaire ou les champs qu'il est possible d'afficher dans la liste des messages.
Aucun attribut ne vient compléter la balise "headerRef", eg.
<ximf:headerRef>header-classification</ximf:headerRef>

Finalement, le fichier "ihm" pourra contenir :
<pre>
<ximf:instance name="Amoco">
<ximf:ihm>
<ximf:panel id="pane_security" ilk="ilk-priority-panel">
<ximf:groupbox id="group-classification" ilk="ilk-secu-box">
<ximf:headerRef>header-correspondance-type</ximf:headerRef>
<ximf:headerRef>header-classification</ximf:headerRef>
</ximf:groupbox>
</ximf:panel>
<ximf:treeRcv>
<ximf:headerRef>header-classification</ximf:headerRef>
</ximf:treeRcv>
</ximf:ihm>
</ximf:instance>
</pre>

=== Fichier headers ===
Le fichier headers spécifie les types des champs de l'interface des formulaires XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient des éléments "header".

<div style="color:red">'''TODO :'''
Il semble que les fichiers headers définissent des champs d'entête devant être envoyés alors que ces mêmes entêtes ne sont pas spécifiés dans le fichier ihm. Ce comportement est logique, en effet, l'utilisateur n'a pas forcément besoin de savoir tout ce qui est envoyé via le formulaire.

Comment intégrer un header (nommé aussi header technique) dans le message sans qu'il soit affiché dans le formulaire XIMF de l'IHM ?

Par exemple, dans l'instance Amoco, le champ d'entête X-XIMF-Security-Policy-Identifier est automatiquement envoyé alors que les champs d'entête X-XIMF-Primary-Precedence et X-XIMF-Copy-Precedence ne le sont pas. Comment est faite la différence ?
</div>

==== Element header ====
Chaque élément "header" décrit un entête de message de format XIMF.
Huit attributs précisent la balise "header" : "headerName", "id", "technicalHeaderName", "type", "technicalType", "isMandatory", "ilk", "description", e.g.,

<div style="color:red;">'''TODO :'''
Comment est effectuée la vérification de l'attribut isMandatory et quelles sont les conditions de fonctionnement de celui-ci ? Est-il possible, par exemple, de spécifier l'attribut isMandatory=true d'un élément header si le contenu de celui-ci est un élément « set » qui dispose des attributs minItem et maxItem ? Actuellement, lorsque l'on crée un élément set avec les attributs minItem et maxItem, le champ du formulaire associé ne peux pas être validé : e.g.,
<ximf:set id="value-amoco-classification" minItem="1" maxItem="64" separator=";" technicalSeparator=".">
</div>

<ximf:header id="header-primary-precedence"
headerName="X-XIMF-Primary-Precedence"
ilk="ilk-primary-precedence"
isMandatory="true"
description="entête d’urgence"
type="string" />

* Détails sur les attributs de l'élément "header" :
** L’attribut "headerName" définit le nom du champ XIMF. Cet attribut est obligatoire.
** L’attribut "id" définit un identifiant de champ, il doit être unique pour chaque élément "header" et est formaté selon la syntaxe "header-xxx". Cet attribut est obligatoire.
** L’attribut "isMandatory" précise si ce champ doit être obligatoirement présent dans le message intégrant les entêtes selon cette description.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.
** L’attribut "type" précise le format des données associées à cet élément. Ce format peut être une date, une chaîne, une adresse mail, un O.I.D.
** L’attribut "technicalHeaderName" permet de compléter l’entête décrit par un autre entête.
** L’attribut "technicalType" précise le format des données associées à l’élément technicalHeaderName.
** L’attribut "description" permet d’ajouter une information sur cet élément.

L’élément "header" contient obligatoirement un élément "set", "multiset", "string", ou "compstring", e.g.,

<ximf:header id="header-reply-by"
headerName="X-XIMF-Reply-By"
ilk="ilk-reply-by"
isMandatory="false" >
<ximf:string id="value-reply-by" editable="true" />
</ximf:header>

<div style="color:red;">
'''TODO :''' Quelles sont les contraintes associées à l'attribut type d'un élément header ?
</div>

==== Element string ====
L’élément "string" précise le contenu d’une ressource de type chaîne de caractères imprimables (a-z, A-Z, 1-9,…)
Quinze attributs complètent l’élément "string" : "id", "ref", "ilk", "aclLevel", "index", "description", "editable", "content", "technicalContent","maxItem", "minItem", "maxLength", "minLength", "separator", "technicalSeparator", e.g.,

<ximf:string ilk="ilk-france" content="FRA" />

* Détails sur les attributs de l'élément "string" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "string".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role| élément role]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut " description " permet d’associer un commentaire sur cette donnée.
** L’attribut "editable" définit une valeur de saisie (champ libre). Cet attribut est de type booléen.
** L’attribut "content" représente la valeur effective de la donnée. C’est cette donnée qui sera associée au champ XIMF créé.
** L’attribut "technicalContent" représente la valeur effective de la donnée technique. C’est cette donnée qui sera associée au champ technique XIMF créé (cf. attribut technicalHeaderName de l’élément "header".
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.

L’élément "string" peut contenir plusieurs éléments "linkedValue".

<ximf:string ilk="ilk-non-protege" content="NON PROTEGE" technicalContent="1" >
<ximf:linkedValue ref="value-non-protege-france " />
</ximf:string>

==== Element compstring ====
<div style="color:red;">
'''TODO :''' L'attribut de l'élément « compstring » nommé « contentFactorise » devrait s'appeler « contentFactorize ».
</div>
L’élément "compstring" décrit un conteneur de concaténation des éléments fils. Il permet notamment de créer des valeurs d’entêtes composées.
Dix-sept attributs complètent l’élément "compstring" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", "content", "technicalContent", "contentPositionEnd", "contentFactorise", "technicalPositionEnd", e.g.,

<ximf:compstring
ilk="ilk-special"
content="SPECIAL"
technicalContent="1.3.4"
separator=" "
technicalSeparator=".">

* Détails sur les attributs de l'élément "compstring" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "compstring".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (cf. [[#Element_role| élément "role"]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut " description " permet d’associer un commentaire sur cette donnée.
** L’attribut "content" représente la valeur effective de la donnée. C’est cette donnée qui sera associée au champ XIMF créé.
** L’attribut "technicalContent" représente la valeur effective de la donnée technique. C’est cette donnée qui sera associée au champ technique XIMF créé (cf. attribut technicalHeaderName de l’élément "header".
** L’attribut "separator" définit le caractère de séparation entre deux valeurs.
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "contentPositionEnd" impose de positionner le contenu de l’élément "compstring" après les valeurs des éléments fils : valuefils1,valuefils2 : valuecompstring.
** L’attribut "technicalPositionEnd" impose de positionner le contenu de l’élément "compstring" après les valeurs des éléments fils.
** L’attribut "contentFactorise" impose d’utiliser le contenu de l’élément "compstring" comme facteur des éléments fils : valuecompstring(valuefils1,valuefils2).

L’élément "compstring" peut contenir un élément "string" ou "set" ou "multiset" ou plusieurs éléments "compstring".

<ximf:compstring
ilk="ilk-special"
content="SPECIAL"
technicalContent="1.3.4"
separator=" "
technicalSeparator=".">
<ximf:set id="ilk-special-op " maxItem="64">
<ximf:string ilk="ilk-special-op1" content="OP1" technicalContent="1" />
<ximf:string ilk="ilk-special-op2" content="OP2" technicalContent="2" />
<ximf:string ilk="ilk-special-op3" content="OP3" technicalContent="3" />
</ximf:set>
</ximf:compstring>

==== Element set ====
L’élément "set" décrit un conteneur de ressources de même type. Cet élément autorise la sélection de plusieurs ressources mais chaque ressource est sélectionnée une seule fois.
Douze attributs précisent la description de la balise "set" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", e.g.,

<ximf:set id="value-categories" ref="value-mentions" maxItem="64" separator=";" />

* Détails sur les attributs de l'élément "set" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "ximf:set".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role|élément rôle]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut "description" permet d’associer un commentaire sur cette donnée.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs

L’élément "set" peut contenir un ou plusieurs éléments "string" ou un ou plusieurs éléments "compstring".

<ximf:set id="value-categories" minItem="1" maxItem="64" separator=";">
<ximf:string ilk="ilk-releasable-to" content="RELEASABLE TO " />
<ximf:string ilk="ilk-eyes-only" content=" EYES ONLY"/>
<ximf:string ilk="ilk-use-only" content=" USE ONLY"/>
</ximf:set>

<div style="color:red;">'''TODO :'''
* Y a-t-il une définition des fichiers associés aux instances XIMF (e.g, le fichier attribution-list.xml utilisé dans l'instance Caterpillar) ?
* Comment le moteur XIMF sait qu'un élément est une "attribution-list" ?
</div>

==== Element multiset ====
L’élément "multiset" décrit un conteneur de ressources de même type. Cet élément autorise la sélection de plusieurs ressources et chaque ressource peut être sélectionnée plusieurs fois.
Douze attributs précisent la description de la balise "multiset" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", e.g.,

<ximf:multiset
id="value-restricted"
ilk=" ilk-value-restricted"
maxItem="64"
separator=";" />

* Détails sur les attributs de l'élément "multiset" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "multiset".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role|élément rôle]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut "description" permet d’associer un commentaire sur cette donnée.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs

L’élément "multiset" peut contenir un ou plusieurs éléments "string" ou un ou plusieurs éléments "compstring".

<ximf:multiset id="value-restricted-example-categories" minItem="1" maxItem="64" separator=";" >
<ximf:string ilk="ilk-releasable-to" content="RELEASABLE TO "/>
<ximf:string ilk="ilk-eyes-only" content=" EYES ONLY"/>
<ximf:string ilk="ilk-use-only" content=" USE ONLY"/>
</ximf:multiset>

<span style="color:red;">'''TODO ''': Comment sont gérées les règles associées aux champs multivaleurs (disposant par exemple des attributs minItem/maxItem ou les champs multiset) ?</span>

==== Element linkedValue ====
L’élément "linkedValue" définit une référence sur une ressource de type conteneur ("set", "multiset") ou "string". Cette ressource devrait être utilisée si la ressource contenant "linkedValue" (noeud parent) est sélectionnée.
Un attribut précise la balise "linkvalue" : "ref", e.g.,

<ximf:linkedValue ref="value-restricted-otan-classification-id" />

* Détails sur les attributs de l'élément "linkedValue" :
** L’attribut "ref" précise la valeur de l’attribut "id" de la ressource cible. Cet attribut est obligatoire.

=== Fichier rules ===
Le fichier rules définit les règles de contrôles d’entêtes XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui peut contenir des éléments "ximf:rule".

==== Element rule ====
<div style="color:red">
'''TODO :''' Mettre à jour la documentation :
* Les éléments autorisés dans un élément « rule » ne sont plus à jour. La présente documentation spécifie 12 éléments : AliasHeader, AliasValue, Compatibility, Association, SecureHeaders, SecurityLabel, Constraint, Assignment, Processing, Accessibility, Role et Custom. Le schéma XML fourni avec le mail en spécifie 5 : Constraint, Processing, Compatibility, Policy et Custom et place les autres en tant qu'extentions des 5 éléments cités précédemment.
* Les éléments SecureHeaders et SecurityLabel associés à l'élément « rule » ne figurent pas dans la nouvelle version du shéma xml. On les retrouve dans les fichiers rules-*.xml mais les éléments sont commentés, ils sont, de plus, présents dans une autre instance : comment ces éléments sont utilisés dans Trustedbird ?
* L'élément ximf:classificationPictures n'est pas documenté. De plus, il serait bon d'avoir des précisions sur la raison qui a motivé l'ajout de cet élément dans les fichiers de règles (alors qu'il semblerait être plus adapté au fichier headers-*.xml).
</div>
L’élément "rule" est le conteneur principal de description d’un comportement particulier à appliquer sur un ensemble d’entêtes XIMF.
Trois attributs précisent la balise "rule" : "id", "agent", "description", e.g.,
<ximf:rule id="compatibility-rule" description="Règle sur la compatibilité X-SMTP / XIMF" >

* Détails sur les attributs de l'élément "rule" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "rule". Cet attribut est obligatoire.
** L’attribut "agent" indique l’équipement cible devant analyser et appliquer le contenu de cet élément.
** L’attribut "description" autorise l’auteur d’ajouter un commentaire sur cet élément.

L’élément "rule" contient un ou plusieurs mêmes éléments de spécialisation de la règle "contraint", "assignement", "processing", "compatibility", "accessibility", "custom",…, e.g.,

<ximf:rule id="precedence-rule" agent="mua" description="Règle sur les priorités">
<ximf:constraint
left="header-primary-precedence"
operator="equalOrGreaterThan"
right="header-copy-precedence" />
</ximf:rule>

==== Element aliasHeader ====
L’élément "aliasHeader" permet de définir le nom de l’entête sur lequel la règle précisée est appliquée
Deux attributs précisent la balise "aliasHeader" : "headerName" et "headerRef", e.g.,

<ximf:aliasHeader headerName ="X-P772-Version" headerRef="X-XIMF-VERSION" />

* Détails sur les attributs de l'élément "aliasHeader" :
* L’attribut "headerName" définit le nom XIMF de l’entête modifié par la règle. Cet attribut est obligatoire.
* L’attribut "headerRef" définit le nom d’un entête XIMF de référence qui est le point d’entrée de l’application de la règle sur l’entête définit par "headerName". Cela permet de lier deux entêtes de messages où l’utilisation de l’un des entêtes influe sur le comportement de l’autre.

L’élément "aliasHeader" peut contenir des éléments "aliasValue",e.g ,

<ximf:aliasHeader headerName="X-P772-Version" />
<ximf:aliasValue vame="1.0"/>
<ximf:aliasHeader>

==== Element aliasValue ====
L’élément "aliasValue" contient une valeur à associer à l’entête XIMF contrôlé par la règle. Il est utile lorsque deux entêtes sont liées (utilisation de l’attribut headerRef dans l’élément aliasHeader) et que les valeurs de l’entêtes de référence permettent de préciser celles de l’entête contrôlé.
Deux attributs précisent la balise "aliasValue" : "valueName", "valueRef", e.g.,

<ximf:aliasValue valueName="2" valueRef="flash" />

* Détails sur les attributs de l'élément "aliasValue" :
** L’attribut "valueName" définit la valeur de l’entête à créer. Cet attribut est obligatoire.
** L’attribut "valueRef" définit la valeur de l’entête XIMF de référence pour utiliser valueName.
<span style="color:red;">'''TODO :''' L'attribut valueRef est-il obligatoire ?</span>

==== Element compatibility ====
L’élément "compatibility" est utilisé pour associer à un entête respectant la norme XIMF un entête respectant une autre norme que XIMF (XSMTP par exemple).
Deux attributs précisent la balise "compatibility" : "targetName", "targetVersion", e.g.,

<ximf:compatibility targetName="X-SMTP" targetVersion="1.1">
<ximf:aliasValue headerName="X-P772-Version" content="1.1" />
<ximf:aliasValue
headerName="X-P772-Primary-Precedence"
headerRef="header-primary-precedence"
dataRef="data-priority-xsmtp"/>
</ximf:compatibility>

* Détails sur les attributs de l'élément "compatibility" :
** L’attribut "targetName" définit la norme de l’entête à associer à l’entête XIMF. Cet attribut est obligatoire.
** L’attribut "targetVersion" définit le numéro de version de la norme de l’entête à associer à l’entête XIMF. Cet attribut est obligatoire.

L’élément "compatibility" contient au moins un élément "aliasHeader".

<u>Pour illustrer cette règle :</u>
Le format XSMTP est déjà supporté par certains équipements. Afin de rendre ceux-ci inter opérables avec le nouveau format XIMF, cette règle permet d’associer un entête XSMTP contenant les mêmes informations qu’un entête XIMF.

L’élément Association : dépendance entre entêtes
L’élément "association" définie les valeurs autorisées pour un entête XIMF en fonction d’une valeur définie pour un autre entête XIMF.

<ximf:association>
<ximf:aliasHeader
headerName="X-XIMF-Primary-Precedence"
headerRef="X-XIMF-Correspondence-Type">
<ximf:aliasValue valueName="routine" valueRef="private" />
<ximf:aliasValue valueName="routine,priority" valueRef="professional" />
<ximf:aliasValue valueName="routine,priority,immediate,flash" valueRef="operational" />
<ximf:aliasValue valueName="routine,priority,immediate" valueRef="official" />
</ximf:aliasHeader>
</ximf:association>

==== Element secureHeaders ====
L’élément "secureHeaders" définie la liste des entêtes à intégrer dans la signature d’un message. Cette règle s’applique sur les équipements proposant un algorithme de signature des messages.

Un élément "secureHeaders" contient un ou plusieurs éléments "aliasHeaders" où chaque élément décrit un entête à intégrer dans la signature et complété d’un attribut "status".

<ximf:secureHeaders targetName="SecureHeaders">
<ximf:aliasHeader headerName="X-XIMF-Primary-Precedence" status="0" />
<ximf:aliasHeader headerName="X-XIMF-Copy-Precedence" status="0" />
</ximf:secureHeaders>

==== Element securityLabel ====
L’élément "securityLabel" définie la liste des entêtes à intégrer dans la signature d’un message. Cette règle s’applique sur les équipements proposant un algorithme de signature des messages selon la norme RFC.

Un élément "securityLabel" contient un ou plusieurs éléments "aliasHeaders" où chaque élément décrit un entête à intégrer dans la signature et complété d’un attribut "status".

<ximf:securityLabel targetName="SecurityLabel" id="Amoco">
<ximf:aliasHeader
headerName="SecurityPolicyIdentifier"
headerRef="X-XIMF-Security-Policy-Identifier" />
<ximf:aliasHeader
headerName="SecurityClassification"
headerRef="X-XIMF-Security-Classification-Identifier" />
<ximf:aliasHeader
headerName="ESSPrivacyMark"
headerRef="X-XIMF-Privacy-Mark" />
<ximf:aliasHeader
headerName="SecurityCategory"
headerRef="X-XIMF-Security-Categories-Identifier"
type="2" />
</ximf:securityLabel>

==== Element constraint ====
L’élément "constraint" est utilisé pour définir une règle de construction de deux entêtes partageant des "datas" identiques.
Trois attributs précisent la balise "constraint" : "left", "right", "operator", e.g.,

<ximf:constraint
left="header-primary-precedence"
operator="equalOrGreaterThan"
right="header-copy-precedence" />

* Détails sur les attributs de l'élément "constraint" :
** L’attribut "left" désigne le premier élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "right" désigne le deuxième élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "operator" indique la règle de poids à appliquer sur la valeur des deux éléments "header", il peut être de type "greaterThan", "lowerThan", "equalOrGreaterThan", "equalOrLowerThan", "equal". Cet attribut est obligatoire.

* Détails sur les valeurs possibles de l'attribut "type" :
** Le type "greaterThan" signifie que la valeur de l’élément "left" doit être strictement supérieur à la valeur de l’élément "right".
** Le type "lowerThan" signifie que la valeur de l’élément "left" doit être strictement inférieur à la valeur de l’élément "right".
** Le type "equalOrGreaterThan" signifie que la valeur de l’élément "left" doit être supérieur ou égale à la valeur de l’élément "right".
** Le type "equalOrLowerThan" signifie que la valeur de l’élément "left" doit être inférieur ou égale à la valeur de l’élément "right".
** Le type "equal" signifie que la valeur de l’élément "left" et de l’élément "right" doivent être identiques.

==== Element assignment ====
<div style="color:red;">'''TODO :''' L'élément assignment n'apparaît pas dans le shéma xml qui avait été envoyé.</div>

L’élément "assignement" est utilisé pour affecter une valeur créée en fonction d’une règle de comparaison sur les valeurs de deux éléments "header".
Quatre attributs précisent la balise "assignement" : "left", "right", "operator", "result", e.g.,

<ximf:assignment
left="header-primary-precedence"
operator="equal"
right="data-routine-precedence"
result="86400" />

* Détails sur les attributs de l'élément "assignment" :
** L’attribut "left" désigne le premier élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "right" désigne le deuxième élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "operator" indique la règle de comparaison entre les valeurs des deux éléments "header", il peut être de type "greaterThan", "lowerThan", "equalOrGreaterThan", "equalOrLowerThan", "equal". Cet attribut est obligatoire.
** L’attribut "result" représente la valeur à utiliser si la règle de comparaison entre les deux éléments est satisfaite. Cet attribut est obligatoire.

==== Element processing ====
L’élément "processing" regroupe des règles de traitement à effectuer sur des entêtes formatés.
L’attribut "type" précise le type de traitement à effectuer sur ces valeurs. Cet attribut est obligatoire, il est de type : "sign-header-value", "encrypt-header-value", "capitalize-header-value", e.g.,

<ximf:processing type="sign-header-value">
<ximf:refHeader>header-primary-precedence</ximf:refheader>
<ximf:refHeader>header-copy-precedence</ximf:refheader>
<ximf:refHeader>header-echange-type</ximf:refheader>
</ximf:processing>

* Détails sur les valeurs possibles de l'attribut "type" :
** Le type "sign-header-value" définit un traitement de signature des entêtes définis dans la balise.
** Le type "encrypt-header-value" définit un traitement de chiffrement des entêtes définis dans la balise.
** Le type "capitalize-header-value" définit un traitement de capitalisation des entêtes définis dans la balise.

L’élément "processing" contient au moins un élément "refHeader".
<div style="color:red;">'''TODO :'''L'élément refHeader n'est pas documenté, s'agit-il en fait de l'élément headerRef ?</div>

==== Element accessibility ====
<div style="color:red;">'''TODO :''' L'élément accessibility n'apparaît pas dans le shéma xml qui avait été envoyé.</div>
L’élément "accessibility" définit un ensemble de règles de droit d’accès aux éléments d’une instance pour une cible déterminée (utilisateur, routeur…).
Cet élément contient un ou plusieurs éléments "role".

<ximf:accessibility>
<ximf:role id="role-flash-allowed" aclLevel="100" />
<ximf:role id="role-flash-prohibited" aclLevel="50" />
</ximf:accessibility>

==== Element role ====
L’élément "role" positionne une valeur d’accès à pour une entité définit.
Deux attributs complètent l’élément "role" : "id", "aclLevel", e.g.,

<ximf:role id="role-flash-allowed" aclLevel="100" />

* Détails sur les attributs de l'élément "role" :
** L’attribut "id" précise l’entité accessible en fonction d’une valeur déterminée.
** L’attribut "aclLevel" précise la valeur seuil d’accès à l’entité.

==== Element custom ====
L’élément "custom" permet à l’auteur de créer des nouvelles règles personnalisées.
Trois attributs précisent la balise "custom" : "id", "provider", "description", e.g.,

<ximf:custom
id="custom-display"
provider="EADS"
description="Affichage de la composition du message" >
<node1><node2><node3></node3></node2></node1>
</ximf:custom>

* Détails sur les attributs de l'élément "custom" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "custom" et formaté selon la syntaxe "custom-xxx". Cet attribut est obligatoire.
** L’attribut "provider" identifie l’auteur de la règle. Cet attribut est obligatoire.
** L’attribut "description" permet d’ajouter un commentaire sur cet élément.

L’élément "custom" peut contenir tous les éléments possibles en respectant les standards XML.

XIMF XML tags/fr

2011-04-06T13:41:43Z

Anthonyjuge : /* Element multiset */

== Introduction ==
Ce document propose un modèle de description, via eXtensible Markup Language (XML), d’entêtes de messages électroniques respectant la norme XIMF. Ce document a deux objectifs :
# Décrire les éléments et attributs de représentation XML pour construire des entêtes de messages électroniques de format XIMF.
# Fournir un modèle de représentation XIMF/XML.

<u>Rappel :</u>
* Un "élément" fait référence à tous les caractères situés entre une balise de départ et un balise de fin, e.g.,
<exemple> texte et/ou éléments fils </exemple>
* Un "attribut" est une composante d’un élément. Il est positionné dans la balise de départ, e.g.,
<exemple nom='value'>

Tous les éléments décrits dans cette documentation paragraphe sont validés dans l’espace de nom "ximf".

<pre>
xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://eads.org/ximf/ximf.xsd"
</pre>

== Description détaillée des balises XML ==

Voici, par ordre d'apparition et en fonction des fichiers, les balises génériques associées aux différents fichiers XML.

=== Fichier ximfmail-profile ===

<div style="color:red;">'''TODO''' :
* Combien d'éléments ihm sont autorisés dans un élément instance ?
* La documentation des fichiers ximfmail-profile.xml n'est pas disponible.
* Quel est le rôle de l'élément "acces" ?
* Quelle est l'utilité des identifiants associés aux éléments instance, shema, ihm, etc.
* Quelle est l'utilité de l'attribut name associé aux éléments instance. Y a-t-il une vérification s'assurant que les fichiers utilisés par une instance correspondent bien à l'instance à laquelle ils sont associés ?
</div>

Un fichier xpi peut contenir plusieurs instances XIMF, celles-ci sont alors regroupées dans une même catégorie. Le fichier ximfmail-profile contient des informations sur toutes les instances contenues dans le xpi, notamment leur nom, leur chemin d'accès, ainsi que les noms des fichiers associés à chaque instance.

==== Element instance ====
L’élément "instance" identifie l’ensemble des entêtes à décrire selon la norme XIMF. C’est le conteneur principal d’une instance XIMF/XML. Cinq attributs précisent la balise "instance" : "ximfVersion", "version", "author", "creation", "name", e.g.,
<ximf:instance name="myInstance" version="1.0" ximfVersion="2.0" >

* Détails sur les attributs de l'élément "instance" :
** L’attribut "name" définit le nom de l’instance décrite. Cet attribut est obligatoire.
** L’attribut "ximfVersion" définit le numéro de version des entêtes XIMF utilisés pour cette représentation. Cet attribut est obligatoire.
** L’attribut "version" définit le numéro de version de l’instance décrite. Cet attribut est obligatoire.
** L’attribut "author" renseigne sur le nom de l’auteur de cette instance.
** L’attribut "creationDate" précise la date de création de cette instance.

L’élément "instance" peut contenir un ou plusieurs éléments "schema", un ou plusieurs éléments "rule", un élément "ihm" et un élément "dictionary".

==== Element dictionary ====
L'élément dictionary contient le chemin vers le fichier spécifiant les données d'internationalisation (Cf. [[#Fichier_dictionary|Fichier dictionary]]).

==== Element schema ====
L'élément shema contient le chemin vers le fichier spécifiant les entêtes XIMF (Cf. [[#Fichier_headers|Fichier headers]]).

==== Element ihm ====
L'élément ihm contient le chemin vers le fichier spécifiant la disposition de l'interface des formulaires XIMF (Cf. [[#Fichier_ihm|Fichier ihm]]).

==== Element rule ====
L'élément rule contient le chemin vers le fichier spécifiant les règles associées aux valeurs des champs XIMF (Cf. [[#Fichier_rules|Fichier rules]]).

=== Fichier dictionary ===
Le fichier dictionnary permet de mettre en œuvre l’internationalisation d’une instance XIMF. Il défini des dictionnaires qui servent à traduire les éléments de l'instance XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient un élément "ximf:dictionnary".

==== Element dictionary ====
<div style="color:red;">'''TODO''' :
* Quel est l'intérêt de renseigner un attribut "id" à l'élément "dictionary" (étant donné qu'un seul élément "dictionary est autorisé dans l'élément "instance") ?</div>

L’élément "dictionary" contient toutes les informations devant être interprétées selon le pays d’utilisation.
L’élément "dictionary" contient un ou plusieurs mêmes éléments "locale", e.g.,

<ximf:dictionary>
<ximf:locale lang="fr-FR" />
<ximf:locale lang="en-US" />
</ximf:dictionary>

==== Element locale ====
L’élément "locale" contient toutes les informations pour un pays et/ou langue désignée.
L’élément "locale" contient un ou plusieurs mêmes éléments "ilk", e.g.,

<ximf:locale lang="fr-FR" >
<ximf:ilk entity="a"/>
<ximf:ilk entity="b"/>
</ximf:locale>

* Détails sur les attributs de la balise "locale" :
** L’attribut "lang" définit le code pays de ce conteneur. Il devrai être construit selon le format défini par la RFC1766 (fr, en, ja, es, …).

==== Element ilk ====
L’élément "ilk" contient une unique information correspondant à une donnée traduite selon le code pays de l’élément père. Cette information est au format chaîne de caractère. Un attribut obligatoire précise la balise "ilk".

<ximf:ilk entity="ilk-lang-ihm">langue</ximf:ilk>

* Détails sur les attributs de la balise "ilk" :
** L’attribut "entity" définit la référence d’entrée pour récupérer le contenu de l’élément selon le code pays souhaité.

Finalement, le fichier "dictionary" pourra contenir :
<ximf:instance name="Whirlpool">
<ximf:dictionary>
<ximf:locale lang="fr-FR" >
<ximf:ilk entity="ilk-lang-ihm">Français</ximf:ilk>
<ximf:ilk entity="ilk-exemple-general">Général</ximf:ilk>
</ximf:locale>
<ximf:locale lang="en-US" >
<ximf:ilk entity="ilk-lang-ihm">English (US)</ximf:ilk>
<ximf:ilk entity="ilk-exemple-general">General</ximf:ilk>
</ximf:locale>
</ximf:dictionary>
</ximf:instance>

=== Fichier ihm ===
<span style="color:red;">'''TODO''' : La documentation originale ne décrit pas le fichier ihm, les informations ci-dessous ont seulement été présumées. Merci de les vérifier/compléter.
</span>

Le fichier ihm spécifie l'agencement de l'interface des formulaires XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient un élément "ximf:ihm".

==== Element ihm ====
L'élément "ihm" contient un ou plusieurs éléments "panel" et un élément "treeRcv".

==== Element panel ====
Un élément ximf:panel correspond à un onglet du formulaire XIMF construit.
Deux attributs précisent la balise "panel" : "id" et "ilk", eg.
<ximf:panel id="pane_security" ilk="ilk-priority-panel" />

* Détails sur les attributs de l'élément "panel" :
** L’attribut "id" définit le nom de l'onglet, il doit être unique pour chaque élément "ximf:panel" et est formaté selon la syntaxe "pane-xxx". Cet attribut est obligatoire.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.

L'élément "ximf:panel" contient au moins un éléments "ximf:groupbox".

==== Element groupbox ====
Un élément groupbox correspond à une sous catégorie d'un onglet du formulaire XIMF.
La structure "groupbox" détaille l’ordre d’affichage des entêtes dans un message.
Deux attributs précisent la balise "ximf:groupbox" : "id" et "ilk", eg.
<ximf:groupbox id="group-classification" ilk="ilk-secu-box" />

* Détails sur les attributs de l'élément "groupbox" :
** L’attribut "id" définit le nom de l'onglet, il doit être unique pour chaque élément "ximf:panel" et est formaté selon la syntaxe "pane-xxx". Cet attribut est obligatoire.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.

L'élément "groupbox" contient au moins un éléments "headerRef".

==== Element treeRcv ====
L'élément "treeRcv" permet de spécifier quelles sont les colonnes susceptibles d'être ajoutées dans le panneau principal du client de messagerie qui contient la liste des messages d’un dossier.

L'élément "treeRcv" peut contenir des éléments "headerRef".

==== Element headerRef ====
L'élément headerRef spécifie les champs associés à chaque sous-groupe d'onglet de formulaire ou les champs qu'il est possible d'afficher dans la liste des messages.
Aucun attribut ne vient compléter la balise "headerRef", eg.
<ximf:headerRef>header-classification</ximf:headerRef>

Finalement, le fichier "ihm" pourra contenir :
<pre>
<ximf:instance name="Amoco">
<ximf:ihm>
<ximf:panel id="pane_security" ilk="ilk-priority-panel">
<ximf:groupbox id="group-classification" ilk="ilk-secu-box">
<ximf:headerRef>header-correspondance-type</ximf:headerRef>
<ximf:headerRef>header-classification</ximf:headerRef>
</ximf:groupbox>
</ximf:panel>
<ximf:treeRcv>
<ximf:headerRef>header-classification</ximf:headerRef>
</ximf:treeRcv>
</ximf:ihm>
</ximf:instance>
</pre>

=== Fichier headers ===
Le fichier headers spécifie les types des champs de l'interface des formulaires XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient des éléments "header".

<div style="color:red">'''TODO :'''
Il semble que les fichiers headers définissent des champs d'entête devant être envoyés alors que ces mêmes entêtes ne sont pas spécifiés dans le fichier ihm. Ce comportement est logique, en effet, l'utilisateur n'a pas forcément besoin de savoir tout ce qui est envoyé via le formulaire.

Comment intégrer un header (nommé aussi header technique) dans le message sans qu'il soit affiché dans le formulaire XIMF de l'IHM ?

Par exemple, dans l'instance Amoco, le champ d'entête X-XIMF-Security-Policy-Identifier est automatiquement envoyé alors que les champs d'entête X-XIMF-Primary-Precedence et X-XIMF-Copy-Precedence ne le sont pas. Comment est faite la différence ?
</div>

==== Element header ====
Chaque élément "header" décrit un entête de message de format XIMF.
Huit attributs précisent la balise "header" : "headerName", "id", "technicalHeaderName", "type", "technicalType", "isMandatory", "ilk", "description", e.g.,

<div style="color:red;">'''TODO :'''
Comment est effectuée la vérification de l'attribut isMandatory et quelles sont les conditions de fonctionnement de celui-ci ? Est-il possible, par exemple, de spécifier l'attribut isMandatory=true d'un élément header si le contenu de celui-ci est un élément « set » qui dispose des attributs minItem et maxItem ? Actuellement, lorsque l'on crée un élément set avec les attributs minItem et maxItem, le champ du formulaire associé ne peux pas être validé : e.g.,
<ximf:set id="value-amoco-classification" minItem="1" maxItem="64" separator=";" technicalSeparator=".">
</div>

<ximf:header id="header-primary-precedence"
headerName="X-XIMF-Primary-Precedence"
ilk="ilk-primary-precedence"
isMandatory="true"
description="entête d’urgence"
type="string" />

* Détails sur les attributs de l'élément "header" :
** L’attribut "headerName" définit le nom du champ XIMF. Cet attribut est obligatoire.
** L’attribut "id" définit un identifiant de champ, il doit être unique pour chaque élément "header" et est formaté selon la syntaxe "header-xxx". Cet attribut est obligatoire.
** L’attribut "isMandatory" précise si ce champ doit être obligatoirement présent dans le message intégrant les entêtes selon cette description.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.
** L’attribut "type" précise le format des données associées à cet élément. Ce format peut être une date, une chaîne, une adresse mail, un O.I.D.
** L’attribut "technicalHeaderName" permet de compléter l’entête décrit par un autre entête.
** L’attribut "technicalType" précise le format des données associées à l’élément technicalHeaderName.
** L’attribut "description" permet d’ajouter une information sur cet élément.

L’élément "header" contient obligatoirement un élément "set", "multiset", "string", ou "compstring", e.g.,

<ximf:header id="header-reply-by"
headerName="X-XIMF-Reply-By"
ilk="ilk-reply-by"
isMandatory="false" >
<ximf:string id="value-reply-by" editable="true" />
</ximf:header>

<div style="color:red;">
'''TODO :''' Quelles sont les contraintes associées à l'attribut type d'un élément header ?
</div>

==== Element string ====
L’élément "string" précise le contenu d’une ressource de type chaîne de caractères imprimables (a-z, A-Z, 1-9,…)
Quinze attributs complètent l’élément "string" : "id", "ref", "ilk", "aclLevel", "index", "description", "editable", "content", "technicalContent","maxItem", "minItem", "maxLength", "minLength", "separator", "technicalSeparator", e.g.,

<ximf:string ilk="ilk-france" content="FRA" />

* Détails sur les attributs de l'élément "string" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "string".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role| élément role]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut " description " permet d’associer un commentaire sur cette donnée.
** L’attribut "editable" définit une valeur de saisie (champ libre). Cet attribut est de type booléen.
** L’attribut "content" représente la valeur effective de la donnée. C’est cette donnée qui sera associée au champ XIMF créé.
** L’attribut "technicalContent" représente la valeur effective de la donnée technique. C’est cette donnée qui sera associée au champ technique XIMF créé (cf. attribut technicalHeaderName de l’élément "header".
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.

L’élément "string" peut contenir plusieurs éléments "linkedValue".

<ximf:string ilk="ilk-non-protege" content="NON PROTEGE" technicalContent="1" >
<ximf:linkedValue ref="value-non-protege-france " />
</ximf:string>

==== Element compstring ====
<div style="color:red;">
'''TODO :''' L'attribut de l'élément « compstring » nommé « contentFactorise » devrait s'appeler « contentFactorize ».
</div>
L’élément "compstring" décrit un conteneur de concaténation des éléments fils. Il permet notamment de créer des valeurs d’entêtes composées.
Dix-sept attributs complètent l’élément "compstring" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", "content", "technicalContent", "contentPositionEnd", "contentFactorise", "technicalPositionEnd", e.g.,

<ximf:compstring
ilk="ilk-special"
content="SPECIAL"
technicalContent="1.3.4"
separator=" "
technicalSeparator=".">

* Détails sur les attributs de l'élément "compstring" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "compstring".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (cf. [[#Element_role| élément "role"]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut " description " permet d’associer un commentaire sur cette donnée.
** L’attribut "content" représente la valeur effective de la donnée. C’est cette donnée qui sera associée au champ XIMF créé.
** L’attribut "technicalContent" représente la valeur effective de la donnée technique. C’est cette donnée qui sera associée au champ technique XIMF créé (cf. attribut technicalHeaderName de l’élément "header".
** L’attribut "separator" définit le caractère de séparation entre deux valeurs.
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "contentPositionEnd" impose de positionner le contenu de l’élément "compstring" après les valeurs des éléments fils : valuefils1,valuefils2 : valuecompstring.
** L’attribut "technicalPositionEnd" impose de positionner le contenu de l’élément "compstring" après les valeurs des éléments fils.
** L’attribut "contentFactorise" impose d’utiliser le contenu de l’élément "compstring" comme facteur des éléments fils : valuecompstring(valuefils1,valuefils2).

L’élément "compstring" peut contenir un élément "string" ou "set" ou "multiset" ou plusieurs éléments "compstring".

<ximf:compstring
ilk="ilk-special"
content="SPECIAL"
technicalContent="1.3.4"
separator=" "
technicalSeparator=".">
<ximf:set id="ilk-special-op " maxItem="64">
<ximf:string ilk="ilk-special-op1" content="OP1" technicalContent="1" />
<ximf:string ilk="ilk-special-op2" content="OP2" technicalContent="2" />
<ximf:string ilk="ilk-special-op3" content="OP3" technicalContent="3" />
</ximf:set>
</ximf:compstring>

==== Element set ====
L’élément "set" décrit un conteneur de ressources de même type. Cet élément autorise la sélection de plusieurs ressources mais chaque ressource est sélectionnée une seule fois.
Douze attributs précisent la description de la balise "set" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", e.g.,

<ximf:set id="value-categories" ref="value-mentions" maxItem="64" separator=";" />

* Détails sur les attributs de l'élément "set" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "ximf:set".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role|élément rôle]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut "description" permet d’associer un commentaire sur cette donnée.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs

L’élément "set" peut contenir un ou plusieurs éléments "string" ou un ou plusieurs éléments "compstring".

<ximf:set id="value-categories" minItem="1" maxItem="64" separator=";">
<ximf:string ilk="ilk-releasable-to" content="RELEASABLE TO " />
<ximf:string ilk="ilk-eyes-only" content=" EYES ONLY"/>
<ximf:string ilk="ilk-use-only" content=" USE ONLY"/>
</ximf:set>

<div style="color:red;">'''TODO :'''
* Y a-t-il une définition des fichiers associés aux instances XIMF (e.g, le fichier attribution-list.xml utilisé dans l'instance Caterpillar) ?
* Comment le moteur XIMF sait qu'un élément est une "attribution-list" ?
</div>

==== Element multiset ====
L’élément "multiset" décrit un conteneur de ressources de même type. Cet élément autorise la sélection de plusieurs ressources et chaque ressource peut être sélectionnée plusieurs fois.
Douze attributs précisent la description de la balise "multiset" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", e.g.,

<ximf:multiset
id="value-restricted"
ilk=" ilk-value-restricted"
maxItem="64"
separator=";" />

* Détails sur les attributs de l'élément "multiset" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "multiset".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role|élément rôle]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut "description" permet d’associer un commentaire sur cette donnée.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs

L’élément "multiset" peut contenir un ou plusieurs éléments "string" ou un ou plusieurs éléments "compstring".

<ximf:multiset id="value-restricted-otan-categories" minItem="1" maxItem="64" separator=";" >
<ximf:string ilk="ilk-releasable-to" content="RELEASABLE TO "/>
<ximf:string ilk="ilk-eyes-only" content=" EYES ONLY"/>
<ximf:string ilk="ilk-use-only" content=" USE ONLY"/>
</ximf:multiset>

<span style="color:red;">'''TODO ''': Comment sont gérées les règles associées aux champs multivaleurs (disposant par exemple des attributs minItem/maxItem ou les champs multiset) ?</span>

==== Element linkedValue ====
L’élément "linkedValue" définit une référence sur une ressource de type conteneur ("set", "multiset") ou "string". Cette ressource devrait être utilisée si la ressource contenant "linkedValue" (noeud parent) est sélectionnée.
Un attribut précise la balise "linkvalue" : "ref", e.g.,

<ximf:linkedValue ref="value-restricted-otan-classification-id" />

* Détails sur les attributs de l'élément "linkedValue" :
** L’attribut "ref" précise la valeur de l’attribut "id" de la ressource cible. Cet attribut est obligatoire.

=== Fichier rules ===
Le fichier rules définit les règles de contrôles d’entêtes XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui peut contenir des éléments "ximf:rule".

==== Element rule ====
<div style="color:red">
'''TODO :''' Mettre à jour la documentation :
* Les éléments autorisés dans un élément « rule » ne sont plus à jour. La présente documentation spécifie 12 éléments : AliasHeader, AliasValue, Compatibility, Association, SecureHeaders, SecurityLabel, Constraint, Assignment, Processing, Accessibility, Role et Custom. Le schéma XML fourni avec le mail en spécifie 5 : Constraint, Processing, Compatibility, Policy et Custom et place les autres en tant qu'extentions des 5 éléments cités précédemment.
* Les éléments SecureHeaders et SecurityLabel associés à l'élément « rule » ne figurent pas dans la nouvelle version du shéma xml. On les retrouve dans les fichiers rules-*.xml mais les éléments sont commentés, ils sont, de plus, présents dans une autre instance : comment ces éléments sont utilisés dans Trustedbird ?
* L'élément ximf:classificationPictures n'est pas documenté. De plus, il serait bon d'avoir des précisions sur la raison qui a motivé l'ajout de cet élément dans les fichiers de règles (alors qu'il semblerait être plus adapté au fichier headers-*.xml).
</div>
L’élément "rule" est le conteneur principal de description d’un comportement particulier à appliquer sur un ensemble d’entêtes XIMF.
Trois attributs précisent la balise "rule" : "id", "agent", "description", e.g.,
<ximf:rule id="compatibility-rule" description="Règle sur la compatibilité X-SMTP / XIMF" >

* Détails sur les attributs de l'élément "rule" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "rule". Cet attribut est obligatoire.
** L’attribut "agent" indique l’équipement cible devant analyser et appliquer le contenu de cet élément.
** L’attribut "description" autorise l’auteur d’ajouter un commentaire sur cet élément.

L’élément "rule" contient un ou plusieurs mêmes éléments de spécialisation de la règle "contraint", "assignement", "processing", "compatibility", "accessibility", "custom",…, e.g.,

<ximf:rule id="precedence-rule" agent="mua" description="Règle sur les priorités">
<ximf:constraint
left="header-primary-precedence"
operator="equalOrGreaterThan"
right="header-copy-precedence" />
</ximf:rule>

==== Element aliasHeader ====
L’élément "aliasHeader" permet de définir le nom de l’entête sur lequel la règle précisée est appliquée
Deux attributs précisent la balise "aliasHeader" : "headerName" et "headerRef", e.g.,

<ximf:aliasHeader headerName ="X-P772-Version" headerRef="X-XIMF-VERSION" />

* Détails sur les attributs de l'élément "aliasHeader" :
* L’attribut "headerName" définit le nom XIMF de l’entête modifié par la règle. Cet attribut est obligatoire.
* L’attribut "headerRef" définit le nom d’un entête XIMF de référence qui est le point d’entrée de l’application de la règle sur l’entête définit par "headerName". Cela permet de lier deux entêtes de messages où l’utilisation de l’un des entêtes influe sur le comportement de l’autre.

L’élément "aliasHeader" peut contenir des éléments "aliasValue",e.g ,

<ximf:aliasHeader headerName="X-P772-Version" />
<ximf:aliasValue vame="1.0"/>
<ximf:aliasHeader>

==== Element aliasValue ====
L’élément "aliasValue" contient une valeur à associer à l’entête XIMF contrôlé par la règle. Il est utile lorsque deux entêtes sont liées (utilisation de l’attribut headerRef dans l’élément aliasHeader) et que les valeurs de l’entêtes de référence permettent de préciser celles de l’entête contrôlé.
Deux attributs précisent la balise "aliasValue" : "valueName", "valueRef", e.g.,

<ximf:aliasValue valueName="2" valueRef="flash" />

* Détails sur les attributs de l'élément "aliasValue" :
** L’attribut "valueName" définit la valeur de l’entête à créer. Cet attribut est obligatoire.
** L’attribut "valueRef" définit la valeur de l’entête XIMF de référence pour utiliser valueName.
<span style="color:red;">'''TODO :''' L'attribut valueRef est-il obligatoire ?</span>

==== Element compatibility ====
L’élément "compatibility" est utilisé pour associer à un entête respectant la norme XIMF un entête respectant une autre norme que XIMF (XSMTP par exemple).
Deux attributs précisent la balise "compatibility" : "targetName", "targetVersion", e.g.,

<ximf:compatibility targetName="X-SMTP" targetVersion="1.1">
<ximf:aliasValue headerName="X-P772-Version" content="1.1" />
<ximf:aliasValue
headerName="X-P772-Primary-Precedence"
headerRef="header-primary-precedence"
dataRef="data-priority-xsmtp"/>
</ximf:compatibility>

* Détails sur les attributs de l'élément "compatibility" :
** L’attribut "targetName" définit la norme de l’entête à associer à l’entête XIMF. Cet attribut est obligatoire.
** L’attribut "targetVersion" définit le numéro de version de la norme de l’entête à associer à l’entête XIMF. Cet attribut est obligatoire.

L’élément "compatibility" contient au moins un élément "aliasHeader".

<u>Pour illustrer cette règle :</u>
Le format XSMTP est déjà supporté par certains équipements. Afin de rendre ceux-ci inter opérables avec le nouveau format XIMF, cette règle permet d’associer un entête XSMTP contenant les mêmes informations qu’un entête XIMF.

L’élément Association : dépendance entre entêtes
L’élément "association" définie les valeurs autorisées pour un entête XIMF en fonction d’une valeur définie pour un autre entête XIMF.

<ximf:association>
<ximf:aliasHeader
headerName="X-XIMF-Primary-Precedence"
headerRef="X-XIMF-Correspondence-Type">
<ximf:aliasValue valueName="routine" valueRef="private" />
<ximf:aliasValue valueName="routine,priority" valueRef="professional" />
<ximf:aliasValue valueName="routine,priority,immediate,flash" valueRef="operational" />
<ximf:aliasValue valueName="routine,priority,immediate" valueRef="official" />
</ximf:aliasHeader>
</ximf:association>

==== Element secureHeaders ====
L’élément "secureHeaders" définie la liste des entêtes à intégrer dans la signature d’un message. Cette règle s’applique sur les équipements proposant un algorithme de signature des messages.

Un élément "secureHeaders" contient un ou plusieurs éléments "aliasHeaders" où chaque élément décrit un entête à intégrer dans la signature et complété d’un attribut "status".

<ximf:secureHeaders targetName="SecureHeaders">
<ximf:aliasHeader headerName="X-XIMF-Primary-Precedence" status="0" />
<ximf:aliasHeader headerName="X-XIMF-Copy-Precedence" status="0" />
</ximf:secureHeaders>

==== Element securityLabel ====
L’élément "securityLabel" définie la liste des entêtes à intégrer dans la signature d’un message. Cette règle s’applique sur les équipements proposant un algorithme de signature des messages selon la norme RFC.

Un élément "securityLabel" contient un ou plusieurs éléments "aliasHeaders" où chaque élément décrit un entête à intégrer dans la signature et complété d’un attribut "status".

<ximf:securityLabel targetName="SecurityLabel" id="Amoco">
<ximf:aliasHeader
headerName="SecurityPolicyIdentifier"
headerRef="X-XIMF-Security-Policy-Identifier" />
<ximf:aliasHeader
headerName="SecurityClassification"
headerRef="X-XIMF-Security-Classification-Identifier" />
<ximf:aliasHeader
headerName="ESSPrivacyMark"
headerRef="X-XIMF-Privacy-Mark" />
<ximf:aliasHeader
headerName="SecurityCategory"
headerRef="X-XIMF-Security-Categories-Identifier"
type="2" />
</ximf:securityLabel>

==== Element constraint ====
L’élément "constraint" est utilisé pour définir une règle de construction de deux entêtes partageant des "datas" identiques.
Trois attributs précisent la balise "constraint" : "left", "right", "operator", e.g.,

<ximf:constraint
left="header-primary-precedence"
operator="equalOrGreaterThan"
right="header-copy-precedence" />

* Détails sur les attributs de l'élément "constraint" :
** L’attribut "left" désigne le premier élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "right" désigne le deuxième élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "operator" indique la règle de poids à appliquer sur la valeur des deux éléments "header", il peut être de type "greaterThan", "lowerThan", "equalOrGreaterThan", "equalOrLowerThan", "equal". Cet attribut est obligatoire.

* Détails sur les valeurs possibles de l'attribut "type" :
** Le type "greaterThan" signifie que la valeur de l’élément "left" doit être strictement supérieur à la valeur de l’élément "right".
** Le type "lowerThan" signifie que la valeur de l’élément "left" doit être strictement inférieur à la valeur de l’élément "right".
** Le type "equalOrGreaterThan" signifie que la valeur de l’élément "left" doit être supérieur ou égale à la valeur de l’élément "right".
** Le type "equalOrLowerThan" signifie que la valeur de l’élément "left" doit être inférieur ou égale à la valeur de l’élément "right".
** Le type "equal" signifie que la valeur de l’élément "left" et de l’élément "right" doivent être identiques.

==== Element assignment ====
<div style="color:red;">'''TODO :''' L'élément assignment n'apparaît pas dans le shéma xml qui avait été envoyé.</div>

L’élément "assignement" est utilisé pour affecter une valeur créée en fonction d’une règle de comparaison sur les valeurs de deux éléments "header".
Quatre attributs précisent la balise "assignement" : "left", "right", "operator", "result", e.g.,

<ximf:assignment
left="header-primary-precedence"
operator="equal"
right="data-routine-precedence"
result="86400" />

* Détails sur les attributs de l'élément "assignment" :
** L’attribut "left" désigne le premier élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "right" désigne le deuxième élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "operator" indique la règle de comparaison entre les valeurs des deux éléments "header", il peut être de type "greaterThan", "lowerThan", "equalOrGreaterThan", "equalOrLowerThan", "equal". Cet attribut est obligatoire.
** L’attribut "result" représente la valeur à utiliser si la règle de comparaison entre les deux éléments est satisfaite. Cet attribut est obligatoire.

==== Element processing ====
L’élément "processing" regroupe des règles de traitement à effectuer sur des entêtes formatés.
L’attribut "type" précise le type de traitement à effectuer sur ces valeurs. Cet attribut est obligatoire, il est de type : "sign-header-value", "encrypt-header-value", "capitalize-header-value", e.g.,

<ximf:processing type="sign-header-value">
<ximf:refHeader>header-primary-precedence</ximf:refheader>
<ximf:refHeader>header-copy-precedence</ximf:refheader>
<ximf:refHeader>header-echange-type</ximf:refheader>
</ximf:processing>

* Détails sur les valeurs possibles de l'attribut "type" :
** Le type "sign-header-value" définit un traitement de signature des entêtes définis dans la balise.
** Le type "encrypt-header-value" définit un traitement de chiffrement des entêtes définis dans la balise.
** Le type "capitalize-header-value" définit un traitement de capitalisation des entêtes définis dans la balise.

L’élément "processing" contient au moins un élément "refHeader".
<div style="color:red;">'''TODO :'''L'élément refHeader n'est pas documenté, s'agit-il en fait de l'élément headerRef ?</div>

==== Element accessibility ====
<div style="color:red;">'''TODO :''' L'élément accessibility n'apparaît pas dans le shéma xml qui avait été envoyé.</div>
L’élément "accessibility" définit un ensemble de règles de droit d’accès aux éléments d’une instance pour une cible déterminée (utilisateur, routeur…).
Cet élément contient un ou plusieurs éléments "role".

<ximf:accessibility>
<ximf:role id="role-flash-allowed" aclLevel="100" />
<ximf:role id="role-flash-prohibited" aclLevel="50" />
</ximf:accessibility>

==== Element role ====
L’élément "role" positionne une valeur d’accès à pour une entité définit.
Deux attributs complètent l’élément "role" : "id", "aclLevel", e.g.,

<ximf:role id="role-flash-allowed" aclLevel="100" />

* Détails sur les attributs de l'élément "role" :
** L’attribut "id" précise l’entité accessible en fonction d’une valeur déterminée.
** L’attribut "aclLevel" précise la valeur seuil d’accès à l’entité.

==== Element custom ====
L’élément "custom" permet à l’auteur de créer des nouvelles règles personnalisées.
Trois attributs précisent la balise "custom" : "id", "provider", "description", e.g.,

<ximf:custom
id="custom-display"
provider="EADS"
description="Affichage de la composition du message" >
<node1><node2><node3></node3></node2></node1>
</ximf:custom>

* Détails sur les attributs de l'élément "custom" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "custom" et formaté selon la syntaxe "custom-xxx". Cet attribut est obligatoire.
** L’attribut "provider" identifie l’auteur de la règle. Cet attribut est obligatoire.
** L’attribut "description" permet d’ajouter un commentaire sur cet élément.

L’élément "custom" peut contenir tous les éléments possibles en respectant les standards XML.

XIMF XML tags/fr

2011-03-15T17:42:24Z

Anthonyjuge : /* Fichier headers */

== Introduction ==
Ce document propose un modèle de description, via eXtensible Markup Language (XML), d’entêtes de messages électroniques respectant la norme XIMF. Ce document a deux objectifs :
# Décrire les éléments et attributs de représentation XML pour construire des entêtes de messages électroniques de format XIMF.
# Fournir un modèle de représentation XIMF/XML.

<u>Rappel :</u>
* Un "élément" fait référence à tous les caractères situés entre une balise de départ et un balise de fin, e.g.,
<exemple> texte et/ou éléments fils </exemple>
* Un "attribut" est une composante d’un élément. Il est positionné dans la balise de départ, e.g.,
<exemple nom='value'>

Tous les éléments décrits dans cette documentation paragraphe sont validés dans l’espace de nom "ximf".

<pre>
xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://eads.org/ximf/ximf.xsd"
</pre>

== Description détaillée des balises XML ==

Voici, par ordre d'apparition et en fonction des fichiers, les balises génériques associées aux différents fichiers XML.

=== Fichier ximfmail-profile ===

<div style="color:red;">'''TODO''' :
* Combien d'éléments ihm sont autorisés dans un élément instance ?
* La documentation des fichiers ximfmail-profile.xml n'est pas disponible.
* Quel est le rôle de l'élément "acces" ?
* Quelle est l'utilité des identifiants associés aux éléments instance, shema, ihm, etc.
* Quelle est l'utilité de l'attribut name associé aux éléments instance. Y a-t-il une vérification s'assurant que les fichiers utilisés par une instance correspondent bien à l'instance à laquelle ils sont associés ?
</div>

Un fichier xpi peut contenir plusieurs instances XIMF, celles-ci sont alors regroupées dans une même catégorie. Le fichier ximfmail-profile contient des informations sur toutes les instances contenues dans le xpi, notamment leur nom, leur chemin d'accès, ainsi que les noms des fichiers associés à chaque instance.

==== Element instance ====
L’élément "instance" identifie l’ensemble des entêtes à décrire selon la norme XIMF. C’est le conteneur principal d’une instance XIMF/XML. Cinq attributs précisent la balise "instance" : "ximfVersion", "version", "author", "creation", "name", e.g.,
<ximf:instance name="myInstance" version="1.0" ximfVersion="2.0" >

* Détails sur les attributs de l'élément "instance" :
** L’attribut "name" définit le nom de l’instance décrite. Cet attribut est obligatoire.
** L’attribut "ximfVersion" définit le numéro de version des entêtes XIMF utilisés pour cette représentation. Cet attribut est obligatoire.
** L’attribut "version" définit le numéro de version de l’instance décrite. Cet attribut est obligatoire.
** L’attribut "author" renseigne sur le nom de l’auteur de cette instance.
** L’attribut "creationDate" précise la date de création de cette instance.

L’élément "instance" peut contenir un ou plusieurs éléments "schema", un ou plusieurs éléments "rule", un élément "ihm" et un élément "dictionary".

==== Element dictionary ====
L'élément dictionary contient le chemin vers le fichier spécifiant les données d'internationalisation (Cf. [[#Fichier_dictionary|Fichier dictionary]]).

==== Element schema ====
L'élément shema contient le chemin vers le fichier spécifiant les entêtes XIMF (Cf. [[#Fichier_headers|Fichier headers]]).

==== Element ihm ====
L'élément ihm contient le chemin vers le fichier spécifiant la disposition de l'interface des formulaires XIMF (Cf. [[#Fichier_ihm|Fichier ihm]]).

==== Element rule ====
L'élément rule contient le chemin vers le fichier spécifiant les règles associées aux valeurs des champs XIMF (Cf. [[#Fichier_rules|Fichier rules]]).

=== Fichier dictionary ===
Le fichier dictionnary permet de mettre en œuvre l’internationalisation d’une instance XIMF. Il défini des dictionnaires qui servent à traduire les éléments de l'instance XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient un élément "ximf:dictionnary".

==== Element dictionary ====
<div style="color:red;">'''TODO''' :
* Quel est l'intérêt de renseigner un attribut "id" à l'élément "dictionary" (étant donné qu'un seul élément "dictionary est autorisé dans l'élément "instance") ?</div>

L’élément "dictionary" contient toutes les informations devant être interprétées selon le pays d’utilisation.
L’élément "dictionary" contient un ou plusieurs mêmes éléments "locale", e.g.,

<ximf:dictionary>
<ximf:locale lang="fr-FR" />
<ximf:locale lang="en-US" />
</ximf:dictionary>

==== Element locale ====
L’élément "locale" contient toutes les informations pour un pays et/ou langue désignée.
L’élément "locale" contient un ou plusieurs mêmes éléments "ilk", e.g.,

<ximf:locale lang="fr-FR" >
<ximf:ilk entity="a"/>
<ximf:ilk entity="b"/>
</ximf:locale>

* Détails sur les attributs de la balise "locale" :
** L’attribut "lang" définit le code pays de ce conteneur. Il devrai être construit selon le format défini par la RFC1766 (fr, en, ja, es, …).

==== Element ilk ====
L’élément "ilk" contient une unique information correspondant à une donnée traduite selon le code pays de l’élément père. Cette information est au format chaîne de caractère. Un attribut obligatoire précise la balise "ilk".

<ximf:ilk entity="ilk-lang-ihm">langue</ximf:ilk>

* Détails sur les attributs de la balise "ilk" :
** L’attribut "entity" définit la référence d’entrée pour récupérer le contenu de l’élément selon le code pays souhaité.

Finalement, le fichier "dictionary" pourra contenir :
<ximf:instance name="Whirlpool">
<ximf:dictionary>
<ximf:locale lang="fr-FR" >
<ximf:ilk entity="ilk-lang-ihm">Français</ximf:ilk>
<ximf:ilk entity="ilk-exemple-general">Général</ximf:ilk>
</ximf:locale>
<ximf:locale lang="en-US" >
<ximf:ilk entity="ilk-lang-ihm">English (US)</ximf:ilk>
<ximf:ilk entity="ilk-exemple-general">General</ximf:ilk>
</ximf:locale>
</ximf:dictionary>
</ximf:instance>

=== Fichier ihm ===
<span style="color:red;">'''TODO''' : La documentation originale ne décrit pas le fichier ihm, les informations ci-dessous ont seulement été présumées. Merci de les vérifier/compléter.
</span>

Le fichier ihm spécifie l'agencement de l'interface des formulaires XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient un élément "ximf:ihm".

==== Element ihm ====
L'élément "ihm" contient un ou plusieurs éléments "panel" et un élément "treeRcv".

==== Element panel ====
Un élément ximf:panel correspond à un onglet du formulaire XIMF construit.
Deux attributs précisent la balise "panel" : "id" et "ilk", eg.
<ximf:panel id="pane_security" ilk="ilk-priority-panel" />

* Détails sur les attributs de l'élément "panel" :
** L’attribut "id" définit le nom de l'onglet, il doit être unique pour chaque élément "ximf:panel" et est formaté selon la syntaxe "pane-xxx". Cet attribut est obligatoire.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.

L'élément "ximf:panel" contient au moins un éléments "ximf:groupbox".

==== Element groupbox ====
Un élément groupbox correspond à une sous catégorie d'un onglet du formulaire XIMF.
La structure "groupbox" détaille l’ordre d’affichage des entêtes dans un message.
Deux attributs précisent la balise "ximf:groupbox" : "id" et "ilk", eg.
<ximf:groupbox id="group-classification" ilk="ilk-secu-box" />

* Détails sur les attributs de l'élément "groupbox" :
** L’attribut "id" définit le nom de l'onglet, il doit être unique pour chaque élément "ximf:panel" et est formaté selon la syntaxe "pane-xxx". Cet attribut est obligatoire.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.

L'élément "groupbox" contient au moins un éléments "headerRef".

==== Element treeRcv ====
L'élément "treeRcv" permet de spécifier quelles sont les colonnes susceptibles d'être ajoutées dans le panneau principal du client de messagerie qui contient la liste des messages d’un dossier.

L'élément "treeRcv" peut contenir des éléments "headerRef".

==== Element headerRef ====
L'élément headerRef spécifie les champs associés à chaque sous-groupe d'onglet de formulaire ou les champs qu'il est possible d'afficher dans la liste des messages.
Aucun attribut ne vient compléter la balise "headerRef", eg.
<ximf:headerRef>header-classification</ximf:headerRef>

Finalement, le fichier "ihm" pourra contenir :
<pre>
<ximf:instance name="Amoco">
<ximf:ihm>
<ximf:panel id="pane_security" ilk="ilk-priority-panel">
<ximf:groupbox id="group-classification" ilk="ilk-secu-box">
<ximf:headerRef>header-correspondance-type</ximf:headerRef>
<ximf:headerRef>header-classification</ximf:headerRef>
</ximf:groupbox>
</ximf:panel>
<ximf:treeRcv>
<ximf:headerRef>header-classification</ximf:headerRef>
</ximf:treeRcv>
</ximf:ihm>
</ximf:instance>
</pre>

=== Fichier headers ===
Le fichier headers spécifie les types des champs de l'interface des formulaires XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient des éléments "header".

<div style="color:red">'''TODO :'''
Il semble que les fichiers headers définissent des champs d'entête devant être envoyés alors que ces mêmes entêtes ne sont pas spécifiés dans le fichier ihm. Ce comportement est logique, en effet, l'utilisateur n'a pas forcément besoin de savoir tout ce qui est envoyé via le formulaire.

Comment intégrer un header (nommé aussi header technique) dans le message sans qu'il soit affiché dans le formulaire XIMF de l'IHM ?

Par exemple, dans l'instance Amoco, le champ d'entête X-XIMF-Security-Policy-Identifier est automatiquement envoyé alors que les champs d'entête X-XIMF-Primary-Precedence et X-XIMF-Copy-Precedence ne le sont pas. Comment est faite la différence ?
</div>

==== Element header ====
Chaque élément "header" décrit un entête de message de format XIMF.
Huit attributs précisent la balise "header" : "headerName", "id", "technicalHeaderName", "type", "technicalType", "isMandatory", "ilk", "description", e.g.,

<div style="color:red;">'''TODO :'''
Comment est effectuée la vérification de l'attribut isMandatory et quelles sont les conditions de fonctionnement de celui-ci ? Est-il possible, par exemple, de spécifier l'attribut isMandatory=true d'un élément header si le contenu de celui-ci est un élément « set » qui dispose des attributs minItem et maxItem ? Actuellement, lorsque l'on crée un élément set avec les attributs minItem et maxItem, le champ du formulaire associé ne peux pas être validé : e.g.,
<ximf:set id="value-amoco-classification" minItem="1" maxItem="64" separator=";" technicalSeparator=".">
</div>

<ximf:header id="header-primary-precedence"
headerName="X-XIMF-Primary-Precedence"
ilk="ilk-primary-precedence"
isMandatory="true"
description="entête d’urgence"
type="string" />

* Détails sur les attributs de l'élément "header" :
** L’attribut "headerName" définit le nom du champ XIMF. Cet attribut est obligatoire.
** L’attribut "id" définit un identifiant de champ, il doit être unique pour chaque élément "header" et est formaté selon la syntaxe "header-xxx". Cet attribut est obligatoire.
** L’attribut "isMandatory" précise si ce champ doit être obligatoirement présent dans le message intégrant les entêtes selon cette description.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.
** L’attribut "type" précise le format des données associées à cet élément. Ce format peut être une date, une chaîne, une adresse mail, un O.I.D.
** L’attribut "technicalHeaderName" permet de compléter l’entête décrit par un autre entête.
** L’attribut "technicalType" précise le format des données associées à l’élément technicalHeaderName.
** L’attribut "description" permet d’ajouter une information sur cet élément.

L’élément "header" contient obligatoirement un élément "set", "multiset", "string", ou "compstring", e.g.,

<ximf:header id="header-reply-by"
headerName="X-XIMF-Reply-By"
ilk="ilk-reply-by"
isMandatory="false" >
<ximf:string id="value-reply-by" editable="true" />
</ximf:header>

<div style="color:red;">
'''TODO :''' Quelles sont les contraintes associées à l'attribut type d'un élément header ?
</div>

==== Element string ====
L’élément "string" précise le contenu d’une ressource de type chaîne de caractères imprimables (a-z, A-Z, 1-9,…)
Quinze attributs complètent l’élément "string" : "id", "ref", "ilk", "aclLevel", "index", "description", "editable", "content", "technicalContent","maxItem", "minItem", "maxLength", "minLength", "separator", "technicalSeparator", e.g.,

<ximf:string ilk="ilk-france" content="FRA" />

* Détails sur les attributs de l'élément "string" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "string".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role| élément role]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut " description " permet d’associer un commentaire sur cette donnée.
** L’attribut "editable" définit une valeur de saisie (champ libre). Cet attribut est de type booléen.
** L’attribut "content" représente la valeur effective de la donnée. C’est cette donnée qui sera associée au champ XIMF créé.
** L’attribut "technicalContent" représente la valeur effective de la donnée technique. C’est cette donnée qui sera associée au champ technique XIMF créé (cf. attribut technicalHeaderName de l’élément "header".
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.

L’élément "string" peut contenir plusieurs éléments "linkedValue".

<ximf:string ilk="ilk-non-protege" content="NON PROTEGE" technicalContent="1" >
<ximf:linkedValue ref="value-non-protege-france " />
</ximf:string>

==== Element compstring ====
<div style="color:red;">
'''TODO :''' L'attribut de l'élément « compstring » nommé « contentFactorise » devrait s'appeler « contentFactorize ».
</div>
L’élément "compstring" décrit un conteneur de concaténation des éléments fils. Il permet notamment de créer des valeurs d’entêtes composées.
Dix-sept attributs complètent l’élément "compstring" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", "content", "technicalContent", "contentPositionEnd", "contentFactorise", "technicalPositionEnd", e.g.,

<ximf:compstring
ilk="ilk-special"
content="SPECIAL"
technicalContent="1.3.4"
separator=" "
technicalSeparator=".">

* Détails sur les attributs de l'élément "compstring" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "compstring".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (cf. [[#Element_role| élément "role"]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut " description " permet d’associer un commentaire sur cette donnée.
** L’attribut "content" représente la valeur effective de la donnée. C’est cette donnée qui sera associée au champ XIMF créé.
** L’attribut "technicalContent" représente la valeur effective de la donnée technique. C’est cette donnée qui sera associée au champ technique XIMF créé (cf. attribut technicalHeaderName de l’élément "header".
** L’attribut "separator" définit le caractère de séparation entre deux valeurs.
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "contentPositionEnd" impose de positionner le contenu de l’élément "compstring" après les valeurs des éléments fils : valuefils1,valuefils2 : valuecompstring.
** L’attribut "technicalPositionEnd" impose de positionner le contenu de l’élément "compstring" après les valeurs des éléments fils.
** L’attribut "contentFactorise" impose d’utiliser le contenu de l’élément "compstring" comme facteur des éléments fils : valuecompstring(valuefils1,valuefils2).

L’élément "compstring" peut contenir un élément "string" ou "set" ou "multiset" ou plusieurs éléments "compstring".

<ximf:compstring
ilk="ilk-special"
content="SPECIAL"
technicalContent="1.3.4"
separator=" "
technicalSeparator=".">
<ximf:set id="ilk-special-op " maxItem="64">
<ximf:string ilk="ilk-special-op1" content="OP1" technicalContent="1" />
<ximf:string ilk="ilk-special-op2" content="OP2" technicalContent="2" />
<ximf:string ilk="ilk-special-op3" content="OP3" technicalContent="3" />
</ximf:set>
</ximf:compstring>

==== Element set ====
L’élément "set" décrit un conteneur de ressources de même type. Cet élément autorise la sélection de plusieurs ressources mais chaque ressource est sélectionnée une seule fois.
Douze attributs précisent la description de la balise "set" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", e.g.,

<ximf:set id="value-categories" ref="value-mentions" maxItem="64" separator=";" />

* Détails sur les attributs de l'élément "set" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "ximf:set".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role|élément rôle]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut "description" permet d’associer un commentaire sur cette donnée.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs

L’élément "set" peut contenir un ou plusieurs éléments "string" ou un ou plusieurs éléments "compstring".

<ximf:set id="value-categories" minItem="1" maxItem="64" separator=";">
<ximf:string ilk="ilk-releasable-to" content="RELEASABLE TO " />
<ximf:string ilk="ilk-eyes-only" content=" EYES ONLY"/>
<ximf:string ilk="ilk-use-only" content=" USE ONLY"/>
</ximf:set>

<div style="color:red;">'''TODO :'''
* Y a-t-il une définition des fichiers associés aux instances XIMF (e.g, le fichier attribution-list.xml utilisé dans l'instance Caterpillar) ?
* Comment le moteur XIMF sait qu'un élément est une "attribution-list" ?
</div>

==== Element multiset ====
L’élément "multiset" décrit un conteneur de ressources de même type. Cet élément autorise la sélection de plusieurs ressources et chaque ressource peut être sélectionnée plusieurs fois.
Douze attributs précisent la description de la balise "multiset" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", e.g.,

<ximf:multiset
id="value-restricted"
ilk=" value-restricted-otan"
maxItem="64"
separator=";" />

* Détails sur les attributs de l'élément "multiset" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "multiset".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role|élément rôle]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut "description" permet d’associer un commentaire sur cette donnée.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs

L’élément "multiset" peut contenir un ou plusieurs éléments "string" ou un ou plusieurs éléments "compstring".

<ximf:multiset id="value-restricted-otan-categories" minItem="1" maxItem="64" separator=";" >
<ximf:string ilk="ilk-releasable-to" content="RELEASABLE TO "/>
<ximf:string ilk="ilk-eyes-only" content=" EYES ONLY"/>
<ximf:string ilk="ilk-use-only" content=" USE ONLY"/>
</ximf:multiset>

<span style="color:red;">'''TODO ''': Comment sont gérées les règles associées aux champs multivaleurs (disposant par exemple des attributs minItem/maxItem ou les champs multiset) ?</span>

==== Element linkedValue ====
L’élément "linkedValue" définit une référence sur une ressource de type conteneur ("set", "multiset") ou "string". Cette ressource devrait être utilisée si la ressource contenant "linkedValue" (noeud parent) est sélectionnée.
Un attribut précise la balise "linkvalue" : "ref", e.g.,

<ximf:linkedValue ref="value-restricted-otan-classification-id" />

* Détails sur les attributs de l'élément "linkedValue" :
** L’attribut "ref" précise la valeur de l’attribut "id" de la ressource cible. Cet attribut est obligatoire.

=== Fichier rules ===
Le fichier rules définit les règles de contrôles d’entêtes XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui peut contenir des éléments "ximf:rule".

==== Element rule ====
<div style="color:red">
'''TODO :''' Mettre à jour la documentation :
* Les éléments autorisés dans un élément « rule » ne sont plus à jour. La présente documentation spécifie 12 éléments : AliasHeader, AliasValue, Compatibility, Association, SecureHeaders, SecurityLabel, Constraint, Assignment, Processing, Accessibility, Role et Custom. Le schéma XML fourni avec le mail en spécifie 5 : Constraint, Processing, Compatibility, Policy et Custom et place les autres en tant qu'extentions des 5 éléments cités précédemment.
* Les éléments SecureHeaders et SecurityLabel associés à l'élément « rule » ne figurent pas dans la nouvelle version du shéma xml. On les retrouve dans les fichiers rules-*.xml mais les éléments sont commentés, ils sont, de plus, présents dans une autre instance : comment ces éléments sont utilisés dans Trustedbird ?
* L'élément ximf:classificationPictures n'est pas documenté. De plus, il serait bon d'avoir des précisions sur la raison qui a motivé l'ajout de cet élément dans les fichiers de règles (alors qu'il semblerait être plus adapté au fichier headers-*.xml).
</div>
L’élément "rule" est le conteneur principal de description d’un comportement particulier à appliquer sur un ensemble d’entêtes XIMF.
Trois attributs précisent la balise "rule" : "id", "agent", "description", e.g.,
<ximf:rule id="compatibility-rule" description="Règle sur la compatibilité X-SMTP / XIMF" >

* Détails sur les attributs de l'élément "rule" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "rule". Cet attribut est obligatoire.
** L’attribut "agent" indique l’équipement cible devant analyser et appliquer le contenu de cet élément.
** L’attribut "description" autorise l’auteur d’ajouter un commentaire sur cet élément.

L’élément "rule" contient un ou plusieurs mêmes éléments de spécialisation de la règle "contraint", "assignement", "processing", "compatibility", "accessibility", "custom",…, e.g.,

<ximf:rule id="precedence-rule" agent="mua" description="Règle sur les priorités">
<ximf:constraint
left="header-primary-precedence"
operator="equalOrGreaterThan"
right="header-copy-precedence" />
</ximf:rule>

==== Element aliasHeader ====
L’élément "aliasHeader" permet de définir le nom de l’entête sur lequel la règle précisée est appliquée
Deux attributs précisent la balise "aliasHeader" : "headerName" et "headerRef", e.g.,

<ximf:aliasHeader headerName ="X-P772-Version" headerRef="X-XIMF-VERSION" />

* Détails sur les attributs de l'élément "aliasHeader" :
* L’attribut "headerName" définit le nom XIMF de l’entête modifié par la règle. Cet attribut est obligatoire.
* L’attribut "headerRef" définit le nom d’un entête XIMF de référence qui est le point d’entrée de l’application de la règle sur l’entête définit par "headerName". Cela permet de lier deux entêtes de messages où l’utilisation de l’un des entêtes influe sur le comportement de l’autre.

L’élément "aliasHeader" peut contenir des éléments "aliasValue",e.g ,

<ximf:aliasHeader headerName="X-P772-Version" />
<ximf:aliasValue vame="1.0"/>
<ximf:aliasHeader>

==== Element aliasValue ====
L’élément "aliasValue" contient une valeur à associer à l’entête XIMF contrôlé par la règle. Il est utile lorsque deux entêtes sont liées (utilisation de l’attribut headerRef dans l’élément aliasHeader) et que les valeurs de l’entêtes de référence permettent de préciser celles de l’entête contrôlé.
Deux attributs précisent la balise "aliasValue" : "valueName", "valueRef", e.g.,

<ximf:aliasValue valueName="2" valueRef="flash" />

* Détails sur les attributs de l'élément "aliasValue" :
** L’attribut "valueName" définit la valeur de l’entête à créer. Cet attribut est obligatoire.
** L’attribut "valueRef" définit la valeur de l’entête XIMF de référence pour utiliser valueName.
<span style="color:red;">'''TODO :''' L'attribut valueRef est-il obligatoire ?</span>

==== Element compatibility ====
L’élément "compatibility" est utilisé pour associer à un entête respectant la norme XIMF un entête respectant une autre norme que XIMF (XSMTP par exemple).
Deux attributs précisent la balise "compatibility" : "targetName", "targetVersion", e.g.,

<ximf:compatibility targetName="X-SMTP" targetVersion="1.1">
<ximf:aliasValue headerName="X-P772-Version" content="1.1" />
<ximf:aliasValue
headerName="X-P772-Primary-Precedence"
headerRef="header-primary-precedence"
dataRef="data-priority-xsmtp"/>
</ximf:compatibility>

* Détails sur les attributs de l'élément "compatibility" :
** L’attribut "targetName" définit la norme de l’entête à associer à l’entête XIMF. Cet attribut est obligatoire.
** L’attribut "targetVersion" définit le numéro de version de la norme de l’entête à associer à l’entête XIMF. Cet attribut est obligatoire.

L’élément "compatibility" contient au moins un élément "aliasHeader".

<u>Pour illustrer cette règle :</u>
Le format XSMTP est déjà supporté par certains équipements. Afin de rendre ceux-ci inter opérables avec le nouveau format XIMF, cette règle permet d’associer un entête XSMTP contenant les mêmes informations qu’un entête XIMF.

L’élément Association : dépendance entre entêtes
L’élément "association" définie les valeurs autorisées pour un entête XIMF en fonction d’une valeur définie pour un autre entête XIMF.

<ximf:association>
<ximf:aliasHeader
headerName="X-XIMF-Primary-Precedence"
headerRef="X-XIMF-Correspondence-Type">
<ximf:aliasValue valueName="routine" valueRef="private" />
<ximf:aliasValue valueName="routine,priority" valueRef="professional" />
<ximf:aliasValue valueName="routine,priority,immediate,flash" valueRef="operational" />
<ximf:aliasValue valueName="routine,priority,immediate" valueRef="official" />
</ximf:aliasHeader>
</ximf:association>

==== Element secureHeaders ====
L’élément "secureHeaders" définie la liste des entêtes à intégrer dans la signature d’un message. Cette règle s’applique sur les équipements proposant un algorithme de signature des messages.

Un élément "secureHeaders" contient un ou plusieurs éléments "aliasHeaders" où chaque élément décrit un entête à intégrer dans la signature et complété d’un attribut "status".

<ximf:secureHeaders targetName="SecureHeaders">
<ximf:aliasHeader headerName="X-XIMF-Primary-Precedence" status="0" />
<ximf:aliasHeader headerName="X-XIMF-Copy-Precedence" status="0" />
</ximf:secureHeaders>

==== Element securityLabel ====
L’élément "securityLabel" définie la liste des entêtes à intégrer dans la signature d’un message. Cette règle s’applique sur les équipements proposant un algorithme de signature des messages selon la norme RFC.

Un élément "securityLabel" contient un ou plusieurs éléments "aliasHeaders" où chaque élément décrit un entête à intégrer dans la signature et complété d’un attribut "status".

<ximf:securityLabel targetName="SecurityLabel" id="Amoco">
<ximf:aliasHeader
headerName="SecurityPolicyIdentifier"
headerRef="X-XIMF-Security-Policy-Identifier" />
<ximf:aliasHeader
headerName="SecurityClassification"
headerRef="X-XIMF-Security-Classification-Identifier" />
<ximf:aliasHeader
headerName="ESSPrivacyMark"
headerRef="X-XIMF-Privacy-Mark" />
<ximf:aliasHeader
headerName="SecurityCategory"
headerRef="X-XIMF-Security-Categories-Identifier"
type="2" />
</ximf:securityLabel>

==== Element constraint ====
L’élément "constraint" est utilisé pour définir une règle de construction de deux entêtes partageant des "datas" identiques.
Trois attributs précisent la balise "constraint" : "left", "right", "operator", e.g.,

<ximf:constraint
left="header-primary-precedence"
operator="equalOrGreaterThan"
right="header-copy-precedence" />

* Détails sur les attributs de l'élément "constraint" :
** L’attribut "left" désigne le premier élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "right" désigne le deuxième élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "operator" indique la règle de poids à appliquer sur la valeur des deux éléments "header", il peut être de type "greaterThan", "lowerThan", "equalOrGreaterThan", "equalOrLowerThan", "equal". Cet attribut est obligatoire.

* Détails sur les valeurs possibles de l'attribut "type" :
** Le type "greaterThan" signifie que la valeur de l’élément "left" doit être strictement supérieur à la valeur de l’élément "right".
** Le type "lowerThan" signifie que la valeur de l’élément "left" doit être strictement inférieur à la valeur de l’élément "right".
** Le type "equalOrGreaterThan" signifie que la valeur de l’élément "left" doit être supérieur ou égale à la valeur de l’élément "right".
** Le type "equalOrLowerThan" signifie que la valeur de l’élément "left" doit être inférieur ou égale à la valeur de l’élément "right".
** Le type "equal" signifie que la valeur de l’élément "left" et de l’élément "right" doivent être identiques.

==== Element assignment ====
<div style="color:red;">'''TODO :''' L'élément assignment n'apparaît pas dans le shéma xml qui avait été envoyé.</div>

L’élément "assignement" est utilisé pour affecter une valeur créée en fonction d’une règle de comparaison sur les valeurs de deux éléments "header".
Quatre attributs précisent la balise "assignement" : "left", "right", "operator", "result", e.g.,

<ximf:assignment
left="header-primary-precedence"
operator="equal"
right="data-routine-precedence"
result="86400" />

* Détails sur les attributs de l'élément "assignment" :
** L’attribut "left" désigne le premier élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "right" désigne le deuxième élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "operator" indique la règle de comparaison entre les valeurs des deux éléments "header", il peut être de type "greaterThan", "lowerThan", "equalOrGreaterThan", "equalOrLowerThan", "equal". Cet attribut est obligatoire.
** L’attribut "result" représente la valeur à utiliser si la règle de comparaison entre les deux éléments est satisfaite. Cet attribut est obligatoire.

==== Element processing ====
L’élément "processing" regroupe des règles de traitement à effectuer sur des entêtes formatés.
L’attribut "type" précise le type de traitement à effectuer sur ces valeurs. Cet attribut est obligatoire, il est de type : "sign-header-value", "encrypt-header-value", "capitalize-header-value", e.g.,

<ximf:processing type="sign-header-value">
<ximf:refHeader>header-primary-precedence</ximf:refheader>
<ximf:refHeader>header-copy-precedence</ximf:refheader>
<ximf:refHeader>header-echange-type</ximf:refheader>
</ximf:processing>

* Détails sur les valeurs possibles de l'attribut "type" :
** Le type "sign-header-value" définit un traitement de signature des entêtes définis dans la balise.
** Le type "encrypt-header-value" définit un traitement de chiffrement des entêtes définis dans la balise.
** Le type "capitalize-header-value" définit un traitement de capitalisation des entêtes définis dans la balise.

L’élément "processing" contient au moins un élément "refHeader".
<div style="color:red;">'''TODO :'''L'élément refHeader n'est pas documenté, s'agit-il en fait de l'élément headerRef ?</div>

==== Element accessibility ====
<div style="color:red;">'''TODO :''' L'élément accessibility n'apparaît pas dans le shéma xml qui avait été envoyé.</div>
L’élément "accessibility" définit un ensemble de règles de droit d’accès aux éléments d’une instance pour une cible déterminée (utilisateur, routeur…).
Cet élément contient un ou plusieurs éléments "role".

<ximf:accessibility>
<ximf:role id="role-flash-allowed" aclLevel="100" />
<ximf:role id="role-flash-prohibited" aclLevel="50" />
</ximf:accessibility>

==== Element role ====
L’élément "role" positionne une valeur d’accès à pour une entité définit.
Deux attributs complètent l’élément "role" : "id", "aclLevel", e.g.,

<ximf:role id="role-flash-allowed" aclLevel="100" />

* Détails sur les attributs de l'élément "role" :
** L’attribut "id" précise l’entité accessible en fonction d’une valeur déterminée.
** L’attribut "aclLevel" précise la valeur seuil d’accès à l’entité.

==== Element custom ====
L’élément "custom" permet à l’auteur de créer des nouvelles règles personnalisées.
Trois attributs précisent la balise "custom" : "id", "provider", "description", e.g.,

<ximf:custom
id="custom-display"
provider="EADS"
description="Affichage de la composition du message" >
<node1><node2><node3></node3></node2></node1>
</ximf:custom>

* Détails sur les attributs de l'élément "custom" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "custom" et formaté selon la syntaxe "custom-xxx". Cet attribut est obligatoire.
** L’attribut "provider" identifie l’auteur de la règle. Cet attribut est obligatoire.
** L’attribut "description" permet d’ajouter un commentaire sur cet élément.

L’élément "custom" peut contenir tous les éléments possibles en respectant les standards XML.

XIMF XML tags/fr

2011-03-15T17:29:53Z

Anthonyjuge : /* Fichier headers */

== Introduction ==
Ce document propose un modèle de description, via eXtensible Markup Language (XML), d’entêtes de messages électroniques respectant la norme XIMF. Ce document a deux objectifs :
# Décrire les éléments et attributs de représentation XML pour construire des entêtes de messages électroniques de format XIMF.
# Fournir un modèle de représentation XIMF/XML.

<u>Rappel :</u>
* Un "élément" fait référence à tous les caractères situés entre une balise de départ et un balise de fin, e.g.,
<exemple> texte et/ou éléments fils </exemple>
* Un "attribut" est une composante d’un élément. Il est positionné dans la balise de départ, e.g.,
<exemple nom='value'>

Tous les éléments décrits dans cette documentation paragraphe sont validés dans l’espace de nom "ximf".

<pre>
xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://eads.org/ximf/ximf.xsd"
</pre>

== Description détaillée des balises XML ==

Voici, par ordre d'apparition et en fonction des fichiers, les balises génériques associées aux différents fichiers XML.

=== Fichier ximfmail-profile ===

<div style="color:red;">'''TODO''' :
* Combien d'éléments ihm sont autorisés dans un élément instance ?
* La documentation des fichiers ximfmail-profile.xml n'est pas disponible.
* Quel est le rôle de l'élément "acces" ?
* Quelle est l'utilité des identifiants associés aux éléments instance, shema, ihm, etc.
* Quelle est l'utilité de l'attribut name associé aux éléments instance. Y a-t-il une vérification s'assurant que les fichiers utilisés par une instance correspondent bien à l'instance à laquelle ils sont associés ?
</div>

Un fichier xpi peut contenir plusieurs instances XIMF, celles-ci sont alors regroupées dans une même catégorie. Le fichier ximfmail-profile contient des informations sur toutes les instances contenues dans le xpi, notamment leur nom, leur chemin d'accès, ainsi que les noms des fichiers associés à chaque instance.

==== Element instance ====
L’élément "instance" identifie l’ensemble des entêtes à décrire selon la norme XIMF. C’est le conteneur principal d’une instance XIMF/XML. Cinq attributs précisent la balise "instance" : "ximfVersion", "version", "author", "creation", "name", e.g.,
<ximf:instance name="myInstance" version="1.0" ximfVersion="2.0" >

* Détails sur les attributs de l'élément "instance" :
** L’attribut "name" définit le nom de l’instance décrite. Cet attribut est obligatoire.
** L’attribut "ximfVersion" définit le numéro de version des entêtes XIMF utilisés pour cette représentation. Cet attribut est obligatoire.
** L’attribut "version" définit le numéro de version de l’instance décrite. Cet attribut est obligatoire.
** L’attribut "author" renseigne sur le nom de l’auteur de cette instance.
** L’attribut "creationDate" précise la date de création de cette instance.

L’élément "instance" peut contenir un ou plusieurs éléments "schema", un ou plusieurs éléments "rule", un élément "ihm" et un élément "dictionary".

==== Element dictionary ====
L'élément dictionary contient le chemin vers le fichier spécifiant les données d'internationalisation (Cf. [[#Fichier_dictionary|Fichier dictionary]]).

==== Element schema ====
L'élément shema contient le chemin vers le fichier spécifiant les entêtes XIMF (Cf. [[#Fichier_headers|Fichier headers]]).

==== Element ihm ====
L'élément ihm contient le chemin vers le fichier spécifiant la disposition de l'interface des formulaires XIMF (Cf. [[#Fichier_ihm|Fichier ihm]]).

==== Element rule ====
L'élément rule contient le chemin vers le fichier spécifiant les règles associées aux valeurs des champs XIMF (Cf. [[#Fichier_rules|Fichier rules]]).

=== Fichier dictionary ===
Le fichier dictionnary permet de mettre en œuvre l’internationalisation d’une instance XIMF. Il défini des dictionnaires qui servent à traduire les éléments de l'instance XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient un élément "ximf:dictionnary".

==== Element dictionary ====
<div style="color:red;">'''TODO''' :
* Quel est l'intérêt de renseigner un attribut "id" à l'élément "dictionary" (étant donné qu'un seul élément "dictionary est autorisé dans l'élément "instance") ?</div>

L’élément "dictionary" contient toutes les informations devant être interprétées selon le pays d’utilisation.
L’élément "dictionary" contient un ou plusieurs mêmes éléments "locale", e.g.,

<ximf:dictionary>
<ximf:locale lang="fr-FR" />
<ximf:locale lang="en-US" />
</ximf:dictionary>

==== Element locale ====
L’élément "locale" contient toutes les informations pour un pays et/ou langue désignée.
L’élément "locale" contient un ou plusieurs mêmes éléments "ilk", e.g.,

<ximf:locale lang="fr-FR" >
<ximf:ilk entity="a"/>
<ximf:ilk entity="b"/>
</ximf:locale>

* Détails sur les attributs de la balise "locale" :
** L’attribut "lang" définit le code pays de ce conteneur. Il devrai être construit selon le format défini par la RFC1766 (fr, en, ja, es, …).

==== Element ilk ====
L’élément "ilk" contient une unique information correspondant à une donnée traduite selon le code pays de l’élément père. Cette information est au format chaîne de caractère. Un attribut obligatoire précise la balise "ilk".

<ximf:ilk entity="ilk-lang-ihm">langue</ximf:ilk>

* Détails sur les attributs de la balise "ilk" :
** L’attribut "entity" définit la référence d’entrée pour récupérer le contenu de l’élément selon le code pays souhaité.

Finalement, le fichier "dictionary" pourra contenir :
<ximf:instance name="Whirlpool">
<ximf:dictionary>
<ximf:locale lang="fr-FR" >
<ximf:ilk entity="ilk-lang-ihm">Français</ximf:ilk>
<ximf:ilk entity="ilk-exemple-general">Général</ximf:ilk>
</ximf:locale>
<ximf:locale lang="en-US" >
<ximf:ilk entity="ilk-lang-ihm">English (US)</ximf:ilk>
<ximf:ilk entity="ilk-exemple-general">General</ximf:ilk>
</ximf:locale>
</ximf:dictionary>
</ximf:instance>

=== Fichier ihm ===
<span style="color:red;">'''TODO''' : La documentation originale ne décrit pas le fichier ihm, les informations ci-dessous ont seulement été présumées. Merci de les vérifier/compléter.
</span>

Le fichier ihm spécifie l'agencement de l'interface des formulaires XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient un élément "ximf:ihm".

==== Element ihm ====
L'élément "ihm" contient un ou plusieurs éléments "panel" et un élément "treeRcv".

==== Element panel ====
Un élément ximf:panel correspond à un onglet du formulaire XIMF construit.
Deux attributs précisent la balise "panel" : "id" et "ilk", eg.
<ximf:panel id="pane_security" ilk="ilk-priority-panel" />

* Détails sur les attributs de l'élément "panel" :
** L’attribut "id" définit le nom de l'onglet, il doit être unique pour chaque élément "ximf:panel" et est formaté selon la syntaxe "pane-xxx". Cet attribut est obligatoire.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.

L'élément "ximf:panel" contient au moins un éléments "ximf:groupbox".

==== Element groupbox ====
Un élément groupbox correspond à une sous catégorie d'un onglet du formulaire XIMF.
La structure "groupbox" détaille l’ordre d’affichage des entêtes dans un message.
Deux attributs précisent la balise "ximf:groupbox" : "id" et "ilk", eg.
<ximf:groupbox id="group-classification" ilk="ilk-secu-box" />

* Détails sur les attributs de l'élément "groupbox" :
** L’attribut "id" définit le nom de l'onglet, il doit être unique pour chaque élément "ximf:panel" et est formaté selon la syntaxe "pane-xxx". Cet attribut est obligatoire.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.

L'élément "groupbox" contient au moins un éléments "headerRef".

==== Element treeRcv ====
L'élément "treeRcv" permet de spécifier quelles sont les colonnes susceptibles d'être ajoutées dans le panneau principal du client de messagerie qui contient la liste des messages d’un dossier.

L'élément "treeRcv" peut contenir des éléments "headerRef".

==== Element headerRef ====
L'élément headerRef spécifie les champs associés à chaque sous-groupe d'onglet de formulaire ou les champs qu'il est possible d'afficher dans la liste des messages.
Aucun attribut ne vient compléter la balise "headerRef", eg.
<ximf:headerRef>header-classification</ximf:headerRef>

Finalement, le fichier "ihm" pourra contenir :
<pre>
<ximf:instance name="Amoco">
<ximf:ihm>
<ximf:panel id="pane_security" ilk="ilk-priority-panel">
<ximf:groupbox id="group-classification" ilk="ilk-secu-box">
<ximf:headerRef>header-correspondance-type</ximf:headerRef>
<ximf:headerRef>header-classification</ximf:headerRef>
</ximf:groupbox>
</ximf:panel>
<ximf:treeRcv>
<ximf:headerRef>header-classification</ximf:headerRef>
</ximf:treeRcv>
</ximf:ihm>
</ximf:instance>
</pre>

=== Fichier headers ===
Le fichier headers spécifie les types des champs de l'interface des formulaires XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient des éléments "header".

<div style="color:red">'''TODO :'''
Il semble que les fichiers headers définissent des champs d'entête devant être envoyés alors que ces mêmes entêtes ne sont pas spécifiés dans le fichier ihm. Ce comportement est logique, en effet, l'utilisateur n'a pas forcément besoin de savoir tout ce qui est envoyé via le formulaire.

Comment intégrer un header (nommé aussi header technique) dans le message sans qu'il soit affiché dans le formulaire XIMF de l'IHM ?

</div>

==== Element header ====
Chaque élément "header" décrit un entête de message de format XIMF.
Huit attributs précisent la balise "header" : "headerName", "id", "technicalHeaderName", "type", "technicalType", "isMandatory", "ilk", "description", e.g.,

<div style="color:red;">'''TODO :'''
Comment est effectuée la vérification de l'attribut isMandatory et quelles sont les conditions de fonctionnement de celui-ci ? Est-il possible, par exemple, de spécifier l'attribut isMandatory=true d'un élément header si le contenu de celui-ci est un élément « set » qui dispose des attributs minItem et maxItem ? Actuellement, lorsque l'on crée un élément set avec les attributs minItem et maxItem, le champ du formulaire associé ne peux pas être validé : e.g.,
<ximf:set id="value-amoco-classification" minItem="1" maxItem="64" separator=";" technicalSeparator=".">
</div>

<ximf:header id="header-primary-precedence"
headerName="X-XIMF-Primary-Precedence"
ilk="ilk-primary-precedence"
isMandatory="true"
description="entête d’urgence"
type="string" />

* Détails sur les attributs de l'élément "header" :
** L’attribut "headerName" définit le nom du champ XIMF. Cet attribut est obligatoire.
** L’attribut "id" définit un identifiant de champ, il doit être unique pour chaque élément "header" et est formaté selon la syntaxe "header-xxx". Cet attribut est obligatoire.
** L’attribut "isMandatory" précise si ce champ doit être obligatoirement présent dans le message intégrant les entêtes selon cette description.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.
** L’attribut "type" précise le format des données associées à cet élément. Ce format peut être une date, une chaîne, une adresse mail, un O.I.D.
** L’attribut "technicalHeaderName" permet de compléter l’entête décrit par un autre entête.
** L’attribut "technicalType" précise le format des données associées à l’élément technicalHeaderName.
** L’attribut "description" permet d’ajouter une information sur cet élément.

L’élément "header" contient obligatoirement un élément "set", "multiset", "string", ou "compstring", e.g.,

<ximf:header id="header-reply-by"
headerName="X-XIMF-Reply-By"
ilk="ilk-reply-by"
isMandatory="false" >
<ximf:string id="value-reply-by" editable="true" />
</ximf:header>

<div style="color:red;">
'''TODO :''' Quelles sont les contraintes associées à l'attribut type d'un élément header ?
</div>

==== Element string ====
L’élément "string" précise le contenu d’une ressource de type chaîne de caractères imprimables (a-z, A-Z, 1-9,…)
Quinze attributs complètent l’élément "string" : "id", "ref", "ilk", "aclLevel", "index", "description", "editable", "content", "technicalContent","maxItem", "minItem", "maxLength", "minLength", "separator", "technicalSeparator", e.g.,

<ximf:string ilk="ilk-france" content="FRA" />

* Détails sur les attributs de l'élément "string" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "string".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role| élément role]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut " description " permet d’associer un commentaire sur cette donnée.
** L’attribut "editable" définit une valeur de saisie (champ libre). Cet attribut est de type booléen.
** L’attribut "content" représente la valeur effective de la donnée. C’est cette donnée qui sera associée au champ XIMF créé.
** L’attribut "technicalContent" représente la valeur effective de la donnée technique. C’est cette donnée qui sera associée au champ technique XIMF créé (cf. attribut technicalHeaderName de l’élément "header".
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.

L’élément "string" peut contenir plusieurs éléments "linkedValue".

<ximf:string ilk="ilk-non-protege" content="NON PROTEGE" technicalContent="1" >
<ximf:linkedValue ref="value-non-protege-france " />
</ximf:string>

==== Element compstring ====
<div style="color:red;">
'''TODO :''' L'attribut de l'élément « compstring » nommé « contentFactorise » devrait s'appeler « contentFactorize ».
</div>
L’élément "compstring" décrit un conteneur de concaténation des éléments fils. Il permet notamment de créer des valeurs d’entêtes composées.
Dix-sept attributs complètent l’élément "compstring" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", "content", "technicalContent", "contentPositionEnd", "contentFactorise", "technicalPositionEnd", e.g.,

<ximf:compstring
ilk="ilk-special"
content="SPECIAL"
technicalContent="1.3.4"
separator=" "
technicalSeparator=".">

* Détails sur les attributs de l'élément "compstring" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "compstring".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (cf. [[#Element_role| élément "role"]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut " description " permet d’associer un commentaire sur cette donnée.
** L’attribut "content" représente la valeur effective de la donnée. C’est cette donnée qui sera associée au champ XIMF créé.
** L’attribut "technicalContent" représente la valeur effective de la donnée technique. C’est cette donnée qui sera associée au champ technique XIMF créé (cf. attribut technicalHeaderName de l’élément "header".
** L’attribut "separator" définit le caractère de séparation entre deux valeurs.
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "contentPositionEnd" impose de positionner le contenu de l’élément "compstring" après les valeurs des éléments fils : valuefils1,valuefils2 : valuecompstring.
** L’attribut "technicalPositionEnd" impose de positionner le contenu de l’élément "compstring" après les valeurs des éléments fils.
** L’attribut "contentFactorise" impose d’utiliser le contenu de l’élément "compstring" comme facteur des éléments fils : valuecompstring(valuefils1,valuefils2).

L’élément "compstring" peut contenir un élément "string" ou "set" ou "multiset" ou plusieurs éléments "compstring".

<ximf:compstring
ilk="ilk-special"
content="SPECIAL"
technicalContent="1.3.4"
separator=" "
technicalSeparator=".">
<ximf:set id="ilk-special-op " maxItem="64">
<ximf:string ilk="ilk-special-op1" content="OP1" technicalContent="1" />
<ximf:string ilk="ilk-special-op2" content="OP2" technicalContent="2" />
<ximf:string ilk="ilk-special-op3" content="OP3" technicalContent="3" />
</ximf:set>
</ximf:compstring>

==== Element set ====
L’élément "set" décrit un conteneur de ressources de même type. Cet élément autorise la sélection de plusieurs ressources mais chaque ressource est sélectionnée une seule fois.
Douze attributs précisent la description de la balise "set" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", e.g.,

<ximf:set id="value-categories" ref="value-mentions" maxItem="64" separator=";" />

* Détails sur les attributs de l'élément "set" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "ximf:set".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role|élément rôle]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut "description" permet d’associer un commentaire sur cette donnée.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs

L’élément "set" peut contenir un ou plusieurs éléments "string" ou un ou plusieurs éléments "compstring".

<ximf:set id="value-categories" minItem="1" maxItem="64" separator=";">
<ximf:string ilk="ilk-releasable-to" content="RELEASABLE TO " />
<ximf:string ilk="ilk-eyes-only" content=" EYES ONLY"/>
<ximf:string ilk="ilk-use-only" content=" USE ONLY"/>
</ximf:set>

<div style="color:red;">'''TODO :'''
* Y a-t-il une définition des fichiers associés aux instances XIMF (e.g, le fichier attribution-list.xml utilisé dans l'instance Caterpillar) ?
* Comment le moteur XIMF sait qu'un élément est une "attribution-list" ?
</div>

==== Element multiset ====
L’élément "multiset" décrit un conteneur de ressources de même type. Cet élément autorise la sélection de plusieurs ressources et chaque ressource peut être sélectionnée plusieurs fois.
Douze attributs précisent la description de la balise "multiset" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", e.g.,

<ximf:multiset
id="value-restricted"
ilk=" value-restricted-otan"
maxItem="64"
separator=";" />

* Détails sur les attributs de l'élément "multiset" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "multiset".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role|élément rôle]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut "description" permet d’associer un commentaire sur cette donnée.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs

L’élément "multiset" peut contenir un ou plusieurs éléments "string" ou un ou plusieurs éléments "compstring".

<ximf:multiset id="value-restricted-otan-categories" minItem="1" maxItem="64" separator=";" >
<ximf:string ilk="ilk-releasable-to" content="RELEASABLE TO "/>
<ximf:string ilk="ilk-eyes-only" content=" EYES ONLY"/>
<ximf:string ilk="ilk-use-only" content=" USE ONLY"/>
</ximf:multiset>

<span style="color:red;">'''TODO ''': Comment sont gérées les règles associées aux champs multivaleurs (disposant par exemple des attributs minItem/maxItem ou les champs multiset) ?</span>

==== Element linkedValue ====
L’élément "linkedValue" définit une référence sur une ressource de type conteneur ("set", "multiset") ou "string". Cette ressource devrait être utilisée si la ressource contenant "linkedValue" (noeud parent) est sélectionnée.
Un attribut précise la balise "linkvalue" : "ref", e.g.,

<ximf:linkedValue ref="value-restricted-otan-classification-id" />

* Détails sur les attributs de l'élément "linkedValue" :
** L’attribut "ref" précise la valeur de l’attribut "id" de la ressource cible. Cet attribut est obligatoire.

=== Fichier rules ===
Le fichier rules définit les règles de contrôles d’entêtes XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui peut contenir des éléments "ximf:rule".

==== Element rule ====
<div style="color:red">
'''TODO :''' Mettre à jour la documentation :
* Les éléments autorisés dans un élément « rule » ne sont plus à jour. La présente documentation spécifie 12 éléments : AliasHeader, AliasValue, Compatibility, Association, SecureHeaders, SecurityLabel, Constraint, Assignment, Processing, Accessibility, Role et Custom. Le schéma XML fourni avec le mail en spécifie 5 : Constraint, Processing, Compatibility, Policy et Custom et place les autres en tant qu'extentions des 5 éléments cités précédemment.
* Les éléments SecureHeaders et SecurityLabel associés à l'élément « rule » ne figurent pas dans la nouvelle version du shéma xml. On les retrouve dans les fichiers rules-*.xml mais les éléments sont commentés, ils sont, de plus, présents dans une autre instance : comment ces éléments sont utilisés dans Trustedbird ?
* L'élément ximf:classificationPictures n'est pas documenté. De plus, il serait bon d'avoir des précisions sur la raison qui a motivé l'ajout de cet élément dans les fichiers de règles (alors qu'il semblerait être plus adapté au fichier headers-*.xml).
</div>
L’élément "rule" est le conteneur principal de description d’un comportement particulier à appliquer sur un ensemble d’entêtes XIMF.
Trois attributs précisent la balise "rule" : "id", "agent", "description", e.g.,
<ximf:rule id="compatibility-rule" description="Règle sur la compatibilité X-SMTP / XIMF" >

* Détails sur les attributs de l'élément "rule" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "rule". Cet attribut est obligatoire.
** L’attribut "agent" indique l’équipement cible devant analyser et appliquer le contenu de cet élément.
** L’attribut "description" autorise l’auteur d’ajouter un commentaire sur cet élément.

L’élément "rule" contient un ou plusieurs mêmes éléments de spécialisation de la règle "contraint", "assignement", "processing", "compatibility", "accessibility", "custom",…, e.g.,

<ximf:rule id="precedence-rule" agent="mua" description="Règle sur les priorités">
<ximf:constraint
left="header-primary-precedence"
operator="equalOrGreaterThan"
right="header-copy-precedence" />
</ximf:rule>

==== Element aliasHeader ====
L’élément "aliasHeader" permet de définir le nom de l’entête sur lequel la règle précisée est appliquée
Deux attributs précisent la balise "aliasHeader" : "headerName" et "headerRef", e.g.,

<ximf:aliasHeader headerName ="X-P772-Version" headerRef="X-XIMF-VERSION" />

* Détails sur les attributs de l'élément "aliasHeader" :
* L’attribut "headerName" définit le nom XIMF de l’entête modifié par la règle. Cet attribut est obligatoire.
* L’attribut "headerRef" définit le nom d’un entête XIMF de référence qui est le point d’entrée de l’application de la règle sur l’entête définit par "headerName". Cela permet de lier deux entêtes de messages où l’utilisation de l’un des entêtes influe sur le comportement de l’autre.

L’élément "aliasHeader" peut contenir des éléments "aliasValue",e.g ,

<ximf:aliasHeader headerName="X-P772-Version" />
<ximf:aliasValue vame="1.0"/>
<ximf:aliasHeader>

==== Element aliasValue ====
L’élément "aliasValue" contient une valeur à associer à l’entête XIMF contrôlé par la règle. Il est utile lorsque deux entêtes sont liées (utilisation de l’attribut headerRef dans l’élément aliasHeader) et que les valeurs de l’entêtes de référence permettent de préciser celles de l’entête contrôlé.
Deux attributs précisent la balise "aliasValue" : "valueName", "valueRef", e.g.,

<ximf:aliasValue valueName="2" valueRef="flash" />

* Détails sur les attributs de l'élément "aliasValue" :
** L’attribut "valueName" définit la valeur de l’entête à créer. Cet attribut est obligatoire.
** L’attribut "valueRef" définit la valeur de l’entête XIMF de référence pour utiliser valueName.
<span style="color:red;">'''TODO :''' L'attribut valueRef est-il obligatoire ?</span>

==== Element compatibility ====
L’élément "compatibility" est utilisé pour associer à un entête respectant la norme XIMF un entête respectant une autre norme que XIMF (XSMTP par exemple).
Deux attributs précisent la balise "compatibility" : "targetName", "targetVersion", e.g.,

<ximf:compatibility targetName="X-SMTP" targetVersion="1.1">
<ximf:aliasValue headerName="X-P772-Version" content="1.1" />
<ximf:aliasValue
headerName="X-P772-Primary-Precedence"
headerRef="header-primary-precedence"
dataRef="data-priority-xsmtp"/>
</ximf:compatibility>

* Détails sur les attributs de l'élément "compatibility" :
** L’attribut "targetName" définit la norme de l’entête à associer à l’entête XIMF. Cet attribut est obligatoire.
** L’attribut "targetVersion" définit le numéro de version de la norme de l’entête à associer à l’entête XIMF. Cet attribut est obligatoire.

L’élément "compatibility" contient au moins un élément "aliasHeader".

<u>Pour illustrer cette règle :</u>
Le format XSMTP est déjà supporté par certains équipements. Afin de rendre ceux-ci inter opérables avec le nouveau format XIMF, cette règle permet d’associer un entête XSMTP contenant les mêmes informations qu’un entête XIMF.

L’élément Association : dépendance entre entêtes
L’élément "association" définie les valeurs autorisées pour un entête XIMF en fonction d’une valeur définie pour un autre entête XIMF.

<ximf:association>
<ximf:aliasHeader
headerName="X-XIMF-Primary-Precedence"
headerRef="X-XIMF-Correspondence-Type">
<ximf:aliasValue valueName="routine" valueRef="private" />
<ximf:aliasValue valueName="routine,priority" valueRef="professional" />
<ximf:aliasValue valueName="routine,priority,immediate,flash" valueRef="operational" />
<ximf:aliasValue valueName="routine,priority,immediate" valueRef="official" />
</ximf:aliasHeader>
</ximf:association>

==== Element secureHeaders ====
L’élément "secureHeaders" définie la liste des entêtes à intégrer dans la signature d’un message. Cette règle s’applique sur les équipements proposant un algorithme de signature des messages.

Un élément "secureHeaders" contient un ou plusieurs éléments "aliasHeaders" où chaque élément décrit un entête à intégrer dans la signature et complété d’un attribut "status".

<ximf:secureHeaders targetName="SecureHeaders">
<ximf:aliasHeader headerName="X-XIMF-Primary-Precedence" status="0" />
<ximf:aliasHeader headerName="X-XIMF-Copy-Precedence" status="0" />
</ximf:secureHeaders>

==== Element securityLabel ====
L’élément "securityLabel" définie la liste des entêtes à intégrer dans la signature d’un message. Cette règle s’applique sur les équipements proposant un algorithme de signature des messages selon la norme RFC.

Un élément "securityLabel" contient un ou plusieurs éléments "aliasHeaders" où chaque élément décrit un entête à intégrer dans la signature et complété d’un attribut "status".

<ximf:securityLabel targetName="SecurityLabel" id="Amoco">
<ximf:aliasHeader
headerName="SecurityPolicyIdentifier"
headerRef="X-XIMF-Security-Policy-Identifier" />
<ximf:aliasHeader
headerName="SecurityClassification"
headerRef="X-XIMF-Security-Classification-Identifier" />
<ximf:aliasHeader
headerName="ESSPrivacyMark"
headerRef="X-XIMF-Privacy-Mark" />
<ximf:aliasHeader
headerName="SecurityCategory"
headerRef="X-XIMF-Security-Categories-Identifier"
type="2" />
</ximf:securityLabel>

==== Element constraint ====
L’élément "constraint" est utilisé pour définir une règle de construction de deux entêtes partageant des "datas" identiques.
Trois attributs précisent la balise "constraint" : "left", "right", "operator", e.g.,

<ximf:constraint
left="header-primary-precedence"
operator="equalOrGreaterThan"
right="header-copy-precedence" />

* Détails sur les attributs de l'élément "constraint" :
** L’attribut "left" désigne le premier élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "right" désigne le deuxième élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "operator" indique la règle de poids à appliquer sur la valeur des deux éléments "header", il peut être de type "greaterThan", "lowerThan", "equalOrGreaterThan", "equalOrLowerThan", "equal". Cet attribut est obligatoire.

* Détails sur les valeurs possibles de l'attribut "type" :
** Le type "greaterThan" signifie que la valeur de l’élément "left" doit être strictement supérieur à la valeur de l’élément "right".
** Le type "lowerThan" signifie que la valeur de l’élément "left" doit être strictement inférieur à la valeur de l’élément "right".
** Le type "equalOrGreaterThan" signifie que la valeur de l’élément "left" doit être supérieur ou égale à la valeur de l’élément "right".
** Le type "equalOrLowerThan" signifie que la valeur de l’élément "left" doit être inférieur ou égale à la valeur de l’élément "right".
** Le type "equal" signifie que la valeur de l’élément "left" et de l’élément "right" doivent être identiques.

==== Element assignment ====
<div style="color:red;">'''TODO :''' L'élément assignment n'apparaît pas dans le shéma xml qui avait été envoyé.</div>

L’élément "assignement" est utilisé pour affecter une valeur créée en fonction d’une règle de comparaison sur les valeurs de deux éléments "header".
Quatre attributs précisent la balise "assignement" : "left", "right", "operator", "result", e.g.,

<ximf:assignment
left="header-primary-precedence"
operator="equal"
right="data-routine-precedence"
result="86400" />

* Détails sur les attributs de l'élément "assignment" :
** L’attribut "left" désigne le premier élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "right" désigne le deuxième élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "operator" indique la règle de comparaison entre les valeurs des deux éléments "header", il peut être de type "greaterThan", "lowerThan", "equalOrGreaterThan", "equalOrLowerThan", "equal". Cet attribut est obligatoire.
** L’attribut "result" représente la valeur à utiliser si la règle de comparaison entre les deux éléments est satisfaite. Cet attribut est obligatoire.

==== Element processing ====
L’élément "processing" regroupe des règles de traitement à effectuer sur des entêtes formatés.
L’attribut "type" précise le type de traitement à effectuer sur ces valeurs. Cet attribut est obligatoire, il est de type : "sign-header-value", "encrypt-header-value", "capitalize-header-value", e.g.,

<ximf:processing type="sign-header-value">
<ximf:refHeader>header-primary-precedence</ximf:refheader>
<ximf:refHeader>header-copy-precedence</ximf:refheader>
<ximf:refHeader>header-echange-type</ximf:refheader>
</ximf:processing>

* Détails sur les valeurs possibles de l'attribut "type" :
** Le type "sign-header-value" définit un traitement de signature des entêtes définis dans la balise.
** Le type "encrypt-header-value" définit un traitement de chiffrement des entêtes définis dans la balise.
** Le type "capitalize-header-value" définit un traitement de capitalisation des entêtes définis dans la balise.

L’élément "processing" contient au moins un élément "refHeader".
<div style="color:red;">'''TODO :'''L'élément refHeader n'est pas documenté, s'agit-il en fait de l'élément headerRef ?</div>

==== Element accessibility ====
<div style="color:red;">'''TODO :''' L'élément accessibility n'apparaît pas dans le shéma xml qui avait été envoyé.</div>
L’élément "accessibility" définit un ensemble de règles de droit d’accès aux éléments d’une instance pour une cible déterminée (utilisateur, routeur…).
Cet élément contient un ou plusieurs éléments "role".

<ximf:accessibility>
<ximf:role id="role-flash-allowed" aclLevel="100" />
<ximf:role id="role-flash-prohibited" aclLevel="50" />
</ximf:accessibility>

==== Element role ====
L’élément "role" positionne une valeur d’accès à pour une entité définit.
Deux attributs complètent l’élément "role" : "id", "aclLevel", e.g.,

<ximf:role id="role-flash-allowed" aclLevel="100" />

* Détails sur les attributs de l'élément "role" :
** L’attribut "id" précise l’entité accessible en fonction d’une valeur déterminée.
** L’attribut "aclLevel" précise la valeur seuil d’accès à l’entité.

==== Element custom ====
L’élément "custom" permet à l’auteur de créer des nouvelles règles personnalisées.
Trois attributs précisent la balise "custom" : "id", "provider", "description", e.g.,

<ximf:custom
id="custom-display"
provider="EADS"
description="Affichage de la composition du message" >
<node1><node2><node3></node3></node2></node1>
</ximf:custom>

* Détails sur les attributs de l'élément "custom" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "custom" et formaté selon la syntaxe "custom-xxx". Cet attribut est obligatoire.
** L’attribut "provider" identifie l’auteur de la règle. Cet attribut est obligatoire.
** L’attribut "description" permet d’ajouter un commentaire sur cet élément.

L’élément "custom" peut contenir tous les éléments possibles en respectant les standards XML.

XIMF XML tags/fr

2011-03-15T17:28:20Z

Anthonyjuge : /* Fichier headers */

== Introduction ==
Ce document propose un modèle de description, via eXtensible Markup Language (XML), d’entêtes de messages électroniques respectant la norme XIMF. Ce document a deux objectifs :
# Décrire les éléments et attributs de représentation XML pour construire des entêtes de messages électroniques de format XIMF.
# Fournir un modèle de représentation XIMF/XML.

<u>Rappel :</u>
* Un "élément" fait référence à tous les caractères situés entre une balise de départ et un balise de fin, e.g.,
<exemple> texte et/ou éléments fils </exemple>
* Un "attribut" est une composante d’un élément. Il est positionné dans la balise de départ, e.g.,
<exemple nom='value'>

Tous les éléments décrits dans cette documentation paragraphe sont validés dans l’espace de nom "ximf".

<pre>
xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://eads.org/ximf/ximf.xsd"
</pre>

== Description détaillée des balises XML ==

Voici, par ordre d'apparition et en fonction des fichiers, les balises génériques associées aux différents fichiers XML.

=== Fichier ximfmail-profile ===

<div style="color:red;">'''TODO''' :
* Combien d'éléments ihm sont autorisés dans un élément instance ?
* La documentation des fichiers ximfmail-profile.xml n'est pas disponible.
* Quel est le rôle de l'élément "acces" ?
* Quelle est l'utilité des identifiants associés aux éléments instance, shema, ihm, etc.
* Quelle est l'utilité de l'attribut name associé aux éléments instance. Y a-t-il une vérification s'assurant que les fichiers utilisés par une instance correspondent bien à l'instance à laquelle ils sont associés ?
</div>

Un fichier xpi peut contenir plusieurs instances XIMF, celles-ci sont alors regroupées dans une même catégorie. Le fichier ximfmail-profile contient des informations sur toutes les instances contenues dans le xpi, notamment leur nom, leur chemin d'accès, ainsi que les noms des fichiers associés à chaque instance.

==== Element instance ====
L’élément "instance" identifie l’ensemble des entêtes à décrire selon la norme XIMF. C’est le conteneur principal d’une instance XIMF/XML. Cinq attributs précisent la balise "instance" : "ximfVersion", "version", "author", "creation", "name", e.g.,
<ximf:instance name="myInstance" version="1.0" ximfVersion="2.0" >

* Détails sur les attributs de l'élément "instance" :
** L’attribut "name" définit le nom de l’instance décrite. Cet attribut est obligatoire.
** L’attribut "ximfVersion" définit le numéro de version des entêtes XIMF utilisés pour cette représentation. Cet attribut est obligatoire.
** L’attribut "version" définit le numéro de version de l’instance décrite. Cet attribut est obligatoire.
** L’attribut "author" renseigne sur le nom de l’auteur de cette instance.
** L’attribut "creationDate" précise la date de création de cette instance.

L’élément "instance" peut contenir un ou plusieurs éléments "schema", un ou plusieurs éléments "rule", un élément "ihm" et un élément "dictionary".

==== Element dictionary ====
L'élément dictionary contient le chemin vers le fichier spécifiant les données d'internationalisation (Cf. [[#Fichier_dictionary|Fichier dictionary]]).

==== Element schema ====
L'élément shema contient le chemin vers le fichier spécifiant les entêtes XIMF (Cf. [[#Fichier_headers|Fichier headers]]).

==== Element ihm ====
L'élément ihm contient le chemin vers le fichier spécifiant la disposition de l'interface des formulaires XIMF (Cf. [[#Fichier_ihm|Fichier ihm]]).

==== Element rule ====
L'élément rule contient le chemin vers le fichier spécifiant les règles associées aux valeurs des champs XIMF (Cf. [[#Fichier_rules|Fichier rules]]).

=== Fichier dictionary ===
Le fichier dictionnary permet de mettre en œuvre l’internationalisation d’une instance XIMF. Il défini des dictionnaires qui servent à traduire les éléments de l'instance XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient un élément "ximf:dictionnary".

==== Element dictionary ====
<div style="color:red;">'''TODO''' :
* Quel est l'intérêt de renseigner un attribut "id" à l'élément "dictionary" (étant donné qu'un seul élément "dictionary est autorisé dans l'élément "instance") ?</div>

L’élément "dictionary" contient toutes les informations devant être interprétées selon le pays d’utilisation.
L’élément "dictionary" contient un ou plusieurs mêmes éléments "locale", e.g.,

<ximf:dictionary>
<ximf:locale lang="fr-FR" />
<ximf:locale lang="en-US" />
</ximf:dictionary>

==== Element locale ====
L’élément "locale" contient toutes les informations pour un pays et/ou langue désignée.
L’élément "locale" contient un ou plusieurs mêmes éléments "ilk", e.g.,

<ximf:locale lang="fr-FR" >
<ximf:ilk entity="a"/>
<ximf:ilk entity="b"/>
</ximf:locale>

* Détails sur les attributs de la balise "locale" :
** L’attribut "lang" définit le code pays de ce conteneur. Il devrai être construit selon le format défini par la RFC1766 (fr, en, ja, es, …).

==== Element ilk ====
L’élément "ilk" contient une unique information correspondant à une donnée traduite selon le code pays de l’élément père. Cette information est au format chaîne de caractère. Un attribut obligatoire précise la balise "ilk".

<ximf:ilk entity="ilk-lang-ihm">langue</ximf:ilk>

* Détails sur les attributs de la balise "ilk" :
** L’attribut "entity" définit la référence d’entrée pour récupérer le contenu de l’élément selon le code pays souhaité.

Finalement, le fichier "dictionary" pourra contenir :
<ximf:instance name="Whirlpool">
<ximf:dictionary>
<ximf:locale lang="fr-FR" >
<ximf:ilk entity="ilk-lang-ihm">Français</ximf:ilk>
<ximf:ilk entity="ilk-exemple-general">Général</ximf:ilk>
</ximf:locale>
<ximf:locale lang="en-US" >
<ximf:ilk entity="ilk-lang-ihm">English (US)</ximf:ilk>
<ximf:ilk entity="ilk-exemple-general">General</ximf:ilk>
</ximf:locale>
</ximf:dictionary>
</ximf:instance>

=== Fichier ihm ===
<span style="color:red;">'''TODO''' : La documentation originale ne décrit pas le fichier ihm, les informations ci-dessous ont seulement été présumées. Merci de les vérifier/compléter.
</span>

Le fichier ihm spécifie l'agencement de l'interface des formulaires XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient un élément "ximf:ihm".

==== Element ihm ====
L'élément "ihm" contient un ou plusieurs éléments "panel" et un élément "treeRcv".

==== Element panel ====
Un élément ximf:panel correspond à un onglet du formulaire XIMF construit.
Deux attributs précisent la balise "panel" : "id" et "ilk", eg.
<ximf:panel id="pane_security" ilk="ilk-priority-panel" />

* Détails sur les attributs de l'élément "panel" :
** L’attribut "id" définit le nom de l'onglet, il doit être unique pour chaque élément "ximf:panel" et est formaté selon la syntaxe "pane-xxx". Cet attribut est obligatoire.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.

L'élément "ximf:panel" contient au moins un éléments "ximf:groupbox".

==== Element groupbox ====
Un élément groupbox correspond à une sous catégorie d'un onglet du formulaire XIMF.
La structure "groupbox" détaille l’ordre d’affichage des entêtes dans un message.
Deux attributs précisent la balise "ximf:groupbox" : "id" et "ilk", eg.
<ximf:groupbox id="group-classification" ilk="ilk-secu-box" />

* Détails sur les attributs de l'élément "groupbox" :
** L’attribut "id" définit le nom de l'onglet, il doit être unique pour chaque élément "ximf:panel" et est formaté selon la syntaxe "pane-xxx". Cet attribut est obligatoire.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.

L'élément "groupbox" contient au moins un éléments "headerRef".

==== Element treeRcv ====
L'élément "treeRcv" permet de spécifier quelles sont les colonnes susceptibles d'être ajoutées dans le panneau principal du client de messagerie qui contient la liste des messages d’un dossier.

L'élément "treeRcv" peut contenir des éléments "headerRef".

==== Element headerRef ====
L'élément headerRef spécifie les champs associés à chaque sous-groupe d'onglet de formulaire ou les champs qu'il est possible d'afficher dans la liste des messages.
Aucun attribut ne vient compléter la balise "headerRef", eg.
<ximf:headerRef>header-classification</ximf:headerRef>

Finalement, le fichier "ihm" pourra contenir :
<pre>
<ximf:instance name="Amoco">
<ximf:ihm>
<ximf:panel id="pane_security" ilk="ilk-priority-panel">
<ximf:groupbox id="group-classification" ilk="ilk-secu-box">
<ximf:headerRef>header-correspondance-type</ximf:headerRef>
<ximf:headerRef>header-classification</ximf:headerRef>
</ximf:groupbox>
</ximf:panel>
<ximf:treeRcv>
<ximf:headerRef>header-classification</ximf:headerRef>
</ximf:treeRcv>
</ximf:ihm>
</ximf:instance>
</pre>

=== Fichier headers ===
Le fichier headers spécifie les types des champs de l'interface des formulaires XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient des éléments "header".

<div style="color:red">'''TODO :'''
Il semble que les fichiers headers définissent des entêtes devant être envoyées alors que ces mêmes entêtes ne sont pas spécifiés dans le fichier ihm. Ce comportement est logique, en effet, l'utilisateur n'a pas forcément besoin de savoir tout ce qui est envoyé via le formulaire. Cependant, comment le moteur XIMF sait quels entêtes doivent être envoyés ?
De même, pourquoi certains headers sont présents dans ce fichiers mais ne sont pas affichés dans l'ihm (ie. les headers X-XIMF-Primary-Precedence et X-XIMF-Copy-Precedence de l'instance Amoco) ?

Comment intégrer un header (nommé aussi header technique) dans le message sans qu'il soit affiché dans le formulaire XIMF de l'IHM ?

</div>

==== Element header ====
Chaque élément "header" décrit un entête de message de format XIMF.
Huit attributs précisent la balise "header" : "headerName", "id", "technicalHeaderName", "type", "technicalType", "isMandatory", "ilk", "description", e.g.,

<div style="color:red;">'''TODO :'''
Comment est effectuée la vérification de l'attribut isMandatory et quelles sont les conditions de fonctionnement de celui-ci ? Est-il possible, par exemple, de spécifier l'attribut isMandatory=true d'un élément header si le contenu de celui-ci est un élément « set » qui dispose des attributs minItem et maxItem ? Actuellement, lorsque l'on crée un élément set avec les attributs minItem et maxItem, le champ du formulaire associé ne peux pas être validé : e.g.,
<ximf:set id="value-amoco-classification" minItem="1" maxItem="64" separator=";" technicalSeparator=".">
</div>

<ximf:header id="header-primary-precedence"
headerName="X-XIMF-Primary-Precedence"
ilk="ilk-primary-precedence"
isMandatory="true"
description="entête d’urgence"
type="string" />

* Détails sur les attributs de l'élément "header" :
** L’attribut "headerName" définit le nom du champ XIMF. Cet attribut est obligatoire.
** L’attribut "id" définit un identifiant de champ, il doit être unique pour chaque élément "header" et est formaté selon la syntaxe "header-xxx". Cet attribut est obligatoire.
** L’attribut "isMandatory" précise si ce champ doit être obligatoirement présent dans le message intégrant les entêtes selon cette description.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.
** L’attribut "type" précise le format des données associées à cet élément. Ce format peut être une date, une chaîne, une adresse mail, un O.I.D.
** L’attribut "technicalHeaderName" permet de compléter l’entête décrit par un autre entête.
** L’attribut "technicalType" précise le format des données associées à l’élément technicalHeaderName.
** L’attribut "description" permet d’ajouter une information sur cet élément.

L’élément "header" contient obligatoirement un élément "set", "multiset", "string", ou "compstring", e.g.,

<ximf:header id="header-reply-by"
headerName="X-XIMF-Reply-By"
ilk="ilk-reply-by"
isMandatory="false" >
<ximf:string id="value-reply-by" editable="true" />
</ximf:header>

<div style="color:red;">
'''TODO :''' Quelles sont les contraintes associées à l'attribut type d'un élément header ?
</div>

==== Element string ====
L’élément "string" précise le contenu d’une ressource de type chaîne de caractères imprimables (a-z, A-Z, 1-9,…)
Quinze attributs complètent l’élément "string" : "id", "ref", "ilk", "aclLevel", "index", "description", "editable", "content", "technicalContent","maxItem", "minItem", "maxLength", "minLength", "separator", "technicalSeparator", e.g.,

<ximf:string ilk="ilk-france" content="FRA" />

* Détails sur les attributs de l'élément "string" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "string".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role| élément role]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut " description " permet d’associer un commentaire sur cette donnée.
** L’attribut "editable" définit une valeur de saisie (champ libre). Cet attribut est de type booléen.
** L’attribut "content" représente la valeur effective de la donnée. C’est cette donnée qui sera associée au champ XIMF créé.
** L’attribut "technicalContent" représente la valeur effective de la donnée technique. C’est cette donnée qui sera associée au champ technique XIMF créé (cf. attribut technicalHeaderName de l’élément "header".
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.

L’élément "string" peut contenir plusieurs éléments "linkedValue".

<ximf:string ilk="ilk-non-protege" content="NON PROTEGE" technicalContent="1" >
<ximf:linkedValue ref="value-non-protege-france " />
</ximf:string>

==== Element compstring ====
<div style="color:red;">
'''TODO :''' L'attribut de l'élément « compstring » nommé « contentFactorise » devrait s'appeler « contentFactorize ».
</div>
L’élément "compstring" décrit un conteneur de concaténation des éléments fils. Il permet notamment de créer des valeurs d’entêtes composées.
Dix-sept attributs complètent l’élément "compstring" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", "content", "technicalContent", "contentPositionEnd", "contentFactorise", "technicalPositionEnd", e.g.,

<ximf:compstring
ilk="ilk-special"
content="SPECIAL"
technicalContent="1.3.4"
separator=" "
technicalSeparator=".">

* Détails sur les attributs de l'élément "compstring" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "compstring".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (cf. [[#Element_role| élément "role"]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut " description " permet d’associer un commentaire sur cette donnée.
** L’attribut "content" représente la valeur effective de la donnée. C’est cette donnée qui sera associée au champ XIMF créé.
** L’attribut "technicalContent" représente la valeur effective de la donnée technique. C’est cette donnée qui sera associée au champ technique XIMF créé (cf. attribut technicalHeaderName de l’élément "header".
** L’attribut "separator" définit le caractère de séparation entre deux valeurs.
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "contentPositionEnd" impose de positionner le contenu de l’élément "compstring" après les valeurs des éléments fils : valuefils1,valuefils2 : valuecompstring.
** L’attribut "technicalPositionEnd" impose de positionner le contenu de l’élément "compstring" après les valeurs des éléments fils.
** L’attribut "contentFactorise" impose d’utiliser le contenu de l’élément "compstring" comme facteur des éléments fils : valuecompstring(valuefils1,valuefils2).

L’élément "compstring" peut contenir un élément "string" ou "set" ou "multiset" ou plusieurs éléments "compstring".

<ximf:compstring
ilk="ilk-special"
content="SPECIAL"
technicalContent="1.3.4"
separator=" "
technicalSeparator=".">
<ximf:set id="ilk-special-op " maxItem="64">
<ximf:string ilk="ilk-special-op1" content="OP1" technicalContent="1" />
<ximf:string ilk="ilk-special-op2" content="OP2" technicalContent="2" />
<ximf:string ilk="ilk-special-op3" content="OP3" technicalContent="3" />
</ximf:set>
</ximf:compstring>

==== Element set ====
L’élément "set" décrit un conteneur de ressources de même type. Cet élément autorise la sélection de plusieurs ressources mais chaque ressource est sélectionnée une seule fois.
Douze attributs précisent la description de la balise "set" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", e.g.,

<ximf:set id="value-categories" ref="value-mentions" maxItem="64" separator=";" />

* Détails sur les attributs de l'élément "set" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "ximf:set".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role|élément rôle]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut "description" permet d’associer un commentaire sur cette donnée.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs

L’élément "set" peut contenir un ou plusieurs éléments "string" ou un ou plusieurs éléments "compstring".

<ximf:set id="value-categories" minItem="1" maxItem="64" separator=";">
<ximf:string ilk="ilk-releasable-to" content="RELEASABLE TO " />
<ximf:string ilk="ilk-eyes-only" content=" EYES ONLY"/>
<ximf:string ilk="ilk-use-only" content=" USE ONLY"/>
</ximf:set>

<div style="color:red;">'''TODO :'''
* Y a-t-il une définition des fichiers associés aux instances XIMF (e.g, le fichier attribution-list.xml utilisé dans l'instance Caterpillar) ?
* Comment le moteur XIMF sait qu'un élément est une "attribution-list" ?
</div>

==== Element multiset ====
L’élément "multiset" décrit un conteneur de ressources de même type. Cet élément autorise la sélection de plusieurs ressources et chaque ressource peut être sélectionnée plusieurs fois.
Douze attributs précisent la description de la balise "multiset" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", e.g.,

<ximf:multiset
id="value-restricted"
ilk=" value-restricted-otan"
maxItem="64"
separator=";" />

* Détails sur les attributs de l'élément "multiset" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "multiset".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role|élément rôle]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut "description" permet d’associer un commentaire sur cette donnée.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs

L’élément "multiset" peut contenir un ou plusieurs éléments "string" ou un ou plusieurs éléments "compstring".

<ximf:multiset id="value-restricted-otan-categories" minItem="1" maxItem="64" separator=";" >
<ximf:string ilk="ilk-releasable-to" content="RELEASABLE TO "/>
<ximf:string ilk="ilk-eyes-only" content=" EYES ONLY"/>
<ximf:string ilk="ilk-use-only" content=" USE ONLY"/>
</ximf:multiset>

<span style="color:red;">'''TODO ''': Comment sont gérées les règles associées aux champs multivaleurs (disposant par exemple des attributs minItem/maxItem ou les champs multiset) ?</span>

==== Element linkedValue ====
L’élément "linkedValue" définit une référence sur une ressource de type conteneur ("set", "multiset") ou "string". Cette ressource devrait être utilisée si la ressource contenant "linkedValue" (noeud parent) est sélectionnée.
Un attribut précise la balise "linkvalue" : "ref", e.g.,

<ximf:linkedValue ref="value-restricted-otan-classification-id" />

* Détails sur les attributs de l'élément "linkedValue" :
** L’attribut "ref" précise la valeur de l’attribut "id" de la ressource cible. Cet attribut est obligatoire.

=== Fichier rules ===
Le fichier rules définit les règles de contrôles d’entêtes XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui peut contenir des éléments "ximf:rule".

==== Element rule ====
<div style="color:red">
'''TODO :''' Mettre à jour la documentation :
* Les éléments autorisés dans un élément « rule » ne sont plus à jour. La présente documentation spécifie 12 éléments : AliasHeader, AliasValue, Compatibility, Association, SecureHeaders, SecurityLabel, Constraint, Assignment, Processing, Accessibility, Role et Custom. Le schéma XML fourni avec le mail en spécifie 5 : Constraint, Processing, Compatibility, Policy et Custom et place les autres en tant qu'extentions des 5 éléments cités précédemment.
* Les éléments SecureHeaders et SecurityLabel associés à l'élément « rule » ne figurent pas dans la nouvelle version du shéma xml. On les retrouve dans les fichiers rules-*.xml mais les éléments sont commentés, ils sont, de plus, présents dans une autre instance : comment ces éléments sont utilisés dans Trustedbird ?
* L'élément ximf:classificationPictures n'est pas documenté. De plus, il serait bon d'avoir des précisions sur la raison qui a motivé l'ajout de cet élément dans les fichiers de règles (alors qu'il semblerait être plus adapté au fichier headers-*.xml).
</div>
L’élément "rule" est le conteneur principal de description d’un comportement particulier à appliquer sur un ensemble d’entêtes XIMF.
Trois attributs précisent la balise "rule" : "id", "agent", "description", e.g.,
<ximf:rule id="compatibility-rule" description="Règle sur la compatibilité X-SMTP / XIMF" >

* Détails sur les attributs de l'élément "rule" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "rule". Cet attribut est obligatoire.
** L’attribut "agent" indique l’équipement cible devant analyser et appliquer le contenu de cet élément.
** L’attribut "description" autorise l’auteur d’ajouter un commentaire sur cet élément.

L’élément "rule" contient un ou plusieurs mêmes éléments de spécialisation de la règle "contraint", "assignement", "processing", "compatibility", "accessibility", "custom",…, e.g.,

<ximf:rule id="precedence-rule" agent="mua" description="Règle sur les priorités">
<ximf:constraint
left="header-primary-precedence"
operator="equalOrGreaterThan"
right="header-copy-precedence" />
</ximf:rule>

==== Element aliasHeader ====
L’élément "aliasHeader" permet de définir le nom de l’entête sur lequel la règle précisée est appliquée
Deux attributs précisent la balise "aliasHeader" : "headerName" et "headerRef", e.g.,

<ximf:aliasHeader headerName ="X-P772-Version" headerRef="X-XIMF-VERSION" />

* Détails sur les attributs de l'élément "aliasHeader" :
* L’attribut "headerName" définit le nom XIMF de l’entête modifié par la règle. Cet attribut est obligatoire.
* L’attribut "headerRef" définit le nom d’un entête XIMF de référence qui est le point d’entrée de l’application de la règle sur l’entête définit par "headerName". Cela permet de lier deux entêtes de messages où l’utilisation de l’un des entêtes influe sur le comportement de l’autre.

L’élément "aliasHeader" peut contenir des éléments "aliasValue",e.g ,

<ximf:aliasHeader headerName="X-P772-Version" />
<ximf:aliasValue vame="1.0"/>
<ximf:aliasHeader>

==== Element aliasValue ====
L’élément "aliasValue" contient une valeur à associer à l’entête XIMF contrôlé par la règle. Il est utile lorsque deux entêtes sont liées (utilisation de l’attribut headerRef dans l’élément aliasHeader) et que les valeurs de l’entêtes de référence permettent de préciser celles de l’entête contrôlé.
Deux attributs précisent la balise "aliasValue" : "valueName", "valueRef", e.g.,

<ximf:aliasValue valueName="2" valueRef="flash" />

* Détails sur les attributs de l'élément "aliasValue" :
** L’attribut "valueName" définit la valeur de l’entête à créer. Cet attribut est obligatoire.
** L’attribut "valueRef" définit la valeur de l’entête XIMF de référence pour utiliser valueName.
<span style="color:red;">'''TODO :''' L'attribut valueRef est-il obligatoire ?</span>

==== Element compatibility ====
L’élément "compatibility" est utilisé pour associer à un entête respectant la norme XIMF un entête respectant une autre norme que XIMF (XSMTP par exemple).
Deux attributs précisent la balise "compatibility" : "targetName", "targetVersion", e.g.,

<ximf:compatibility targetName="X-SMTP" targetVersion="1.1">
<ximf:aliasValue headerName="X-P772-Version" content="1.1" />
<ximf:aliasValue
headerName="X-P772-Primary-Precedence"
headerRef="header-primary-precedence"
dataRef="data-priority-xsmtp"/>
</ximf:compatibility>

* Détails sur les attributs de l'élément "compatibility" :
** L’attribut "targetName" définit la norme de l’entête à associer à l’entête XIMF. Cet attribut est obligatoire.
** L’attribut "targetVersion" définit le numéro de version de la norme de l’entête à associer à l’entête XIMF. Cet attribut est obligatoire.

L’élément "compatibility" contient au moins un élément "aliasHeader".

<u>Pour illustrer cette règle :</u>
Le format XSMTP est déjà supporté par certains équipements. Afin de rendre ceux-ci inter opérables avec le nouveau format XIMF, cette règle permet d’associer un entête XSMTP contenant les mêmes informations qu’un entête XIMF.

L’élément Association : dépendance entre entêtes
L’élément "association" définie les valeurs autorisées pour un entête XIMF en fonction d’une valeur définie pour un autre entête XIMF.

<ximf:association>
<ximf:aliasHeader
headerName="X-XIMF-Primary-Precedence"
headerRef="X-XIMF-Correspondence-Type">
<ximf:aliasValue valueName="routine" valueRef="private" />
<ximf:aliasValue valueName="routine,priority" valueRef="professional" />
<ximf:aliasValue valueName="routine,priority,immediate,flash" valueRef="operational" />
<ximf:aliasValue valueName="routine,priority,immediate" valueRef="official" />
</ximf:aliasHeader>
</ximf:association>

==== Element secureHeaders ====
L’élément "secureHeaders" définie la liste des entêtes à intégrer dans la signature d’un message. Cette règle s’applique sur les équipements proposant un algorithme de signature des messages.

Un élément "secureHeaders" contient un ou plusieurs éléments "aliasHeaders" où chaque élément décrit un entête à intégrer dans la signature et complété d’un attribut "status".

<ximf:secureHeaders targetName="SecureHeaders">
<ximf:aliasHeader headerName="X-XIMF-Primary-Precedence" status="0" />
<ximf:aliasHeader headerName="X-XIMF-Copy-Precedence" status="0" />
</ximf:secureHeaders>

==== Element securityLabel ====
L’élément "securityLabel" définie la liste des entêtes à intégrer dans la signature d’un message. Cette règle s’applique sur les équipements proposant un algorithme de signature des messages selon la norme RFC.

Un élément "securityLabel" contient un ou plusieurs éléments "aliasHeaders" où chaque élément décrit un entête à intégrer dans la signature et complété d’un attribut "status".

<ximf:securityLabel targetName="SecurityLabel" id="Amoco">
<ximf:aliasHeader
headerName="SecurityPolicyIdentifier"
headerRef="X-XIMF-Security-Policy-Identifier" />
<ximf:aliasHeader
headerName="SecurityClassification"
headerRef="X-XIMF-Security-Classification-Identifier" />
<ximf:aliasHeader
headerName="ESSPrivacyMark"
headerRef="X-XIMF-Privacy-Mark" />
<ximf:aliasHeader
headerName="SecurityCategory"
headerRef="X-XIMF-Security-Categories-Identifier"
type="2" />
</ximf:securityLabel>

==== Element constraint ====
L’élément "constraint" est utilisé pour définir une règle de construction de deux entêtes partageant des "datas" identiques.
Trois attributs précisent la balise "constraint" : "left", "right", "operator", e.g.,

<ximf:constraint
left="header-primary-precedence"
operator="equalOrGreaterThan"
right="header-copy-precedence" />

* Détails sur les attributs de l'élément "constraint" :
** L’attribut "left" désigne le premier élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "right" désigne le deuxième élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "operator" indique la règle de poids à appliquer sur la valeur des deux éléments "header", il peut être de type "greaterThan", "lowerThan", "equalOrGreaterThan", "equalOrLowerThan", "equal". Cet attribut est obligatoire.

* Détails sur les valeurs possibles de l'attribut "type" :
** Le type "greaterThan" signifie que la valeur de l’élément "left" doit être strictement supérieur à la valeur de l’élément "right".
** Le type "lowerThan" signifie que la valeur de l’élément "left" doit être strictement inférieur à la valeur de l’élément "right".
** Le type "equalOrGreaterThan" signifie que la valeur de l’élément "left" doit être supérieur ou égale à la valeur de l’élément "right".
** Le type "equalOrLowerThan" signifie que la valeur de l’élément "left" doit être inférieur ou égale à la valeur de l’élément "right".
** Le type "equal" signifie que la valeur de l’élément "left" et de l’élément "right" doivent être identiques.

==== Element assignment ====
<div style="color:red;">'''TODO :''' L'élément assignment n'apparaît pas dans le shéma xml qui avait été envoyé.</div>

L’élément "assignement" est utilisé pour affecter une valeur créée en fonction d’une règle de comparaison sur les valeurs de deux éléments "header".
Quatre attributs précisent la balise "assignement" : "left", "right", "operator", "result", e.g.,

<ximf:assignment
left="header-primary-precedence"
operator="equal"
right="data-routine-precedence"
result="86400" />

* Détails sur les attributs de l'élément "assignment" :
** L’attribut "left" désigne le premier élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "right" désigne le deuxième élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "operator" indique la règle de comparaison entre les valeurs des deux éléments "header", il peut être de type "greaterThan", "lowerThan", "equalOrGreaterThan", "equalOrLowerThan", "equal". Cet attribut est obligatoire.
** L’attribut "result" représente la valeur à utiliser si la règle de comparaison entre les deux éléments est satisfaite. Cet attribut est obligatoire.

==== Element processing ====
L’élément "processing" regroupe des règles de traitement à effectuer sur des entêtes formatés.
L’attribut "type" précise le type de traitement à effectuer sur ces valeurs. Cet attribut est obligatoire, il est de type : "sign-header-value", "encrypt-header-value", "capitalize-header-value", e.g.,

<ximf:processing type="sign-header-value">
<ximf:refHeader>header-primary-precedence</ximf:refheader>
<ximf:refHeader>header-copy-precedence</ximf:refheader>
<ximf:refHeader>header-echange-type</ximf:refheader>
</ximf:processing>

* Détails sur les valeurs possibles de l'attribut "type" :
** Le type "sign-header-value" définit un traitement de signature des entêtes définis dans la balise.
** Le type "encrypt-header-value" définit un traitement de chiffrement des entêtes définis dans la balise.
** Le type "capitalize-header-value" définit un traitement de capitalisation des entêtes définis dans la balise.

L’élément "processing" contient au moins un élément "refHeader".
<div style="color:red;">'''TODO :'''L'élément refHeader n'est pas documenté, s'agit-il en fait de l'élément headerRef ?</div>

==== Element accessibility ====
<div style="color:red;">'''TODO :''' L'élément accessibility n'apparaît pas dans le shéma xml qui avait été envoyé.</div>
L’élément "accessibility" définit un ensemble de règles de droit d’accès aux éléments d’une instance pour une cible déterminée (utilisateur, routeur…).
Cet élément contient un ou plusieurs éléments "role".

<ximf:accessibility>
<ximf:role id="role-flash-allowed" aclLevel="100" />
<ximf:role id="role-flash-prohibited" aclLevel="50" />
</ximf:accessibility>

==== Element role ====
L’élément "role" positionne une valeur d’accès à pour une entité définit.
Deux attributs complètent l’élément "role" : "id", "aclLevel", e.g.,

<ximf:role id="role-flash-allowed" aclLevel="100" />

* Détails sur les attributs de l'élément "role" :
** L’attribut "id" précise l’entité accessible en fonction d’une valeur déterminée.
** L’attribut "aclLevel" précise la valeur seuil d’accès à l’entité.

==== Element custom ====
L’élément "custom" permet à l’auteur de créer des nouvelles règles personnalisées.
Trois attributs précisent la balise "custom" : "id", "provider", "description", e.g.,

<ximf:custom
id="custom-display"
provider="EADS"
description="Affichage de la composition du message" >
<node1><node2><node3></node3></node2></node1>
</ximf:custom>

* Détails sur les attributs de l'élément "custom" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "custom" et formaté selon la syntaxe "custom-xxx". Cet attribut est obligatoire.
** L’attribut "provider" identifie l’auteur de la règle. Cet attribut est obligatoire.
** L’attribut "description" permet d’ajouter un commentaire sur cet élément.

L’élément "custom" peut contenir tous les éléments possibles en respectant les standards XML.

XIMF XML tags/fr

2011-03-15T16:01:30Z

Anthonyjuge : /* Fichier headers */

== Introduction ==
Ce document propose un modèle de description, via eXtensible Markup Language (XML), d’entêtes de messages électroniques respectant la norme XIMF. Ce document a deux objectifs :
# Décrire les éléments et attributs de représentation XML pour construire des entêtes de messages électroniques de format XIMF.
# Fournir un modèle de représentation XIMF/XML.

<u>Rappel :</u>
* Un "élément" fait référence à tous les caractères situés entre une balise de départ et un balise de fin, e.g.,
<exemple> texte et/ou éléments fils </exemple>
* Un "attribut" est une composante d’un élément. Il est positionné dans la balise de départ, e.g.,
<exemple nom='value'>

Tous les éléments décrits dans cette documentation paragraphe sont validés dans l’espace de nom "ximf".

<pre>
xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://eads.org/ximf/ximf.xsd"
</pre>

== Description détaillée des balises XML ==

Voici, par ordre d'apparition et en fonction des fichiers, les balises génériques associées aux différents fichiers XML.

=== Fichier ximfmail-profile ===

<div style="color:red;">'''TODO''' :
* Combien d'éléments ihm sont autorisés dans un élément instance ?
* La documentation des fichiers ximfmail-profile.xml n'est pas disponible.
* Quel est le rôle de l'élément "acces" ?
* Quelle est l'utilité des identifiants associés aux éléments instance, shema, ihm, etc.
* Quelle est l'utilité de l'attribut name associé aux éléments instance. Y a-t-il une vérification s'assurant que les fichiers utilisés par une instance correspondent bien à l'instance à laquelle ils sont associés ?
</div>

Un fichier xpi peut contenir plusieurs instances XIMF, celles-ci sont alors regroupées dans une même catégorie. Le fichier ximfmail-profile contient des informations sur toutes les instances contenues dans le xpi, notamment leur nom, leur chemin d'accès, ainsi que les noms des fichiers associés à chaque instance.

==== Element instance ====
L’élément "instance" identifie l’ensemble des entêtes à décrire selon la norme XIMF. C’est le conteneur principal d’une instance XIMF/XML. Cinq attributs précisent la balise "instance" : "ximfVersion", "version", "author", "creation", "name", e.g.,
<ximf:instance name="myInstance" version="1.0" ximfVersion="2.0" >

* Détails sur les attributs de l'élément "instance" :
** L’attribut "name" définit le nom de l’instance décrite. Cet attribut est obligatoire.
** L’attribut "ximfVersion" définit le numéro de version des entêtes XIMF utilisés pour cette représentation. Cet attribut est obligatoire.
** L’attribut "version" définit le numéro de version de l’instance décrite. Cet attribut est obligatoire.
** L’attribut "author" renseigne sur le nom de l’auteur de cette instance.
** L’attribut "creationDate" précise la date de création de cette instance.

L’élément "instance" peut contenir un ou plusieurs éléments "schema", un ou plusieurs éléments "rule", un élément "ihm" et un élément "dictionary".

==== Element dictionary ====
L'élément dictionary contient le chemin vers le fichier spécifiant les données d'internationalisation (Cf. [[#Fichier_dictionary|Fichier dictionary]]).

==== Element schema ====
L'élément shema contient le chemin vers le fichier spécifiant les entêtes XIMF (Cf. [[#Fichier_headers|Fichier headers]]).

==== Element ihm ====
L'élément ihm contient le chemin vers le fichier spécifiant la disposition de l'interface des formulaires XIMF (Cf. [[#Fichier_ihm|Fichier ihm]]).

==== Element rule ====
L'élément rule contient le chemin vers le fichier spécifiant les règles associées aux valeurs des champs XIMF (Cf. [[#Fichier_rules|Fichier rules]]).

=== Fichier dictionary ===
Le fichier dictionnary permet de mettre en œuvre l’internationalisation d’une instance XIMF. Il défini des dictionnaires qui servent à traduire les éléments de l'instance XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient un élément "ximf:dictionnary".

==== Element dictionary ====
<div style="color:red;">'''TODO''' :
* Quel est l'intérêt de renseigner un attribut "id" à l'élément "dictionary" (étant donné qu'un seul élément "dictionary est autorisé dans l'élément "instance") ?</div>

L’élément "dictionary" contient toutes les informations devant être interprétées selon le pays d’utilisation.
L’élément "dictionary" contient un ou plusieurs mêmes éléments "locale", e.g.,

<ximf:dictionary>
<ximf:locale lang="fr-FR" />
<ximf:locale lang="en-US" />
</ximf:dictionary>

==== Element locale ====
L’élément "locale" contient toutes les informations pour un pays et/ou langue désignée.
L’élément "locale" contient un ou plusieurs mêmes éléments "ilk", e.g.,

<ximf:locale lang="fr-FR" >
<ximf:ilk entity="a"/>
<ximf:ilk entity="b"/>
</ximf:locale>

* Détails sur les attributs de la balise "locale" :
** L’attribut "lang" définit le code pays de ce conteneur. Il devrai être construit selon le format défini par la RFC1766 (fr, en, ja, es, …).

==== Element ilk ====
L’élément "ilk" contient une unique information correspondant à une donnée traduite selon le code pays de l’élément père. Cette information est au format chaîne de caractère. Un attribut obligatoire précise la balise "ilk".

<ximf:ilk entity="ilk-lang-ihm">langue</ximf:ilk>

* Détails sur les attributs de la balise "ilk" :
** L’attribut "entity" définit la référence d’entrée pour récupérer le contenu de l’élément selon le code pays souhaité.

Finalement, le fichier "dictionary" pourra contenir :
<ximf:instance name="Whirlpool">
<ximf:dictionary>
<ximf:locale lang="fr-FR" >
<ximf:ilk entity="ilk-lang-ihm">Français</ximf:ilk>
<ximf:ilk entity="ilk-exemple-general">Général</ximf:ilk>
</ximf:locale>
<ximf:locale lang="en-US" >
<ximf:ilk entity="ilk-lang-ihm">English (US)</ximf:ilk>
<ximf:ilk entity="ilk-exemple-general">General</ximf:ilk>
</ximf:locale>
</ximf:dictionary>
</ximf:instance>

=== Fichier ihm ===
<span style="color:red;">'''TODO''' : La documentation originale ne décrit pas le fichier ihm, les informations ci-dessous ont seulement été présumées. Merci de les vérifier/compléter.
</span>

Le fichier ihm spécifie l'agencement de l'interface des formulaires XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient un élément "ximf:ihm".

==== Element ihm ====
L'élément "ihm" contient un ou plusieurs éléments "panel" et un élément "treeRcv".

==== Element panel ====
Un élément ximf:panel correspond à un onglet du formulaire XIMF construit.
Deux attributs précisent la balise "panel" : "id" et "ilk", eg.
<ximf:panel id="pane_security" ilk="ilk-priority-panel" />

* Détails sur les attributs de l'élément "panel" :
** L’attribut "id" définit le nom de l'onglet, il doit être unique pour chaque élément "ximf:panel" et est formaté selon la syntaxe "pane-xxx". Cet attribut est obligatoire.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.

L'élément "ximf:panel" contient au moins un éléments "ximf:groupbox".

==== Element groupbox ====
Un élément groupbox correspond à une sous catégorie d'un onglet du formulaire XIMF.
La structure "groupbox" détaille l’ordre d’affichage des entêtes dans un message.
Deux attributs précisent la balise "ximf:groupbox" : "id" et "ilk", eg.
<ximf:groupbox id="group-classification" ilk="ilk-secu-box" />

* Détails sur les attributs de l'élément "groupbox" :
** L’attribut "id" définit le nom de l'onglet, il doit être unique pour chaque élément "ximf:panel" et est formaté selon la syntaxe "pane-xxx". Cet attribut est obligatoire.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.

L'élément "groupbox" contient au moins un éléments "headerRef".

==== Element treeRcv ====
L'élément "treeRcv" permet de spécifier quelles sont les colonnes susceptibles d'être ajoutées dans le panneau principal du client de messagerie qui contient la liste des messages d’un dossier.

L'élément "treeRcv" peut contenir des éléments "headerRef".

==== Element headerRef ====
L'élément headerRef spécifie les champs associés à chaque sous-groupe d'onglet de formulaire ou les champs qu'il est possible d'afficher dans la liste des messages.
Aucun attribut ne vient compléter la balise "headerRef", eg.
<ximf:headerRef>header-classification</ximf:headerRef>

Finalement, le fichier "ihm" pourra contenir :
<pre>
<ximf:instance name="Amoco">
<ximf:ihm>
<ximf:panel id="pane_security" ilk="ilk-priority-panel">
<ximf:groupbox id="group-classification" ilk="ilk-secu-box">
<ximf:headerRef>header-correspondance-type</ximf:headerRef>
<ximf:headerRef>header-classification</ximf:headerRef>
</ximf:groupbox>
</ximf:panel>
<ximf:treeRcv>
<ximf:headerRef>header-classification</ximf:headerRef>
</ximf:treeRcv>
</ximf:ihm>
</ximf:instance>
</pre>

=== Fichier headers ===
Le fichier headers spécifie les types des champs de l'interface des formulaires XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient des éléments "header".

<div style="color:red">'''TODO :'''
Il semble que les fichiers headers définissent des entêtes devant être envoyées alors que ces mêmes entêtes ne sont pas spécifiés dans le fichier ihm. Ce comportement est logique, en effet, l'utilisateur n'a pas forcément besoin de savoir tout ce qui est envoyé via le formulaire. Cependant, comment le moteur XIMF sait quels entêtes doivent être envoyés ?
De même, pourquoi certains headers sont présents dans ce fichiers mais ne sont pas affichés dans l'ihm (ie. les headers X-XIMF-Primary-Precedence et X-XIMF-Copy-Precedence de l'instance Amoco) ? Comment est faite la différence entre un header discriminant (par exemple le header X-XIMF-Security-Policy-Identifier de la même instance) et un header affichable à l'utilisateur ?
</div>

==== Element header ====
Chaque élément "header" décrit un entête de message de format XIMF.
Huit attributs précisent la balise "header" : "headerName", "id", "technicalHeaderName", "type", "technicalType", "isMandatory", "ilk", "description", e.g.,

<div style="color:red;">'''TODO :'''
Comment est effectuée la vérification de l'attribut isMandatory et quelles sont les conditions de fonctionnement de celui-ci ? Est-il possible, par exemple, de spécifier l'attribut isMandatory=true d'un élément header si le contenu de celui-ci est un élément « set » qui dispose des attributs minItem et maxItem ? Actuellement, lorsque l'on crée un élément set avec les attributs minItem et maxItem, le champ du formulaire associé ne peux pas être validé : e.g.,
<ximf:set id="value-amoco-classification" minItem="1" maxItem="64" separator=";" technicalSeparator=".">
</div>

<ximf:header id="header-primary-precedence"
headerName="X-XIMF-Primary-Precedence"
ilk="ilk-primary-precedence"
isMandatory="true"
description="entête d’urgence"
type="string" />

* Détails sur les attributs de l'élément "header" :
** L’attribut "headerName" définit le nom du champ XIMF. Cet attribut est obligatoire.
** L’attribut "id" définit un identifiant de champ, il doit être unique pour chaque élément "header" et est formaté selon la syntaxe "header-xxx". Cet attribut est obligatoire.
** L’attribut "isMandatory" précise si ce champ doit être obligatoirement présent dans le message intégrant les entêtes selon cette description.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.
** L’attribut "type" précise le format des données associées à cet élément. Ce format peut être une date, une chaîne, une adresse mail, un O.I.D.
** L’attribut "technicalHeaderName" permet de compléter l’entête décrit par un autre entête.
** L’attribut "technicalType" précise le format des données associées à l’élément technicalHeaderName.
** L’attribut "description" permet d’ajouter une information sur cet élément.

L’élément "header" contient obligatoirement un élément "set", "multiset", "string", ou "compstring", e.g.,

<ximf:header id="header-reply-by"
headerName="X-XIMF-Reply-By"
ilk="ilk-reply-by"
isMandatory="false" >
<ximf:string id="value-reply-by" editable="true" />
</ximf:header>

<div style="color:red;">
'''TODO :''' Quelles sont les contraintes associées à l'attribut type d'un élément header ?
</div>

==== Element string ====
L’élément "string" précise le contenu d’une ressource de type chaîne de caractères imprimables (a-z, A-Z, 1-9,…)
Quinze attributs complètent l’élément "string" : "id", "ref", "ilk", "aclLevel", "index", "description", "editable", "content", "technicalContent","maxItem", "minItem", "maxLength", "minLength", "separator", "technicalSeparator", e.g.,

<ximf:string ilk="ilk-france" content="FRA" />

* Détails sur les attributs de l'élément "string" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "string".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role| élément role]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut " description " permet d’associer un commentaire sur cette donnée.
** L’attribut "editable" définit une valeur de saisie (champ libre). Cet attribut est de type booléen.
** L’attribut "content" représente la valeur effective de la donnée. C’est cette donnée qui sera associée au champ XIMF créé.
** L’attribut "technicalContent" représente la valeur effective de la donnée technique. C’est cette donnée qui sera associée au champ technique XIMF créé (cf. attribut technicalHeaderName de l’élément "header".
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.

L’élément "string" peut contenir plusieurs éléments "linkedValue".

<ximf:string ilk="ilk-non-protege" content="NON PROTEGE" technicalContent="1" >
<ximf:linkedValue ref="value-non-protege-france " />
</ximf:string>

==== Element compstring ====
<div style="color:red;">
'''TODO :''' L'attribut de l'élément « compstring » nommé « contentFactorise » devrait s'appeler « contentFactorize ».
</div>
L’élément "compstring" décrit un conteneur de concaténation des éléments fils. Il permet notamment de créer des valeurs d’entêtes composées.
Dix-sept attributs complètent l’élément "compstring" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", "content", "technicalContent", "contentPositionEnd", "contentFactorise", "technicalPositionEnd", e.g.,

<ximf:compstring
ilk="ilk-special"
content="SPECIAL"
technicalContent="1.3.4"
separator=" "
technicalSeparator=".">

* Détails sur les attributs de l'élément "compstring" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "compstring".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (cf. [[#Element_role| élément "role"]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut " description " permet d’associer un commentaire sur cette donnée.
** L’attribut "content" représente la valeur effective de la donnée. C’est cette donnée qui sera associée au champ XIMF créé.
** L’attribut "technicalContent" représente la valeur effective de la donnée technique. C’est cette donnée qui sera associée au champ technique XIMF créé (cf. attribut technicalHeaderName de l’élément "header".
** L’attribut "separator" définit le caractère de séparation entre deux valeurs.
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "contentPositionEnd" impose de positionner le contenu de l’élément "compstring" après les valeurs des éléments fils : valuefils1,valuefils2 : valuecompstring.
** L’attribut "technicalPositionEnd" impose de positionner le contenu de l’élément "compstring" après les valeurs des éléments fils.
** L’attribut "contentFactorise" impose d’utiliser le contenu de l’élément "compstring" comme facteur des éléments fils : valuecompstring(valuefils1,valuefils2).

L’élément "compstring" peut contenir un élément "string" ou "set" ou "multiset" ou plusieurs éléments "compstring".

<ximf:compstring
ilk="ilk-special"
content="SPECIAL"
technicalContent="1.3.4"
separator=" "
technicalSeparator=".">
<ximf:set id="ilk-special-op " maxItem="64">
<ximf:string ilk="ilk-special-op1" content="OP1" technicalContent="1" />
<ximf:string ilk="ilk-special-op2" content="OP2" technicalContent="2" />
<ximf:string ilk="ilk-special-op3" content="OP3" technicalContent="3" />
</ximf:set>
</ximf:compstring>

==== Element set ====
L’élément "set" décrit un conteneur de ressources de même type. Cet élément autorise la sélection de plusieurs ressources mais chaque ressource est sélectionnée une seule fois.
Douze attributs précisent la description de la balise "set" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", e.g.,

<ximf:set id="value-categories" ref="value-mentions" maxItem="64" separator=";" />

* Détails sur les attributs de l'élément "set" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "ximf:set".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role|élément rôle]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut "description" permet d’associer un commentaire sur cette donnée.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs

L’élément "set" peut contenir un ou plusieurs éléments "string" ou un ou plusieurs éléments "compstring".

<ximf:set id="value-categories" minItem="1" maxItem="64" separator=";">
<ximf:string ilk="ilk-releasable-to" content="RELEASABLE TO " />
<ximf:string ilk="ilk-eyes-only" content=" EYES ONLY"/>
<ximf:string ilk="ilk-use-only" content=" USE ONLY"/>
</ximf:set>

<div style="color:red;">'''TODO :'''
* Y a-t-il une définition des fichiers associés aux instances XIMF (e.g, le fichier attribution-list.xml utilisé dans l'instance Caterpillar) ?
* Comment le moteur XIMF sait qu'un élément est une "attribution-list" ?
</div>

==== Element multiset ====
L’élément "multiset" décrit un conteneur de ressources de même type. Cet élément autorise la sélection de plusieurs ressources et chaque ressource peut être sélectionnée plusieurs fois.
Douze attributs précisent la description de la balise "multiset" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", e.g.,

<ximf:multiset
id="value-restricted"
ilk=" value-restricted-otan"
maxItem="64"
separator=";" />

* Détails sur les attributs de l'élément "multiset" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "multiset".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role|élément rôle]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut "description" permet d’associer un commentaire sur cette donnée.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs

L’élément "multiset" peut contenir un ou plusieurs éléments "string" ou un ou plusieurs éléments "compstring".

<ximf:multiset id="value-restricted-otan-categories" minItem="1" maxItem="64" separator=";" >
<ximf:string ilk="ilk-releasable-to" content="RELEASABLE TO "/>
<ximf:string ilk="ilk-eyes-only" content=" EYES ONLY"/>
<ximf:string ilk="ilk-use-only" content=" USE ONLY"/>
</ximf:multiset>

<span style="color:red;">'''TODO ''': Comment sont gérées les règles associées aux champs multivaleurs (disposant par exemple des attributs minItem/maxItem ou les champs multiset) ?</span>

==== Element linkedValue ====
L’élément "linkedValue" définit une référence sur une ressource de type conteneur ("set", "multiset") ou "string". Cette ressource devrait être utilisée si la ressource contenant "linkedValue" (noeud parent) est sélectionnée.
Un attribut précise la balise "linkvalue" : "ref", e.g.,

<ximf:linkedValue ref="value-restricted-otan-classification-id" />

* Détails sur les attributs de l'élément "linkedValue" :
** L’attribut "ref" précise la valeur de l’attribut "id" de la ressource cible. Cet attribut est obligatoire.

=== Fichier rules ===
Le fichier rules définit les règles de contrôles d’entêtes XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui peut contenir des éléments "ximf:rule".

==== Element rule ====
<div style="color:red">
'''TODO :''' Mettre à jour la documentation :
* Les éléments autorisés dans un élément « rule » ne sont plus à jour. La présente documentation spécifie 12 éléments : AliasHeader, AliasValue, Compatibility, Association, SecureHeaders, SecurityLabel, Constraint, Assignment, Processing, Accessibility, Role et Custom. Le schéma XML fourni avec le mail en spécifie 5 : Constraint, Processing, Compatibility, Policy et Custom et place les autres en tant qu'extentions des 5 éléments cités précédemment.
* Les éléments SecureHeaders et SecurityLabel associés à l'élément « rule » ne figurent pas dans la nouvelle version du shéma xml. On les retrouve dans les fichiers rules-*.xml mais les éléments sont commentés, ils sont, de plus, présents dans une autre instance : comment ces éléments sont utilisés dans Trustedbird ?
* L'élément ximf:classificationPictures n'est pas documenté. De plus, il serait bon d'avoir des précisions sur la raison qui a motivé l'ajout de cet élément dans les fichiers de règles (alors qu'il semblerait être plus adapté au fichier headers-*.xml).
</div>
L’élément "rule" est le conteneur principal de description d’un comportement particulier à appliquer sur un ensemble d’entêtes XIMF.
Trois attributs précisent la balise "rule" : "id", "agent", "description", e.g.,
<ximf:rule id="compatibility-rule" description="Règle sur la compatibilité X-SMTP / XIMF" >

* Détails sur les attributs de l'élément "rule" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "rule". Cet attribut est obligatoire.
** L’attribut "agent" indique l’équipement cible devant analyser et appliquer le contenu de cet élément.
** L’attribut "description" autorise l’auteur d’ajouter un commentaire sur cet élément.

L’élément "rule" contient un ou plusieurs mêmes éléments de spécialisation de la règle "contraint", "assignement", "processing", "compatibility", "accessibility", "custom",…, e.g.,

<ximf:rule id="precedence-rule" agent="mua" description="Règle sur les priorités">
<ximf:constraint
left="header-primary-precedence"
operator="equalOrGreaterThan"
right="header-copy-precedence" />
</ximf:rule>

==== Element aliasHeader ====
L’élément "aliasHeader" permet de définir le nom de l’entête sur lequel la règle précisée est appliquée
Deux attributs précisent la balise "aliasHeader" : "headerName" et "headerRef", e.g.,

<ximf:aliasHeader headerName ="X-P772-Version" headerRef="X-XIMF-VERSION" />

* Détails sur les attributs de l'élément "aliasHeader" :
* L’attribut "headerName" définit le nom XIMF de l’entête modifié par la règle. Cet attribut est obligatoire.
* L’attribut "headerRef" définit le nom d’un entête XIMF de référence qui est le point d’entrée de l’application de la règle sur l’entête définit par "headerName". Cela permet de lier deux entêtes de messages où l’utilisation de l’un des entêtes influe sur le comportement de l’autre.

L’élément "aliasHeader" peut contenir des éléments "aliasValue",e.g ,

<ximf:aliasHeader headerName="X-P772-Version" />
<ximf:aliasValue vame="1.0"/>
<ximf:aliasHeader>

==== Element aliasValue ====
L’élément "aliasValue" contient une valeur à associer à l’entête XIMF contrôlé par la règle. Il est utile lorsque deux entêtes sont liées (utilisation de l’attribut headerRef dans l’élément aliasHeader) et que les valeurs de l’entêtes de référence permettent de préciser celles de l’entête contrôlé.
Deux attributs précisent la balise "aliasValue" : "valueName", "valueRef", e.g.,

<ximf:aliasValue valueName="2" valueRef="flash" />

* Détails sur les attributs de l'élément "aliasValue" :
** L’attribut "valueName" définit la valeur de l’entête à créer. Cet attribut est obligatoire.
** L’attribut "valueRef" définit la valeur de l’entête XIMF de référence pour utiliser valueName.
<span style="color:red;">'''TODO :''' L'attribut valueRef est-il obligatoire ?</span>

==== Element compatibility ====
L’élément "compatibility" est utilisé pour associer à un entête respectant la norme XIMF un entête respectant une autre norme que XIMF (XSMTP par exemple).
Deux attributs précisent la balise "compatibility" : "targetName", "targetVersion", e.g.,

<ximf:compatibility targetName="X-SMTP" targetVersion="1.1">
<ximf:aliasValue headerName="X-P772-Version" content="1.1" />
<ximf:aliasValue
headerName="X-P772-Primary-Precedence"
headerRef="header-primary-precedence"
dataRef="data-priority-xsmtp"/>
</ximf:compatibility>

* Détails sur les attributs de l'élément "compatibility" :
** L’attribut "targetName" définit la norme de l’entête à associer à l’entête XIMF. Cet attribut est obligatoire.
** L’attribut "targetVersion" définit le numéro de version de la norme de l’entête à associer à l’entête XIMF. Cet attribut est obligatoire.

L’élément "compatibility" contient au moins un élément "aliasHeader".

<u>Pour illustrer cette règle :</u>
Le format XSMTP est déjà supporté par certains équipements. Afin de rendre ceux-ci inter opérables avec le nouveau format XIMF, cette règle permet d’associer un entête XSMTP contenant les mêmes informations qu’un entête XIMF.

L’élément Association : dépendance entre entêtes
L’élément "association" définie les valeurs autorisées pour un entête XIMF en fonction d’une valeur définie pour un autre entête XIMF.

<ximf:association>
<ximf:aliasHeader
headerName="X-XIMF-Primary-Precedence"
headerRef="X-XIMF-Correspondence-Type">
<ximf:aliasValue valueName="routine" valueRef="private" />
<ximf:aliasValue valueName="routine,priority" valueRef="professional" />
<ximf:aliasValue valueName="routine,priority,immediate,flash" valueRef="operational" />
<ximf:aliasValue valueName="routine,priority,immediate" valueRef="official" />
</ximf:aliasHeader>
</ximf:association>

==== Element secureHeaders ====
L’élément "secureHeaders" définie la liste des entêtes à intégrer dans la signature d’un message. Cette règle s’applique sur les équipements proposant un algorithme de signature des messages.

Un élément "secureHeaders" contient un ou plusieurs éléments "aliasHeaders" où chaque élément décrit un entête à intégrer dans la signature et complété d’un attribut "status".

<ximf:secureHeaders targetName="SecureHeaders">
<ximf:aliasHeader headerName="X-XIMF-Primary-Precedence" status="0" />
<ximf:aliasHeader headerName="X-XIMF-Copy-Precedence" status="0" />
</ximf:secureHeaders>

==== Element securityLabel ====
L’élément "securityLabel" définie la liste des entêtes à intégrer dans la signature d’un message. Cette règle s’applique sur les équipements proposant un algorithme de signature des messages selon la norme RFC.

Un élément "securityLabel" contient un ou plusieurs éléments "aliasHeaders" où chaque élément décrit un entête à intégrer dans la signature et complété d’un attribut "status".

<ximf:securityLabel targetName="SecurityLabel" id="Amoco">
<ximf:aliasHeader
headerName="SecurityPolicyIdentifier"
headerRef="X-XIMF-Security-Policy-Identifier" />
<ximf:aliasHeader
headerName="SecurityClassification"
headerRef="X-XIMF-Security-Classification-Identifier" />
<ximf:aliasHeader
headerName="ESSPrivacyMark"
headerRef="X-XIMF-Privacy-Mark" />
<ximf:aliasHeader
headerName="SecurityCategory"
headerRef="X-XIMF-Security-Categories-Identifier"
type="2" />
</ximf:securityLabel>

==== Element constraint ====
L’élément "constraint" est utilisé pour définir une règle de construction de deux entêtes partageant des "datas" identiques.
Trois attributs précisent la balise "constraint" : "left", "right", "operator", e.g.,

<ximf:constraint
left="header-primary-precedence"
operator="equalOrGreaterThan"
right="header-copy-precedence" />

* Détails sur les attributs de l'élément "constraint" :
** L’attribut "left" désigne le premier élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "right" désigne le deuxième élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "operator" indique la règle de poids à appliquer sur la valeur des deux éléments "header", il peut être de type "greaterThan", "lowerThan", "equalOrGreaterThan", "equalOrLowerThan", "equal". Cet attribut est obligatoire.

* Détails sur les valeurs possibles de l'attribut "type" :
** Le type "greaterThan" signifie que la valeur de l’élément "left" doit être strictement supérieur à la valeur de l’élément "right".
** Le type "lowerThan" signifie que la valeur de l’élément "left" doit être strictement inférieur à la valeur de l’élément "right".
** Le type "equalOrGreaterThan" signifie que la valeur de l’élément "left" doit être supérieur ou égale à la valeur de l’élément "right".
** Le type "equalOrLowerThan" signifie que la valeur de l’élément "left" doit être inférieur ou égale à la valeur de l’élément "right".
** Le type "equal" signifie que la valeur de l’élément "left" et de l’élément "right" doivent être identiques.

==== Element assignment ====
<div style="color:red;">'''TODO :''' L'élément assignment n'apparaît pas dans le shéma xml qui avait été envoyé.</div>

L’élément "assignement" est utilisé pour affecter une valeur créée en fonction d’une règle de comparaison sur les valeurs de deux éléments "header".
Quatre attributs précisent la balise "assignement" : "left", "right", "operator", "result", e.g.,

<ximf:assignment
left="header-primary-precedence"
operator="equal"
right="data-routine-precedence"
result="86400" />

* Détails sur les attributs de l'élément "assignment" :
** L’attribut "left" désigne le premier élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "right" désigne le deuxième élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "operator" indique la règle de comparaison entre les valeurs des deux éléments "header", il peut être de type "greaterThan", "lowerThan", "equalOrGreaterThan", "equalOrLowerThan", "equal". Cet attribut est obligatoire.
** L’attribut "result" représente la valeur à utiliser si la règle de comparaison entre les deux éléments est satisfaite. Cet attribut est obligatoire.

==== Element processing ====
L’élément "processing" regroupe des règles de traitement à effectuer sur des entêtes formatés.
L’attribut "type" précise le type de traitement à effectuer sur ces valeurs. Cet attribut est obligatoire, il est de type : "sign-header-value", "encrypt-header-value", "capitalize-header-value", e.g.,

<ximf:processing type="sign-header-value">
<ximf:refHeader>header-primary-precedence</ximf:refheader>
<ximf:refHeader>header-copy-precedence</ximf:refheader>
<ximf:refHeader>header-echange-type</ximf:refheader>
</ximf:processing>

* Détails sur les valeurs possibles de l'attribut "type" :
** Le type "sign-header-value" définit un traitement de signature des entêtes définis dans la balise.
** Le type "encrypt-header-value" définit un traitement de chiffrement des entêtes définis dans la balise.
** Le type "capitalize-header-value" définit un traitement de capitalisation des entêtes définis dans la balise.

L’élément "processing" contient au moins un élément "refHeader".
<div style="color:red;">'''TODO :'''L'élément refHeader n'est pas documenté, s'agit-il en fait de l'élément headerRef ?</div>

==== Element accessibility ====
<div style="color:red;">'''TODO :''' L'élément accessibility n'apparaît pas dans le shéma xml qui avait été envoyé.</div>
L’élément "accessibility" définit un ensemble de règles de droit d’accès aux éléments d’une instance pour une cible déterminée (utilisateur, routeur…).
Cet élément contient un ou plusieurs éléments "role".

<ximf:accessibility>
<ximf:role id="role-flash-allowed" aclLevel="100" />
<ximf:role id="role-flash-prohibited" aclLevel="50" />
</ximf:accessibility>

==== Element role ====
L’élément "role" positionne une valeur d’accès à pour une entité définit.
Deux attributs complètent l’élément "role" : "id", "aclLevel", e.g.,

<ximf:role id="role-flash-allowed" aclLevel="100" />

* Détails sur les attributs de l'élément "role" :
** L’attribut "id" précise l’entité accessible en fonction d’une valeur déterminée.
** L’attribut "aclLevel" précise la valeur seuil d’accès à l’entité.

==== Element custom ====
L’élément "custom" permet à l’auteur de créer des nouvelles règles personnalisées.
Trois attributs précisent la balise "custom" : "id", "provider", "description", e.g.,

<ximf:custom
id="custom-display"
provider="EADS"
description="Affichage de la composition du message" >
<node1><node2><node3></node3></node2></node1>
</ximf:custom>

* Détails sur les attributs de l'élément "custom" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "custom" et formaté selon la syntaxe "custom-xxx". Cet attribut est obligatoire.
** L’attribut "provider" identifie l’auteur de la règle. Cet attribut est obligatoire.
** L’attribut "description" permet d’ajouter un commentaire sur cet élément.

L’élément "custom" peut contenir tous les éléments possibles en respectant les standards XML.

XIMF XML tags/fr

2011-03-15T10:40:58Z

Anthonyjuge : /* Fichier headers */

== Introduction ==
Ce document propose un modèle de description, via eXtensible Markup Language (XML), d’entêtes de messages électroniques respectant la norme XIMF. Ce document a deux objectifs :
# Décrire les éléments et attributs de représentation XML pour construire des entêtes de messages électroniques de format XIMF.
# Fournir un modèle de représentation XIMF/XML.

<u>Rappel :</u>
* Un "élément" fait référence à tous les caractères situés entre une balise de départ et un balise de fin, e.g.,
<exemple> texte et/ou éléments fils </exemple>
* Un "attribut" est une composante d’un élément. Il est positionné dans la balise de départ, e.g.,
<exemple nom='value'>

Tous les éléments décrits dans cette documentation paragraphe sont validés dans l’espace de nom "ximf".

<pre>
xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://eads.org/ximf/ximf.xsd"
</pre>

== Description détaillée des balises XML ==

Voici, par ordre d'apparition et en fonction des fichiers, les balises génériques associées aux différents fichiers XML.

=== Fichier ximfmail-profile ===

<div style="color:red;">'''TODO''' :
* Combien d'éléments ihm sont autorisés dans un élément instance ?
* La documentation des fichiers ximfmail-profile.xml n'est pas disponible.
* Quel est le rôle de l'élément "acces" ?
* Quelle est l'utilité des identifiants associés aux éléments instance, shema, ihm, etc.
* Quelle est l'utilité de l'attribut name associé aux éléments instance. Y a-t-il une vérification s'assurant que les fichiers utilisés par une instance correspondent bien à l'instance à laquelle ils sont associés ?
</div>

Un fichier xpi peut contenir plusieurs instances XIMF, celles-ci sont alors regroupées dans une même catégorie. Le fichier ximfmail-profile contient des informations sur toutes les instances contenues dans le xpi, notamment leur nom, leur chemin d'accès, ainsi que les noms des fichiers associés à chaque instance.

==== Element instance ====
L’élément "instance" identifie l’ensemble des entêtes à décrire selon la norme XIMF. C’est le conteneur principal d’une instance XIMF/XML. Cinq attributs précisent la balise "instance" : "ximfVersion", "version", "author", "creation", "name", e.g.,
<ximf:instance name="myInstance" version="1.0" ximfVersion="2.0" >

* Détails sur les attributs de l'élément "instance" :
** L’attribut "name" définit le nom de l’instance décrite. Cet attribut est obligatoire.
** L’attribut "ximfVersion" définit le numéro de version des entêtes XIMF utilisés pour cette représentation. Cet attribut est obligatoire.
** L’attribut "version" définit le numéro de version de l’instance décrite. Cet attribut est obligatoire.
** L’attribut "author" renseigne sur le nom de l’auteur de cette instance.
** L’attribut "creationDate" précise la date de création de cette instance.

L’élément "instance" peut contenir un ou plusieurs éléments "schema", un ou plusieurs éléments "rule", un élément "ihm" et un élément "dictionary".

==== Element dictionary ====
L'élément dictionary contient le chemin vers le fichier spécifiant les données d'internationalisation (Cf. [[#Fichier_dictionary|Fichier dictionary]]).

==== Element schema ====
L'élément shema contient le chemin vers le fichier spécifiant les entêtes XIMF (Cf. [[#Fichier_headers|Fichier headers]]).

==== Element ihm ====
L'élément ihm contient le chemin vers le fichier spécifiant la disposition de l'interface des formulaires XIMF (Cf. [[#Fichier_ihm|Fichier ihm]]).

==== Element rule ====
L'élément rule contient le chemin vers le fichier spécifiant les règles associées aux valeurs des champs XIMF (Cf. [[#Fichier_rules|Fichier rules]]).

=== Fichier dictionary ===
Le fichier dictionnary permet de mettre en œuvre l’internationalisation d’une instance XIMF. Il défini des dictionnaires qui servent à traduire les éléments de l'instance XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient un élément "ximf:dictionnary".

==== Element dictionary ====
<div style="color:red;">'''TODO''' :
* Quel est l'intérêt de renseigner un attribut "id" à l'élément "dictionary" (étant donné qu'un seul élément "dictionary est autorisé dans l'élément "instance") ?</div>

L’élément "dictionary" contient toutes les informations devant être interprétées selon le pays d’utilisation.
L’élément "dictionary" contient un ou plusieurs mêmes éléments "locale", e.g.,

<ximf:dictionary>
<ximf:locale lang="fr-FR" />
<ximf:locale lang="en-US" />
</ximf:dictionary>

==== Element locale ====
L’élément "locale" contient toutes les informations pour un pays et/ou langue désignée.
L’élément "locale" contient un ou plusieurs mêmes éléments "ilk", e.g.,

<ximf:locale lang="fr-FR" >
<ximf:ilk entity="a"/>
<ximf:ilk entity="b"/>
</ximf:locale>

* Détails sur les attributs de la balise "locale" :
** L’attribut "lang" définit le code pays de ce conteneur. Il devrai être construit selon le format défini par la RFC1766 (fr, en, ja, es, …).

==== Element ilk ====
L’élément "ilk" contient une unique information correspondant à une donnée traduite selon le code pays de l’élément père. Cette information est au format chaîne de caractère. Un attribut obligatoire précise la balise "ilk".

<ximf:ilk entity="ilk-lang-ihm">langue</ximf:ilk>

* Détails sur les attributs de la balise "ilk" :
** L’attribut "entity" définit la référence d’entrée pour récupérer le contenu de l’élément selon le code pays souhaité.

Finalement, le fichier "dictionary" pourra contenir :
<ximf:instance name="Whirlpool">
<ximf:dictionary>
<ximf:locale lang="fr-FR" >
<ximf:ilk entity="ilk-lang-ihm">Français</ximf:ilk>
<ximf:ilk entity="ilk-exemple-general">Général</ximf:ilk>
</ximf:locale>
<ximf:locale lang="en-US" >
<ximf:ilk entity="ilk-lang-ihm">English (US)</ximf:ilk>
<ximf:ilk entity="ilk-exemple-general">General</ximf:ilk>
</ximf:locale>
</ximf:dictionary>
</ximf:instance>

=== Fichier ihm ===
<span style="color:red;">'''TODO''' : La documentation originale ne décrit pas le fichier ihm, les informations ci-dessous ont seulement été présumées. Merci de les vérifier/compléter.
</span>

Le fichier ihm spécifie l'agencement de l'interface des formulaires XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient un élément "ximf:ihm".

==== Element ihm ====
L'élément "ihm" contient un ou plusieurs éléments "panel" et un élément "treeRcv".

==== Element panel ====
Un élément ximf:panel correspond à un onglet du formulaire XIMF construit.
Deux attributs précisent la balise "panel" : "id" et "ilk", eg.
<ximf:panel id="pane_security" ilk="ilk-priority-panel" />

* Détails sur les attributs de l'élément "panel" :
** L’attribut "id" définit le nom de l'onglet, il doit être unique pour chaque élément "ximf:panel" et est formaté selon la syntaxe "pane-xxx". Cet attribut est obligatoire.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.

L'élément "ximf:panel" contient au moins un éléments "ximf:groupbox".

==== Element groupbox ====
Un élément groupbox correspond à une sous catégorie d'un onglet du formulaire XIMF.
La structure "groupbox" détaille l’ordre d’affichage des entêtes dans un message.
Deux attributs précisent la balise "ximf:groupbox" : "id" et "ilk", eg.
<ximf:groupbox id="group-classification" ilk="ilk-secu-box" />

* Détails sur les attributs de l'élément "groupbox" :
** L’attribut "id" définit le nom de l'onglet, il doit être unique pour chaque élément "ximf:panel" et est formaté selon la syntaxe "pane-xxx". Cet attribut est obligatoire.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.

L'élément "groupbox" contient au moins un éléments "headerRef".

==== Element treeRcv ====
L'élément "treeRcv" permet de spécifier quelles sont les colonnes susceptibles d'être ajoutées dans le panneau principal du client de messagerie qui contient la liste des messages d’un dossier.

L'élément "treeRcv" peut contenir des éléments "headerRef".

==== Element headerRef ====
L'élément headerRef spécifie les champs associés à chaque sous-groupe d'onglet de formulaire ou les champs qu'il est possible d'afficher dans la liste des messages.
Aucun attribut ne vient compléter la balise "headerRef", eg.
<ximf:headerRef>header-classification</ximf:headerRef>

Finalement, le fichier "ihm" pourra contenir :
<pre>
<ximf:instance name="Amoco">
<ximf:ihm>
<ximf:panel id="pane_security" ilk="ilk-priority-panel">
<ximf:groupbox id="group-classification" ilk="ilk-secu-box">
<ximf:headerRef>header-correspondance-type</ximf:headerRef>
<ximf:headerRef>header-classification</ximf:headerRef>
</ximf:groupbox>
</ximf:panel>
<ximf:treeRcv>
<ximf:headerRef>header-classification</ximf:headerRef>
</ximf:treeRcv>
</ximf:ihm>
</ximf:instance>
</pre>

=== Fichier headers ===
Le fichier headers spécifie les types des champs de l'interface des formulaires XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient des éléments "header".

<div style="color:red">'''TODO :'''
Il semble que les fichiers headers définissent des entêtes devant être envoyées alors que ces mêmes entêtes ne sont pas spécifiés dans le fichier ihm. Ce comportement est logique, en effet, l'utilisateur n'a pas forcément besoin de savoir tout ce qui est envoyé via le formulaire. Cependant, comment le moteur XIMF sait quels entêtes doivent être envoyés ?
De même, pourquoi certains headers sont présents dans ce fichiers mais ne sont pas affichés dans l'ihm (ie. les headers X-XIMF-Primary-Precedence et X-XIMF-Copy-Precedence de l'instance Amoco) ?
</div>

==== Element header ====
Chaque élément "header" décrit un entête de message de format XIMF.
Huit attributs précisent la balise "header" : "headerName", "id", "technicalHeaderName", "type", "technicalType", "isMandatory", "ilk", "description", e.g.,

<div style="color:red;">'''TODO :'''
Comment est effectuée la vérification de l'attribut isMandatory et quelles sont les conditions de fonctionnement de celui-ci ? Est-il possible, par exemple, de spécifier l'attribut isMandatory=true d'un élément header si le contenu de celui-ci est un élément « set » qui dispose des attributs minItem et maxItem ? Actuellement, lorsque l'on crée un élément set avec les attributs minItem et maxItem, le champ du formulaire associé ne peux pas être validé : e.g.,
<ximf:set id="value-amoco-classification" minItem="1" maxItem="64" separator=";" technicalSeparator=".">
</div>

<ximf:header id="header-primary-precedence"
headerName="X-XIMF-Primary-Precedence"
ilk="ilk-primary-precedence"
isMandatory="true"
description="entête d’urgence"
type="string" />

* Détails sur les attributs de l'élément "header" :
** L’attribut "headerName" définit le nom du champ XIMF. Cet attribut est obligatoire.
** L’attribut "id" définit un identifiant de champ, il doit être unique pour chaque élément "header" et est formaté selon la syntaxe "header-xxx". Cet attribut est obligatoire.
** L’attribut "isMandatory" précise si ce champ doit être obligatoirement présent dans le message intégrant les entêtes selon cette description.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.
** L’attribut "type" précise le format des données associées à cet élément. Ce format peut être une date, une chaîne, une adresse mail, un O.I.D.
** L’attribut "technicalHeaderName" permet de compléter l’entête décrit par un autre entête.
** L’attribut "technicalType" précise le format des données associées à l’élément technicalHeaderName.
** L’attribut "description" permet d’ajouter une information sur cet élément.

L’élément "header" contient obligatoirement un élément "set", "multiset", "string", ou "compstring", e.g.,

<ximf:header id="header-reply-by"
headerName="X-XIMF-Reply-By"
ilk="ilk-reply-by"
isMandatory="false" >
<ximf:string id="value-reply-by" editable="true" />
</ximf:header>

<div style="color:red;">
'''TODO :''' Quelles sont les contraintes associées à l'attribut type d'un élément header ?
</div>

==== Element string ====
L’élément "string" précise le contenu d’une ressource de type chaîne de caractères imprimables (a-z, A-Z, 1-9,…)
Quinze attributs complètent l’élément "string" : "id", "ref", "ilk", "aclLevel", "index", "description", "editable", "content", "technicalContent","maxItem", "minItem", "maxLength", "minLength", "separator", "technicalSeparator", e.g.,

<ximf:string ilk="ilk-france" content="FRA" />

* Détails sur les attributs de l'élément "string" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "string".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role| élément role]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut " description " permet d’associer un commentaire sur cette donnée.
** L’attribut "editable" définit une valeur de saisie (champ libre). Cet attribut est de type booléen.
** L’attribut "content" représente la valeur effective de la donnée. C’est cette donnée qui sera associée au champ XIMF créé.
** L’attribut "technicalContent" représente la valeur effective de la donnée technique. C’est cette donnée qui sera associée au champ technique XIMF créé (cf. attribut technicalHeaderName de l’élément "header".
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.

L’élément "string" peut contenir plusieurs éléments "linkedValue".

<ximf:string ilk="ilk-non-protege" content="NON PROTEGE" technicalContent="1" >
<ximf:linkedValue ref="value-non-protege-france " />
</ximf:string>

==== Element compstring ====
<div style="color:red;">
'''TODO :''' L'attribut de l'élément « compstring » nommé « contentFactorise » devrait s'appeler « contentFactorize ».
</div>
L’élément "compstring" décrit un conteneur de concaténation des éléments fils. Il permet notamment de créer des valeurs d’entêtes composées.
Dix-sept attributs complètent l’élément "compstring" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", "content", "technicalContent", "contentPositionEnd", "contentFactorise", "technicalPositionEnd", e.g.,

<ximf:compstring
ilk="ilk-special"
content="SPECIAL"
technicalContent="1.3.4"
separator=" "
technicalSeparator=".">

* Détails sur les attributs de l'élément "compstring" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "compstring".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (cf. [[#Element_role| élément "role"]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut " description " permet d’associer un commentaire sur cette donnée.
** L’attribut "content" représente la valeur effective de la donnée. C’est cette donnée qui sera associée au champ XIMF créé.
** L’attribut "technicalContent" représente la valeur effective de la donnée technique. C’est cette donnée qui sera associée au champ technique XIMF créé (cf. attribut technicalHeaderName de l’élément "header".
** L’attribut "separator" définit le caractère de séparation entre deux valeurs.
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "contentPositionEnd" impose de positionner le contenu de l’élément "compstring" après les valeurs des éléments fils : valuefils1,valuefils2 : valuecompstring.
** L’attribut "technicalPositionEnd" impose de positionner le contenu de l’élément "compstring" après les valeurs des éléments fils.
** L’attribut "contentFactorise" impose d’utiliser le contenu de l’élément "compstring" comme facteur des éléments fils : valuecompstring(valuefils1,valuefils2).

L’élément "compstring" peut contenir un élément "string" ou "set" ou "multiset" ou plusieurs éléments "compstring".

<ximf:compstring
ilk="ilk-special"
content="SPECIAL"
technicalContent="1.3.4"
separator=" "
technicalSeparator=".">
<ximf:set id="ilk-special-op " maxItem="64">
<ximf:string ilk="ilk-special-op1" content="OP1" technicalContent="1" />
<ximf:string ilk="ilk-special-op2" content="OP2" technicalContent="2" />
<ximf:string ilk="ilk-special-op3" content="OP3" technicalContent="3" />
</ximf:set>
</ximf:compstring>

==== Element set ====
L’élément "set" décrit un conteneur de ressources de même type. Cet élément autorise la sélection de plusieurs ressources mais chaque ressource est sélectionnée une seule fois.
Douze attributs précisent la description de la balise "set" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", e.g.,

<ximf:set id="value-categories" ref="value-mentions" maxItem="64" separator=";" />

* Détails sur les attributs de l'élément "set" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "ximf:set".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role|élément rôle]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut "description" permet d’associer un commentaire sur cette donnée.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs

L’élément "set" peut contenir un ou plusieurs éléments "string" ou un ou plusieurs éléments "compstring".

<ximf:set id="value-categories" minItem="1" maxItem="64" separator=";">
<ximf:string ilk="ilk-releasable-to" content="RELEASABLE TO " />
<ximf:string ilk="ilk-eyes-only" content=" EYES ONLY"/>
<ximf:string ilk="ilk-use-only" content=" USE ONLY"/>
</ximf:set>

<div style="color:red;">'''TODO :'''
* Y a-t-il une définition des fichiers associés aux instances XIMF (e.g, le fichier attribution-list.xml utilisé dans l'instance Caterpillar) ?
* Comment le moteur XIMF sait qu'un élément est une "attribution-list" ?
</div>

==== Element multiset ====
L’élément "multiset" décrit un conteneur de ressources de même type. Cet élément autorise la sélection de plusieurs ressources et chaque ressource peut être sélectionnée plusieurs fois.
Douze attributs précisent la description de la balise "multiset" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", e.g.,

<ximf:multiset
id="value-restricted"
ilk=" value-restricted-otan"
maxItem="64"
separator=";" />

* Détails sur les attributs de l'élément "multiset" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "multiset".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role|élément rôle]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut "description" permet d’associer un commentaire sur cette donnée.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs

L’élément "multiset" peut contenir un ou plusieurs éléments "string" ou un ou plusieurs éléments "compstring".

<ximf:multiset id="value-restricted-otan-categories" minItem="1" maxItem="64" separator=";" >
<ximf:string ilk="ilk-releasable-to" content="RELEASABLE TO "/>
<ximf:string ilk="ilk-eyes-only" content=" EYES ONLY"/>
<ximf:string ilk="ilk-use-only" content=" USE ONLY"/>
</ximf:multiset>

<span style="color:red;">'''TODO ''': Comment sont gérées les règles associées aux champs multivaleurs (disposant par exemple des attributs minItem/maxItem ou les champs multiset) ?</span>

==== Element linkedValue ====
L’élément "linkedValue" définit une référence sur une ressource de type conteneur ("set", "multiset") ou "string". Cette ressource devrait être utilisée si la ressource contenant "linkedValue" (noeud parent) est sélectionnée.
Un attribut précise la balise "linkvalue" : "ref", e.g.,

<ximf:linkedValue ref="value-restricted-otan-classification-id" />

* Détails sur les attributs de l'élément "linkedValue" :
** L’attribut "ref" précise la valeur de l’attribut "id" de la ressource cible. Cet attribut est obligatoire.

=== Fichier rules ===
Le fichier rules définit les règles de contrôles d’entêtes XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui peut contenir des éléments "ximf:rule".

==== Element rule ====
<div style="color:red">
'''TODO :''' Mettre à jour la documentation :
* Les éléments autorisés dans un élément « rule » ne sont plus à jour. La présente documentation spécifie 12 éléments : AliasHeader, AliasValue, Compatibility, Association, SecureHeaders, SecurityLabel, Constraint, Assignment, Processing, Accessibility, Role et Custom. Le schéma XML fourni avec le mail en spécifie 5 : Constraint, Processing, Compatibility, Policy et Custom et place les autres en tant qu'extentions des 5 éléments cités précédemment.
* Les éléments SecureHeaders et SecurityLabel associés à l'élément « rule » ne figurent pas dans la nouvelle version du shéma xml. On les retrouve dans les fichiers rules-*.xml mais les éléments sont commentés, ils sont, de plus, présents dans une autre instance : comment ces éléments sont utilisés dans Trustedbird ?
* L'élément ximf:classificationPictures n'est pas documenté. De plus, il serait bon d'avoir des précisions sur la raison qui a motivé l'ajout de cet élément dans les fichiers de règles (alors qu'il semblerait être plus adapté au fichier headers-*.xml).
</div>
L’élément "rule" est le conteneur principal de description d’un comportement particulier à appliquer sur un ensemble d’entêtes XIMF.
Trois attributs précisent la balise "rule" : "id", "agent", "description", e.g.,
<ximf:rule id="compatibility-rule" description="Règle sur la compatibilité X-SMTP / XIMF" >

* Détails sur les attributs de l'élément "rule" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "rule". Cet attribut est obligatoire.
** L’attribut "agent" indique l’équipement cible devant analyser et appliquer le contenu de cet élément.
** L’attribut "description" autorise l’auteur d’ajouter un commentaire sur cet élément.

L’élément "rule" contient un ou plusieurs mêmes éléments de spécialisation de la règle "contraint", "assignement", "processing", "compatibility", "accessibility", "custom",…, e.g.,

<ximf:rule id="precedence-rule" agent="mua" description="Règle sur les priorités">
<ximf:constraint
left="header-primary-precedence"
operator="equalOrGreaterThan"
right="header-copy-precedence" />
</ximf:rule>

==== Element aliasHeader ====
L’élément "aliasHeader" permet de définir le nom de l’entête sur lequel la règle précisée est appliquée
Deux attributs précisent la balise "aliasHeader" : "headerName" et "headerRef", e.g.,

<ximf:aliasHeader headerName ="X-P772-Version" headerRef="X-XIMF-VERSION" />

* Détails sur les attributs de l'élément "aliasHeader" :
* L’attribut "headerName" définit le nom XIMF de l’entête modifié par la règle. Cet attribut est obligatoire.
* L’attribut "headerRef" définit le nom d’un entête XIMF de référence qui est le point d’entrée de l’application de la règle sur l’entête définit par "headerName". Cela permet de lier deux entêtes de messages où l’utilisation de l’un des entêtes influe sur le comportement de l’autre.

L’élément "aliasHeader" peut contenir des éléments "aliasValue",e.g ,

<ximf:aliasHeader headerName="X-P772-Version" />
<ximf:aliasValue vame="1.0"/>
<ximf:aliasHeader>

==== Element aliasValue ====
L’élément "aliasValue" contient une valeur à associer à l’entête XIMF contrôlé par la règle. Il est utile lorsque deux entêtes sont liées (utilisation de l’attribut headerRef dans l’élément aliasHeader) et que les valeurs de l’entêtes de référence permettent de préciser celles de l’entête contrôlé.
Deux attributs précisent la balise "aliasValue" : "valueName", "valueRef", e.g.,

<ximf:aliasValue valueName="2" valueRef="flash" />

* Détails sur les attributs de l'élément "aliasValue" :
** L’attribut "valueName" définit la valeur de l’entête à créer. Cet attribut est obligatoire.
** L’attribut "valueRef" définit la valeur de l’entête XIMF de référence pour utiliser valueName.
<span style="color:red;">'''TODO :''' L'attribut valueRef est-il obligatoire ?</span>

==== Element compatibility ====
L’élément "compatibility" est utilisé pour associer à un entête respectant la norme XIMF un entête respectant une autre norme que XIMF (XSMTP par exemple).
Deux attributs précisent la balise "compatibility" : "targetName", "targetVersion", e.g.,

<ximf:compatibility targetName="X-SMTP" targetVersion="1.1">
<ximf:aliasValue headerName="X-P772-Version" content="1.1" />
<ximf:aliasValue
headerName="X-P772-Primary-Precedence"
headerRef="header-primary-precedence"
dataRef="data-priority-xsmtp"/>
</ximf:compatibility>

* Détails sur les attributs de l'élément "compatibility" :
** L’attribut "targetName" définit la norme de l’entête à associer à l’entête XIMF. Cet attribut est obligatoire.
** L’attribut "targetVersion" définit le numéro de version de la norme de l’entête à associer à l’entête XIMF. Cet attribut est obligatoire.

L’élément "compatibility" contient au moins un élément "aliasHeader".

<u>Pour illustrer cette règle :</u>
Le format XSMTP est déjà supporté par certains équipements. Afin de rendre ceux-ci inter opérables avec le nouveau format XIMF, cette règle permet d’associer un entête XSMTP contenant les mêmes informations qu’un entête XIMF.

L’élément Association : dépendance entre entêtes
L’élément "association" définie les valeurs autorisées pour un entête XIMF en fonction d’une valeur définie pour un autre entête XIMF.

<ximf:association>
<ximf:aliasHeader
headerName="X-XIMF-Primary-Precedence"
headerRef="X-XIMF-Correspondence-Type">
<ximf:aliasValue valueName="routine" valueRef="private" />
<ximf:aliasValue valueName="routine,priority" valueRef="professional" />
<ximf:aliasValue valueName="routine,priority,immediate,flash" valueRef="operational" />
<ximf:aliasValue valueName="routine,priority,immediate" valueRef="official" />
</ximf:aliasHeader>
</ximf:association>

==== Element secureHeaders ====
L’élément "secureHeaders" définie la liste des entêtes à intégrer dans la signature d’un message. Cette règle s’applique sur les équipements proposant un algorithme de signature des messages.

Un élément "secureHeaders" contient un ou plusieurs éléments "aliasHeaders" où chaque élément décrit un entête à intégrer dans la signature et complété d’un attribut "status".

<ximf:secureHeaders targetName="SecureHeaders">
<ximf:aliasHeader headerName="X-XIMF-Primary-Precedence" status="0" />
<ximf:aliasHeader headerName="X-XIMF-Copy-Precedence" status="0" />
</ximf:secureHeaders>

==== Element securityLabel ====
L’élément "securityLabel" définie la liste des entêtes à intégrer dans la signature d’un message. Cette règle s’applique sur les équipements proposant un algorithme de signature des messages selon la norme RFC.

Un élément "securityLabel" contient un ou plusieurs éléments "aliasHeaders" où chaque élément décrit un entête à intégrer dans la signature et complété d’un attribut "status".

<ximf:securityLabel targetName="SecurityLabel" id="Amoco">
<ximf:aliasHeader
headerName="SecurityPolicyIdentifier"
headerRef="X-XIMF-Security-Policy-Identifier" />
<ximf:aliasHeader
headerName="SecurityClassification"
headerRef="X-XIMF-Security-Classification-Identifier" />
<ximf:aliasHeader
headerName="ESSPrivacyMark"
headerRef="X-XIMF-Privacy-Mark" />
<ximf:aliasHeader
headerName="SecurityCategory"
headerRef="X-XIMF-Security-Categories-Identifier"
type="2" />
</ximf:securityLabel>

==== Element constraint ====
L’élément "constraint" est utilisé pour définir une règle de construction de deux entêtes partageant des "datas" identiques.
Trois attributs précisent la balise "constraint" : "left", "right", "operator", e.g.,

<ximf:constraint
left="header-primary-precedence"
operator="equalOrGreaterThan"
right="header-copy-precedence" />

* Détails sur les attributs de l'élément "constraint" :
** L’attribut "left" désigne le premier élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "right" désigne le deuxième élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "operator" indique la règle de poids à appliquer sur la valeur des deux éléments "header", il peut être de type "greaterThan", "lowerThan", "equalOrGreaterThan", "equalOrLowerThan", "equal". Cet attribut est obligatoire.

* Détails sur les valeurs possibles de l'attribut "type" :
** Le type "greaterThan" signifie que la valeur de l’élément "left" doit être strictement supérieur à la valeur de l’élément "right".
** Le type "lowerThan" signifie que la valeur de l’élément "left" doit être strictement inférieur à la valeur de l’élément "right".
** Le type "equalOrGreaterThan" signifie que la valeur de l’élément "left" doit être supérieur ou égale à la valeur de l’élément "right".
** Le type "equalOrLowerThan" signifie que la valeur de l’élément "left" doit être inférieur ou égale à la valeur de l’élément "right".
** Le type "equal" signifie que la valeur de l’élément "left" et de l’élément "right" doivent être identiques.

==== Element assignment ====
<div style="color:red;">'''TODO :''' L'élément assignment n'apparaît pas dans le shéma xml qui avait été envoyé.</div>

L’élément "assignement" est utilisé pour affecter une valeur créée en fonction d’une règle de comparaison sur les valeurs de deux éléments "header".
Quatre attributs précisent la balise "assignement" : "left", "right", "operator", "result", e.g.,

<ximf:assignment
left="header-primary-precedence"
operator="equal"
right="data-routine-precedence"
result="86400" />

* Détails sur les attributs de l'élément "assignment" :
** L’attribut "left" désigne le premier élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "right" désigne le deuxième élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "operator" indique la règle de comparaison entre les valeurs des deux éléments "header", il peut être de type "greaterThan", "lowerThan", "equalOrGreaterThan", "equalOrLowerThan", "equal". Cet attribut est obligatoire.
** L’attribut "result" représente la valeur à utiliser si la règle de comparaison entre les deux éléments est satisfaite. Cet attribut est obligatoire.

==== Element processing ====
L’élément "processing" regroupe des règles de traitement à effectuer sur des entêtes formatés.
L’attribut "type" précise le type de traitement à effectuer sur ces valeurs. Cet attribut est obligatoire, il est de type : "sign-header-value", "encrypt-header-value", "capitalize-header-value", e.g.,

<ximf:processing type="sign-header-value">
<ximf:refHeader>header-primary-precedence</ximf:refheader>
<ximf:refHeader>header-copy-precedence</ximf:refheader>
<ximf:refHeader>header-echange-type</ximf:refheader>
</ximf:processing>

* Détails sur les valeurs possibles de l'attribut "type" :
** Le type "sign-header-value" définit un traitement de signature des entêtes définis dans la balise.
** Le type "encrypt-header-value" définit un traitement de chiffrement des entêtes définis dans la balise.
** Le type "capitalize-header-value" définit un traitement de capitalisation des entêtes définis dans la balise.

L’élément "processing" contient au moins un élément "refHeader".
<div style="color:red;">'''TODO :'''L'élément refHeader n'est pas documenté, s'agit-il en fait de l'élément headerRef ?</div>

==== Element accessibility ====
<div style="color:red;">'''TODO :''' L'élément accessibility n'apparaît pas dans le shéma xml qui avait été envoyé.</div>
L’élément "accessibility" définit un ensemble de règles de droit d’accès aux éléments d’une instance pour une cible déterminée (utilisateur, routeur…).
Cet élément contient un ou plusieurs éléments "role".

<ximf:accessibility>
<ximf:role id="role-flash-allowed" aclLevel="100" />
<ximf:role id="role-flash-prohibited" aclLevel="50" />
</ximf:accessibility>

==== Element role ====
L’élément "role" positionne une valeur d’accès à pour une entité définit.
Deux attributs complètent l’élément "role" : "id", "aclLevel", e.g.,

<ximf:role id="role-flash-allowed" aclLevel="100" />

* Détails sur les attributs de l'élément "role" :
** L’attribut "id" précise l’entité accessible en fonction d’une valeur déterminée.
** L’attribut "aclLevel" précise la valeur seuil d’accès à l’entité.

==== Element custom ====
L’élément "custom" permet à l’auteur de créer des nouvelles règles personnalisées.
Trois attributs précisent la balise "custom" : "id", "provider", "description", e.g.,

<ximf:custom
id="custom-display"
provider="EADS"
description="Affichage de la composition du message" >
<node1><node2><node3></node3></node2></node1>
</ximf:custom>

* Détails sur les attributs de l'élément "custom" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "custom" et formaté selon la syntaxe "custom-xxx". Cet attribut est obligatoire.
** L’attribut "provider" identifie l’auteur de la règle. Cet attribut est obligatoire.
** L’attribut "description" permet d’ajouter un commentaire sur cet élément.

L’élément "custom" peut contenir tous les éléments possibles en respectant les standards XML.

XIMF XML tags/fr

2011-03-15T10:36:30Z

Anthonyjuge : /* Fichier ximfmail-profile */

== Introduction ==
Ce document propose un modèle de description, via eXtensible Markup Language (XML), d’entêtes de messages électroniques respectant la norme XIMF. Ce document a deux objectifs :
# Décrire les éléments et attributs de représentation XML pour construire des entêtes de messages électroniques de format XIMF.
# Fournir un modèle de représentation XIMF/XML.

<u>Rappel :</u>
* Un "élément" fait référence à tous les caractères situés entre une balise de départ et un balise de fin, e.g.,
<exemple> texte et/ou éléments fils </exemple>
* Un "attribut" est une composante d’un élément. Il est positionné dans la balise de départ, e.g.,
<exemple nom='value'>

Tous les éléments décrits dans cette documentation paragraphe sont validés dans l’espace de nom "ximf".

<pre>
xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://eads.org/ximf/ximf.xsd"
</pre>

== Description détaillée des balises XML ==

Voici, par ordre d'apparition et en fonction des fichiers, les balises génériques associées aux différents fichiers XML.

=== Fichier ximfmail-profile ===

<div style="color:red;">'''TODO''' :
* Combien d'éléments ihm sont autorisés dans un élément instance ?
* La documentation des fichiers ximfmail-profile.xml n'est pas disponible.
* Quel est le rôle de l'élément "acces" ?
* Quelle est l'utilité des identifiants associés aux éléments instance, shema, ihm, etc.
* Quelle est l'utilité de l'attribut name associé aux éléments instance. Y a-t-il une vérification s'assurant que les fichiers utilisés par une instance correspondent bien à l'instance à laquelle ils sont associés ?
</div>

Un fichier xpi peut contenir plusieurs instances XIMF, celles-ci sont alors regroupées dans une même catégorie. Le fichier ximfmail-profile contient des informations sur toutes les instances contenues dans le xpi, notamment leur nom, leur chemin d'accès, ainsi que les noms des fichiers associés à chaque instance.

==== Element instance ====
L’élément "instance" identifie l’ensemble des entêtes à décrire selon la norme XIMF. C’est le conteneur principal d’une instance XIMF/XML. Cinq attributs précisent la balise "instance" : "ximfVersion", "version", "author", "creation", "name", e.g.,
<ximf:instance name="myInstance" version="1.0" ximfVersion="2.0" >

* Détails sur les attributs de l'élément "instance" :
** L’attribut "name" définit le nom de l’instance décrite. Cet attribut est obligatoire.
** L’attribut "ximfVersion" définit le numéro de version des entêtes XIMF utilisés pour cette représentation. Cet attribut est obligatoire.
** L’attribut "version" définit le numéro de version de l’instance décrite. Cet attribut est obligatoire.
** L’attribut "author" renseigne sur le nom de l’auteur de cette instance.
** L’attribut "creationDate" précise la date de création de cette instance.

L’élément "instance" peut contenir un ou plusieurs éléments "schema", un ou plusieurs éléments "rule", un élément "ihm" et un élément "dictionary".

==== Element dictionary ====
L'élément dictionary contient le chemin vers le fichier spécifiant les données d'internationalisation (Cf. [[#Fichier_dictionary|Fichier dictionary]]).

==== Element schema ====
L'élément shema contient le chemin vers le fichier spécifiant les entêtes XIMF (Cf. [[#Fichier_headers|Fichier headers]]).

==== Element ihm ====
L'élément ihm contient le chemin vers le fichier spécifiant la disposition de l'interface des formulaires XIMF (Cf. [[#Fichier_ihm|Fichier ihm]]).

==== Element rule ====
L'élément rule contient le chemin vers le fichier spécifiant les règles associées aux valeurs des champs XIMF (Cf. [[#Fichier_rules|Fichier rules]]).

=== Fichier dictionary ===
Le fichier dictionnary permet de mettre en œuvre l’internationalisation d’une instance XIMF. Il défini des dictionnaires qui servent à traduire les éléments de l'instance XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient un élément "ximf:dictionnary".

==== Element dictionary ====
<div style="color:red;">'''TODO''' :
* Quel est l'intérêt de renseigner un attribut "id" à l'élément "dictionary" (étant donné qu'un seul élément "dictionary est autorisé dans l'élément "instance") ?</div>

L’élément "dictionary" contient toutes les informations devant être interprétées selon le pays d’utilisation.
L’élément "dictionary" contient un ou plusieurs mêmes éléments "locale", e.g.,

<ximf:dictionary>
<ximf:locale lang="fr-FR" />
<ximf:locale lang="en-US" />
</ximf:dictionary>

==== Element locale ====
L’élément "locale" contient toutes les informations pour un pays et/ou langue désignée.
L’élément "locale" contient un ou plusieurs mêmes éléments "ilk", e.g.,

<ximf:locale lang="fr-FR" >
<ximf:ilk entity="a"/>
<ximf:ilk entity="b"/>
</ximf:locale>

* Détails sur les attributs de la balise "locale" :
** L’attribut "lang" définit le code pays de ce conteneur. Il devrai être construit selon le format défini par la RFC1766 (fr, en, ja, es, …).

==== Element ilk ====
L’élément "ilk" contient une unique information correspondant à une donnée traduite selon le code pays de l’élément père. Cette information est au format chaîne de caractère. Un attribut obligatoire précise la balise "ilk".

<ximf:ilk entity="ilk-lang-ihm">langue</ximf:ilk>

* Détails sur les attributs de la balise "ilk" :
** L’attribut "entity" définit la référence d’entrée pour récupérer le contenu de l’élément selon le code pays souhaité.

Finalement, le fichier "dictionary" pourra contenir :
<ximf:instance name="Whirlpool">
<ximf:dictionary>
<ximf:locale lang="fr-FR" >
<ximf:ilk entity="ilk-lang-ihm">Français</ximf:ilk>
<ximf:ilk entity="ilk-exemple-general">Général</ximf:ilk>
</ximf:locale>
<ximf:locale lang="en-US" >
<ximf:ilk entity="ilk-lang-ihm">English (US)</ximf:ilk>
<ximf:ilk entity="ilk-exemple-general">General</ximf:ilk>
</ximf:locale>
</ximf:dictionary>
</ximf:instance>

=== Fichier ihm ===
<span style="color:red;">'''TODO''' : La documentation originale ne décrit pas le fichier ihm, les informations ci-dessous ont seulement été présumées. Merci de les vérifier/compléter.
</span>

Le fichier ihm spécifie l'agencement de l'interface des formulaires XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient un élément "ximf:ihm".

==== Element ihm ====
L'élément "ihm" contient un ou plusieurs éléments "panel" et un élément "treeRcv".

==== Element panel ====
Un élément ximf:panel correspond à un onglet du formulaire XIMF construit.
Deux attributs précisent la balise "panel" : "id" et "ilk", eg.
<ximf:panel id="pane_security" ilk="ilk-priority-panel" />

* Détails sur les attributs de l'élément "panel" :
** L’attribut "id" définit le nom de l'onglet, il doit être unique pour chaque élément "ximf:panel" et est formaté selon la syntaxe "pane-xxx". Cet attribut est obligatoire.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.

L'élément "ximf:panel" contient au moins un éléments "ximf:groupbox".

==== Element groupbox ====
Un élément groupbox correspond à une sous catégorie d'un onglet du formulaire XIMF.
La structure "groupbox" détaille l’ordre d’affichage des entêtes dans un message.
Deux attributs précisent la balise "ximf:groupbox" : "id" et "ilk", eg.
<ximf:groupbox id="group-classification" ilk="ilk-secu-box" />

* Détails sur les attributs de l'élément "groupbox" :
** L’attribut "id" définit le nom de l'onglet, il doit être unique pour chaque élément "ximf:panel" et est formaté selon la syntaxe "pane-xxx". Cet attribut est obligatoire.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.

L'élément "groupbox" contient au moins un éléments "headerRef".

==== Element treeRcv ====
L'élément "treeRcv" permet de spécifier quelles sont les colonnes susceptibles d'être ajoutées dans le panneau principal du client de messagerie qui contient la liste des messages d’un dossier.

L'élément "treeRcv" peut contenir des éléments "headerRef".

==== Element headerRef ====
L'élément headerRef spécifie les champs associés à chaque sous-groupe d'onglet de formulaire ou les champs qu'il est possible d'afficher dans la liste des messages.
Aucun attribut ne vient compléter la balise "headerRef", eg.
<ximf:headerRef>header-classification</ximf:headerRef>

Finalement, le fichier "ihm" pourra contenir :
<pre>
<ximf:instance name="Amoco">
<ximf:ihm>
<ximf:panel id="pane_security" ilk="ilk-priority-panel">
<ximf:groupbox id="group-classification" ilk="ilk-secu-box">
<ximf:headerRef>header-correspondance-type</ximf:headerRef>
<ximf:headerRef>header-classification</ximf:headerRef>
</ximf:groupbox>
</ximf:panel>
<ximf:treeRcv>
<ximf:headerRef>header-classification</ximf:headerRef>
</ximf:treeRcv>
</ximf:ihm>
</ximf:instance>
</pre>

=== Fichier headers ===
Le fichier headers spécifie les types des champs de l'interface des formulaires XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient des éléments "header".

<div style="color:red">'''TODO :'''
Il semble que les fichiers headers définissent des entêtes devant être envoyées alors que ces mêmes entêtes ne sont pas spécifiés dans le fichier ihm. Ce comportement est logique, en effet, l'utilisateur n'a pas forcément besoin de savoir tout ce qui est envoyé via le formulaire. Cependant, comment le moteur XIMF sait quels entêtes doivent être envoyés ?
</div>

==== Element header ====
Chaque élément "header" décrit un entête de message de format XIMF.
Huit attributs précisent la balise "header" : "headerName", "id", "technicalHeaderName", "type", "technicalType", "isMandatory", "ilk", "description", e.g.,

<div style="color:red;">'''TODO :'''
Comment est effectuée la vérification de l'attribut isMandatory et quelles sont les conditions de fonctionnement de celui-ci ? Est-il possible, par exemple, de spécifier l'attribut isMandatory=true d'un élément header si le contenu de celui-ci est un élément « set » qui dispose des attributs minItem et maxItem ? Actuellement, lorsque l'on crée un élément set avec les attributs minItem et maxItem, le champ du formulaire associé ne peux pas être validé : e.g.,
<ximf:set id="value-amoco-classification" minItem="1" maxItem="64" separator=";" technicalSeparator=".">
</div>

<ximf:header id="header-primary-precedence"
headerName="X-XIMF-Primary-Precedence"
ilk="ilk-primary-precedence"
isMandatory="true"
description="entête d’urgence"
type="string" />

* Détails sur les attributs de l'élément "header" :
** L’attribut "headerName" définit le nom du champ XIMF. Cet attribut est obligatoire.
** L’attribut "id" définit un identifiant de champ, il doit être unique pour chaque élément "header" et est formaté selon la syntaxe "header-xxx". Cet attribut est obligatoire.
** L’attribut "isMandatory" précise si ce champ doit être obligatoirement présent dans le message intégrant les entêtes selon cette description.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.
** L’attribut "type" précise le format des données associées à cet élément. Ce format peut être une date, une chaîne, une adresse mail, un O.I.D.
** L’attribut "technicalHeaderName" permet de compléter l’entête décrit par un autre entête.
** L’attribut "technicalType" précise le format des données associées à l’élément technicalHeaderName.
** L’attribut "description" permet d’ajouter une information sur cet élément.

L’élément "header" contient obligatoirement un élément "set", "multiset", "string", ou "compstring", e.g.,

<ximf:header id="header-reply-by"
headerName="X-XIMF-Reply-By"
ilk="ilk-reply-by"
isMandatory="false" >
<ximf:string id="value-reply-by" editable="true" />
</ximf:header>

<div style="color:red;">
'''TODO :''' Quelles sont les contraintes associées à l'attribut type d'un élément header ?
</div>

==== Element string ====
L’élément "string" précise le contenu d’une ressource de type chaîne de caractères imprimables (a-z, A-Z, 1-9,…)
Quinze attributs complètent l’élément "string" : "id", "ref", "ilk", "aclLevel", "index", "description", "editable", "content", "technicalContent","maxItem", "minItem", "maxLength", "minLength", "separator", "technicalSeparator", e.g.,

<ximf:string ilk="ilk-france" content="FRA" />

* Détails sur les attributs de l'élément "string" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "string".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role| élément role]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut " description " permet d’associer un commentaire sur cette donnée.
** L’attribut "editable" définit une valeur de saisie (champ libre). Cet attribut est de type booléen.
** L’attribut "content" représente la valeur effective de la donnée. C’est cette donnée qui sera associée au champ XIMF créé.
** L’attribut "technicalContent" représente la valeur effective de la donnée technique. C’est cette donnée qui sera associée au champ technique XIMF créé (cf. attribut technicalHeaderName de l’élément "header".
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.

L’élément "string" peut contenir plusieurs éléments "linkedValue".

<ximf:string ilk="ilk-non-protege" content="NON PROTEGE" technicalContent="1" >
<ximf:linkedValue ref="value-non-protege-france " />
</ximf:string>

==== Element compstring ====
<div style="color:red;">
'''TODO :''' L'attribut de l'élément « compstring » nommé « contentFactorise » devrait s'appeler « contentFactorize ».
</div>
L’élément "compstring" décrit un conteneur de concaténation des éléments fils. Il permet notamment de créer des valeurs d’entêtes composées.
Dix-sept attributs complètent l’élément "compstring" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", "content", "technicalContent", "contentPositionEnd", "contentFactorise", "technicalPositionEnd", e.g.,

<ximf:compstring
ilk="ilk-special"
content="SPECIAL"
technicalContent="1.3.4"
separator=" "
technicalSeparator=".">

* Détails sur les attributs de l'élément "compstring" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "compstring".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (cf. [[#Element_role| élément "role"]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut " description " permet d’associer un commentaire sur cette donnée.
** L’attribut "content" représente la valeur effective de la donnée. C’est cette donnée qui sera associée au champ XIMF créé.
** L’attribut "technicalContent" représente la valeur effective de la donnée technique. C’est cette donnée qui sera associée au champ technique XIMF créé (cf. attribut technicalHeaderName de l’élément "header".
** L’attribut "separator" définit le caractère de séparation entre deux valeurs.
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "contentPositionEnd" impose de positionner le contenu de l’élément "compstring" après les valeurs des éléments fils : valuefils1,valuefils2 : valuecompstring.
** L’attribut "technicalPositionEnd" impose de positionner le contenu de l’élément "compstring" après les valeurs des éléments fils.
** L’attribut "contentFactorise" impose d’utiliser le contenu de l’élément "compstring" comme facteur des éléments fils : valuecompstring(valuefils1,valuefils2).

L’élément "compstring" peut contenir un élément "string" ou "set" ou "multiset" ou plusieurs éléments "compstring".

<ximf:compstring
ilk="ilk-special"
content="SPECIAL"
technicalContent="1.3.4"
separator=" "
technicalSeparator=".">
<ximf:set id="ilk-special-op " maxItem="64">
<ximf:string ilk="ilk-special-op1" content="OP1" technicalContent="1" />
<ximf:string ilk="ilk-special-op2" content="OP2" technicalContent="2" />
<ximf:string ilk="ilk-special-op3" content="OP3" technicalContent="3" />
</ximf:set>
</ximf:compstring>

==== Element set ====
L’élément "set" décrit un conteneur de ressources de même type. Cet élément autorise la sélection de plusieurs ressources mais chaque ressource est sélectionnée une seule fois.
Douze attributs précisent la description de la balise "set" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", e.g.,

<ximf:set id="value-categories" ref="value-mentions" maxItem="64" separator=";" />

* Détails sur les attributs de l'élément "set" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "ximf:set".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role|élément rôle]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut "description" permet d’associer un commentaire sur cette donnée.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs

L’élément "set" peut contenir un ou plusieurs éléments "string" ou un ou plusieurs éléments "compstring".

<ximf:set id="value-categories" minItem="1" maxItem="64" separator=";">
<ximf:string ilk="ilk-releasable-to" content="RELEASABLE TO " />
<ximf:string ilk="ilk-eyes-only" content=" EYES ONLY"/>
<ximf:string ilk="ilk-use-only" content=" USE ONLY"/>
</ximf:set>

<div style="color:red;">'''TODO :'''
* Y a-t-il une définition des fichiers associés aux instances XIMF (e.g, le fichier attribution-list.xml utilisé dans l'instance Caterpillar) ?
* Comment le moteur XIMF sait qu'un élément est une "attribution-list" ?
</div>

==== Element multiset ====
L’élément "multiset" décrit un conteneur de ressources de même type. Cet élément autorise la sélection de plusieurs ressources et chaque ressource peut être sélectionnée plusieurs fois.
Douze attributs précisent la description de la balise "multiset" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", e.g.,

<ximf:multiset
id="value-restricted"
ilk=" value-restricted-otan"
maxItem="64"
separator=";" />

* Détails sur les attributs de l'élément "multiset" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "multiset".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role|élément rôle]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut "description" permet d’associer un commentaire sur cette donnée.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs

L’élément "multiset" peut contenir un ou plusieurs éléments "string" ou un ou plusieurs éléments "compstring".

<ximf:multiset id="value-restricted-otan-categories" minItem="1" maxItem="64" separator=";" >
<ximf:string ilk="ilk-releasable-to" content="RELEASABLE TO "/>
<ximf:string ilk="ilk-eyes-only" content=" EYES ONLY"/>
<ximf:string ilk="ilk-use-only" content=" USE ONLY"/>
</ximf:multiset>

<span style="color:red;">'''TODO ''': Comment sont gérées les règles associées aux champs multivaleurs (disposant par exemple des attributs minItem/maxItem ou les champs multiset) ?</span>

==== Element linkedValue ====
L’élément "linkedValue" définit une référence sur une ressource de type conteneur ("set", "multiset") ou "string". Cette ressource devrait être utilisée si la ressource contenant "linkedValue" (noeud parent) est sélectionnée.
Un attribut précise la balise "linkvalue" : "ref", e.g.,

<ximf:linkedValue ref="value-restricted-otan-classification-id" />

* Détails sur les attributs de l'élément "linkedValue" :
** L’attribut "ref" précise la valeur de l’attribut "id" de la ressource cible. Cet attribut est obligatoire.

=== Fichier rules ===
Le fichier rules définit les règles de contrôles d’entêtes XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui peut contenir des éléments "ximf:rule".

==== Element rule ====
<div style="color:red">
'''TODO :''' Mettre à jour la documentation :
* Les éléments autorisés dans un élément « rule » ne sont plus à jour. La présente documentation spécifie 12 éléments : AliasHeader, AliasValue, Compatibility, Association, SecureHeaders, SecurityLabel, Constraint, Assignment, Processing, Accessibility, Role et Custom. Le schéma XML fourni avec le mail en spécifie 5 : Constraint, Processing, Compatibility, Policy et Custom et place les autres en tant qu'extentions des 5 éléments cités précédemment.
* Les éléments SecureHeaders et SecurityLabel associés à l'élément « rule » ne figurent pas dans la nouvelle version du shéma xml. On les retrouve dans les fichiers rules-*.xml mais les éléments sont commentés, ils sont, de plus, présents dans une autre instance : comment ces éléments sont utilisés dans Trustedbird ?
* L'élément ximf:classificationPictures n'est pas documenté. De plus, il serait bon d'avoir des précisions sur la raison qui a motivé l'ajout de cet élément dans les fichiers de règles (alors qu'il semblerait être plus adapté au fichier headers-*.xml).
</div>
L’élément "rule" est le conteneur principal de description d’un comportement particulier à appliquer sur un ensemble d’entêtes XIMF.
Trois attributs précisent la balise "rule" : "id", "agent", "description", e.g.,
<ximf:rule id="compatibility-rule" description="Règle sur la compatibilité X-SMTP / XIMF" >

* Détails sur les attributs de l'élément "rule" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "rule". Cet attribut est obligatoire.
** L’attribut "agent" indique l’équipement cible devant analyser et appliquer le contenu de cet élément.
** L’attribut "description" autorise l’auteur d’ajouter un commentaire sur cet élément.

L’élément "rule" contient un ou plusieurs mêmes éléments de spécialisation de la règle "contraint", "assignement", "processing", "compatibility", "accessibility", "custom",…, e.g.,

<ximf:rule id="precedence-rule" agent="mua" description="Règle sur les priorités">
<ximf:constraint
left="header-primary-precedence"
operator="equalOrGreaterThan"
right="header-copy-precedence" />
</ximf:rule>

==== Element aliasHeader ====
L’élément "aliasHeader" permet de définir le nom de l’entête sur lequel la règle précisée est appliquée
Deux attributs précisent la balise "aliasHeader" : "headerName" et "headerRef", e.g.,

<ximf:aliasHeader headerName ="X-P772-Version" headerRef="X-XIMF-VERSION" />

* Détails sur les attributs de l'élément "aliasHeader" :
* L’attribut "headerName" définit le nom XIMF de l’entête modifié par la règle. Cet attribut est obligatoire.
* L’attribut "headerRef" définit le nom d’un entête XIMF de référence qui est le point d’entrée de l’application de la règle sur l’entête définit par "headerName". Cela permet de lier deux entêtes de messages où l’utilisation de l’un des entêtes influe sur le comportement de l’autre.

L’élément "aliasHeader" peut contenir des éléments "aliasValue",e.g ,

<ximf:aliasHeader headerName="X-P772-Version" />
<ximf:aliasValue vame="1.0"/>
<ximf:aliasHeader>

==== Element aliasValue ====
L’élément "aliasValue" contient une valeur à associer à l’entête XIMF contrôlé par la règle. Il est utile lorsque deux entêtes sont liées (utilisation de l’attribut headerRef dans l’élément aliasHeader) et que les valeurs de l’entêtes de référence permettent de préciser celles de l’entête contrôlé.
Deux attributs précisent la balise "aliasValue" : "valueName", "valueRef", e.g.,

<ximf:aliasValue valueName="2" valueRef="flash" />

* Détails sur les attributs de l'élément "aliasValue" :
** L’attribut "valueName" définit la valeur de l’entête à créer. Cet attribut est obligatoire.
** L’attribut "valueRef" définit la valeur de l’entête XIMF de référence pour utiliser valueName.
<span style="color:red;">'''TODO :''' L'attribut valueRef est-il obligatoire ?</span>

==== Element compatibility ====
L’élément "compatibility" est utilisé pour associer à un entête respectant la norme XIMF un entête respectant une autre norme que XIMF (XSMTP par exemple).
Deux attributs précisent la balise "compatibility" : "targetName", "targetVersion", e.g.,

<ximf:compatibility targetName="X-SMTP" targetVersion="1.1">
<ximf:aliasValue headerName="X-P772-Version" content="1.1" />
<ximf:aliasValue
headerName="X-P772-Primary-Precedence"
headerRef="header-primary-precedence"
dataRef="data-priority-xsmtp"/>
</ximf:compatibility>

* Détails sur les attributs de l'élément "compatibility" :
** L’attribut "targetName" définit la norme de l’entête à associer à l’entête XIMF. Cet attribut est obligatoire.
** L’attribut "targetVersion" définit le numéro de version de la norme de l’entête à associer à l’entête XIMF. Cet attribut est obligatoire.

L’élément "compatibility" contient au moins un élément "aliasHeader".

<u>Pour illustrer cette règle :</u>
Le format XSMTP est déjà supporté par certains équipements. Afin de rendre ceux-ci inter opérables avec le nouveau format XIMF, cette règle permet d’associer un entête XSMTP contenant les mêmes informations qu’un entête XIMF.

L’élément Association : dépendance entre entêtes
L’élément "association" définie les valeurs autorisées pour un entête XIMF en fonction d’une valeur définie pour un autre entête XIMF.

<ximf:association>
<ximf:aliasHeader
headerName="X-XIMF-Primary-Precedence"
headerRef="X-XIMF-Correspondence-Type">
<ximf:aliasValue valueName="routine" valueRef="private" />
<ximf:aliasValue valueName="routine,priority" valueRef="professional" />
<ximf:aliasValue valueName="routine,priority,immediate,flash" valueRef="operational" />
<ximf:aliasValue valueName="routine,priority,immediate" valueRef="official" />
</ximf:aliasHeader>
</ximf:association>

==== Element secureHeaders ====
L’élément "secureHeaders" définie la liste des entêtes à intégrer dans la signature d’un message. Cette règle s’applique sur les équipements proposant un algorithme de signature des messages.

Un élément "secureHeaders" contient un ou plusieurs éléments "aliasHeaders" où chaque élément décrit un entête à intégrer dans la signature et complété d’un attribut "status".

<ximf:secureHeaders targetName="SecureHeaders">
<ximf:aliasHeader headerName="X-XIMF-Primary-Precedence" status="0" />
<ximf:aliasHeader headerName="X-XIMF-Copy-Precedence" status="0" />
</ximf:secureHeaders>

==== Element securityLabel ====
L’élément "securityLabel" définie la liste des entêtes à intégrer dans la signature d’un message. Cette règle s’applique sur les équipements proposant un algorithme de signature des messages selon la norme RFC.

Un élément "securityLabel" contient un ou plusieurs éléments "aliasHeaders" où chaque élément décrit un entête à intégrer dans la signature et complété d’un attribut "status".

<ximf:securityLabel targetName="SecurityLabel" id="Amoco">
<ximf:aliasHeader
headerName="SecurityPolicyIdentifier"
headerRef="X-XIMF-Security-Policy-Identifier" />
<ximf:aliasHeader
headerName="SecurityClassification"
headerRef="X-XIMF-Security-Classification-Identifier" />
<ximf:aliasHeader
headerName="ESSPrivacyMark"
headerRef="X-XIMF-Privacy-Mark" />
<ximf:aliasHeader
headerName="SecurityCategory"
headerRef="X-XIMF-Security-Categories-Identifier"
type="2" />
</ximf:securityLabel>

==== Element constraint ====
L’élément "constraint" est utilisé pour définir une règle de construction de deux entêtes partageant des "datas" identiques.
Trois attributs précisent la balise "constraint" : "left", "right", "operator", e.g.,

<ximf:constraint
left="header-primary-precedence"
operator="equalOrGreaterThan"
right="header-copy-precedence" />

* Détails sur les attributs de l'élément "constraint" :
** L’attribut "left" désigne le premier élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "right" désigne le deuxième élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "operator" indique la règle de poids à appliquer sur la valeur des deux éléments "header", il peut être de type "greaterThan", "lowerThan", "equalOrGreaterThan", "equalOrLowerThan", "equal". Cet attribut est obligatoire.

* Détails sur les valeurs possibles de l'attribut "type" :
** Le type "greaterThan" signifie que la valeur de l’élément "left" doit être strictement supérieur à la valeur de l’élément "right".
** Le type "lowerThan" signifie que la valeur de l’élément "left" doit être strictement inférieur à la valeur de l’élément "right".
** Le type "equalOrGreaterThan" signifie que la valeur de l’élément "left" doit être supérieur ou égale à la valeur de l’élément "right".
** Le type "equalOrLowerThan" signifie que la valeur de l’élément "left" doit être inférieur ou égale à la valeur de l’élément "right".
** Le type "equal" signifie que la valeur de l’élément "left" et de l’élément "right" doivent être identiques.

==== Element assignment ====
<div style="color:red;">'''TODO :''' L'élément assignment n'apparaît pas dans le shéma xml qui avait été envoyé.</div>

L’élément "assignement" est utilisé pour affecter une valeur créée en fonction d’une règle de comparaison sur les valeurs de deux éléments "header".
Quatre attributs précisent la balise "assignement" : "left", "right", "operator", "result", e.g.,

<ximf:assignment
left="header-primary-precedence"
operator="equal"
right="data-routine-precedence"
result="86400" />

* Détails sur les attributs de l'élément "assignment" :
** L’attribut "left" désigne le premier élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "right" désigne le deuxième élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "operator" indique la règle de comparaison entre les valeurs des deux éléments "header", il peut être de type "greaterThan", "lowerThan", "equalOrGreaterThan", "equalOrLowerThan", "equal". Cet attribut est obligatoire.
** L’attribut "result" représente la valeur à utiliser si la règle de comparaison entre les deux éléments est satisfaite. Cet attribut est obligatoire.

==== Element processing ====
L’élément "processing" regroupe des règles de traitement à effectuer sur des entêtes formatés.
L’attribut "type" précise le type de traitement à effectuer sur ces valeurs. Cet attribut est obligatoire, il est de type : "sign-header-value", "encrypt-header-value", "capitalize-header-value", e.g.,

<ximf:processing type="sign-header-value">
<ximf:refHeader>header-primary-precedence</ximf:refheader>
<ximf:refHeader>header-copy-precedence</ximf:refheader>
<ximf:refHeader>header-echange-type</ximf:refheader>
</ximf:processing>

* Détails sur les valeurs possibles de l'attribut "type" :
** Le type "sign-header-value" définit un traitement de signature des entêtes définis dans la balise.
** Le type "encrypt-header-value" définit un traitement de chiffrement des entêtes définis dans la balise.
** Le type "capitalize-header-value" définit un traitement de capitalisation des entêtes définis dans la balise.

L’élément "processing" contient au moins un élément "refHeader".
<div style="color:red;">'''TODO :'''L'élément refHeader n'est pas documenté, s'agit-il en fait de l'élément headerRef ?</div>

==== Element accessibility ====
<div style="color:red;">'''TODO :''' L'élément accessibility n'apparaît pas dans le shéma xml qui avait été envoyé.</div>
L’élément "accessibility" définit un ensemble de règles de droit d’accès aux éléments d’une instance pour une cible déterminée (utilisateur, routeur…).
Cet élément contient un ou plusieurs éléments "role".

<ximf:accessibility>
<ximf:role id="role-flash-allowed" aclLevel="100" />
<ximf:role id="role-flash-prohibited" aclLevel="50" />
</ximf:accessibility>

==== Element role ====
L’élément "role" positionne une valeur d’accès à pour une entité définit.
Deux attributs complètent l’élément "role" : "id", "aclLevel", e.g.,

<ximf:role id="role-flash-allowed" aclLevel="100" />

* Détails sur les attributs de l'élément "role" :
** L’attribut "id" précise l’entité accessible en fonction d’une valeur déterminée.
** L’attribut "aclLevel" précise la valeur seuil d’accès à l’entité.

==== Element custom ====
L’élément "custom" permet à l’auteur de créer des nouvelles règles personnalisées.
Trois attributs précisent la balise "custom" : "id", "provider", "description", e.g.,

<ximf:custom
id="custom-display"
provider="EADS"
description="Affichage de la composition du message" >
<node1><node2><node3></node3></node2></node1>
</ximf:custom>

* Détails sur les attributs de l'élément "custom" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "custom" et formaté selon la syntaxe "custom-xxx". Cet attribut est obligatoire.
** L’attribut "provider" identifie l’auteur de la règle. Cet attribut est obligatoire.
** L’attribut "description" permet d’ajouter un commentaire sur cet élément.

L’élément "custom" peut contenir tous les éléments possibles en respectant les standards XML.

XIMF XML tags/fr

2011-03-02T07:25:27Z

Anthonyjuge : /* Element secureHeaders */

== Introduction ==
Ce document propose un modèle de description, via eXtensible Markup Language (XML), d’entêtes de messages électroniques respectant la norme XIMF. Ce document a deux objectifs :
# Décrire les éléments et attributs de représentation XML pour construire des entêtes de messages électroniques de format XIMF.
# Fournir un modèle de représentation XIMF/XML.

<u>Rappel :</u>
* Un "élément" fait référence à tous les caractères situés entre une balise de départ et un balise de fin, e.g.,
<exemple> texte et/ou éléments fils </exemple>
* Un "attribut" est une composante d’un élément. Il est positionné dans la balise de départ, e.g.,
<exemple nom='value'>

Tous les éléments décrits dans cette documentation paragraphe sont validés dans l’espace de nom "ximf".

<pre>
xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://eads.org/ximf/ximf.xsd"
</pre>

== Description détaillée des balises XML ==

Voici, par ordre d'apparition et en fonction des fichiers, les balises génériques associées aux différents fichiers XML.

=== Fichier ximfmail-profile ===

<div style="color:red;">'''TODO''' :
* Combien d'éléments ihm sont autorisés dans un élément instance ?
* La documentation des fichiers ximfmail-profile.xml n'est pas disponible. Est-il possible d'avoir accès au fichier ximf_profile.xsd mentionné dans les ximfmail-profile.xml ?
</div>

Un fichier xpi peut contenir plusieurs instances XIMF, celles-ci sont alors regroupées dans une même catégorie. Le fichier ximfmail-profile contient des informations sur toutes les instances contenues dans le xpi, notamment leur nom, leur chemin d'accès, ainsi que les noms des fichiers associés à chaque instance.

==== Element instance ====
L’élément "instance" identifie l’ensemble des entêtes à décrire selon la norme XIMF. C’est le conteneur principal d’une instance XIMF/XML. Cinq attributs précisent la balise "instance" : "ximfVersion", "version", "author", "creation", "name", e.g.,
<ximf:instance name="myInstance" version="1.0" ximfVersion="2.0" >

* Détails sur les attributs de l'élément "instance" :
** L’attribut "name" définit le nom de l’instance décrite. Cet attribut est obligatoire.
** L’attribut "ximfVersion" définit le numéro de version des entêtes XIMF utilisés pour cette représentation. Cet attribut est obligatoire.
** L’attribut "version" définit le numéro de version de l’instance décrite. Cet attribut est obligatoire.
** L’attribut "author" renseigne sur le nom de l’auteur de cette instance.
** L’attribut "creationDate" précise la date de création de cette instance.

L’élément "instance" peut contenir un ou plusieurs éléments "schema", un ou plusieurs éléments "rule", un élément "ihm" et un élément "dictionary".

==== Element dictionary ====
L'élément dictionary contient le chemin vers le fichier spécifiant les données d'internationalisation (Cf. [[#Fichier_dictionary|Fichier dictionary]]).

==== Element schema ====
L'élément shema contient le chemin vers le fichier spécifiant les entêtes XIMF (Cf. [[#Fichier_headers|Fichier headers]]).

==== Element ihm ====
L'élément ihm contient le chemin vers le fichier spécifiant la disposition de l'interface des formulaires XIMF (Cf. [[#Fichier_ihm|Fichier ihm]]).

==== Element rule ====
L'élément rule contient le chemin vers le fichier spécifiant les règles associées aux valeurs des champs XIMF (Cf. [[#Fichier_rules|Fichier rules]]).

=== Fichier dictionary ===
Le fichier dictionnary permet de mettre en œuvre l’internationalisation d’une instance XIMF. Il défini des dictionnaires qui servent à traduire les éléments de l'instance XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient un élément "ximf:dictionnary".

==== Element dictionary ====
<div style="color:red;">'''TODO''' :
* Quel est l'intérêt de renseigner un attribut "id" à l'élément "dictionary" (étant donné qu'un seul élément "dictionary est autorisé dans l'élément "instance") ?</div>

L’élément "dictionary" contient toutes les informations devant être interprétées selon le pays d’utilisation.
L’élément "dictionary" contient un ou plusieurs mêmes éléments "locale", e.g.,

<ximf:dictionary>
<ximf:locale lang="fr-FR" />
<ximf:locale lang="en-US" />
</ximf:dictionary>

==== Element locale ====
L’élément "locale" contient toutes les informations pour un pays et/ou langue désignée.
L’élément "locale" contient un ou plusieurs mêmes éléments "ilk", e.g.,

<ximf:locale lang="fr-FR" >
<ximf:ilk entity="a"/>
<ximf:ilk entity="b"/>
</ximf:locale>

* Détails sur les attributs de la balise "locale" :
** L’attribut "lang" définit le code pays de ce conteneur. Il devrai être construit selon le format défini par la RFC1766 (fr, en, ja, es, …).

==== Element ilk ====
L’élément "ilk" contient une unique information correspondant à une donnée traduite selon le code pays de l’élément père. Cette information est au format chaîne de caractère. Un attribut obligatoire précise la balise "ilk".

<ximf:ilk entity="ilk-lang-ihm">langue</ximf:ilk>

* Détails sur les attributs de la balise "ilk" :
** L’attribut "entity" définit la référence d’entrée pour récupérer le contenu de l’élément selon le code pays souhaité.

Finalement, le fichier "dictionary" pourra contenir :
<ximf:instance name="Whirlpool">
<ximf:dictionary>
<ximf:locale lang="fr-FR" >
<ximf:ilk entity="ilk-lang-ihm">Français</ximf:ilk>
<ximf:ilk entity="ilk-exemple-general">Général</ximf:ilk>
</ximf:locale>
<ximf:locale lang="en-US" >
<ximf:ilk entity="ilk-lang-ihm">English (US)</ximf:ilk>
<ximf:ilk entity="ilk-exemple-general">General</ximf:ilk>
</ximf:locale>
</ximf:dictionary>
</ximf:instance>

=== Fichier ihm ===
<span style="color:red;">'''TODO''' : La documentation originale ne décrit pas le fichier ihm, les informations ci-dessous ont seulement été présumées. Merci de les vérifier/compléter.
</span>

Le fichier ihm spécifie l'agencement de l'interface des formulaires XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient un élément "ximf:ihm".

==== Element ihm ====
L'élément "ihm" contient un ou plusieurs éléments "panel" et un élément "treeRcv".

==== Element panel ====
Un élément ximf:panel correspond à un onglet du formulaire XIMF construit.
Deux attributs précisent la balise "panel" : "id" et "ilk", eg.
<ximf:panel id="pane_security" ilk="ilk-priority-panel" />

* Détails sur les attributs de l'élément "panel" :
** L’attribut "id" définit le nom de l'onglet, il doit être unique pour chaque élément "ximf:panel" et est formaté selon la syntaxe "pane-xxx". Cet attribut est obligatoire.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.

L'élément "ximf:panel" contient au moins un éléments "ximf:groupbox".

==== Element groupbox ====
Un élément groupbox correspond à une sous catégorie d'un onglet du formulaire XIMF.
La structure "groupbox" détaille l’ordre d’affichage des entêtes dans un message.
Deux attributs précisent la balise "ximf:groupbox" : "id" et "ilk", eg.
<ximf:groupbox id="group-classification" ilk="ilk-secu-box" />

* Détails sur les attributs de l'élément "groupbox" :
** L’attribut "id" définit le nom de l'onglet, il doit être unique pour chaque élément "ximf:panel" et est formaté selon la syntaxe "pane-xxx". Cet attribut est obligatoire.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.

L'élément "groupbox" contient au moins un éléments "headerRef".

==== Element treeRcv ====
L'élément "treeRcv" permet de spécifier quelles sont les colonnes susceptibles d'être ajoutées dans le panneau principal du client de messagerie qui contient la liste des messages d’un dossier.

L'élément "treeRcv" peut contenir des éléments "headerRef".

==== Element headerRef ====
L'élément headerRef spécifie les champs associés à chaque sous-groupe d'onglet de formulaire ou les champs qu'il est possible d'afficher dans la liste des messages.
Aucun attribut ne vient compléter la balise "headerRef", eg.
<ximf:headerRef>header-classification</ximf:headerRef>

Finalement, le fichier "ihm" pourra contenir :
<pre>
<ximf:instance name="Amoco">
<ximf:ihm>
<ximf:panel id="pane_security" ilk="ilk-priority-panel">
<ximf:groupbox id="group-classification" ilk="ilk-secu-box">
<ximf:headerRef>header-correspondance-type</ximf:headerRef>
<ximf:headerRef>header-classification</ximf:headerRef>
</ximf:groupbox>
</ximf:panel>
<ximf:treeRcv>
<ximf:headerRef>header-classification</ximf:headerRef>
</ximf:treeRcv>
</ximf:ihm>
</ximf:instance>
</pre>

=== Fichier headers ===
Le fichier headers spécifie les types des champs de l'interface des formulaires XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient des éléments "header".

<div style="color:red">'''TODO :'''
Il semble que les fichiers headers définissent des entêtes devant être envoyées alors que ces mêmes entêtes ne sont pas spécifiés dans le fichier ihm. Ce comportement est logique, en effet, l'utilisateur n'a pas forcément besoin de savoir tout ce qui est envoyé via le formulaire. Cependant, comment le moteur XIMF sait quels entêtes doivent être envoyés ?
</div>

==== Element header ====
Chaque élément "header" décrit un entête de message de format XIMF.
Huit attributs précisent la balise "header" : "headerName", "id", "technicalHeaderName", "type", "technicalType", "isMandatory", "ilk", "description", e.g.,

<div style="color:red;">'''TODO :'''
Comment est effectuée la vérification de l'attribut isMandatory et quelles sont les conditions de fonctionnement de celui-ci ? Est-il possible, par exemple, de spécifier l'attribut isMandatory=true d'un élément header si le contenu de celui-ci est un élément « set » qui dispose des attributs minItem et maxItem ? Actuellement, lorsque l'on crée un élément set avec les attributs minItem et maxItem, le champ du formulaire associé ne peux pas être validé : e.g.,
<ximf:set id="value-amoco-classification" minItem="1" maxItem="64" separator=";" technicalSeparator=".">
</div>

<ximf:header id="header-primary-precedence"
headerName="X-XIMF-Primary-Precedence"
ilk="ilk-primary-precedence"
isMandatory="true"
description="entête d’urgence"
type="string" />

* Détails sur les attributs de l'élément "header" :
** L’attribut "headerName" définit le nom du champ XIMF. Cet attribut est obligatoire.
** L’attribut "id" définit un identifiant de champ, il doit être unique pour chaque élément "header" et est formaté selon la syntaxe "header-xxx". Cet attribut est obligatoire.
** L’attribut "isMandatory" précise si ce champ doit être obligatoirement présent dans le message intégrant les entêtes selon cette description.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.
** L’attribut "type" précise le format des données associées à cet élément. Ce format peut être une date, une chaîne, une adresse mail, un O.I.D.
** L’attribut "technicalHeaderName" permet de compléter l’entête décrit par un autre entête.
** L’attribut "technicalType" précise le format des données associées à l’élément technicalHeaderName.
** L’attribut "description" permet d’ajouter une information sur cet élément.

L’élément "header" contient obligatoirement un élément "set", "multiset", "string", ou "compstring", e.g.,

<ximf:header id="header-reply-by"
headerName="X-XIMF-Reply-By"
ilk="ilk-reply-by"
isMandatory="false" >
<ximf:string id="value-reply-by" editable="true" />
</ximf:header>

<div style="color:red;">
'''TODO :''' Quelles sont les contraintes associées à l'attribut type d'un élément header ?
</div>

==== Element string ====
L’élément "string" précise le contenu d’une ressource de type chaîne de caractères imprimables (a-z, A-Z, 1-9,…)
Quinze attributs complètent l’élément "string" : "id", "ref", "ilk", "aclLevel", "index", "description", "editable", "content", "technicalContent","maxItem", "minItem", "maxLength", "minLength", "separator", "technicalSeparator", e.g.,

<ximf:string ilk="ilk-france" content="FRA" />

* Détails sur les attributs de l'élément "string" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "string".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role| élément role]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut " description " permet d’associer un commentaire sur cette donnée.
** L’attribut "editable" définit une valeur de saisie (champ libre). Cet attribut est de type booléen.
** L’attribut "content" représente la valeur effective de la donnée. C’est cette donnée qui sera associée au champ XIMF créé.
** L’attribut "technicalContent" représente la valeur effective de la donnée technique. C’est cette donnée qui sera associée au champ technique XIMF créé (cf. attribut technicalHeaderName de l’élément "header".
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.

L’élément "string" peut contenir plusieurs éléments "linkedValue".

<ximf:string ilk="ilk-non-protege" content="NON PROTEGE" technicalContent="1" >
<ximf:linkedValue ref="value-non-protege-france " />
</ximf:string>

==== Element compstring ====
<div style="color:red;">
'''TODO :''' L'attribut de l'élément « compstring » nommé « contentFactorise » devrait s'appeler « contentFactorize ».
</div>
L’élément "compstring" décrit un conteneur de concaténation des éléments fils. Il permet notamment de créer des valeurs d’entêtes composées.
Dix-sept attributs complètent l’élément "compstring" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", "content", "technicalContent", "contentPositionEnd", "contentFactorise", "technicalPositionEnd", e.g.,

<ximf:compstring
ilk="ilk-special"
content="SPECIAL"
technicalContent="1.3.4"
separator=" "
technicalSeparator=".">

* Détails sur les attributs de l'élément "compstring" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "compstring".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (cf. [[#Element_role| élément "role"]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut " description " permet d’associer un commentaire sur cette donnée.
** L’attribut "content" représente la valeur effective de la donnée. C’est cette donnée qui sera associée au champ XIMF créé.
** L’attribut "technicalContent" représente la valeur effective de la donnée technique. C’est cette donnée qui sera associée au champ technique XIMF créé (cf. attribut technicalHeaderName de l’élément "header".
** L’attribut "separator" définit le caractère de séparation entre deux valeurs.
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "contentPositionEnd" impose de positionner le contenu de l’élément "compstring" après les valeurs des éléments fils : valuefils1,valuefils2 : valuecompstring.
** L’attribut "technicalPositionEnd" impose de positionner le contenu de l’élément "compstring" après les valeurs des éléments fils.
** L’attribut "contentFactorise" impose d’utiliser le contenu de l’élément "compstring" comme facteur des éléments fils : valuecompstring(valuefils1,valuefils2).

L’élément "compstring" peut contenir un élément "string" ou "set" ou "multiset" ou plusieurs éléments "compstring".

<ximf:compstring
ilk="ilk-special"
content="SPECIAL"
technicalContent="1.3.4"
separator=" "
technicalSeparator=".">
<ximf:set id="ilk-special-op " maxItem="64">
<ximf:string ilk="ilk-special-op1" content="OP1" technicalContent="1" />
<ximf:string ilk="ilk-special-op2" content="OP2" technicalContent="2" />
<ximf:string ilk="ilk-special-op3" content="OP3" technicalContent="3" />
</ximf:set>
</ximf:compstring>

==== Element set ====
L’élément "set" décrit un conteneur de ressources de même type. Cet élément autorise la sélection de plusieurs ressources mais chaque ressource est sélectionnée une seule fois.
Douze attributs précisent la description de la balise "set" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", e.g.,

<ximf:set id="value-categories" ref="value-mentions" maxItem="64" separator=";" />

* Détails sur les attributs de l'élément "set" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "ximf:set".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role|élément rôle]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut "description" permet d’associer un commentaire sur cette donnée.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs

L’élément "set" peut contenir un ou plusieurs éléments "string" ou un ou plusieurs éléments "compstring".

<ximf:set id="value-categories" minItem="1" maxItem="64" separator=";">
<ximf:string ilk="ilk-releasable-to" content="RELEASABLE TO " />
<ximf:string ilk="ilk-eyes-only" content=" EYES ONLY"/>
<ximf:string ilk="ilk-use-only" content=" USE ONLY"/>
</ximf:set>

<div style="color:red;">'''TODO :'''
* Y a-t-il une définition des fichiers associés aux instances XIMF (e.g, le fichier attribution-list.xml utilisé dans l'instance Caterpillar) ?
* Comment le moteur XIMF sait qu'un élément est une "attribution-list" ?
</div>

==== Element multiset ====
L’élément "multiset" décrit un conteneur de ressources de même type. Cet élément autorise la sélection de plusieurs ressources et chaque ressource peut être sélectionnée plusieurs fois.
Douze attributs précisent la description de la balise "multiset" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", e.g.,

<ximf:multiset
id="value-restricted"
ilk=" value-restricted-otan"
maxItem="64"
separator=";" />

* Détails sur les attributs de l'élément "multiset" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "multiset".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role|élément rôle]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut "description" permet d’associer un commentaire sur cette donnée.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs

L’élément "multiset" peut contenir un ou plusieurs éléments "string" ou un ou plusieurs éléments "compstring".

<ximf:multiset id="value-restricted-otan-categories" minItem="1" maxItem="64" separator=";" >
<ximf:string ilk="ilk-releasable-to" content="RELEASABLE TO "/>
<ximf:string ilk="ilk-eyes-only" content=" EYES ONLY"/>
<ximf:string ilk="ilk-use-only" content=" USE ONLY"/>
</ximf:multiset>

<span style="color:red;">'''TODO ''': Comment sont gérées les règles associées aux champs multivaleurs (disposant par exemple des attributs minItem/maxItem ou les champs multiset) ?</span>

==== Element linkedValue ====
L’élément "linkedValue" définit une référence sur une ressource de type conteneur ("set", "multiset") ou "string". Cette ressource devrait être utilisée si la ressource contenant "linkedValue" (noeud parent) est sélectionnée.
Un attribut précise la balise "linkvalue" : "ref", e.g.,

<ximf:linkedValue ref="value-restricted-otan-classification-id" />

* Détails sur les attributs de l'élément "linkedValue" :
** L’attribut "ref" précise la valeur de l’attribut "id" de la ressource cible. Cet attribut est obligatoire.

=== Fichier rules ===
Le fichier rules définit les règles de contrôles d’entêtes XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui peut contenir des éléments "ximf:rule".

==== Element rule ====
<div style="color:red">
'''TODO :''' Mettre à jour la documentation :
* Les éléments autorisés dans un élément « rule » ne sont plus à jour. La présente documentation spécifie 12 éléments : AliasHeader, AliasValue, Compatibility, Association, SecureHeaders, SecurityLabel, Constraint, Assignment, Processing, Accessibility, Role et Custom. Le schéma XML fourni avec le mail en spécifie 5 : Constraint, Processing, Compatibility, Policy et Custom et place les autres en tant qu'extentions des 5 éléments cités précédemment.
* Les éléments SecureHeaders et SecurityLabel associés à l'élément « rule » ne figurent pas dans la nouvelle version du shéma xml. On les retrouve dans les fichiers rules-*.xml mais les éléments sont commentés, ils sont, de plus, présents dans une autre instance : comment ces éléments sont utilisés dans Trustedbird ?
* L'élément ximf:classificationPictures n'est pas documenté. De plus, il serait bon d'avoir des précisions sur la raison qui a motivé l'ajout de cet élément dans les fichiers de règles (alors qu'il semblerait être plus adapté au fichier headers-*.xml).
</div>
L’élément "rule" est le conteneur principal de description d’un comportement particulier à appliquer sur un ensemble d’entêtes XIMF.
Trois attributs précisent la balise "rule" : "id", "agent", "description", e.g.,
<ximf:rule id="compatibility-rule" description="Règle sur la compatibilité X-SMTP / XIMF" >

* Détails sur les attributs de l'élément "rule" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "rule". Cet attribut est obligatoire.
** L’attribut "agent" indique l’équipement cible devant analyser et appliquer le contenu de cet élément.
** L’attribut "description" autorise l’auteur d’ajouter un commentaire sur cet élément.

L’élément "rule" contient un ou plusieurs mêmes éléments de spécialisation de la règle "contraint", "assignement", "processing", "compatibility", "accessibility", "custom",…, e.g.,

<ximf:rule id="precedence-rule" agent="mua" description="Règle sur les priorités">
<ximf:constraint
left="header-primary-precedence"
operator="equalOrGreaterThan"
right="header-copy-precedence" />
</ximf:rule>

==== Element aliasHeader ====
L’élément "aliasHeader" permet de définir le nom de l’entête sur lequel la règle précisée est appliquée
Deux attributs précisent la balise "aliasHeader" : "headerName" et "headerRef", e.g.,

<ximf:aliasHeader headerName ="X-P772-Version" headerRef="X-XIMF-VERSION" />

* Détails sur les attributs de l'élément "aliasHeader" :
* L’attribut "headerName" définit le nom XIMF de l’entête modifié par la règle. Cet attribut est obligatoire.
* L’attribut "headerRef" définit le nom d’un entête XIMF de référence qui est le point d’entrée de l’application de la règle sur l’entête définit par "headerName". Cela permet de lier deux entêtes de messages où l’utilisation de l’un des entêtes influe sur le comportement de l’autre.

L’élément "aliasHeader" peut contenir des éléments "aliasValue",e.g ,

<ximf:aliasHeader headerName="X-P772-Version" />
<ximf:aliasValue vame="1.0"/>
<ximf:aliasHeader>

==== Element aliasValue ====
L’élément "aliasValue" contient une valeur à associer à l’entête XIMF contrôlé par la règle. Il est utile lorsque deux entêtes sont liées (utilisation de l’attribut headerRef dans l’élément aliasHeader) et que les valeurs de l’entêtes de référence permettent de préciser celles de l’entête contrôlé.
Deux attributs précisent la balise "aliasValue" : "valueName", "valueRef", e.g.,

<ximf:aliasValue valueName="2" valueRef="flash" />

* Détails sur les attributs de l'élément "aliasValue" :
** L’attribut "valueName" définit la valeur de l’entête à créer. Cet attribut est obligatoire.
** L’attribut "valueRef" définit la valeur de l’entête XIMF de référence pour utiliser valueName.
<span style="color:red;">'''TODO :''' L'attribut valueRef est-il obligatoire ?</span>

==== Element compatibility ====
L’élément "compatibility" est utilisé pour associer à un entête respectant la norme XIMF un entête respectant une autre norme que XIMF (XSMTP par exemple).
Deux attributs précisent la balise "compatibility" : "targetName", "targetVersion", e.g.,

<ximf:compatibility targetName="X-SMTP" targetVersion="1.1">
<ximf:aliasValue headerName="X-P772-Version" content="1.1" />
<ximf:aliasValue
headerName="X-P772-Primary-Precedence"
headerRef="header-primary-precedence"
dataRef="data-priority-xsmtp"/>
</ximf:compatibility>

* Détails sur les attributs de l'élément "compatibility" :
** L’attribut "targetName" définit la norme de l’entête à associer à l’entête XIMF. Cet attribut est obligatoire.
** L’attribut "targetVersion" définit le numéro de version de la norme de l’entête à associer à l’entête XIMF. Cet attribut est obligatoire.

L’élément "compatibility" contient au moins un élément "aliasHeader".

<u>Pour illustrer cette règle :</u>
Le format XSMTP est déjà supporté par certains équipements. Afin de rendre ceux-ci inter opérables avec le nouveau format XIMF, cette règle permet d’associer un entête XSMTP contenant les mêmes informations qu’un entête XIMF.

L’élément Association : dépendance entre entêtes
L’élément "association" définie les valeurs autorisées pour un entête XIMF en fonction d’une valeur définie pour un autre entête XIMF.

<ximf:association>
<ximf:aliasHeader
headerName="X-XIMF-Primary-Precedence"
headerRef="X-XIMF-Correspondence-Type">
<ximf:aliasValue valueName="routine" valueRef="private" />
<ximf:aliasValue valueName="routine,priority" valueRef="professional" />
<ximf:aliasValue valueName="routine,priority,immediate,flash" valueRef="operational" />
<ximf:aliasValue valueName="routine,priority,immediate" valueRef="official" />
</ximf:aliasHeader>
</ximf:association>

==== Element secureHeaders ====
L’élément "secureHeaders" définie la liste des entêtes à intégrer dans la signature d’un message. Cette règle s’applique sur les équipements proposant un algorithme de signature des messages.

Un élément "secureHeaders" contient un ou plusieurs éléments "aliasHeaders" où chaque élément décrit un entête à intégrer dans la signature et complété d’un attribut "status".

<ximf:secureHeaders targetName="SecureHeaders">
<ximf:aliasHeader headerName="X-XIMF-Primary-Precedence" status="0" />
<ximf:aliasHeader headerName="X-XIMF-Copy-Precedence" status="0" />
</ximf:secureHeaders>

==== Element securityLabel ====
L’élément "securityLabel" définie la liste des entêtes à intégrer dans la signature d’un message. Cette règle s’applique sur les équipements proposant un algorithme de signature des messages selon la norme RFC.

Un élément "securityLabel" contient un ou plusieurs éléments "aliasHeaders" où chaque élément décrit un entête à intégrer dans la signature et complété d’un attribut "status".

<ximf:securityLabel targetName="SecurityLabel" id="Amoco">
<ximf:aliasHeader
headerName="SecurityPolicyIdentifier"
headerRef="X-XIMF-Security-Policy-Identifier" />
<ximf:aliasHeader
headerName="SecurityClassification"
headerRef="X-XIMF-Security-Classification-Identifier" />
<ximf:aliasHeader
headerName="ESSPrivacyMark"
headerRef="X-XIMF-Privacy-Mark" />
<ximf:aliasHeader
headerName="SecurityCategory"
headerRef="X-XIMF-Security-Categories-Identifier"
type="2" />
</ximf:securityLabel>

==== Element constraint ====
L’élément "constraint" est utilisé pour définir une règle de construction de deux entêtes partageant des "datas" identiques.
Trois attributs précisent la balise "constraint" : "left", "right", "operator", e.g.,

<ximf:constraint
left="header-primary-precedence"
operator="equalOrGreaterThan"
right="header-copy-precedence" />

* Détails sur les attributs de l'élément "constraint" :
** L’attribut "left" désigne le premier élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "right" désigne le deuxième élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "operator" indique la règle de poids à appliquer sur la valeur des deux éléments "header", il peut être de type "greaterThan", "lowerThan", "equalOrGreaterThan", "equalOrLowerThan", "equal". Cet attribut est obligatoire.

* Détails sur les valeurs possibles de l'attribut "type" :
** Le type "greaterThan" signifie que la valeur de l’élément "left" doit être strictement supérieur à la valeur de l’élément "right".
** Le type "lowerThan" signifie que la valeur de l’élément "left" doit être strictement inférieur à la valeur de l’élément "right".
** Le type "equalOrGreaterThan" signifie que la valeur de l’élément "left" doit être supérieur ou égale à la valeur de l’élément "right".
** Le type "equalOrLowerThan" signifie que la valeur de l’élément "left" doit être inférieur ou égale à la valeur de l’élément "right".
** Le type "equal" signifie que la valeur de l’élément "left" et de l’élément "right" doivent être identiques.

==== Element assignment ====
<div style="color:red;">'''TODO :''' L'élément assignment n'apparaît pas dans le shéma xml qui avait été envoyé.</div>

L’élément "assignement" est utilisé pour affecter une valeur créée en fonction d’une règle de comparaison sur les valeurs de deux éléments "header".
Quatre attributs précisent la balise "assignement" : "left", "right", "operator", "result", e.g.,

<ximf:assignment
left="header-primary-precedence"
operator="equal"
right="data-routine-precedence"
result="86400" />

* Détails sur les attributs de l'élément "assignment" :
** L’attribut "left" désigne le premier élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "right" désigne le deuxième élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "operator" indique la règle de comparaison entre les valeurs des deux éléments "header", il peut être de type "greaterThan", "lowerThan", "equalOrGreaterThan", "equalOrLowerThan", "equal". Cet attribut est obligatoire.
** L’attribut "result" représente la valeur à utiliser si la règle de comparaison entre les deux éléments est satisfaite. Cet attribut est obligatoire.

==== Element processing ====
L’élément "processing" regroupe des règles de traitement à effectuer sur des entêtes formatés.
L’attribut "type" précise le type de traitement à effectuer sur ces valeurs. Cet attribut est obligatoire, il est de type : "sign-header-value", "encrypt-header-value", "capitalize-header-value", e.g.,

<ximf:processing type="sign-header-value">
<ximf:refHeader>header-primary-precedence</ximf:refheader>
<ximf:refHeader>header-copy-precedence</ximf:refheader>
<ximf:refHeader>header-echange-type</ximf:refheader>
</ximf:processing>

* Détails sur les valeurs possibles de l'attribut "type" :
** Le type "sign-header-value" définit un traitement de signature des entêtes définis dans la balise.
** Le type "encrypt-header-value" définit un traitement de chiffrement des entêtes définis dans la balise.
** Le type "capitalize-header-value" définit un traitement de capitalisation des entêtes définis dans la balise.

L’élément "processing" contient au moins un élément "refHeader".
<div style="color:red;">'''TODO :'''L'élément refHeader n'est pas documenté, s'agit-il en fait de l'élément headerRef ?</div>

==== Element accessibility ====
<div style="color:red;">'''TODO :''' L'élément accessibility n'apparaît pas dans le shéma xml qui avait été envoyé.</div>
L’élément "accessibility" définit un ensemble de règles de droit d’accès aux éléments d’une instance pour une cible déterminée (utilisateur, routeur…).
Cet élément contient un ou plusieurs éléments "role".

<ximf:accessibility>
<ximf:role id="role-flash-allowed" aclLevel="100" />
<ximf:role id="role-flash-prohibited" aclLevel="50" />
</ximf:accessibility>

==== Element role ====
L’élément "role" positionne une valeur d’accès à pour une entité définit.
Deux attributs complètent l’élément "role" : "id", "aclLevel", e.g.,

<ximf:role id="role-flash-allowed" aclLevel="100" />

* Détails sur les attributs de l'élément "role" :
** L’attribut "id" précise l’entité accessible en fonction d’une valeur déterminée.
** L’attribut "aclLevel" précise la valeur seuil d’accès à l’entité.

==== Element custom ====
L’élément "custom" permet à l’auteur de créer des nouvelles règles personnalisées.
Trois attributs précisent la balise "custom" : "id", "provider", "description", e.g.,

<ximf:custom
id="custom-display"
provider="EADS"
description="Affichage de la composition du message" >
<node1><node2><node3></node3></node2></node1>
</ximf:custom>

* Détails sur les attributs de l'élément "custom" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "custom" et formaté selon la syntaxe "custom-xxx". Cet attribut est obligatoire.
** L’attribut "provider" identifie l’auteur de la règle. Cet attribut est obligatoire.
** L’attribut "description" permet d’ajouter un commentaire sur cet élément.

L’élément "custom" peut contenir tous les éléments possibles en respectant les standards XML.

XIMF XML tags/fr

2011-03-02T07:24:23Z

Anthonyjuge : /* Element aliasValue */

== Introduction ==
Ce document propose un modèle de description, via eXtensible Markup Language (XML), d’entêtes de messages électroniques respectant la norme XIMF. Ce document a deux objectifs :
# Décrire les éléments et attributs de représentation XML pour construire des entêtes de messages électroniques de format XIMF.
# Fournir un modèle de représentation XIMF/XML.

<u>Rappel :</u>
* Un "élément" fait référence à tous les caractères situés entre une balise de départ et un balise de fin, e.g.,
<exemple> texte et/ou éléments fils </exemple>
* Un "attribut" est une composante d’un élément. Il est positionné dans la balise de départ, e.g.,
<exemple nom='value'>

Tous les éléments décrits dans cette documentation paragraphe sont validés dans l’espace de nom "ximf".

<pre>
xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://eads.org/ximf/ximf.xsd"
</pre>

== Description détaillée des balises XML ==

Voici, par ordre d'apparition et en fonction des fichiers, les balises génériques associées aux différents fichiers XML.

=== Fichier ximfmail-profile ===

<div style="color:red;">'''TODO''' :
* Combien d'éléments ihm sont autorisés dans un élément instance ?
* La documentation des fichiers ximfmail-profile.xml n'est pas disponible. Est-il possible d'avoir accès au fichier ximf_profile.xsd mentionné dans les ximfmail-profile.xml ?
</div>

Un fichier xpi peut contenir plusieurs instances XIMF, celles-ci sont alors regroupées dans une même catégorie. Le fichier ximfmail-profile contient des informations sur toutes les instances contenues dans le xpi, notamment leur nom, leur chemin d'accès, ainsi que les noms des fichiers associés à chaque instance.

==== Element instance ====
L’élément "instance" identifie l’ensemble des entêtes à décrire selon la norme XIMF. C’est le conteneur principal d’une instance XIMF/XML. Cinq attributs précisent la balise "instance" : "ximfVersion", "version", "author", "creation", "name", e.g.,
<ximf:instance name="myInstance" version="1.0" ximfVersion="2.0" >

* Détails sur les attributs de l'élément "instance" :
** L’attribut "name" définit le nom de l’instance décrite. Cet attribut est obligatoire.
** L’attribut "ximfVersion" définit le numéro de version des entêtes XIMF utilisés pour cette représentation. Cet attribut est obligatoire.
** L’attribut "version" définit le numéro de version de l’instance décrite. Cet attribut est obligatoire.
** L’attribut "author" renseigne sur le nom de l’auteur de cette instance.
** L’attribut "creationDate" précise la date de création de cette instance.

L’élément "instance" peut contenir un ou plusieurs éléments "schema", un ou plusieurs éléments "rule", un élément "ihm" et un élément "dictionary".

==== Element dictionary ====
L'élément dictionary contient le chemin vers le fichier spécifiant les données d'internationalisation (Cf. [[#Fichier_dictionary|Fichier dictionary]]).

==== Element schema ====
L'élément shema contient le chemin vers le fichier spécifiant les entêtes XIMF (Cf. [[#Fichier_headers|Fichier headers]]).

==== Element ihm ====
L'élément ihm contient le chemin vers le fichier spécifiant la disposition de l'interface des formulaires XIMF (Cf. [[#Fichier_ihm|Fichier ihm]]).

==== Element rule ====
L'élément rule contient le chemin vers le fichier spécifiant les règles associées aux valeurs des champs XIMF (Cf. [[#Fichier_rules|Fichier rules]]).

=== Fichier dictionary ===
Le fichier dictionnary permet de mettre en œuvre l’internationalisation d’une instance XIMF. Il défini des dictionnaires qui servent à traduire les éléments de l'instance XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient un élément "ximf:dictionnary".

==== Element dictionary ====
<div style="color:red;">'''TODO''' :
* Quel est l'intérêt de renseigner un attribut "id" à l'élément "dictionary" (étant donné qu'un seul élément "dictionary est autorisé dans l'élément "instance") ?</div>

L’élément "dictionary" contient toutes les informations devant être interprétées selon le pays d’utilisation.
L’élément "dictionary" contient un ou plusieurs mêmes éléments "locale", e.g.,

<ximf:dictionary>
<ximf:locale lang="fr-FR" />
<ximf:locale lang="en-US" />
</ximf:dictionary>

==== Element locale ====
L’élément "locale" contient toutes les informations pour un pays et/ou langue désignée.
L’élément "locale" contient un ou plusieurs mêmes éléments "ilk", e.g.,

<ximf:locale lang="fr-FR" >
<ximf:ilk entity="a"/>
<ximf:ilk entity="b"/>
</ximf:locale>

* Détails sur les attributs de la balise "locale" :
** L’attribut "lang" définit le code pays de ce conteneur. Il devrai être construit selon le format défini par la RFC1766 (fr, en, ja, es, …).

==== Element ilk ====
L’élément "ilk" contient une unique information correspondant à une donnée traduite selon le code pays de l’élément père. Cette information est au format chaîne de caractère. Un attribut obligatoire précise la balise "ilk".

<ximf:ilk entity="ilk-lang-ihm">langue</ximf:ilk>

* Détails sur les attributs de la balise "ilk" :
** L’attribut "entity" définit la référence d’entrée pour récupérer le contenu de l’élément selon le code pays souhaité.

Finalement, le fichier "dictionary" pourra contenir :
<ximf:instance name="Whirlpool">
<ximf:dictionary>
<ximf:locale lang="fr-FR" >
<ximf:ilk entity="ilk-lang-ihm">Français</ximf:ilk>
<ximf:ilk entity="ilk-exemple-general">Général</ximf:ilk>
</ximf:locale>
<ximf:locale lang="en-US" >
<ximf:ilk entity="ilk-lang-ihm">English (US)</ximf:ilk>
<ximf:ilk entity="ilk-exemple-general">General</ximf:ilk>
</ximf:locale>
</ximf:dictionary>
</ximf:instance>

=== Fichier ihm ===
<span style="color:red;">'''TODO''' : La documentation originale ne décrit pas le fichier ihm, les informations ci-dessous ont seulement été présumées. Merci de les vérifier/compléter.
</span>

Le fichier ihm spécifie l'agencement de l'interface des formulaires XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient un élément "ximf:ihm".

==== Element ihm ====
L'élément "ihm" contient un ou plusieurs éléments "panel" et un élément "treeRcv".

==== Element panel ====
Un élément ximf:panel correspond à un onglet du formulaire XIMF construit.
Deux attributs précisent la balise "panel" : "id" et "ilk", eg.
<ximf:panel id="pane_security" ilk="ilk-priority-panel" />

* Détails sur les attributs de l'élément "panel" :
** L’attribut "id" définit le nom de l'onglet, il doit être unique pour chaque élément "ximf:panel" et est formaté selon la syntaxe "pane-xxx". Cet attribut est obligatoire.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.

L'élément "ximf:panel" contient au moins un éléments "ximf:groupbox".

==== Element groupbox ====
Un élément groupbox correspond à une sous catégorie d'un onglet du formulaire XIMF.
La structure "groupbox" détaille l’ordre d’affichage des entêtes dans un message.
Deux attributs précisent la balise "ximf:groupbox" : "id" et "ilk", eg.
<ximf:groupbox id="group-classification" ilk="ilk-secu-box" />

* Détails sur les attributs de l'élément "groupbox" :
** L’attribut "id" définit le nom de l'onglet, il doit être unique pour chaque élément "ximf:panel" et est formaté selon la syntaxe "pane-xxx". Cet attribut est obligatoire.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.

L'élément "groupbox" contient au moins un éléments "headerRef".

==== Element treeRcv ====
L'élément "treeRcv" permet de spécifier quelles sont les colonnes susceptibles d'être ajoutées dans le panneau principal du client de messagerie qui contient la liste des messages d’un dossier.

L'élément "treeRcv" peut contenir des éléments "headerRef".

==== Element headerRef ====
L'élément headerRef spécifie les champs associés à chaque sous-groupe d'onglet de formulaire ou les champs qu'il est possible d'afficher dans la liste des messages.
Aucun attribut ne vient compléter la balise "headerRef", eg.
<ximf:headerRef>header-classification</ximf:headerRef>

Finalement, le fichier "ihm" pourra contenir :
<pre>
<ximf:instance name="Amoco">
<ximf:ihm>
<ximf:panel id="pane_security" ilk="ilk-priority-panel">
<ximf:groupbox id="group-classification" ilk="ilk-secu-box">
<ximf:headerRef>header-correspondance-type</ximf:headerRef>
<ximf:headerRef>header-classification</ximf:headerRef>
</ximf:groupbox>
</ximf:panel>
<ximf:treeRcv>
<ximf:headerRef>header-classification</ximf:headerRef>
</ximf:treeRcv>
</ximf:ihm>
</ximf:instance>
</pre>

=== Fichier headers ===
Le fichier headers spécifie les types des champs de l'interface des formulaires XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient des éléments "header".

<div style="color:red">'''TODO :'''
Il semble que les fichiers headers définissent des entêtes devant être envoyées alors que ces mêmes entêtes ne sont pas spécifiés dans le fichier ihm. Ce comportement est logique, en effet, l'utilisateur n'a pas forcément besoin de savoir tout ce qui est envoyé via le formulaire. Cependant, comment le moteur XIMF sait quels entêtes doivent être envoyés ?
</div>

==== Element header ====
Chaque élément "header" décrit un entête de message de format XIMF.
Huit attributs précisent la balise "header" : "headerName", "id", "technicalHeaderName", "type", "technicalType", "isMandatory", "ilk", "description", e.g.,

<div style="color:red;">'''TODO :'''
Comment est effectuée la vérification de l'attribut isMandatory et quelles sont les conditions de fonctionnement de celui-ci ? Est-il possible, par exemple, de spécifier l'attribut isMandatory=true d'un élément header si le contenu de celui-ci est un élément « set » qui dispose des attributs minItem et maxItem ? Actuellement, lorsque l'on crée un élément set avec les attributs minItem et maxItem, le champ du formulaire associé ne peux pas être validé : e.g.,
<ximf:set id="value-amoco-classification" minItem="1" maxItem="64" separator=";" technicalSeparator=".">
</div>

<ximf:header id="header-primary-precedence"
headerName="X-XIMF-Primary-Precedence"
ilk="ilk-primary-precedence"
isMandatory="true"
description="entête d’urgence"
type="string" />

* Détails sur les attributs de l'élément "header" :
** L’attribut "headerName" définit le nom du champ XIMF. Cet attribut est obligatoire.
** L’attribut "id" définit un identifiant de champ, il doit être unique pour chaque élément "header" et est formaté selon la syntaxe "header-xxx". Cet attribut est obligatoire.
** L’attribut "isMandatory" précise si ce champ doit être obligatoirement présent dans le message intégrant les entêtes selon cette description.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.
** L’attribut "type" précise le format des données associées à cet élément. Ce format peut être une date, une chaîne, une adresse mail, un O.I.D.
** L’attribut "technicalHeaderName" permet de compléter l’entête décrit par un autre entête.
** L’attribut "technicalType" précise le format des données associées à l’élément technicalHeaderName.
** L’attribut "description" permet d’ajouter une information sur cet élément.

L’élément "header" contient obligatoirement un élément "set", "multiset", "string", ou "compstring", e.g.,

<ximf:header id="header-reply-by"
headerName="X-XIMF-Reply-By"
ilk="ilk-reply-by"
isMandatory="false" >
<ximf:string id="value-reply-by" editable="true" />
</ximf:header>

<div style="color:red;">
'''TODO :''' Quelles sont les contraintes associées à l'attribut type d'un élément header ?
</div>

==== Element string ====
L’élément "string" précise le contenu d’une ressource de type chaîne de caractères imprimables (a-z, A-Z, 1-9,…)
Quinze attributs complètent l’élément "string" : "id", "ref", "ilk", "aclLevel", "index", "description", "editable", "content", "technicalContent","maxItem", "minItem", "maxLength", "minLength", "separator", "technicalSeparator", e.g.,

<ximf:string ilk="ilk-france" content="FRA" />

* Détails sur les attributs de l'élément "string" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "string".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role| élément role]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut " description " permet d’associer un commentaire sur cette donnée.
** L’attribut "editable" définit une valeur de saisie (champ libre). Cet attribut est de type booléen.
** L’attribut "content" représente la valeur effective de la donnée. C’est cette donnée qui sera associée au champ XIMF créé.
** L’attribut "technicalContent" représente la valeur effective de la donnée technique. C’est cette donnée qui sera associée au champ technique XIMF créé (cf. attribut technicalHeaderName de l’élément "header".
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.

L’élément "string" peut contenir plusieurs éléments "linkedValue".

<ximf:string ilk="ilk-non-protege" content="NON PROTEGE" technicalContent="1" >
<ximf:linkedValue ref="value-non-protege-france " />
</ximf:string>

==== Element compstring ====
<div style="color:red;">
'''TODO :''' L'attribut de l'élément « compstring » nommé « contentFactorise » devrait s'appeler « contentFactorize ».
</div>
L’élément "compstring" décrit un conteneur de concaténation des éléments fils. Il permet notamment de créer des valeurs d’entêtes composées.
Dix-sept attributs complètent l’élément "compstring" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", "content", "technicalContent", "contentPositionEnd", "contentFactorise", "technicalPositionEnd", e.g.,

<ximf:compstring
ilk="ilk-special"
content="SPECIAL"
technicalContent="1.3.4"
separator=" "
technicalSeparator=".">

* Détails sur les attributs de l'élément "compstring" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "compstring".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (cf. [[#Element_role| élément "role"]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut " description " permet d’associer un commentaire sur cette donnée.
** L’attribut "content" représente la valeur effective de la donnée. C’est cette donnée qui sera associée au champ XIMF créé.
** L’attribut "technicalContent" représente la valeur effective de la donnée technique. C’est cette donnée qui sera associée au champ technique XIMF créé (cf. attribut technicalHeaderName de l’élément "header".
** L’attribut "separator" définit le caractère de séparation entre deux valeurs.
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "contentPositionEnd" impose de positionner le contenu de l’élément "compstring" après les valeurs des éléments fils : valuefils1,valuefils2 : valuecompstring.
** L’attribut "technicalPositionEnd" impose de positionner le contenu de l’élément "compstring" après les valeurs des éléments fils.
** L’attribut "contentFactorise" impose d’utiliser le contenu de l’élément "compstring" comme facteur des éléments fils : valuecompstring(valuefils1,valuefils2).

L’élément "compstring" peut contenir un élément "string" ou "set" ou "multiset" ou plusieurs éléments "compstring".

<ximf:compstring
ilk="ilk-special"
content="SPECIAL"
technicalContent="1.3.4"
separator=" "
technicalSeparator=".">
<ximf:set id="ilk-special-op " maxItem="64">
<ximf:string ilk="ilk-special-op1" content="OP1" technicalContent="1" />
<ximf:string ilk="ilk-special-op2" content="OP2" technicalContent="2" />
<ximf:string ilk="ilk-special-op3" content="OP3" technicalContent="3" />
</ximf:set>
</ximf:compstring>

==== Element set ====
L’élément "set" décrit un conteneur de ressources de même type. Cet élément autorise la sélection de plusieurs ressources mais chaque ressource est sélectionnée une seule fois.
Douze attributs précisent la description de la balise "set" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", e.g.,

<ximf:set id="value-categories" ref="value-mentions" maxItem="64" separator=";" />

* Détails sur les attributs de l'élément "set" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "ximf:set".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role|élément rôle]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut "description" permet d’associer un commentaire sur cette donnée.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs

L’élément "set" peut contenir un ou plusieurs éléments "string" ou un ou plusieurs éléments "compstring".

<ximf:set id="value-categories" minItem="1" maxItem="64" separator=";">
<ximf:string ilk="ilk-releasable-to" content="RELEASABLE TO " />
<ximf:string ilk="ilk-eyes-only" content=" EYES ONLY"/>
<ximf:string ilk="ilk-use-only" content=" USE ONLY"/>
</ximf:set>

<div style="color:red;">'''TODO :'''
* Y a-t-il une définition des fichiers associés aux instances XIMF (e.g, le fichier attribution-list.xml utilisé dans l'instance Caterpillar) ?
* Comment le moteur XIMF sait qu'un élément est une "attribution-list" ?
</div>

==== Element multiset ====
L’élément "multiset" décrit un conteneur de ressources de même type. Cet élément autorise la sélection de plusieurs ressources et chaque ressource peut être sélectionnée plusieurs fois.
Douze attributs précisent la description de la balise "multiset" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", e.g.,

<ximf:multiset
id="value-restricted"
ilk=" value-restricted-otan"
maxItem="64"
separator=";" />

* Détails sur les attributs de l'élément "multiset" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "multiset".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role|élément rôle]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut "description" permet d’associer un commentaire sur cette donnée.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs

L’élément "multiset" peut contenir un ou plusieurs éléments "string" ou un ou plusieurs éléments "compstring".

<ximf:multiset id="value-restricted-otan-categories" minItem="1" maxItem="64" separator=";" >
<ximf:string ilk="ilk-releasable-to" content="RELEASABLE TO "/>
<ximf:string ilk="ilk-eyes-only" content=" EYES ONLY"/>
<ximf:string ilk="ilk-use-only" content=" USE ONLY"/>
</ximf:multiset>

<span style="color:red;">'''TODO ''': Comment sont gérées les règles associées aux champs multivaleurs (disposant par exemple des attributs minItem/maxItem ou les champs multiset) ?</span>

==== Element linkedValue ====
L’élément "linkedValue" définit une référence sur une ressource de type conteneur ("set", "multiset") ou "string". Cette ressource devrait être utilisée si la ressource contenant "linkedValue" (noeud parent) est sélectionnée.
Un attribut précise la balise "linkvalue" : "ref", e.g.,

<ximf:linkedValue ref="value-restricted-otan-classification-id" />

* Détails sur les attributs de l'élément "linkedValue" :
** L’attribut "ref" précise la valeur de l’attribut "id" de la ressource cible. Cet attribut est obligatoire.

=== Fichier rules ===
Le fichier rules définit les règles de contrôles d’entêtes XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui peut contenir des éléments "ximf:rule".

==== Element rule ====
<div style="color:red">
'''TODO :''' Mettre à jour la documentation :
* Les éléments autorisés dans un élément « rule » ne sont plus à jour. La présente documentation spécifie 12 éléments : AliasHeader, AliasValue, Compatibility, Association, SecureHeaders, SecurityLabel, Constraint, Assignment, Processing, Accessibility, Role et Custom. Le schéma XML fourni avec le mail en spécifie 5 : Constraint, Processing, Compatibility, Policy et Custom et place les autres en tant qu'extentions des 5 éléments cités précédemment.
* Les éléments SecureHeaders et SecurityLabel associés à l'élément « rule » ne figurent pas dans la nouvelle version du shéma xml. On les retrouve dans les fichiers rules-*.xml mais les éléments sont commentés, ils sont, de plus, présents dans une autre instance : comment ces éléments sont utilisés dans Trustedbird ?
* L'élément ximf:classificationPictures n'est pas documenté. De plus, il serait bon d'avoir des précisions sur la raison qui a motivé l'ajout de cet élément dans les fichiers de règles (alors qu'il semblerait être plus adapté au fichier headers-*.xml).
</div>
L’élément "rule" est le conteneur principal de description d’un comportement particulier à appliquer sur un ensemble d’entêtes XIMF.
Trois attributs précisent la balise "rule" : "id", "agent", "description", e.g.,
<ximf:rule id="compatibility-rule" description="Règle sur la compatibilité X-SMTP / XIMF" >

* Détails sur les attributs de l'élément "rule" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "rule". Cet attribut est obligatoire.
** L’attribut "agent" indique l’équipement cible devant analyser et appliquer le contenu de cet élément.
** L’attribut "description" autorise l’auteur d’ajouter un commentaire sur cet élément.

L’élément "rule" contient un ou plusieurs mêmes éléments de spécialisation de la règle "contraint", "assignement", "processing", "compatibility", "accessibility", "custom",…, e.g.,

<ximf:rule id="precedence-rule" agent="mua" description="Règle sur les priorités">
<ximf:constraint
left="header-primary-precedence"
operator="equalOrGreaterThan"
right="header-copy-precedence" />
</ximf:rule>

==== Element aliasHeader ====
L’élément "aliasHeader" permet de définir le nom de l’entête sur lequel la règle précisée est appliquée
Deux attributs précisent la balise "aliasHeader" : "headerName" et "headerRef", e.g.,

<ximf:aliasHeader headerName ="X-P772-Version" headerRef="X-XIMF-VERSION" />

* Détails sur les attributs de l'élément "aliasHeader" :
* L’attribut "headerName" définit le nom XIMF de l’entête modifié par la règle. Cet attribut est obligatoire.
* L’attribut "headerRef" définit le nom d’un entête XIMF de référence qui est le point d’entrée de l’application de la règle sur l’entête définit par "headerName". Cela permet de lier deux entêtes de messages où l’utilisation de l’un des entêtes influe sur le comportement de l’autre.

L’élément "aliasHeader" peut contenir des éléments "aliasValue",e.g ,

<ximf:aliasHeader headerName="X-P772-Version" />
<ximf:aliasValue vame="1.0"/>
<ximf:aliasHeader>

==== Element aliasValue ====
L’élément "aliasValue" contient une valeur à associer à l’entête XIMF contrôlé par la règle. Il est utile lorsque deux entêtes sont liées (utilisation de l’attribut headerRef dans l’élément aliasHeader) et que les valeurs de l’entêtes de référence permettent de préciser celles de l’entête contrôlé.
Deux attributs précisent la balise "aliasValue" : "valueName", "valueRef", e.g.,

<ximf:aliasValue valueName="2" valueRef="flash" />

* Détails sur les attributs de l'élément "aliasValue" :
** L’attribut "valueName" définit la valeur de l’entête à créer. Cet attribut est obligatoire.
** L’attribut "valueRef" définit la valeur de l’entête XIMF de référence pour utiliser valueName.
<span style="color:red;">'''TODO :''' L'attribut valueRef est-il obligatoire ?</span>

==== Element compatibility ====
L’élément "compatibility" est utilisé pour associer à un entête respectant la norme XIMF un entête respectant une autre norme que XIMF (XSMTP par exemple).
Deux attributs précisent la balise "compatibility" : "targetName", "targetVersion", e.g.,

<ximf:compatibility targetName="X-SMTP" targetVersion="1.1">
<ximf:aliasValue headerName="X-P772-Version" content="1.1" />
<ximf:aliasValue
headerName="X-P772-Primary-Precedence"
headerRef="header-primary-precedence"
dataRef="data-priority-xsmtp"/>
</ximf:compatibility>

* Détails sur les attributs de l'élément "compatibility" :
** L’attribut "targetName" définit la norme de l’entête à associer à l’entête XIMF. Cet attribut est obligatoire.
** L’attribut "targetVersion" définit le numéro de version de la norme de l’entête à associer à l’entête XIMF. Cet attribut est obligatoire.

L’élément "compatibility" contient au moins un élément "aliasHeader".

<u>Pour illustrer cette règle :</u>
Le format XSMTP est déjà supporté par certains équipements. Afin de rendre ceux-ci inter opérables avec le nouveau format XIMF, cette règle permet d’associer un entête XSMTP contenant les mêmes informations qu’un entête XIMF.

L’élément Association : dépendance entre entêtes
L’élément "association" définie les valeurs autorisées pour un entête XIMF en fonction d’une valeur définie pour un autre entête XIMF.

<ximf:association>
<ximf:aliasHeader
headerName="X-XIMF-Primary-Precedence"
headerRef="X-XIMF-Correspondence-Type">
<ximf:aliasValue valueName="routine" valueRef="private" />
<ximf:aliasValue valueName="routine,priority" valueRef="professional" />
<ximf:aliasValue valueName="routine,priority,immediate,flash" valueRef="operational" />
<ximf:aliasValue valueName="routine,priority,immediate" valueRef="official" />
</ximf:aliasHeader>
</ximf:association>

==== Element secureHeaders ====
<div style="color:red;">'''TODO :''' Les éléments SecureHeaders et SecurityLabel associés à l'élément « rule » dans la version ci-dessus ne figurent plus dans le shéma xml. On les retrouve dans les fichiers rules-*.xml mais les éléments sont commentés. En revanche, ils sont bien présents dans une autre instance : s'agit-il d'une fonctionnalité non-documentée ou plus documentée ?</div>
L’élément "secureHeaders" définie la liste des entêtes à intégrer dans la signature d’un message. Cette règle s’applique sur les équipements proposant un algorithme de signature des messages.

Un élément "secureHeaders" contient un ou plusieurs éléments "aliasHeaders" où chaque élément décrit un entête à intégrer dans la signature et complété d’un attribut "status".

<ximf:secureHeaders targetName="SecureHeaders">
<ximf:aliasHeader headerName="X-XIMF-Primary-Precedence" status="0" />
<ximf:aliasHeader headerName="X-XIMF-Copy-Precedence" status="0" />
</ximf:secureHeaders>

==== Element securityLabel ====
L’élément "securityLabel" définie la liste des entêtes à intégrer dans la signature d’un message. Cette règle s’applique sur les équipements proposant un algorithme de signature des messages selon la norme RFC.

Un élément "securityLabel" contient un ou plusieurs éléments "aliasHeaders" où chaque élément décrit un entête à intégrer dans la signature et complété d’un attribut "status".

<ximf:securityLabel targetName="SecurityLabel" id="Amoco">
<ximf:aliasHeader
headerName="SecurityPolicyIdentifier"
headerRef="X-XIMF-Security-Policy-Identifier" />
<ximf:aliasHeader
headerName="SecurityClassification"
headerRef="X-XIMF-Security-Classification-Identifier" />
<ximf:aliasHeader
headerName="ESSPrivacyMark"
headerRef="X-XIMF-Privacy-Mark" />
<ximf:aliasHeader
headerName="SecurityCategory"
headerRef="X-XIMF-Security-Categories-Identifier"
type="2" />
</ximf:securityLabel>

==== Element constraint ====
L’élément "constraint" est utilisé pour définir une règle de construction de deux entêtes partageant des "datas" identiques.
Trois attributs précisent la balise "constraint" : "left", "right", "operator", e.g.,

<ximf:constraint
left="header-primary-precedence"
operator="equalOrGreaterThan"
right="header-copy-precedence" />

* Détails sur les attributs de l'élément "constraint" :
** L’attribut "left" désigne le premier élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "right" désigne le deuxième élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "operator" indique la règle de poids à appliquer sur la valeur des deux éléments "header", il peut être de type "greaterThan", "lowerThan", "equalOrGreaterThan", "equalOrLowerThan", "equal". Cet attribut est obligatoire.

* Détails sur les valeurs possibles de l'attribut "type" :
** Le type "greaterThan" signifie que la valeur de l’élément "left" doit être strictement supérieur à la valeur de l’élément "right".
** Le type "lowerThan" signifie que la valeur de l’élément "left" doit être strictement inférieur à la valeur de l’élément "right".
** Le type "equalOrGreaterThan" signifie que la valeur de l’élément "left" doit être supérieur ou égale à la valeur de l’élément "right".
** Le type "equalOrLowerThan" signifie que la valeur de l’élément "left" doit être inférieur ou égale à la valeur de l’élément "right".
** Le type "equal" signifie que la valeur de l’élément "left" et de l’élément "right" doivent être identiques.

==== Element assignment ====
<div style="color:red;">'''TODO :''' L'élément assignment n'apparaît pas dans le shéma xml qui avait été envoyé.</div>

L’élément "assignement" est utilisé pour affecter une valeur créée en fonction d’une règle de comparaison sur les valeurs de deux éléments "header".
Quatre attributs précisent la balise "assignement" : "left", "right", "operator", "result", e.g.,

<ximf:assignment
left="header-primary-precedence"
operator="equal"
right="data-routine-precedence"
result="86400" />

* Détails sur les attributs de l'élément "assignment" :
** L’attribut "left" désigne le premier élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "right" désigne le deuxième élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "operator" indique la règle de comparaison entre les valeurs des deux éléments "header", il peut être de type "greaterThan", "lowerThan", "equalOrGreaterThan", "equalOrLowerThan", "equal". Cet attribut est obligatoire.
** L’attribut "result" représente la valeur à utiliser si la règle de comparaison entre les deux éléments est satisfaite. Cet attribut est obligatoire.

==== Element processing ====
L’élément "processing" regroupe des règles de traitement à effectuer sur des entêtes formatés.
L’attribut "type" précise le type de traitement à effectuer sur ces valeurs. Cet attribut est obligatoire, il est de type : "sign-header-value", "encrypt-header-value", "capitalize-header-value", e.g.,

<ximf:processing type="sign-header-value">
<ximf:refHeader>header-primary-precedence</ximf:refheader>
<ximf:refHeader>header-copy-precedence</ximf:refheader>
<ximf:refHeader>header-echange-type</ximf:refheader>
</ximf:processing>

* Détails sur les valeurs possibles de l'attribut "type" :
** Le type "sign-header-value" définit un traitement de signature des entêtes définis dans la balise.
** Le type "encrypt-header-value" définit un traitement de chiffrement des entêtes définis dans la balise.
** Le type "capitalize-header-value" définit un traitement de capitalisation des entêtes définis dans la balise.

L’élément "processing" contient au moins un élément "refHeader".
<div style="color:red;">'''TODO :'''L'élément refHeader n'est pas documenté, s'agit-il en fait de l'élément headerRef ?</div>

==== Element accessibility ====
<div style="color:red;">'''TODO :''' L'élément accessibility n'apparaît pas dans le shéma xml qui avait été envoyé.</div>
L’élément "accessibility" définit un ensemble de règles de droit d’accès aux éléments d’une instance pour une cible déterminée (utilisateur, routeur…).
Cet élément contient un ou plusieurs éléments "role".

<ximf:accessibility>
<ximf:role id="role-flash-allowed" aclLevel="100" />
<ximf:role id="role-flash-prohibited" aclLevel="50" />
</ximf:accessibility>

==== Element role ====
L’élément "role" positionne une valeur d’accès à pour une entité définit.
Deux attributs complètent l’élément "role" : "id", "aclLevel", e.g.,

<ximf:role id="role-flash-allowed" aclLevel="100" />

* Détails sur les attributs de l'élément "role" :
** L’attribut "id" précise l’entité accessible en fonction d’une valeur déterminée.
** L’attribut "aclLevel" précise la valeur seuil d’accès à l’entité.

==== Element custom ====
L’élément "custom" permet à l’auteur de créer des nouvelles règles personnalisées.
Trois attributs précisent la balise "custom" : "id", "provider", "description", e.g.,

<ximf:custom
id="custom-display"
provider="EADS"
description="Affichage de la composition du message" >
<node1><node2><node3></node3></node2></node1>
</ximf:custom>

* Détails sur les attributs de l'élément "custom" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "custom" et formaté selon la syntaxe "custom-xxx". Cet attribut est obligatoire.
** L’attribut "provider" identifie l’auteur de la règle. Cet attribut est obligatoire.
** L’attribut "description" permet d’ajouter un commentaire sur cet élément.

L’élément "custom" peut contenir tous les éléments possibles en respectant les standards XML.

XIMF XML tags/fr

2011-03-02T07:23:26Z

Anthonyjuge : /* Element rule */

== Introduction ==
Ce document propose un modèle de description, via eXtensible Markup Language (XML), d’entêtes de messages électroniques respectant la norme XIMF. Ce document a deux objectifs :
# Décrire les éléments et attributs de représentation XML pour construire des entêtes de messages électroniques de format XIMF.
# Fournir un modèle de représentation XIMF/XML.

<u>Rappel :</u>
* Un "élément" fait référence à tous les caractères situés entre une balise de départ et un balise de fin, e.g.,
<exemple> texte et/ou éléments fils </exemple>
* Un "attribut" est une composante d’un élément. Il est positionné dans la balise de départ, e.g.,
<exemple nom='value'>

Tous les éléments décrits dans cette documentation paragraphe sont validés dans l’espace de nom "ximf".

<pre>
xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://eads.org/ximf/ximf.xsd"
</pre>

== Description détaillée des balises XML ==

Voici, par ordre d'apparition et en fonction des fichiers, les balises génériques associées aux différents fichiers XML.

=== Fichier ximfmail-profile ===

<div style="color:red;">'''TODO''' :
* Combien d'éléments ihm sont autorisés dans un élément instance ?
* La documentation des fichiers ximfmail-profile.xml n'est pas disponible. Est-il possible d'avoir accès au fichier ximf_profile.xsd mentionné dans les ximfmail-profile.xml ?
</div>

Un fichier xpi peut contenir plusieurs instances XIMF, celles-ci sont alors regroupées dans une même catégorie. Le fichier ximfmail-profile contient des informations sur toutes les instances contenues dans le xpi, notamment leur nom, leur chemin d'accès, ainsi que les noms des fichiers associés à chaque instance.

==== Element instance ====
L’élément "instance" identifie l’ensemble des entêtes à décrire selon la norme XIMF. C’est le conteneur principal d’une instance XIMF/XML. Cinq attributs précisent la balise "instance" : "ximfVersion", "version", "author", "creation", "name", e.g.,
<ximf:instance name="myInstance" version="1.0" ximfVersion="2.0" >

* Détails sur les attributs de l'élément "instance" :
** L’attribut "name" définit le nom de l’instance décrite. Cet attribut est obligatoire.
** L’attribut "ximfVersion" définit le numéro de version des entêtes XIMF utilisés pour cette représentation. Cet attribut est obligatoire.
** L’attribut "version" définit le numéro de version de l’instance décrite. Cet attribut est obligatoire.
** L’attribut "author" renseigne sur le nom de l’auteur de cette instance.
** L’attribut "creationDate" précise la date de création de cette instance.

L’élément "instance" peut contenir un ou plusieurs éléments "schema", un ou plusieurs éléments "rule", un élément "ihm" et un élément "dictionary".

==== Element dictionary ====
L'élément dictionary contient le chemin vers le fichier spécifiant les données d'internationalisation (Cf. [[#Fichier_dictionary|Fichier dictionary]]).

==== Element schema ====
L'élément shema contient le chemin vers le fichier spécifiant les entêtes XIMF (Cf. [[#Fichier_headers|Fichier headers]]).

==== Element ihm ====
L'élément ihm contient le chemin vers le fichier spécifiant la disposition de l'interface des formulaires XIMF (Cf. [[#Fichier_ihm|Fichier ihm]]).

==== Element rule ====
L'élément rule contient le chemin vers le fichier spécifiant les règles associées aux valeurs des champs XIMF (Cf. [[#Fichier_rules|Fichier rules]]).

=== Fichier dictionary ===
Le fichier dictionnary permet de mettre en œuvre l’internationalisation d’une instance XIMF. Il défini des dictionnaires qui servent à traduire les éléments de l'instance XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient un élément "ximf:dictionnary".

==== Element dictionary ====
<div style="color:red;">'''TODO''' :
* Quel est l'intérêt de renseigner un attribut "id" à l'élément "dictionary" (étant donné qu'un seul élément "dictionary est autorisé dans l'élément "instance") ?</div>

L’élément "dictionary" contient toutes les informations devant être interprétées selon le pays d’utilisation.
L’élément "dictionary" contient un ou plusieurs mêmes éléments "locale", e.g.,

<ximf:dictionary>
<ximf:locale lang="fr-FR" />
<ximf:locale lang="en-US" />
</ximf:dictionary>

==== Element locale ====
L’élément "locale" contient toutes les informations pour un pays et/ou langue désignée.
L’élément "locale" contient un ou plusieurs mêmes éléments "ilk", e.g.,

<ximf:locale lang="fr-FR" >
<ximf:ilk entity="a"/>
<ximf:ilk entity="b"/>
</ximf:locale>

* Détails sur les attributs de la balise "locale" :
** L’attribut "lang" définit le code pays de ce conteneur. Il devrai être construit selon le format défini par la RFC1766 (fr, en, ja, es, …).

==== Element ilk ====
L’élément "ilk" contient une unique information correspondant à une donnée traduite selon le code pays de l’élément père. Cette information est au format chaîne de caractère. Un attribut obligatoire précise la balise "ilk".

<ximf:ilk entity="ilk-lang-ihm">langue</ximf:ilk>

* Détails sur les attributs de la balise "ilk" :
** L’attribut "entity" définit la référence d’entrée pour récupérer le contenu de l’élément selon le code pays souhaité.

Finalement, le fichier "dictionary" pourra contenir :
<ximf:instance name="Whirlpool">
<ximf:dictionary>
<ximf:locale lang="fr-FR" >
<ximf:ilk entity="ilk-lang-ihm">Français</ximf:ilk>
<ximf:ilk entity="ilk-exemple-general">Général</ximf:ilk>
</ximf:locale>
<ximf:locale lang="en-US" >
<ximf:ilk entity="ilk-lang-ihm">English (US)</ximf:ilk>
<ximf:ilk entity="ilk-exemple-general">General</ximf:ilk>
</ximf:locale>
</ximf:dictionary>
</ximf:instance>

=== Fichier ihm ===
<span style="color:red;">'''TODO''' : La documentation originale ne décrit pas le fichier ihm, les informations ci-dessous ont seulement été présumées. Merci de les vérifier/compléter.
</span>

Le fichier ihm spécifie l'agencement de l'interface des formulaires XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient un élément "ximf:ihm".

==== Element ihm ====
L'élément "ihm" contient un ou plusieurs éléments "panel" et un élément "treeRcv".

==== Element panel ====
Un élément ximf:panel correspond à un onglet du formulaire XIMF construit.
Deux attributs précisent la balise "panel" : "id" et "ilk", eg.
<ximf:panel id="pane_security" ilk="ilk-priority-panel" />

* Détails sur les attributs de l'élément "panel" :
** L’attribut "id" définit le nom de l'onglet, il doit être unique pour chaque élément "ximf:panel" et est formaté selon la syntaxe "pane-xxx". Cet attribut est obligatoire.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.

L'élément "ximf:panel" contient au moins un éléments "ximf:groupbox".

==== Element groupbox ====
Un élément groupbox correspond à une sous catégorie d'un onglet du formulaire XIMF.
La structure "groupbox" détaille l’ordre d’affichage des entêtes dans un message.
Deux attributs précisent la balise "ximf:groupbox" : "id" et "ilk", eg.
<ximf:groupbox id="group-classification" ilk="ilk-secu-box" />

* Détails sur les attributs de l'élément "groupbox" :
** L’attribut "id" définit le nom de l'onglet, il doit être unique pour chaque élément "ximf:panel" et est formaté selon la syntaxe "pane-xxx". Cet attribut est obligatoire.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.

L'élément "groupbox" contient au moins un éléments "headerRef".

==== Element treeRcv ====
L'élément "treeRcv" permet de spécifier quelles sont les colonnes susceptibles d'être ajoutées dans le panneau principal du client de messagerie qui contient la liste des messages d’un dossier.

L'élément "treeRcv" peut contenir des éléments "headerRef".

==== Element headerRef ====
L'élément headerRef spécifie les champs associés à chaque sous-groupe d'onglet de formulaire ou les champs qu'il est possible d'afficher dans la liste des messages.
Aucun attribut ne vient compléter la balise "headerRef", eg.
<ximf:headerRef>header-classification</ximf:headerRef>

Finalement, le fichier "ihm" pourra contenir :
<pre>
<ximf:instance name="Amoco">
<ximf:ihm>
<ximf:panel id="pane_security" ilk="ilk-priority-panel">
<ximf:groupbox id="group-classification" ilk="ilk-secu-box">
<ximf:headerRef>header-correspondance-type</ximf:headerRef>
<ximf:headerRef>header-classification</ximf:headerRef>
</ximf:groupbox>
</ximf:panel>
<ximf:treeRcv>
<ximf:headerRef>header-classification</ximf:headerRef>
</ximf:treeRcv>
</ximf:ihm>
</ximf:instance>
</pre>

=== Fichier headers ===
Le fichier headers spécifie les types des champs de l'interface des formulaires XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient des éléments "header".

<div style="color:red">'''TODO :'''
Il semble que les fichiers headers définissent des entêtes devant être envoyées alors que ces mêmes entêtes ne sont pas spécifiés dans le fichier ihm. Ce comportement est logique, en effet, l'utilisateur n'a pas forcément besoin de savoir tout ce qui est envoyé via le formulaire. Cependant, comment le moteur XIMF sait quels entêtes doivent être envoyés ?
</div>

==== Element header ====
Chaque élément "header" décrit un entête de message de format XIMF.
Huit attributs précisent la balise "header" : "headerName", "id", "technicalHeaderName", "type", "technicalType", "isMandatory", "ilk", "description", e.g.,

<div style="color:red;">'''TODO :'''
Comment est effectuée la vérification de l'attribut isMandatory et quelles sont les conditions de fonctionnement de celui-ci ? Est-il possible, par exemple, de spécifier l'attribut isMandatory=true d'un élément header si le contenu de celui-ci est un élément « set » qui dispose des attributs minItem et maxItem ? Actuellement, lorsque l'on crée un élément set avec les attributs minItem et maxItem, le champ du formulaire associé ne peux pas être validé : e.g.,
<ximf:set id="value-amoco-classification" minItem="1" maxItem="64" separator=";" technicalSeparator=".">
</div>

<ximf:header id="header-primary-precedence"
headerName="X-XIMF-Primary-Precedence"
ilk="ilk-primary-precedence"
isMandatory="true"
description="entête d’urgence"
type="string" />

* Détails sur les attributs de l'élément "header" :
** L’attribut "headerName" définit le nom du champ XIMF. Cet attribut est obligatoire.
** L’attribut "id" définit un identifiant de champ, il doit être unique pour chaque élément "header" et est formaté selon la syntaxe "header-xxx". Cet attribut est obligatoire.
** L’attribut "isMandatory" précise si ce champ doit être obligatoirement présent dans le message intégrant les entêtes selon cette description.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.
** L’attribut "type" précise le format des données associées à cet élément. Ce format peut être une date, une chaîne, une adresse mail, un O.I.D.
** L’attribut "technicalHeaderName" permet de compléter l’entête décrit par un autre entête.
** L’attribut "technicalType" précise le format des données associées à l’élément technicalHeaderName.
** L’attribut "description" permet d’ajouter une information sur cet élément.

L’élément "header" contient obligatoirement un élément "set", "multiset", "string", ou "compstring", e.g.,

<ximf:header id="header-reply-by"
headerName="X-XIMF-Reply-By"
ilk="ilk-reply-by"
isMandatory="false" >
<ximf:string id="value-reply-by" editable="true" />
</ximf:header>

<div style="color:red;">
'''TODO :''' Quelles sont les contraintes associées à l'attribut type d'un élément header ?
</div>

==== Element string ====
L’élément "string" précise le contenu d’une ressource de type chaîne de caractères imprimables (a-z, A-Z, 1-9,…)
Quinze attributs complètent l’élément "string" : "id", "ref", "ilk", "aclLevel", "index", "description", "editable", "content", "technicalContent","maxItem", "minItem", "maxLength", "minLength", "separator", "technicalSeparator", e.g.,

<ximf:string ilk="ilk-france" content="FRA" />

* Détails sur les attributs de l'élément "string" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "string".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role| élément role]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut " description " permet d’associer un commentaire sur cette donnée.
** L’attribut "editable" définit une valeur de saisie (champ libre). Cet attribut est de type booléen.
** L’attribut "content" représente la valeur effective de la donnée. C’est cette donnée qui sera associée au champ XIMF créé.
** L’attribut "technicalContent" représente la valeur effective de la donnée technique. C’est cette donnée qui sera associée au champ technique XIMF créé (cf. attribut technicalHeaderName de l’élément "header".
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.

L’élément "string" peut contenir plusieurs éléments "linkedValue".

<ximf:string ilk="ilk-non-protege" content="NON PROTEGE" technicalContent="1" >
<ximf:linkedValue ref="value-non-protege-france " />
</ximf:string>

==== Element compstring ====
<div style="color:red;">
'''TODO :''' L'attribut de l'élément « compstring » nommé « contentFactorise » devrait s'appeler « contentFactorize ».
</div>
L’élément "compstring" décrit un conteneur de concaténation des éléments fils. Il permet notamment de créer des valeurs d’entêtes composées.
Dix-sept attributs complètent l’élément "compstring" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", "content", "technicalContent", "contentPositionEnd", "contentFactorise", "technicalPositionEnd", e.g.,

<ximf:compstring
ilk="ilk-special"
content="SPECIAL"
technicalContent="1.3.4"
separator=" "
technicalSeparator=".">

* Détails sur les attributs de l'élément "compstring" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "compstring".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (cf. [[#Element_role| élément "role"]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut " description " permet d’associer un commentaire sur cette donnée.
** L’attribut "content" représente la valeur effective de la donnée. C’est cette donnée qui sera associée au champ XIMF créé.
** L’attribut "technicalContent" représente la valeur effective de la donnée technique. C’est cette donnée qui sera associée au champ technique XIMF créé (cf. attribut technicalHeaderName de l’élément "header".
** L’attribut "separator" définit le caractère de séparation entre deux valeurs.
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "contentPositionEnd" impose de positionner le contenu de l’élément "compstring" après les valeurs des éléments fils : valuefils1,valuefils2 : valuecompstring.
** L’attribut "technicalPositionEnd" impose de positionner le contenu de l’élément "compstring" après les valeurs des éléments fils.
** L’attribut "contentFactorise" impose d’utiliser le contenu de l’élément "compstring" comme facteur des éléments fils : valuecompstring(valuefils1,valuefils2).

L’élément "compstring" peut contenir un élément "string" ou "set" ou "multiset" ou plusieurs éléments "compstring".

<ximf:compstring
ilk="ilk-special"
content="SPECIAL"
technicalContent="1.3.4"
separator=" "
technicalSeparator=".">
<ximf:set id="ilk-special-op " maxItem="64">
<ximf:string ilk="ilk-special-op1" content="OP1" technicalContent="1" />
<ximf:string ilk="ilk-special-op2" content="OP2" technicalContent="2" />
<ximf:string ilk="ilk-special-op3" content="OP3" technicalContent="3" />
</ximf:set>
</ximf:compstring>

==== Element set ====
L’élément "set" décrit un conteneur de ressources de même type. Cet élément autorise la sélection de plusieurs ressources mais chaque ressource est sélectionnée une seule fois.
Douze attributs précisent la description de la balise "set" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", e.g.,

<ximf:set id="value-categories" ref="value-mentions" maxItem="64" separator=";" />

* Détails sur les attributs de l'élément "set" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "ximf:set".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role|élément rôle]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut "description" permet d’associer un commentaire sur cette donnée.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs

L’élément "set" peut contenir un ou plusieurs éléments "string" ou un ou plusieurs éléments "compstring".

<ximf:set id="value-categories" minItem="1" maxItem="64" separator=";">
<ximf:string ilk="ilk-releasable-to" content="RELEASABLE TO " />
<ximf:string ilk="ilk-eyes-only" content=" EYES ONLY"/>
<ximf:string ilk="ilk-use-only" content=" USE ONLY"/>
</ximf:set>

<div style="color:red;">'''TODO :'''
* Y a-t-il une définition des fichiers associés aux instances XIMF (e.g, le fichier attribution-list.xml utilisé dans l'instance Caterpillar) ?
* Comment le moteur XIMF sait qu'un élément est une "attribution-list" ?
</div>

==== Element multiset ====
L’élément "multiset" décrit un conteneur de ressources de même type. Cet élément autorise la sélection de plusieurs ressources et chaque ressource peut être sélectionnée plusieurs fois.
Douze attributs précisent la description de la balise "multiset" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", e.g.,

<ximf:multiset
id="value-restricted"
ilk=" value-restricted-otan"
maxItem="64"
separator=";" />

* Détails sur les attributs de l'élément "multiset" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "multiset".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role|élément rôle]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut "description" permet d’associer un commentaire sur cette donnée.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs

L’élément "multiset" peut contenir un ou plusieurs éléments "string" ou un ou plusieurs éléments "compstring".

<ximf:multiset id="value-restricted-otan-categories" minItem="1" maxItem="64" separator=";" >
<ximf:string ilk="ilk-releasable-to" content="RELEASABLE TO "/>
<ximf:string ilk="ilk-eyes-only" content=" EYES ONLY"/>
<ximf:string ilk="ilk-use-only" content=" USE ONLY"/>
</ximf:multiset>

<span style="color:red;">'''TODO ''': Comment sont gérées les règles associées aux champs multivaleurs (disposant par exemple des attributs minItem/maxItem ou les champs multiset) ?</span>

==== Element linkedValue ====
L’élément "linkedValue" définit une référence sur une ressource de type conteneur ("set", "multiset") ou "string". Cette ressource devrait être utilisée si la ressource contenant "linkedValue" (noeud parent) est sélectionnée.
Un attribut précise la balise "linkvalue" : "ref", e.g.,

<ximf:linkedValue ref="value-restricted-otan-classification-id" />

* Détails sur les attributs de l'élément "linkedValue" :
** L’attribut "ref" précise la valeur de l’attribut "id" de la ressource cible. Cet attribut est obligatoire.

=== Fichier rules ===
Le fichier rules définit les règles de contrôles d’entêtes XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui peut contenir des éléments "ximf:rule".

==== Element rule ====
<div style="color:red">
'''TODO :''' Mettre à jour la documentation :
* Les éléments autorisés dans un élément « rule » ne sont plus à jour. La présente documentation spécifie 12 éléments : AliasHeader, AliasValue, Compatibility, Association, SecureHeaders, SecurityLabel, Constraint, Assignment, Processing, Accessibility, Role et Custom. Le schéma XML fourni avec le mail en spécifie 5 : Constraint, Processing, Compatibility, Policy et Custom et place les autres en tant qu'extentions des 5 éléments cités précédemment.
* Les éléments SecureHeaders et SecurityLabel associés à l'élément « rule » ne figurent pas dans la nouvelle version du shéma xml. On les retrouve dans les fichiers rules-*.xml mais les éléments sont commentés, ils sont, de plus, présents dans une autre instance : comment ces éléments sont utilisés dans Trustedbird ?
* L'élément ximf:classificationPictures n'est pas documenté. De plus, il serait bon d'avoir des précisions sur la raison qui a motivé l'ajout de cet élément dans les fichiers de règles (alors qu'il semblerait être plus adapté au fichier headers-*.xml).
</div>
L’élément "rule" est le conteneur principal de description d’un comportement particulier à appliquer sur un ensemble d’entêtes XIMF.
Trois attributs précisent la balise "rule" : "id", "agent", "description", e.g.,
<ximf:rule id="compatibility-rule" description="Règle sur la compatibilité X-SMTP / XIMF" >

* Détails sur les attributs de l'élément "rule" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "rule". Cet attribut est obligatoire.
** L’attribut "agent" indique l’équipement cible devant analyser et appliquer le contenu de cet élément.
** L’attribut "description" autorise l’auteur d’ajouter un commentaire sur cet élément.

L’élément "rule" contient un ou plusieurs mêmes éléments de spécialisation de la règle "contraint", "assignement", "processing", "compatibility", "accessibility", "custom",…, e.g.,

<ximf:rule id="precedence-rule" agent="mua" description="Règle sur les priorités">
<ximf:constraint
left="header-primary-precedence"
operator="equalOrGreaterThan"
right="header-copy-precedence" />
</ximf:rule>

==== Element aliasHeader ====
L’élément "aliasHeader" permet de définir le nom de l’entête sur lequel la règle précisée est appliquée
Deux attributs précisent la balise "aliasHeader" : "headerName" et "headerRef", e.g.,

<ximf:aliasHeader headerName ="X-P772-Version" headerRef="X-XIMF-VERSION" />

* Détails sur les attributs de l'élément "aliasHeader" :
* L’attribut "headerName" définit le nom XIMF de l’entête modifié par la règle. Cet attribut est obligatoire.
* L’attribut "headerRef" définit le nom d’un entête XIMF de référence qui est le point d’entrée de l’application de la règle sur l’entête définit par "headerName". Cela permet de lier deux entêtes de messages où l’utilisation de l’un des entêtes influe sur le comportement de l’autre.

L’élément "aliasHeader" peut contenir des éléments "aliasValue",e.g ,

<ximf:aliasHeader headerName="X-P772-Version" />
<ximf:aliasValue vame="1.0"/>
<ximf:aliasHeader>

==== Element aliasValue ====
L’élément "aliasValue" contient une valeur à associer à l’entête XIMF contrôlé par la règle. Il est utile lorsque deux entêtes sont liées (utilisation de l’attribut headerRef dans l’élément aliasHeader) et que les valeurs de l’entêtes de référence permettent de préciser celles de l’entête contrôlé.
Deux attributs précisent la balise "aliasValue" : "valueName", "valueRef", e.g.,

<ximf:aliasValue valueName="2" valueRef ="flash" />

* Détails sur les attributs de l'élément "aliasValue" :
** L’attribut "valueName" définit la valeur de l’entête à créer. Cet attribut est obligatoire.
** L’attribut "valueRef" définit la valeur de l’entête XIMF de référence pour utiliser valueName.
<span style="color:red;">'''TODO :''' L'attribut valueRef est-il obligatoire ?</span>

==== Element compatibility ====
L’élément "compatibility" est utilisé pour associer à un entête respectant la norme XIMF un entête respectant une autre norme que XIMF (XSMTP par exemple).
Deux attributs précisent la balise "compatibility" : "targetName", "targetVersion", e.g.,

<ximf:compatibility targetName="X-SMTP" targetVersion="1.1">
<ximf:aliasValue headerName="X-P772-Version" content="1.1" />
<ximf:aliasValue
headerName="X-P772-Primary-Precedence"
headerRef="header-primary-precedence"
dataRef="data-priority-xsmtp"/>
</ximf:compatibility>

* Détails sur les attributs de l'élément "compatibility" :
** L’attribut "targetName" définit la norme de l’entête à associer à l’entête XIMF. Cet attribut est obligatoire.
** L’attribut "targetVersion" définit le numéro de version de la norme de l’entête à associer à l’entête XIMF. Cet attribut est obligatoire.

L’élément "compatibility" contient au moins un élément "aliasHeader".

<u>Pour illustrer cette règle :</u>
Le format XSMTP est déjà supporté par certains équipements. Afin de rendre ceux-ci inter opérables avec le nouveau format XIMF, cette règle permet d’associer un entête XSMTP contenant les mêmes informations qu’un entête XIMF.

L’élément Association : dépendance entre entêtes
L’élément "association" définie les valeurs autorisées pour un entête XIMF en fonction d’une valeur définie pour un autre entête XIMF.

<ximf:association>
<ximf:aliasHeader
headerName="X-XIMF-Primary-Precedence"
headerRef="X-XIMF-Correspondence-Type">
<ximf:aliasValue valueName="routine" valueRef="private" />
<ximf:aliasValue valueName="routine,priority" valueRef="professional" />
<ximf:aliasValue valueName="routine,priority,immediate,flash" valueRef="operational" />
<ximf:aliasValue valueName="routine,priority,immediate" valueRef="official" />
</ximf:aliasHeader>
</ximf:association>

==== Element secureHeaders ====
<div style="color:red;">'''TODO :''' Les éléments SecureHeaders et SecurityLabel associés à l'élément « rule » dans la version ci-dessus ne figurent plus dans le shéma xml. On les retrouve dans les fichiers rules-*.xml mais les éléments sont commentés. En revanche, ils sont bien présents dans une autre instance : s'agit-il d'une fonctionnalité non-documentée ou plus documentée ?</div>
L’élément "secureHeaders" définie la liste des entêtes à intégrer dans la signature d’un message. Cette règle s’applique sur les équipements proposant un algorithme de signature des messages.

Un élément "secureHeaders" contient un ou plusieurs éléments "aliasHeaders" où chaque élément décrit un entête à intégrer dans la signature et complété d’un attribut "status".

<ximf:secureHeaders targetName="SecureHeaders">
<ximf:aliasHeader headerName="X-XIMF-Primary-Precedence" status="0" />
<ximf:aliasHeader headerName="X-XIMF-Copy-Precedence" status="0" />
</ximf:secureHeaders>

==== Element securityLabel ====
L’élément "securityLabel" définie la liste des entêtes à intégrer dans la signature d’un message. Cette règle s’applique sur les équipements proposant un algorithme de signature des messages selon la norme RFC.

Un élément "securityLabel" contient un ou plusieurs éléments "aliasHeaders" où chaque élément décrit un entête à intégrer dans la signature et complété d’un attribut "status".

<ximf:securityLabel targetName="SecurityLabel" id="Amoco">
<ximf:aliasHeader
headerName="SecurityPolicyIdentifier"
headerRef="X-XIMF-Security-Policy-Identifier" />
<ximf:aliasHeader
headerName="SecurityClassification"
headerRef="X-XIMF-Security-Classification-Identifier" />
<ximf:aliasHeader
headerName="ESSPrivacyMark"
headerRef="X-XIMF-Privacy-Mark" />
<ximf:aliasHeader
headerName="SecurityCategory"
headerRef="X-XIMF-Security-Categories-Identifier"
type="2" />
</ximf:securityLabel>

==== Element constraint ====
L’élément "constraint" est utilisé pour définir une règle de construction de deux entêtes partageant des "datas" identiques.
Trois attributs précisent la balise "constraint" : "left", "right", "operator", e.g.,

<ximf:constraint
left="header-primary-precedence"
operator="equalOrGreaterThan"
right="header-copy-precedence" />

* Détails sur les attributs de l'élément "constraint" :
** L’attribut "left" désigne le premier élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "right" désigne le deuxième élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "operator" indique la règle de poids à appliquer sur la valeur des deux éléments "header", il peut être de type "greaterThan", "lowerThan", "equalOrGreaterThan", "equalOrLowerThan", "equal". Cet attribut est obligatoire.

* Détails sur les valeurs possibles de l'attribut "type" :
** Le type "greaterThan" signifie que la valeur de l’élément "left" doit être strictement supérieur à la valeur de l’élément "right".
** Le type "lowerThan" signifie que la valeur de l’élément "left" doit être strictement inférieur à la valeur de l’élément "right".
** Le type "equalOrGreaterThan" signifie que la valeur de l’élément "left" doit être supérieur ou égale à la valeur de l’élément "right".
** Le type "equalOrLowerThan" signifie que la valeur de l’élément "left" doit être inférieur ou égale à la valeur de l’élément "right".
** Le type "equal" signifie que la valeur de l’élément "left" et de l’élément "right" doivent être identiques.

==== Element assignment ====
<div style="color:red;">'''TODO :''' L'élément assignment n'apparaît pas dans le shéma xml qui avait été envoyé.</div>

L’élément "assignement" est utilisé pour affecter une valeur créée en fonction d’une règle de comparaison sur les valeurs de deux éléments "header".
Quatre attributs précisent la balise "assignement" : "left", "right", "operator", "result", e.g.,

<ximf:assignment
left="header-primary-precedence"
operator="equal"
right="data-routine-precedence"
result="86400" />

* Détails sur les attributs de l'élément "assignment" :
** L’attribut "left" désigne le premier élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "right" désigne le deuxième élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "operator" indique la règle de comparaison entre les valeurs des deux éléments "header", il peut être de type "greaterThan", "lowerThan", "equalOrGreaterThan", "equalOrLowerThan", "equal". Cet attribut est obligatoire.
** L’attribut "result" représente la valeur à utiliser si la règle de comparaison entre les deux éléments est satisfaite. Cet attribut est obligatoire.

==== Element processing ====
L’élément "processing" regroupe des règles de traitement à effectuer sur des entêtes formatés.
L’attribut "type" précise le type de traitement à effectuer sur ces valeurs. Cet attribut est obligatoire, il est de type : "sign-header-value", "encrypt-header-value", "capitalize-header-value", e.g.,

<ximf:processing type="sign-header-value">
<ximf:refHeader>header-primary-precedence</ximf:refheader>
<ximf:refHeader>header-copy-precedence</ximf:refheader>
<ximf:refHeader>header-echange-type</ximf:refheader>
</ximf:processing>

* Détails sur les valeurs possibles de l'attribut "type" :
** Le type "sign-header-value" définit un traitement de signature des entêtes définis dans la balise.
** Le type "encrypt-header-value" définit un traitement de chiffrement des entêtes définis dans la balise.
** Le type "capitalize-header-value" définit un traitement de capitalisation des entêtes définis dans la balise.

L’élément "processing" contient au moins un élément "refHeader".
<div style="color:red;">'''TODO :'''L'élément refHeader n'est pas documenté, s'agit-il en fait de l'élément headerRef ?</div>

==== Element accessibility ====
<div style="color:red;">'''TODO :''' L'élément accessibility n'apparaît pas dans le shéma xml qui avait été envoyé.</div>
L’élément "accessibility" définit un ensemble de règles de droit d’accès aux éléments d’une instance pour une cible déterminée (utilisateur, routeur…).
Cet élément contient un ou plusieurs éléments "role".

<ximf:accessibility>
<ximf:role id="role-flash-allowed" aclLevel="100" />
<ximf:role id="role-flash-prohibited" aclLevel="50" />
</ximf:accessibility>

==== Element role ====
L’élément "role" positionne une valeur d’accès à pour une entité définit.
Deux attributs complètent l’élément "role" : "id", "aclLevel", e.g.,

<ximf:role id="role-flash-allowed" aclLevel="100" />

* Détails sur les attributs de l'élément "role" :
** L’attribut "id" précise l’entité accessible en fonction d’une valeur déterminée.
** L’attribut "aclLevel" précise la valeur seuil d’accès à l’entité.

==== Element custom ====
L’élément "custom" permet à l’auteur de créer des nouvelles règles personnalisées.
Trois attributs précisent la balise "custom" : "id", "provider", "description", e.g.,

<ximf:custom
id="custom-display"
provider="EADS"
description="Affichage de la composition du message" >
<node1><node2><node3></node3></node2></node1>
</ximf:custom>

* Détails sur les attributs de l'élément "custom" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "custom" et formaté selon la syntaxe "custom-xxx". Cet attribut est obligatoire.
** L’attribut "provider" identifie l’auteur de la règle. Cet attribut est obligatoire.
** L’attribut "description" permet d’ajouter un commentaire sur cet élément.

L’élément "custom" peut contenir tous les éléments possibles en respectant les standards XML.

XIMF XML tags/fr

2011-03-02T07:17:32Z

Anthonyjuge : /* Element header */

== Introduction ==
Ce document propose un modèle de description, via eXtensible Markup Language (XML), d’entêtes de messages électroniques respectant la norme XIMF. Ce document a deux objectifs :
# Décrire les éléments et attributs de représentation XML pour construire des entêtes de messages électroniques de format XIMF.
# Fournir un modèle de représentation XIMF/XML.

<u>Rappel :</u>
* Un "élément" fait référence à tous les caractères situés entre une balise de départ et un balise de fin, e.g.,
<exemple> texte et/ou éléments fils </exemple>
* Un "attribut" est une composante d’un élément. Il est positionné dans la balise de départ, e.g.,
<exemple nom='value'>

Tous les éléments décrits dans cette documentation paragraphe sont validés dans l’espace de nom "ximf".

<pre>
xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://eads.org/ximf/ximf.xsd"
</pre>

== Description détaillée des balises XML ==

Voici, par ordre d'apparition et en fonction des fichiers, les balises génériques associées aux différents fichiers XML.

=== Fichier ximfmail-profile ===

<div style="color:red;">'''TODO''' :
* Combien d'éléments ihm sont autorisés dans un élément instance ?
* La documentation des fichiers ximfmail-profile.xml n'est pas disponible. Est-il possible d'avoir accès au fichier ximf_profile.xsd mentionné dans les ximfmail-profile.xml ?
</div>

Un fichier xpi peut contenir plusieurs instances XIMF, celles-ci sont alors regroupées dans une même catégorie. Le fichier ximfmail-profile contient des informations sur toutes les instances contenues dans le xpi, notamment leur nom, leur chemin d'accès, ainsi que les noms des fichiers associés à chaque instance.

==== Element instance ====
L’élément "instance" identifie l’ensemble des entêtes à décrire selon la norme XIMF. C’est le conteneur principal d’une instance XIMF/XML. Cinq attributs précisent la balise "instance" : "ximfVersion", "version", "author", "creation", "name", e.g.,
<ximf:instance name="myInstance" version="1.0" ximfVersion="2.0" >

* Détails sur les attributs de l'élément "instance" :
** L’attribut "name" définit le nom de l’instance décrite. Cet attribut est obligatoire.
** L’attribut "ximfVersion" définit le numéro de version des entêtes XIMF utilisés pour cette représentation. Cet attribut est obligatoire.
** L’attribut "version" définit le numéro de version de l’instance décrite. Cet attribut est obligatoire.
** L’attribut "author" renseigne sur le nom de l’auteur de cette instance.
** L’attribut "creationDate" précise la date de création de cette instance.

L’élément "instance" peut contenir un ou plusieurs éléments "schema", un ou plusieurs éléments "rule", un élément "ihm" et un élément "dictionary".

==== Element dictionary ====
L'élément dictionary contient le chemin vers le fichier spécifiant les données d'internationalisation (Cf. [[#Fichier_dictionary|Fichier dictionary]]).

==== Element schema ====
L'élément shema contient le chemin vers le fichier spécifiant les entêtes XIMF (Cf. [[#Fichier_headers|Fichier headers]]).

==== Element ihm ====
L'élément ihm contient le chemin vers le fichier spécifiant la disposition de l'interface des formulaires XIMF (Cf. [[#Fichier_ihm|Fichier ihm]]).

==== Element rule ====
L'élément rule contient le chemin vers le fichier spécifiant les règles associées aux valeurs des champs XIMF (Cf. [[#Fichier_rules|Fichier rules]]).

=== Fichier dictionary ===
Le fichier dictionnary permet de mettre en œuvre l’internationalisation d’une instance XIMF. Il défini des dictionnaires qui servent à traduire les éléments de l'instance XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient un élément "ximf:dictionnary".

==== Element dictionary ====
<div style="color:red;">'''TODO''' :
* Quel est l'intérêt de renseigner un attribut "id" à l'élément "dictionary" (étant donné qu'un seul élément "dictionary est autorisé dans l'élément "instance") ?</div>

L’élément "dictionary" contient toutes les informations devant être interprétées selon le pays d’utilisation.
L’élément "dictionary" contient un ou plusieurs mêmes éléments "locale", e.g.,

<ximf:dictionary>
<ximf:locale lang="fr-FR" />
<ximf:locale lang="en-US" />
</ximf:dictionary>

==== Element locale ====
L’élément "locale" contient toutes les informations pour un pays et/ou langue désignée.
L’élément "locale" contient un ou plusieurs mêmes éléments "ilk", e.g.,

<ximf:locale lang="fr-FR" >
<ximf:ilk entity="a"/>
<ximf:ilk entity="b"/>
</ximf:locale>

* Détails sur les attributs de la balise "locale" :
** L’attribut "lang" définit le code pays de ce conteneur. Il devrai être construit selon le format défini par la RFC1766 (fr, en, ja, es, …).

==== Element ilk ====
L’élément "ilk" contient une unique information correspondant à une donnée traduite selon le code pays de l’élément père. Cette information est au format chaîne de caractère. Un attribut obligatoire précise la balise "ilk".

<ximf:ilk entity="ilk-lang-ihm">langue</ximf:ilk>

* Détails sur les attributs de la balise "ilk" :
** L’attribut "entity" définit la référence d’entrée pour récupérer le contenu de l’élément selon le code pays souhaité.

Finalement, le fichier "dictionary" pourra contenir :
<ximf:instance name="Whirlpool">
<ximf:dictionary>
<ximf:locale lang="fr-FR" >
<ximf:ilk entity="ilk-lang-ihm">Français</ximf:ilk>
<ximf:ilk entity="ilk-exemple-general">Général</ximf:ilk>
</ximf:locale>
<ximf:locale lang="en-US" >
<ximf:ilk entity="ilk-lang-ihm">English (US)</ximf:ilk>
<ximf:ilk entity="ilk-exemple-general">General</ximf:ilk>
</ximf:locale>
</ximf:dictionary>
</ximf:instance>

=== Fichier ihm ===
<span style="color:red;">'''TODO''' : La documentation originale ne décrit pas le fichier ihm, les informations ci-dessous ont seulement été présumées. Merci de les vérifier/compléter.
</span>

Le fichier ihm spécifie l'agencement de l'interface des formulaires XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient un élément "ximf:ihm".

==== Element ihm ====
L'élément "ihm" contient un ou plusieurs éléments "panel" et un élément "treeRcv".

==== Element panel ====
Un élément ximf:panel correspond à un onglet du formulaire XIMF construit.
Deux attributs précisent la balise "panel" : "id" et "ilk", eg.
<ximf:panel id="pane_security" ilk="ilk-priority-panel" />

* Détails sur les attributs de l'élément "panel" :
** L’attribut "id" définit le nom de l'onglet, il doit être unique pour chaque élément "ximf:panel" et est formaté selon la syntaxe "pane-xxx". Cet attribut est obligatoire.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.

L'élément "ximf:panel" contient au moins un éléments "ximf:groupbox".

==== Element groupbox ====
Un élément groupbox correspond à une sous catégorie d'un onglet du formulaire XIMF.
La structure "groupbox" détaille l’ordre d’affichage des entêtes dans un message.
Deux attributs précisent la balise "ximf:groupbox" : "id" et "ilk", eg.
<ximf:groupbox id="group-classification" ilk="ilk-secu-box" />

* Détails sur les attributs de l'élément "groupbox" :
** L’attribut "id" définit le nom de l'onglet, il doit être unique pour chaque élément "ximf:panel" et est formaté selon la syntaxe "pane-xxx". Cet attribut est obligatoire.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.

L'élément "groupbox" contient au moins un éléments "headerRef".

==== Element treeRcv ====
L'élément "treeRcv" permet de spécifier quelles sont les colonnes susceptibles d'être ajoutées dans le panneau principal du client de messagerie qui contient la liste des messages d’un dossier.

L'élément "treeRcv" peut contenir des éléments "headerRef".

==== Element headerRef ====
L'élément headerRef spécifie les champs associés à chaque sous-groupe d'onglet de formulaire ou les champs qu'il est possible d'afficher dans la liste des messages.
Aucun attribut ne vient compléter la balise "headerRef", eg.
<ximf:headerRef>header-classification</ximf:headerRef>

Finalement, le fichier "ihm" pourra contenir :
<pre>
<ximf:instance name="Amoco">
<ximf:ihm>
<ximf:panel id="pane_security" ilk="ilk-priority-panel">
<ximf:groupbox id="group-classification" ilk="ilk-secu-box">
<ximf:headerRef>header-correspondance-type</ximf:headerRef>
<ximf:headerRef>header-classification</ximf:headerRef>
</ximf:groupbox>
</ximf:panel>
<ximf:treeRcv>
<ximf:headerRef>header-classification</ximf:headerRef>
</ximf:treeRcv>
</ximf:ihm>
</ximf:instance>
</pre>

=== Fichier headers ===
Le fichier headers spécifie les types des champs de l'interface des formulaires XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient des éléments "header".

<div style="color:red">'''TODO :'''
Il semble que les fichiers headers définissent des entêtes devant être envoyées alors que ces mêmes entêtes ne sont pas spécifiés dans le fichier ihm. Ce comportement est logique, en effet, l'utilisateur n'a pas forcément besoin de savoir tout ce qui est envoyé via le formulaire. Cependant, comment le moteur XIMF sait quels entêtes doivent être envoyés ?
</div>

==== Element header ====
Chaque élément "header" décrit un entête de message de format XIMF.
Huit attributs précisent la balise "header" : "headerName", "id", "technicalHeaderName", "type", "technicalType", "isMandatory", "ilk", "description", e.g.,

<div style="color:red;">'''TODO :'''
Comment est effectuée la vérification de l'attribut isMandatory et quelles sont les conditions de fonctionnement de celui-ci ? Est-il possible, par exemple, de spécifier l'attribut isMandatory=true d'un élément header si le contenu de celui-ci est un élément « set » qui dispose des attributs minItem et maxItem ? Actuellement, lorsque l'on crée un élément set avec les attributs minItem et maxItem, le champ du formulaire associé ne peux pas être validé : e.g.,
<ximf:set id="value-amoco-classification" minItem="1" maxItem="64" separator=";" technicalSeparator=".">
</div>

<ximf:header id="header-primary-precedence"
headerName="X-XIMF-Primary-Precedence"
ilk="ilk-primary-precedence"
isMandatory="true"
description="entête d’urgence"
type="string" />

* Détails sur les attributs de l'élément "header" :
** L’attribut "headerName" définit le nom du champ XIMF. Cet attribut est obligatoire.
** L’attribut "id" définit un identifiant de champ, il doit être unique pour chaque élément "header" et est formaté selon la syntaxe "header-xxx". Cet attribut est obligatoire.
** L’attribut "isMandatory" précise si ce champ doit être obligatoirement présent dans le message intégrant les entêtes selon cette description.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.
** L’attribut "type" précise le format des données associées à cet élément. Ce format peut être une date, une chaîne, une adresse mail, un O.I.D.
** L’attribut "technicalHeaderName" permet de compléter l’entête décrit par un autre entête.
** L’attribut "technicalType" précise le format des données associées à l’élément technicalHeaderName.
** L’attribut "description" permet d’ajouter une information sur cet élément.

L’élément "header" contient obligatoirement un élément "set", "multiset", "string", ou "compstring", e.g.,

<ximf:header id="header-reply-by"
headerName="X-XIMF-Reply-By"
ilk="ilk-reply-by"
isMandatory="false" >
<ximf:string id="value-reply-by" editable="true" />
</ximf:header>

<div style="color:red;">
'''TODO :''' Quelles sont les contraintes associées à l'attribut type d'un élément header ?
</div>

==== Element string ====
L’élément "string" précise le contenu d’une ressource de type chaîne de caractères imprimables (a-z, A-Z, 1-9,…)
Quinze attributs complètent l’élément "string" : "id", "ref", "ilk", "aclLevel", "index", "description", "editable", "content", "technicalContent","maxItem", "minItem", "maxLength", "minLength", "separator", "technicalSeparator", e.g.,

<ximf:string ilk="ilk-france" content="FRA" />

* Détails sur les attributs de l'élément "string" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "string".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role| élément role]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut " description " permet d’associer un commentaire sur cette donnée.
** L’attribut "editable" définit une valeur de saisie (champ libre). Cet attribut est de type booléen.
** L’attribut "content" représente la valeur effective de la donnée. C’est cette donnée qui sera associée au champ XIMF créé.
** L’attribut "technicalContent" représente la valeur effective de la donnée technique. C’est cette donnée qui sera associée au champ technique XIMF créé (cf. attribut technicalHeaderName de l’élément "header".
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.

L’élément "string" peut contenir plusieurs éléments "linkedValue".

<ximf:string ilk="ilk-non-protege" content="NON PROTEGE" technicalContent="1" >
<ximf:linkedValue ref="value-non-protege-france " />
</ximf:string>

==== Element compstring ====
<div style="color:red;">
'''TODO :''' L'attribut de l'élément « compstring » nommé « contentFactorise » devrait s'appeler « contentFactorize ».
</div>
L’élément "compstring" décrit un conteneur de concaténation des éléments fils. Il permet notamment de créer des valeurs d’entêtes composées.
Dix-sept attributs complètent l’élément "compstring" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", "content", "technicalContent", "contentPositionEnd", "contentFactorise", "technicalPositionEnd", e.g.,

<ximf:compstring
ilk="ilk-special"
content="SPECIAL"
technicalContent="1.3.4"
separator=" "
technicalSeparator=".">

* Détails sur les attributs de l'élément "compstring" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "compstring".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (cf. [[#Element_role| élément "role"]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut " description " permet d’associer un commentaire sur cette donnée.
** L’attribut "content" représente la valeur effective de la donnée. C’est cette donnée qui sera associée au champ XIMF créé.
** L’attribut "technicalContent" représente la valeur effective de la donnée technique. C’est cette donnée qui sera associée au champ technique XIMF créé (cf. attribut technicalHeaderName de l’élément "header".
** L’attribut "separator" définit le caractère de séparation entre deux valeurs.
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "contentPositionEnd" impose de positionner le contenu de l’élément "compstring" après les valeurs des éléments fils : valuefils1,valuefils2 : valuecompstring.
** L’attribut "technicalPositionEnd" impose de positionner le contenu de l’élément "compstring" après les valeurs des éléments fils.
** L’attribut "contentFactorise" impose d’utiliser le contenu de l’élément "compstring" comme facteur des éléments fils : valuecompstring(valuefils1,valuefils2).

L’élément "compstring" peut contenir un élément "string" ou "set" ou "multiset" ou plusieurs éléments "compstring".

<ximf:compstring
ilk="ilk-special"
content="SPECIAL"
technicalContent="1.3.4"
separator=" "
technicalSeparator=".">
<ximf:set id="ilk-special-op " maxItem="64">
<ximf:string ilk="ilk-special-op1" content="OP1" technicalContent="1" />
<ximf:string ilk="ilk-special-op2" content="OP2" technicalContent="2" />
<ximf:string ilk="ilk-special-op3" content="OP3" technicalContent="3" />
</ximf:set>
</ximf:compstring>

==== Element set ====
L’élément "set" décrit un conteneur de ressources de même type. Cet élément autorise la sélection de plusieurs ressources mais chaque ressource est sélectionnée une seule fois.
Douze attributs précisent la description de la balise "set" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", e.g.,

<ximf:set id="value-categories" ref="value-mentions" maxItem="64" separator=";" />

* Détails sur les attributs de l'élément "set" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "ximf:set".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role|élément rôle]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut "description" permet d’associer un commentaire sur cette donnée.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs

L’élément "set" peut contenir un ou plusieurs éléments "string" ou un ou plusieurs éléments "compstring".

<ximf:set id="value-categories" minItem="1" maxItem="64" separator=";">
<ximf:string ilk="ilk-releasable-to" content="RELEASABLE TO " />
<ximf:string ilk="ilk-eyes-only" content=" EYES ONLY"/>
<ximf:string ilk="ilk-use-only" content=" USE ONLY"/>
</ximf:set>

<div style="color:red;">'''TODO :'''
* Y a-t-il une définition des fichiers associés aux instances XIMF (e.g, le fichier attribution-list.xml utilisé dans l'instance Caterpillar) ?
* Comment le moteur XIMF sait qu'un élément est une "attribution-list" ?
</div>

==== Element multiset ====
L’élément "multiset" décrit un conteneur de ressources de même type. Cet élément autorise la sélection de plusieurs ressources et chaque ressource peut être sélectionnée plusieurs fois.
Douze attributs précisent la description de la balise "multiset" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", e.g.,

<ximf:multiset
id="value-restricted"
ilk=" value-restricted-otan"
maxItem="64"
separator=";" />

* Détails sur les attributs de l'élément "multiset" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "multiset".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role|élément rôle]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut "description" permet d’associer un commentaire sur cette donnée.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs

L’élément "multiset" peut contenir un ou plusieurs éléments "string" ou un ou plusieurs éléments "compstring".

<ximf:multiset id="value-restricted-otan-categories" minItem="1" maxItem="64" separator=";" >
<ximf:string ilk="ilk-releasable-to" content="RELEASABLE TO "/>
<ximf:string ilk="ilk-eyes-only" content=" EYES ONLY"/>
<ximf:string ilk="ilk-use-only" content=" USE ONLY"/>
</ximf:multiset>

<span style="color:red;">'''TODO ''': Comment sont gérées les règles associées aux champs multivaleurs (disposant par exemple des attributs minItem/maxItem ou les champs multiset) ?</span>

==== Element linkedValue ====
L’élément "linkedValue" définit une référence sur une ressource de type conteneur ("set", "multiset") ou "string". Cette ressource devrait être utilisée si la ressource contenant "linkedValue" (noeud parent) est sélectionnée.
Un attribut précise la balise "linkvalue" : "ref", e.g.,

<ximf:linkedValue ref="value-restricted-otan-classification-id" />

* Détails sur les attributs de l'élément "linkedValue" :
** L’attribut "ref" précise la valeur de l’attribut "id" de la ressource cible. Cet attribut est obligatoire.

=== Fichier rules ===
Le fichier rules définit les règles de contrôles d’entêtes XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui peut contenir des éléments "ximf:rule".

==== Element rule ====
<div style="color:red">
'''TODO :''' Mettre à jour la documentation :
* Les éléments autorisés dans un élément « rule » ne sont plus à jour. La présente documentation spécifie 12 éléments : AliasHeader, AliasValue, Compatibility, Association, SecureHeaders, SecurityLabel, Constraint, Assignment, Processing, Accessibility, Role et Custom. Le schéma XML fourni avec le mail en spécifie 5 : Constraint, Processing, Compatibility, Policy et Custom et place les autres en tant qu'extentions des 5 éléments cités précédemment.
* Les éléments SecureHeaders et SecurityLabel associés à l'élément « rule » dans la version ci-dessus ne figurent plus dans la nouvelle version. On les retrouve dans les fichiers rules-*.xml mais les éléments sont commentés. En revanche, ils sont bien présents dans une autre instance : s'agit-il d'une fonctionnalité non-documentée ou plus documentée ?
* L'élément ximf:classificationPictures n'est pas documenté. De plus, il serait bon d'avoir des précisions sur la raison qui a motivé l'ajout de cet élément dans les fichiers de règles (alors qu'il semblerait être plus adapté au fichier headers-*.xml).
</div>
L’élément "rule" est le conteneur principal de description d’un comportement particulier à appliquer sur un ensemble d’entêtes XIMF.
Trois attributs précisent la balise "rule" : "id", "agent", "description", e.g.,
<ximf:rule id="compatibility-rule" description="Règle sur la compatibilité X-SMTP / XIMF" >

* Détails sur les attributs de l'élément "rule" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "rule". Cet attribut est obligatoire.
** L’attribut "agent" indique l’équipement cible devant analyser et appliquer le contenu de cet élément.
** L’attribut "description" autorise l’auteur d’ajouter un commentaire sur cet élément.

L’élément "rule" contient un ou plusieurs mêmes éléments de spécialisation de la règle "contraint", "assignement", "processing", "compatibility", "accessibility", "custom",…, e.g.,

<ximf:rule id="precedence-rule" agent="mua" description="Règle sur les priorités">
<ximf:constraint
left="header-primary-precedence"
operator="equalOrGreaterThan"
right="header-copy-precedence" />
</ximf:rule>

==== Element aliasHeader ====
L’élément "aliasHeader" permet de définir le nom de l’entête sur lequel la règle précisée est appliquée
Deux attributs précisent la balise "aliasHeader" : "headerName" et "headerRef", e.g.,

<ximf:aliasHeader headerName ="X-P772-Version" headerRef="X-XIMF-VERSION" />

* Détails sur les attributs de l'élément "aliasHeader" :
* L’attribut "headerName" définit le nom XIMF de l’entête modifié par la règle. Cet attribut est obligatoire.
* L’attribut "headerRef" définit le nom d’un entête XIMF de référence qui est le point d’entrée de l’application de la règle sur l’entête définit par "headerName". Cela permet de lier deux entêtes de messages où l’utilisation de l’un des entêtes influe sur le comportement de l’autre.

L’élément "aliasHeader" peut contenir des éléments "aliasValue",e.g ,

<ximf:aliasHeader headerName="X-P772-Version" />
<ximf:aliasValue vame="1.0"/>
<ximf:aliasHeader>

==== Element aliasValue ====
L’élément "aliasValue" contient une valeur à associer à l’entête XIMF contrôlé par la règle. Il est utile lorsque deux entêtes sont liées (utilisation de l’attribut headerRef dans l’élément aliasHeader) et que les valeurs de l’entêtes de référence permettent de préciser celles de l’entête contrôlé.
Deux attributs précisent la balise "aliasValue" : "valueName", "valueRef", e.g.,

<ximf:aliasValue valueName="2" valueRef ="flash" />

* Détails sur les attributs de l'élément "aliasValue" :
** L’attribut "valueName" définit la valeur de l’entête à créer. Cet attribut est obligatoire.
** L’attribut "valueRef" définit la valeur de l’entête XIMF de référence pour utiliser valueName.
<span style="color:red;">'''TODO :''' L'attribut valueRef est-il obligatoire ?</span>

==== Element compatibility ====
L’élément "compatibility" est utilisé pour associer à un entête respectant la norme XIMF un entête respectant une autre norme que XIMF (XSMTP par exemple).
Deux attributs précisent la balise "compatibility" : "targetName", "targetVersion", e.g.,

<ximf:compatibility targetName="X-SMTP" targetVersion="1.1">
<ximf:aliasValue headerName="X-P772-Version" content="1.1" />
<ximf:aliasValue
headerName="X-P772-Primary-Precedence"
headerRef="header-primary-precedence"
dataRef="data-priority-xsmtp"/>
</ximf:compatibility>

* Détails sur les attributs de l'élément "compatibility" :
** L’attribut "targetName" définit la norme de l’entête à associer à l’entête XIMF. Cet attribut est obligatoire.
** L’attribut "targetVersion" définit le numéro de version de la norme de l’entête à associer à l’entête XIMF. Cet attribut est obligatoire.

L’élément "compatibility" contient au moins un élément "aliasHeader".

<u>Pour illustrer cette règle :</u>
Le format XSMTP est déjà supporté par certains équipements. Afin de rendre ceux-ci inter opérables avec le nouveau format XIMF, cette règle permet d’associer un entête XSMTP contenant les mêmes informations qu’un entête XIMF.

L’élément Association : dépendance entre entêtes
L’élément "association" définie les valeurs autorisées pour un entête XIMF en fonction d’une valeur définie pour un autre entête XIMF.

<ximf:association>
<ximf:aliasHeader
headerName="X-XIMF-Primary-Precedence"
headerRef="X-XIMF-Correspondence-Type">
<ximf:aliasValue valueName="routine" valueRef="private" />
<ximf:aliasValue valueName="routine,priority" valueRef="professional" />
<ximf:aliasValue valueName="routine,priority,immediate,flash" valueRef="operational" />
<ximf:aliasValue valueName="routine,priority,immediate" valueRef="official" />
</ximf:aliasHeader>
</ximf:association>

==== Element secureHeaders ====
<div style="color:red;">'''TODO :''' Les éléments SecureHeaders et SecurityLabel associés à l'élément « rule » dans la version ci-dessus ne figurent plus dans le shéma xml. On les retrouve dans les fichiers rules-*.xml mais les éléments sont commentés. En revanche, ils sont bien présents dans une autre instance : s'agit-il d'une fonctionnalité non-documentée ou plus documentée ?</div>
L’élément "secureHeaders" définie la liste des entêtes à intégrer dans la signature d’un message. Cette règle s’applique sur les équipements proposant un algorithme de signature des messages.

Un élément "secureHeaders" contient un ou plusieurs éléments "aliasHeaders" où chaque élément décrit un entête à intégrer dans la signature et complété d’un attribut "status".

<ximf:secureHeaders targetName="SecureHeaders">
<ximf:aliasHeader headerName="X-XIMF-Primary-Precedence" status="0" />
<ximf:aliasHeader headerName="X-XIMF-Copy-Precedence" status="0" />
</ximf:secureHeaders>

==== Element securityLabel ====
L’élément "securityLabel" définie la liste des entêtes à intégrer dans la signature d’un message. Cette règle s’applique sur les équipements proposant un algorithme de signature des messages selon la norme RFC.

Un élément "securityLabel" contient un ou plusieurs éléments "aliasHeaders" où chaque élément décrit un entête à intégrer dans la signature et complété d’un attribut "status".

<ximf:securityLabel targetName="SecurityLabel" id="Amoco">
<ximf:aliasHeader
headerName="SecurityPolicyIdentifier"
headerRef="X-XIMF-Security-Policy-Identifier" />
<ximf:aliasHeader
headerName="SecurityClassification"
headerRef="X-XIMF-Security-Classification-Identifier" />
<ximf:aliasHeader
headerName="ESSPrivacyMark"
headerRef="X-XIMF-Privacy-Mark" />
<ximf:aliasHeader
headerName="SecurityCategory"
headerRef="X-XIMF-Security-Categories-Identifier"
type="2" />
</ximf:securityLabel>

==== Element constraint ====
L’élément "constraint" est utilisé pour définir une règle de construction de deux entêtes partageant des "datas" identiques.
Trois attributs précisent la balise "constraint" : "left", "right", "operator", e.g.,

<ximf:constraint
left="header-primary-precedence"
operator="equalOrGreaterThan"
right="header-copy-precedence" />

* Détails sur les attributs de l'élément "constraint" :
** L’attribut "left" désigne le premier élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "right" désigne le deuxième élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "operator" indique la règle de poids à appliquer sur la valeur des deux éléments "header", il peut être de type "greaterThan", "lowerThan", "equalOrGreaterThan", "equalOrLowerThan", "equal". Cet attribut est obligatoire.

* Détails sur les valeurs possibles de l'attribut "type" :
** Le type "greaterThan" signifie que la valeur de l’élément "left" doit être strictement supérieur à la valeur de l’élément "right".
** Le type "lowerThan" signifie que la valeur de l’élément "left" doit être strictement inférieur à la valeur de l’élément "right".
** Le type "equalOrGreaterThan" signifie que la valeur de l’élément "left" doit être supérieur ou égale à la valeur de l’élément "right".
** Le type "equalOrLowerThan" signifie que la valeur de l’élément "left" doit être inférieur ou égale à la valeur de l’élément "right".
** Le type "equal" signifie que la valeur de l’élément "left" et de l’élément "right" doivent être identiques.

==== Element assignment ====
<div style="color:red;">'''TODO :''' L'élément assignment n'apparaît pas dans le shéma xml qui avait été envoyé.</div>

L’élément "assignement" est utilisé pour affecter une valeur créée en fonction d’une règle de comparaison sur les valeurs de deux éléments "header".
Quatre attributs précisent la balise "assignement" : "left", "right", "operator", "result", e.g.,

<ximf:assignment
left="header-primary-precedence"
operator="equal"
right="data-routine-precedence"
result="86400" />

* Détails sur les attributs de l'élément "assignment" :
** L’attribut "left" désigne le premier élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "right" désigne le deuxième élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "operator" indique la règle de comparaison entre les valeurs des deux éléments "header", il peut être de type "greaterThan", "lowerThan", "equalOrGreaterThan", "equalOrLowerThan", "equal". Cet attribut est obligatoire.
** L’attribut "result" représente la valeur à utiliser si la règle de comparaison entre les deux éléments est satisfaite. Cet attribut est obligatoire.

==== Element processing ====
L’élément "processing" regroupe des règles de traitement à effectuer sur des entêtes formatés.
L’attribut "type" précise le type de traitement à effectuer sur ces valeurs. Cet attribut est obligatoire, il est de type : "sign-header-value", "encrypt-header-value", "capitalize-header-value", e.g.,

<ximf:processing type="sign-header-value">
<ximf:refHeader>header-primary-precedence</ximf:refheader>
<ximf:refHeader>header-copy-precedence</ximf:refheader>
<ximf:refHeader>header-echange-type</ximf:refheader>
</ximf:processing>

* Détails sur les valeurs possibles de l'attribut "type" :
** Le type "sign-header-value" définit un traitement de signature des entêtes définis dans la balise.
** Le type "encrypt-header-value" définit un traitement de chiffrement des entêtes définis dans la balise.
** Le type "capitalize-header-value" définit un traitement de capitalisation des entêtes définis dans la balise.

L’élément "processing" contient au moins un élément "refHeader".
<div style="color:red;">'''TODO :'''L'élément refHeader n'est pas documenté, s'agit-il en fait de l'élément headerRef ?</div>

==== Element accessibility ====
<div style="color:red;">'''TODO :''' L'élément accessibility n'apparaît pas dans le shéma xml qui avait été envoyé.</div>
L’élément "accessibility" définit un ensemble de règles de droit d’accès aux éléments d’une instance pour une cible déterminée (utilisateur, routeur…).
Cet élément contient un ou plusieurs éléments "role".

<ximf:accessibility>
<ximf:role id="role-flash-allowed" aclLevel="100" />
<ximf:role id="role-flash-prohibited" aclLevel="50" />
</ximf:accessibility>

==== Element role ====
L’élément "role" positionne une valeur d’accès à pour une entité définit.
Deux attributs complètent l’élément "role" : "id", "aclLevel", e.g.,

<ximf:role id="role-flash-allowed" aclLevel="100" />

* Détails sur les attributs de l'élément "role" :
** L’attribut "id" précise l’entité accessible en fonction d’une valeur déterminée.
** L’attribut "aclLevel" précise la valeur seuil d’accès à l’entité.

==== Element custom ====
L’élément "custom" permet à l’auteur de créer des nouvelles règles personnalisées.
Trois attributs précisent la balise "custom" : "id", "provider", "description", e.g.,

<ximf:custom
id="custom-display"
provider="EADS"
description="Affichage de la composition du message" >
<node1><node2><node3></node3></node2></node1>
</ximf:custom>

* Détails sur les attributs de l'élément "custom" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "custom" et formaté selon la syntaxe "custom-xxx". Cet attribut est obligatoire.
** L’attribut "provider" identifie l’auteur de la règle. Cet attribut est obligatoire.
** L’attribut "description" permet d’ajouter un commentaire sur cet élément.

L’élément "custom" peut contenir tous les éléments possibles en respectant les standards XML.

XIMF XML tags/fr

2011-03-02T07:16:59Z

Anthonyjuge : /* Fichier headers */

== Introduction ==
Ce document propose un modèle de description, via eXtensible Markup Language (XML), d’entêtes de messages électroniques respectant la norme XIMF. Ce document a deux objectifs :
# Décrire les éléments et attributs de représentation XML pour construire des entêtes de messages électroniques de format XIMF.
# Fournir un modèle de représentation XIMF/XML.

<u>Rappel :</u>
* Un "élément" fait référence à tous les caractères situés entre une balise de départ et un balise de fin, e.g.,
<exemple> texte et/ou éléments fils </exemple>
* Un "attribut" est une composante d’un élément. Il est positionné dans la balise de départ, e.g.,
<exemple nom='value'>

Tous les éléments décrits dans cette documentation paragraphe sont validés dans l’espace de nom "ximf".

<pre>
xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://eads.org/ximf/ximf.xsd"
</pre>

== Description détaillée des balises XML ==

Voici, par ordre d'apparition et en fonction des fichiers, les balises génériques associées aux différents fichiers XML.

=== Fichier ximfmail-profile ===

<div style="color:red;">'''TODO''' :
* Combien d'éléments ihm sont autorisés dans un élément instance ?
* La documentation des fichiers ximfmail-profile.xml n'est pas disponible. Est-il possible d'avoir accès au fichier ximf_profile.xsd mentionné dans les ximfmail-profile.xml ?
</div>

Un fichier xpi peut contenir plusieurs instances XIMF, celles-ci sont alors regroupées dans une même catégorie. Le fichier ximfmail-profile contient des informations sur toutes les instances contenues dans le xpi, notamment leur nom, leur chemin d'accès, ainsi que les noms des fichiers associés à chaque instance.

==== Element instance ====
L’élément "instance" identifie l’ensemble des entêtes à décrire selon la norme XIMF. C’est le conteneur principal d’une instance XIMF/XML. Cinq attributs précisent la balise "instance" : "ximfVersion", "version", "author", "creation", "name", e.g.,
<ximf:instance name="myInstance" version="1.0" ximfVersion="2.0" >

* Détails sur les attributs de l'élément "instance" :
** L’attribut "name" définit le nom de l’instance décrite. Cet attribut est obligatoire.
** L’attribut "ximfVersion" définit le numéro de version des entêtes XIMF utilisés pour cette représentation. Cet attribut est obligatoire.
** L’attribut "version" définit le numéro de version de l’instance décrite. Cet attribut est obligatoire.
** L’attribut "author" renseigne sur le nom de l’auteur de cette instance.
** L’attribut "creationDate" précise la date de création de cette instance.

L’élément "instance" peut contenir un ou plusieurs éléments "schema", un ou plusieurs éléments "rule", un élément "ihm" et un élément "dictionary".

==== Element dictionary ====
L'élément dictionary contient le chemin vers le fichier spécifiant les données d'internationalisation (Cf. [[#Fichier_dictionary|Fichier dictionary]]).

==== Element schema ====
L'élément shema contient le chemin vers le fichier spécifiant les entêtes XIMF (Cf. [[#Fichier_headers|Fichier headers]]).

==== Element ihm ====
L'élément ihm contient le chemin vers le fichier spécifiant la disposition de l'interface des formulaires XIMF (Cf. [[#Fichier_ihm|Fichier ihm]]).

==== Element rule ====
L'élément rule contient le chemin vers le fichier spécifiant les règles associées aux valeurs des champs XIMF (Cf. [[#Fichier_rules|Fichier rules]]).

=== Fichier dictionary ===
Le fichier dictionnary permet de mettre en œuvre l’internationalisation d’une instance XIMF. Il défini des dictionnaires qui servent à traduire les éléments de l'instance XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient un élément "ximf:dictionnary".

==== Element dictionary ====
<div style="color:red;">'''TODO''' :
* Quel est l'intérêt de renseigner un attribut "id" à l'élément "dictionary" (étant donné qu'un seul élément "dictionary est autorisé dans l'élément "instance") ?</div>

L’élément "dictionary" contient toutes les informations devant être interprétées selon le pays d’utilisation.
L’élément "dictionary" contient un ou plusieurs mêmes éléments "locale", e.g.,

<ximf:dictionary>
<ximf:locale lang="fr-FR" />
<ximf:locale lang="en-US" />
</ximf:dictionary>

==== Element locale ====
L’élément "locale" contient toutes les informations pour un pays et/ou langue désignée.
L’élément "locale" contient un ou plusieurs mêmes éléments "ilk", e.g.,

<ximf:locale lang="fr-FR" >
<ximf:ilk entity="a"/>
<ximf:ilk entity="b"/>
</ximf:locale>

* Détails sur les attributs de la balise "locale" :
** L’attribut "lang" définit le code pays de ce conteneur. Il devrai être construit selon le format défini par la RFC1766 (fr, en, ja, es, …).

==== Element ilk ====
L’élément "ilk" contient une unique information correspondant à une donnée traduite selon le code pays de l’élément père. Cette information est au format chaîne de caractère. Un attribut obligatoire précise la balise "ilk".

<ximf:ilk entity="ilk-lang-ihm">langue</ximf:ilk>

* Détails sur les attributs de la balise "ilk" :
** L’attribut "entity" définit la référence d’entrée pour récupérer le contenu de l’élément selon le code pays souhaité.

Finalement, le fichier "dictionary" pourra contenir :
<ximf:instance name="Whirlpool">
<ximf:dictionary>
<ximf:locale lang="fr-FR" >
<ximf:ilk entity="ilk-lang-ihm">Français</ximf:ilk>
<ximf:ilk entity="ilk-exemple-general">Général</ximf:ilk>
</ximf:locale>
<ximf:locale lang="en-US" >
<ximf:ilk entity="ilk-lang-ihm">English (US)</ximf:ilk>
<ximf:ilk entity="ilk-exemple-general">General</ximf:ilk>
</ximf:locale>
</ximf:dictionary>
</ximf:instance>

=== Fichier ihm ===
<span style="color:red;">'''TODO''' : La documentation originale ne décrit pas le fichier ihm, les informations ci-dessous ont seulement été présumées. Merci de les vérifier/compléter.
</span>

Le fichier ihm spécifie l'agencement de l'interface des formulaires XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient un élément "ximf:ihm".

==== Element ihm ====
L'élément "ihm" contient un ou plusieurs éléments "panel" et un élément "treeRcv".

==== Element panel ====
Un élément ximf:panel correspond à un onglet du formulaire XIMF construit.
Deux attributs précisent la balise "panel" : "id" et "ilk", eg.
<ximf:panel id="pane_security" ilk="ilk-priority-panel" />

* Détails sur les attributs de l'élément "panel" :
** L’attribut "id" définit le nom de l'onglet, il doit être unique pour chaque élément "ximf:panel" et est formaté selon la syntaxe "pane-xxx". Cet attribut est obligatoire.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.

L'élément "ximf:panel" contient au moins un éléments "ximf:groupbox".

==== Element groupbox ====
Un élément groupbox correspond à une sous catégorie d'un onglet du formulaire XIMF.
La structure "groupbox" détaille l’ordre d’affichage des entêtes dans un message.
Deux attributs précisent la balise "ximf:groupbox" : "id" et "ilk", eg.
<ximf:groupbox id="group-classification" ilk="ilk-secu-box" />

* Détails sur les attributs de l'élément "groupbox" :
** L’attribut "id" définit le nom de l'onglet, il doit être unique pour chaque élément "ximf:panel" et est formaté selon la syntaxe "pane-xxx". Cet attribut est obligatoire.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.

L'élément "groupbox" contient au moins un éléments "headerRef".

==== Element treeRcv ====
L'élément "treeRcv" permet de spécifier quelles sont les colonnes susceptibles d'être ajoutées dans le panneau principal du client de messagerie qui contient la liste des messages d’un dossier.

L'élément "treeRcv" peut contenir des éléments "headerRef".

==== Element headerRef ====
L'élément headerRef spécifie les champs associés à chaque sous-groupe d'onglet de formulaire ou les champs qu'il est possible d'afficher dans la liste des messages.
Aucun attribut ne vient compléter la balise "headerRef", eg.
<ximf:headerRef>header-classification</ximf:headerRef>

Finalement, le fichier "ihm" pourra contenir :
<pre>
<ximf:instance name="Amoco">
<ximf:ihm>
<ximf:panel id="pane_security" ilk="ilk-priority-panel">
<ximf:groupbox id="group-classification" ilk="ilk-secu-box">
<ximf:headerRef>header-correspondance-type</ximf:headerRef>
<ximf:headerRef>header-classification</ximf:headerRef>
</ximf:groupbox>
</ximf:panel>
<ximf:treeRcv>
<ximf:headerRef>header-classification</ximf:headerRef>
</ximf:treeRcv>
</ximf:ihm>
</ximf:instance>
</pre>

=== Fichier headers ===
Le fichier headers spécifie les types des champs de l'interface des formulaires XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient des éléments "header".

<div style="color:red">'''TODO :'''
Il semble que les fichiers headers définissent des entêtes devant être envoyées alors que ces mêmes entêtes ne sont pas spécifiés dans le fichier ihm. Ce comportement est logique, en effet, l'utilisateur n'a pas forcément besoin de savoir tout ce qui est envoyé via le formulaire. Cependant, comment le moteur XIMF sait quels entêtes doivent être envoyés ?
</div>

==== Element header ====
Chaque élément "header" décrit un entête de message de format XIMF.
Huit attributs précisent la balise "header" : "headerName", "id", "technicalHeaderName", "type", "technicalType", "isMandatory", "ilk", "description", e.g.,

<div style="color:red;">'''TODO :'''
Comment est effectuée la vérification de l'attribut isMandatory et quelles sont les conditions de fonctionnement de celui-ci ? Est-il possible, par exemple, de spécifier l'attribut isMandatory=true d'un élément header si le contenu de celui-ci est un élément « set » qui dispose des attributs minItem et maxItem ?Actuellement, lorsque l'on crée un élément set avec les attributs minItem et maxItem, le champ du formulaire associé ne peux pas être validé (Est-ce un bug ?) : e.g.,
<ximf:set id="value-amoco-classification" minItem="1" maxItem="64" separator=";" technicalSeparator=".">
</div>

<ximf:header id="header-primary-precedence"
headerName="X-XIMF-Primary-Precedence"
ilk="ilk-primary-precedence"
isMandatory="true"
description="entête d’urgence"
type="string" />

* Détails sur les attributs de l'élément "header" :
** L’attribut "headerName" définit le nom du champ XIMF. Cet attribut est obligatoire.
** L’attribut "id" définit un identifiant de champ, il doit être unique pour chaque élément "header" et est formaté selon la syntaxe "header-xxx". Cet attribut est obligatoire.
** L’attribut "isMandatory" précise si ce champ doit être obligatoirement présent dans le message intégrant les entêtes selon cette description.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.
** L’attribut "type" précise le format des données associées à cet élément. Ce format peut être une date, une chaîne, une adresse mail, un O.I.D.
** L’attribut "technicalHeaderName" permet de compléter l’entête décrit par un autre entête.
** L’attribut "technicalType" précise le format des données associées à l’élément technicalHeaderName.
** L’attribut "description" permet d’ajouter une information sur cet élément.

L’élément "header" contient obligatoirement un élément "set", "multiset", "string", ou "compstring", e.g.,

<ximf:header id="header-reply-by"
headerName="X-XIMF-Reply-By"
ilk="ilk-reply-by"
isMandatory="false" >
<ximf:string id="value-reply-by" editable="true" />
</ximf:header>

<div style="color:red;">
'''TODO :''' Quelles sont les contraintes associées à l'attribut type d'un élément header ?
</div>

==== Element string ====
L’élément "string" précise le contenu d’une ressource de type chaîne de caractères imprimables (a-z, A-Z, 1-9,…)
Quinze attributs complètent l’élément "string" : "id", "ref", "ilk", "aclLevel", "index", "description", "editable", "content", "technicalContent","maxItem", "minItem", "maxLength", "minLength", "separator", "technicalSeparator", e.g.,

<ximf:string ilk="ilk-france" content="FRA" />

* Détails sur les attributs de l'élément "string" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "string".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role| élément role]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut " description " permet d’associer un commentaire sur cette donnée.
** L’attribut "editable" définit une valeur de saisie (champ libre). Cet attribut est de type booléen.
** L’attribut "content" représente la valeur effective de la donnée. C’est cette donnée qui sera associée au champ XIMF créé.
** L’attribut "technicalContent" représente la valeur effective de la donnée technique. C’est cette donnée qui sera associée au champ technique XIMF créé (cf. attribut technicalHeaderName de l’élément "header".
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.

L’élément "string" peut contenir plusieurs éléments "linkedValue".

<ximf:string ilk="ilk-non-protege" content="NON PROTEGE" technicalContent="1" >
<ximf:linkedValue ref="value-non-protege-france " />
</ximf:string>

==== Element compstring ====
<div style="color:red;">
'''TODO :''' L'attribut de l'élément « compstring » nommé « contentFactorise » devrait s'appeler « contentFactorize ».
</div>
L’élément "compstring" décrit un conteneur de concaténation des éléments fils. Il permet notamment de créer des valeurs d’entêtes composées.
Dix-sept attributs complètent l’élément "compstring" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", "content", "technicalContent", "contentPositionEnd", "contentFactorise", "technicalPositionEnd", e.g.,

<ximf:compstring
ilk="ilk-special"
content="SPECIAL"
technicalContent="1.3.4"
separator=" "
technicalSeparator=".">

* Détails sur les attributs de l'élément "compstring" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "compstring".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (cf. [[#Element_role| élément "role"]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut " description " permet d’associer un commentaire sur cette donnée.
** L’attribut "content" représente la valeur effective de la donnée. C’est cette donnée qui sera associée au champ XIMF créé.
** L’attribut "technicalContent" représente la valeur effective de la donnée technique. C’est cette donnée qui sera associée au champ technique XIMF créé (cf. attribut technicalHeaderName de l’élément "header".
** L’attribut "separator" définit le caractère de séparation entre deux valeurs.
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "contentPositionEnd" impose de positionner le contenu de l’élément "compstring" après les valeurs des éléments fils : valuefils1,valuefils2 : valuecompstring.
** L’attribut "technicalPositionEnd" impose de positionner le contenu de l’élément "compstring" après les valeurs des éléments fils.
** L’attribut "contentFactorise" impose d’utiliser le contenu de l’élément "compstring" comme facteur des éléments fils : valuecompstring(valuefils1,valuefils2).

L’élément "compstring" peut contenir un élément "string" ou "set" ou "multiset" ou plusieurs éléments "compstring".

<ximf:compstring
ilk="ilk-special"
content="SPECIAL"
technicalContent="1.3.4"
separator=" "
technicalSeparator=".">
<ximf:set id="ilk-special-op " maxItem="64">
<ximf:string ilk="ilk-special-op1" content="OP1" technicalContent="1" />
<ximf:string ilk="ilk-special-op2" content="OP2" technicalContent="2" />
<ximf:string ilk="ilk-special-op3" content="OP3" technicalContent="3" />
</ximf:set>
</ximf:compstring>

==== Element set ====
L’élément "set" décrit un conteneur de ressources de même type. Cet élément autorise la sélection de plusieurs ressources mais chaque ressource est sélectionnée une seule fois.
Douze attributs précisent la description de la balise "set" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", e.g.,

<ximf:set id="value-categories" ref="value-mentions" maxItem="64" separator=";" />

* Détails sur les attributs de l'élément "set" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "ximf:set".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role|élément rôle]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut "description" permet d’associer un commentaire sur cette donnée.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs

L’élément "set" peut contenir un ou plusieurs éléments "string" ou un ou plusieurs éléments "compstring".

<ximf:set id="value-categories" minItem="1" maxItem="64" separator=";">
<ximf:string ilk="ilk-releasable-to" content="RELEASABLE TO " />
<ximf:string ilk="ilk-eyes-only" content=" EYES ONLY"/>
<ximf:string ilk="ilk-use-only" content=" USE ONLY"/>
</ximf:set>

<div style="color:red;">'''TODO :'''
* Y a-t-il une définition des fichiers associés aux instances XIMF (e.g, le fichier attribution-list.xml utilisé dans l'instance Caterpillar) ?
* Comment le moteur XIMF sait qu'un élément est une "attribution-list" ?
</div>

==== Element multiset ====
L’élément "multiset" décrit un conteneur de ressources de même type. Cet élément autorise la sélection de plusieurs ressources et chaque ressource peut être sélectionnée plusieurs fois.
Douze attributs précisent la description de la balise "multiset" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", e.g.,

<ximf:multiset
id="value-restricted"
ilk=" value-restricted-otan"
maxItem="64"
separator=";" />

* Détails sur les attributs de l'élément "multiset" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "multiset".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role|élément rôle]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut "description" permet d’associer un commentaire sur cette donnée.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs

L’élément "multiset" peut contenir un ou plusieurs éléments "string" ou un ou plusieurs éléments "compstring".

<ximf:multiset id="value-restricted-otan-categories" minItem="1" maxItem="64" separator=";" >
<ximf:string ilk="ilk-releasable-to" content="RELEASABLE TO "/>
<ximf:string ilk="ilk-eyes-only" content=" EYES ONLY"/>
<ximf:string ilk="ilk-use-only" content=" USE ONLY"/>
</ximf:multiset>

<span style="color:red;">'''TODO ''': Comment sont gérées les règles associées aux champs multivaleurs (disposant par exemple des attributs minItem/maxItem ou les champs multiset) ?</span>

==== Element linkedValue ====
L’élément "linkedValue" définit une référence sur une ressource de type conteneur ("set", "multiset") ou "string". Cette ressource devrait être utilisée si la ressource contenant "linkedValue" (noeud parent) est sélectionnée.
Un attribut précise la balise "linkvalue" : "ref", e.g.,

<ximf:linkedValue ref="value-restricted-otan-classification-id" />

* Détails sur les attributs de l'élément "linkedValue" :
** L’attribut "ref" précise la valeur de l’attribut "id" de la ressource cible. Cet attribut est obligatoire.

=== Fichier rules ===
Le fichier rules définit les règles de contrôles d’entêtes XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui peut contenir des éléments "ximf:rule".

==== Element rule ====
<div style="color:red">
'''TODO :''' Mettre à jour la documentation :
* Les éléments autorisés dans un élément « rule » ne sont plus à jour. La présente documentation spécifie 12 éléments : AliasHeader, AliasValue, Compatibility, Association, SecureHeaders, SecurityLabel, Constraint, Assignment, Processing, Accessibility, Role et Custom. Le schéma XML fourni avec le mail en spécifie 5 : Constraint, Processing, Compatibility, Policy et Custom et place les autres en tant qu'extentions des 5 éléments cités précédemment.
* Les éléments SecureHeaders et SecurityLabel associés à l'élément « rule » dans la version ci-dessus ne figurent plus dans la nouvelle version. On les retrouve dans les fichiers rules-*.xml mais les éléments sont commentés. En revanche, ils sont bien présents dans une autre instance : s'agit-il d'une fonctionnalité non-documentée ou plus documentée ?
* L'élément ximf:classificationPictures n'est pas documenté. De plus, il serait bon d'avoir des précisions sur la raison qui a motivé l'ajout de cet élément dans les fichiers de règles (alors qu'il semblerait être plus adapté au fichier headers-*.xml).
</div>
L’élément "rule" est le conteneur principal de description d’un comportement particulier à appliquer sur un ensemble d’entêtes XIMF.
Trois attributs précisent la balise "rule" : "id", "agent", "description", e.g.,
<ximf:rule id="compatibility-rule" description="Règle sur la compatibilité X-SMTP / XIMF" >

* Détails sur les attributs de l'élément "rule" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "rule". Cet attribut est obligatoire.
** L’attribut "agent" indique l’équipement cible devant analyser et appliquer le contenu de cet élément.
** L’attribut "description" autorise l’auteur d’ajouter un commentaire sur cet élément.

L’élément "rule" contient un ou plusieurs mêmes éléments de spécialisation de la règle "contraint", "assignement", "processing", "compatibility", "accessibility", "custom",…, e.g.,

<ximf:rule id="precedence-rule" agent="mua" description="Règle sur les priorités">
<ximf:constraint
left="header-primary-precedence"
operator="equalOrGreaterThan"
right="header-copy-precedence" />
</ximf:rule>

==== Element aliasHeader ====
L’élément "aliasHeader" permet de définir le nom de l’entête sur lequel la règle précisée est appliquée
Deux attributs précisent la balise "aliasHeader" : "headerName" et "headerRef", e.g.,

<ximf:aliasHeader headerName ="X-P772-Version" headerRef="X-XIMF-VERSION" />

* Détails sur les attributs de l'élément "aliasHeader" :
* L’attribut "headerName" définit le nom XIMF de l’entête modifié par la règle. Cet attribut est obligatoire.
* L’attribut "headerRef" définit le nom d’un entête XIMF de référence qui est le point d’entrée de l’application de la règle sur l’entête définit par "headerName". Cela permet de lier deux entêtes de messages où l’utilisation de l’un des entêtes influe sur le comportement de l’autre.

L’élément "aliasHeader" peut contenir des éléments "aliasValue",e.g ,

<ximf:aliasHeader headerName="X-P772-Version" />
<ximf:aliasValue vame="1.0"/>
<ximf:aliasHeader>

==== Element aliasValue ====
L’élément "aliasValue" contient une valeur à associer à l’entête XIMF contrôlé par la règle. Il est utile lorsque deux entêtes sont liées (utilisation de l’attribut headerRef dans l’élément aliasHeader) et que les valeurs de l’entêtes de référence permettent de préciser celles de l’entête contrôlé.
Deux attributs précisent la balise "aliasValue" : "valueName", "valueRef", e.g.,

<ximf:aliasValue valueName="2" valueRef ="flash" />

* Détails sur les attributs de l'élément "aliasValue" :
** L’attribut "valueName" définit la valeur de l’entête à créer. Cet attribut est obligatoire.
** L’attribut "valueRef" définit la valeur de l’entête XIMF de référence pour utiliser valueName.
<span style="color:red;">'''TODO :''' L'attribut valueRef est-il obligatoire ?</span>

==== Element compatibility ====
L’élément "compatibility" est utilisé pour associer à un entête respectant la norme XIMF un entête respectant une autre norme que XIMF (XSMTP par exemple).
Deux attributs précisent la balise "compatibility" : "targetName", "targetVersion", e.g.,

<ximf:compatibility targetName="X-SMTP" targetVersion="1.1">
<ximf:aliasValue headerName="X-P772-Version" content="1.1" />
<ximf:aliasValue
headerName="X-P772-Primary-Precedence"
headerRef="header-primary-precedence"
dataRef="data-priority-xsmtp"/>
</ximf:compatibility>

* Détails sur les attributs de l'élément "compatibility" :
** L’attribut "targetName" définit la norme de l’entête à associer à l’entête XIMF. Cet attribut est obligatoire.
** L’attribut "targetVersion" définit le numéro de version de la norme de l’entête à associer à l’entête XIMF. Cet attribut est obligatoire.

L’élément "compatibility" contient au moins un élément "aliasHeader".

<u>Pour illustrer cette règle :</u>
Le format XSMTP est déjà supporté par certains équipements. Afin de rendre ceux-ci inter opérables avec le nouveau format XIMF, cette règle permet d’associer un entête XSMTP contenant les mêmes informations qu’un entête XIMF.

L’élément Association : dépendance entre entêtes
L’élément "association" définie les valeurs autorisées pour un entête XIMF en fonction d’une valeur définie pour un autre entête XIMF.

<ximf:association>
<ximf:aliasHeader
headerName="X-XIMF-Primary-Precedence"
headerRef="X-XIMF-Correspondence-Type">
<ximf:aliasValue valueName="routine" valueRef="private" />
<ximf:aliasValue valueName="routine,priority" valueRef="professional" />
<ximf:aliasValue valueName="routine,priority,immediate,flash" valueRef="operational" />
<ximf:aliasValue valueName="routine,priority,immediate" valueRef="official" />
</ximf:aliasHeader>
</ximf:association>

==== Element secureHeaders ====
<div style="color:red;">'''TODO :''' Les éléments SecureHeaders et SecurityLabel associés à l'élément « rule » dans la version ci-dessus ne figurent plus dans le shéma xml. On les retrouve dans les fichiers rules-*.xml mais les éléments sont commentés. En revanche, ils sont bien présents dans une autre instance : s'agit-il d'une fonctionnalité non-documentée ou plus documentée ?</div>
L’élément "secureHeaders" définie la liste des entêtes à intégrer dans la signature d’un message. Cette règle s’applique sur les équipements proposant un algorithme de signature des messages.

Un élément "secureHeaders" contient un ou plusieurs éléments "aliasHeaders" où chaque élément décrit un entête à intégrer dans la signature et complété d’un attribut "status".

<ximf:secureHeaders targetName="SecureHeaders">
<ximf:aliasHeader headerName="X-XIMF-Primary-Precedence" status="0" />
<ximf:aliasHeader headerName="X-XIMF-Copy-Precedence" status="0" />
</ximf:secureHeaders>

==== Element securityLabel ====
L’élément "securityLabel" définie la liste des entêtes à intégrer dans la signature d’un message. Cette règle s’applique sur les équipements proposant un algorithme de signature des messages selon la norme RFC.

Un élément "securityLabel" contient un ou plusieurs éléments "aliasHeaders" où chaque élément décrit un entête à intégrer dans la signature et complété d’un attribut "status".

<ximf:securityLabel targetName="SecurityLabel" id="Amoco">
<ximf:aliasHeader
headerName="SecurityPolicyIdentifier"
headerRef="X-XIMF-Security-Policy-Identifier" />
<ximf:aliasHeader
headerName="SecurityClassification"
headerRef="X-XIMF-Security-Classification-Identifier" />
<ximf:aliasHeader
headerName="ESSPrivacyMark"
headerRef="X-XIMF-Privacy-Mark" />
<ximf:aliasHeader
headerName="SecurityCategory"
headerRef="X-XIMF-Security-Categories-Identifier"
type="2" />
</ximf:securityLabel>

==== Element constraint ====
L’élément "constraint" est utilisé pour définir une règle de construction de deux entêtes partageant des "datas" identiques.
Trois attributs précisent la balise "constraint" : "left", "right", "operator", e.g.,

<ximf:constraint
left="header-primary-precedence"
operator="equalOrGreaterThan"
right="header-copy-precedence" />

* Détails sur les attributs de l'élément "constraint" :
** L’attribut "left" désigne le premier élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "right" désigne le deuxième élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "operator" indique la règle de poids à appliquer sur la valeur des deux éléments "header", il peut être de type "greaterThan", "lowerThan", "equalOrGreaterThan", "equalOrLowerThan", "equal". Cet attribut est obligatoire.

* Détails sur les valeurs possibles de l'attribut "type" :
** Le type "greaterThan" signifie que la valeur de l’élément "left" doit être strictement supérieur à la valeur de l’élément "right".
** Le type "lowerThan" signifie que la valeur de l’élément "left" doit être strictement inférieur à la valeur de l’élément "right".
** Le type "equalOrGreaterThan" signifie que la valeur de l’élément "left" doit être supérieur ou égale à la valeur de l’élément "right".
** Le type "equalOrLowerThan" signifie que la valeur de l’élément "left" doit être inférieur ou égale à la valeur de l’élément "right".
** Le type "equal" signifie que la valeur de l’élément "left" et de l’élément "right" doivent être identiques.

==== Element assignment ====
<div style="color:red;">'''TODO :''' L'élément assignment n'apparaît pas dans le shéma xml qui avait été envoyé.</div>

L’élément "assignement" est utilisé pour affecter une valeur créée en fonction d’une règle de comparaison sur les valeurs de deux éléments "header".
Quatre attributs précisent la balise "assignement" : "left", "right", "operator", "result", e.g.,

<ximf:assignment
left="header-primary-precedence"
operator="equal"
right="data-routine-precedence"
result="86400" />

* Détails sur les attributs de l'élément "assignment" :
** L’attribut "left" désigne le premier élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "right" désigne le deuxième élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "operator" indique la règle de comparaison entre les valeurs des deux éléments "header", il peut être de type "greaterThan", "lowerThan", "equalOrGreaterThan", "equalOrLowerThan", "equal". Cet attribut est obligatoire.
** L’attribut "result" représente la valeur à utiliser si la règle de comparaison entre les deux éléments est satisfaite. Cet attribut est obligatoire.

==== Element processing ====
L’élément "processing" regroupe des règles de traitement à effectuer sur des entêtes formatés.
L’attribut "type" précise le type de traitement à effectuer sur ces valeurs. Cet attribut est obligatoire, il est de type : "sign-header-value", "encrypt-header-value", "capitalize-header-value", e.g.,

<ximf:processing type="sign-header-value">
<ximf:refHeader>header-primary-precedence</ximf:refheader>
<ximf:refHeader>header-copy-precedence</ximf:refheader>
<ximf:refHeader>header-echange-type</ximf:refheader>
</ximf:processing>

* Détails sur les valeurs possibles de l'attribut "type" :
** Le type "sign-header-value" définit un traitement de signature des entêtes définis dans la balise.
** Le type "encrypt-header-value" définit un traitement de chiffrement des entêtes définis dans la balise.
** Le type "capitalize-header-value" définit un traitement de capitalisation des entêtes définis dans la balise.

L’élément "processing" contient au moins un élément "refHeader".
<div style="color:red;">'''TODO :'''L'élément refHeader n'est pas documenté, s'agit-il en fait de l'élément headerRef ?</div>

==== Element accessibility ====
<div style="color:red;">'''TODO :''' L'élément accessibility n'apparaît pas dans le shéma xml qui avait été envoyé.</div>
L’élément "accessibility" définit un ensemble de règles de droit d’accès aux éléments d’une instance pour une cible déterminée (utilisateur, routeur…).
Cet élément contient un ou plusieurs éléments "role".

<ximf:accessibility>
<ximf:role id="role-flash-allowed" aclLevel="100" />
<ximf:role id="role-flash-prohibited" aclLevel="50" />
</ximf:accessibility>

==== Element role ====
L’élément "role" positionne une valeur d’accès à pour une entité définit.
Deux attributs complètent l’élément "role" : "id", "aclLevel", e.g.,

<ximf:role id="role-flash-allowed" aclLevel="100" />

* Détails sur les attributs de l'élément "role" :
** L’attribut "id" précise l’entité accessible en fonction d’une valeur déterminée.
** L’attribut "aclLevel" précise la valeur seuil d’accès à l’entité.

==== Element custom ====
L’élément "custom" permet à l’auteur de créer des nouvelles règles personnalisées.
Trois attributs précisent la balise "custom" : "id", "provider", "description", e.g.,

<ximf:custom
id="custom-display"
provider="EADS"
description="Affichage de la composition du message" >
<node1><node2><node3></node3></node2></node1>
</ximf:custom>

* Détails sur les attributs de l'élément "custom" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "custom" et formaté selon la syntaxe "custom-xxx". Cet attribut est obligatoire.
** L’attribut "provider" identifie l’auteur de la règle. Cet attribut est obligatoire.
** L’attribut "description" permet d’ajouter un commentaire sur cet élément.

L’élément "custom" peut contenir tous les éléments possibles en respectant les standards XML.

XIMF XML tags/fr

2011-03-02T07:07:40Z

Anthonyjuge : /* Element header */

== Introduction ==
Ce document propose un modèle de description, via eXtensible Markup Language (XML), d’entêtes de messages électroniques respectant la norme XIMF. Ce document a deux objectifs :
# Décrire les éléments et attributs de représentation XML pour construire des entêtes de messages électroniques de format XIMF.
# Fournir un modèle de représentation XIMF/XML.

<u>Rappel :</u>
* Un "élément" fait référence à tous les caractères situés entre une balise de départ et un balise de fin, e.g.,
<exemple> texte et/ou éléments fils </exemple>
* Un "attribut" est une composante d’un élément. Il est positionné dans la balise de départ, e.g.,
<exemple nom='value'>

Tous les éléments décrits dans cette documentation paragraphe sont validés dans l’espace de nom "ximf".

<pre>
xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://eads.org/ximf/ximf.xsd"
</pre>

== Description détaillée des balises XML ==

Voici, par ordre d'apparition et en fonction des fichiers, les balises génériques associées aux différents fichiers XML.

=== Fichier ximfmail-profile ===

<div style="color:red;">'''TODO''' :
* Combien d'éléments ihm sont autorisés dans un élément instance ?
* La documentation des fichiers ximfmail-profile.xml n'est pas disponible. Est-il possible d'avoir accès au fichier ximf_profile.xsd mentionné dans les ximfmail-profile.xml ?
</div>

Un fichier xpi peut contenir plusieurs instances XIMF, celles-ci sont alors regroupées dans une même catégorie. Le fichier ximfmail-profile contient des informations sur toutes les instances contenues dans le xpi, notamment leur nom, leur chemin d'accès, ainsi que les noms des fichiers associés à chaque instance.

==== Element instance ====
L’élément "instance" identifie l’ensemble des entêtes à décrire selon la norme XIMF. C’est le conteneur principal d’une instance XIMF/XML. Cinq attributs précisent la balise "instance" : "ximfVersion", "version", "author", "creation", "name", e.g.,
<ximf:instance name="myInstance" version="1.0" ximfVersion="2.0" >

* Détails sur les attributs de l'élément "instance" :
** L’attribut "name" définit le nom de l’instance décrite. Cet attribut est obligatoire.
** L’attribut "ximfVersion" définit le numéro de version des entêtes XIMF utilisés pour cette représentation. Cet attribut est obligatoire.
** L’attribut "version" définit le numéro de version de l’instance décrite. Cet attribut est obligatoire.
** L’attribut "author" renseigne sur le nom de l’auteur de cette instance.
** L’attribut "creationDate" précise la date de création de cette instance.

L’élément "instance" peut contenir un ou plusieurs éléments "schema", un ou plusieurs éléments "rule", un élément "ihm" et un élément "dictionary".

==== Element dictionary ====
L'élément dictionary contient le chemin vers le fichier spécifiant les données d'internationalisation (Cf. [[#Fichier_dictionary|Fichier dictionary]]).

==== Element schema ====
L'élément shema contient le chemin vers le fichier spécifiant les entêtes XIMF (Cf. [[#Fichier_headers|Fichier headers]]).

==== Element ihm ====
L'élément ihm contient le chemin vers le fichier spécifiant la disposition de l'interface des formulaires XIMF (Cf. [[#Fichier_ihm|Fichier ihm]]).

==== Element rule ====
L'élément rule contient le chemin vers le fichier spécifiant les règles associées aux valeurs des champs XIMF (Cf. [[#Fichier_rules|Fichier rules]]).

=== Fichier dictionary ===
Le fichier dictionnary permet de mettre en œuvre l’internationalisation d’une instance XIMF. Il défini des dictionnaires qui servent à traduire les éléments de l'instance XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient un élément "ximf:dictionnary".

==== Element dictionary ====
<div style="color:red;">'''TODO''' :
* Quel est l'intérêt de renseigner un attribut "id" à l'élément "dictionary" (étant donné qu'un seul élément "dictionary est autorisé dans l'élément "instance") ?</div>

L’élément "dictionary" contient toutes les informations devant être interprétées selon le pays d’utilisation.
L’élément "dictionary" contient un ou plusieurs mêmes éléments "locale", e.g.,

<ximf:dictionary>
<ximf:locale lang="fr-FR" />
<ximf:locale lang="en-US" />
</ximf:dictionary>

==== Element locale ====
L’élément "locale" contient toutes les informations pour un pays et/ou langue désignée.
L’élément "locale" contient un ou plusieurs mêmes éléments "ilk", e.g.,

<ximf:locale lang="fr-FR" >
<ximf:ilk entity="a"/>
<ximf:ilk entity="b"/>
</ximf:locale>

* Détails sur les attributs de la balise "locale" :
** L’attribut "lang" définit le code pays de ce conteneur. Il devrai être construit selon le format défini par la RFC1766 (fr, en, ja, es, …).

==== Element ilk ====
L’élément "ilk" contient une unique information correspondant à une donnée traduite selon le code pays de l’élément père. Cette information est au format chaîne de caractère. Un attribut obligatoire précise la balise "ilk".

<ximf:ilk entity="ilk-lang-ihm">langue</ximf:ilk>

* Détails sur les attributs de la balise "ilk" :
** L’attribut "entity" définit la référence d’entrée pour récupérer le contenu de l’élément selon le code pays souhaité.

Finalement, le fichier "dictionary" pourra contenir :
<ximf:instance name="Whirlpool">
<ximf:dictionary>
<ximf:locale lang="fr-FR" >
<ximf:ilk entity="ilk-lang-ihm">Français</ximf:ilk>
<ximf:ilk entity="ilk-exemple-general">Général</ximf:ilk>
</ximf:locale>
<ximf:locale lang="en-US" >
<ximf:ilk entity="ilk-lang-ihm">English (US)</ximf:ilk>
<ximf:ilk entity="ilk-exemple-general">General</ximf:ilk>
</ximf:locale>
</ximf:dictionary>
</ximf:instance>

=== Fichier ihm ===
<span style="color:red;">'''TODO''' : La documentation originale ne décrit pas le fichier ihm, les informations ci-dessous ont seulement été présumées. Merci de les vérifier/compléter.
</span>

Le fichier ihm spécifie l'agencement de l'interface des formulaires XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient un élément "ximf:ihm".

==== Element ihm ====
L'élément "ihm" contient un ou plusieurs éléments "panel" et un élément "treeRcv".

==== Element panel ====
Un élément ximf:panel correspond à un onglet du formulaire XIMF construit.
Deux attributs précisent la balise "panel" : "id" et "ilk", eg.
<ximf:panel id="pane_security" ilk="ilk-priority-panel" />

* Détails sur les attributs de l'élément "panel" :
** L’attribut "id" définit le nom de l'onglet, il doit être unique pour chaque élément "ximf:panel" et est formaté selon la syntaxe "pane-xxx". Cet attribut est obligatoire.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.

L'élément "ximf:panel" contient au moins un éléments "ximf:groupbox".

==== Element groupbox ====
Un élément groupbox correspond à une sous catégorie d'un onglet du formulaire XIMF.
La structure "groupbox" détaille l’ordre d’affichage des entêtes dans un message.
Deux attributs précisent la balise "ximf:groupbox" : "id" et "ilk", eg.
<ximf:groupbox id="group-classification" ilk="ilk-secu-box" />

* Détails sur les attributs de l'élément "groupbox" :
** L’attribut "id" définit le nom de l'onglet, il doit être unique pour chaque élément "ximf:panel" et est formaté selon la syntaxe "pane-xxx". Cet attribut est obligatoire.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.

L'élément "groupbox" contient au moins un éléments "headerRef".

==== Element treeRcv ====
L'élément "treeRcv" permet de spécifier quelles sont les colonnes susceptibles d'être ajoutées dans le panneau principal du client de messagerie qui contient la liste des messages d’un dossier.

L'élément "treeRcv" peut contenir des éléments "headerRef".

==== Element headerRef ====
L'élément headerRef spécifie les champs associés à chaque sous-groupe d'onglet de formulaire ou les champs qu'il est possible d'afficher dans la liste des messages.
Aucun attribut ne vient compléter la balise "headerRef", eg.
<ximf:headerRef>header-classification</ximf:headerRef>

Finalement, le fichier "ihm" pourra contenir :
<pre>
<ximf:instance name="Amoco">
<ximf:ihm>
<ximf:panel id="pane_security" ilk="ilk-priority-panel">
<ximf:groupbox id="group-classification" ilk="ilk-secu-box">
<ximf:headerRef>header-correspondance-type</ximf:headerRef>
<ximf:headerRef>header-classification</ximf:headerRef>
</ximf:groupbox>
</ximf:panel>
<ximf:treeRcv>
<ximf:headerRef>header-classification</ximf:headerRef>
</ximf:treeRcv>
</ximf:ihm>
</ximf:instance>
</pre>

=== Fichier headers ===
Le fichier headers spécifie les types des champs de l'interface des formulaires XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient des éléments "header".

<div style="color:red">'''TODO :'''
Il semble que les fichiers headers définissent des entêtes devant être envoyées alors que ces mêmes entêtes ne sont pas spécifiés dans le fichier ihm. Ce comportement est logique (l'utilisateur n'a pas forcément besoin de savoir tout ce qui est envoyé via le formulaire. Cependant, comment est-il possible de savoir quels entêtes doivent être envoyés ?
</div>

==== Element header ====
Chaque élément "header" décrit un entête de message de format XIMF.
Huit attributs précisent la balise "header" : "headerName", "id", "technicalHeaderName", "type", "technicalType", "isMandatory", "ilk", "description", e.g.,

<div style="color:red;">'''TODO :'''
Comment est effectuée la vérification de l'attribut isMandatory et quelles sont les conditions de fonctionnement de celui-ci ? Est-il possible, par exemple, de spécifier l'attribut isMandatory=true d'un élément header si le contenu de celui-ci est un élément « set » qui dispose des attributs minItem et maxItem ?Actuellement, lorsque l'on crée un élément set avec les attributs minItem et maxItem, le champ du formulaire associé ne peux pas être validé (Est-ce un bug ?) : e.g.,
<ximf:set id="value-amoco-classification" minItem="1" maxItem="64" separator=";" technicalSeparator=".">
</div>

<ximf:header id="header-primary-precedence"
headerName="X-XIMF-Primary-Precedence"
ilk="ilk-primary-precedence"
isMandatory="true"
description="entête d’urgence"
type="string" />

* Détails sur les attributs de l'élément "header" :
** L’attribut "headerName" définit le nom du champ XIMF. Cet attribut est obligatoire.
** L’attribut "id" définit un identifiant de champ, il doit être unique pour chaque élément "header" et est formaté selon la syntaxe "header-xxx". Cet attribut est obligatoire.
** L’attribut "isMandatory" précise si ce champ doit être obligatoirement présent dans le message intégrant les entêtes selon cette description.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.
** L’attribut "type" précise le format des données associées à cet élément. Ce format peut être une date, une chaîne, une adresse mail, un O.I.D.
** L’attribut "technicalHeaderName" permet de compléter l’entête décrit par un autre entête.
** L’attribut "technicalType" précise le format des données associées à l’élément technicalHeaderName.
** L’attribut "description" permet d’ajouter une information sur cet élément.

L’élément "header" contient obligatoirement un élément "set", "multiset", "string", ou "compstring", e.g.,

<ximf:header id="header-reply-by"
headerName="X-XIMF-Reply-By"
ilk="ilk-reply-by"
isMandatory="false" >
<ximf:string id="value-reply-by" editable="true" />
</ximf:header>

<div style="color:red;">
'''TODO :''' Quelles sont les contraintes associées à l'attribut type d'un élément header ?
</div>

==== Element string ====
L’élément "string" précise le contenu d’une ressource de type chaîne de caractères imprimables (a-z, A-Z, 1-9,…)
Quinze attributs complètent l’élément "string" : "id", "ref", "ilk", "aclLevel", "index", "description", "editable", "content", "technicalContent","maxItem", "minItem", "maxLength", "minLength", "separator", "technicalSeparator", e.g.,

<ximf:string ilk="ilk-france" content="FRA" />

* Détails sur les attributs de l'élément "string" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "string".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role| élément role]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut " description " permet d’associer un commentaire sur cette donnée.
** L’attribut "editable" définit une valeur de saisie (champ libre). Cet attribut est de type booléen.
** L’attribut "content" représente la valeur effective de la donnée. C’est cette donnée qui sera associée au champ XIMF créé.
** L’attribut "technicalContent" représente la valeur effective de la donnée technique. C’est cette donnée qui sera associée au champ technique XIMF créé (cf. attribut technicalHeaderName de l’élément "header".
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.

L’élément "string" peut contenir plusieurs éléments "linkedValue".

<ximf:string ilk="ilk-non-protege" content="NON PROTEGE" technicalContent="1" >
<ximf:linkedValue ref="value-non-protege-france " />
</ximf:string>

==== Element compstring ====
<div style="color:red;">
'''TODO :''' L'attribut de l'élément « compstring » nommé « contentFactorise » devrait s'appeler « contentFactorize ».
</div>
L’élément "compstring" décrit un conteneur de concaténation des éléments fils. Il permet notamment de créer des valeurs d’entêtes composées.
Dix-sept attributs complètent l’élément "compstring" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", "content", "technicalContent", "contentPositionEnd", "contentFactorise", "technicalPositionEnd", e.g.,

<ximf:compstring
ilk="ilk-special"
content="SPECIAL"
technicalContent="1.3.4"
separator=" "
technicalSeparator=".">

* Détails sur les attributs de l'élément "compstring" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "compstring".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (cf. [[#Element_role| élément "role"]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut " description " permet d’associer un commentaire sur cette donnée.
** L’attribut "content" représente la valeur effective de la donnée. C’est cette donnée qui sera associée au champ XIMF créé.
** L’attribut "technicalContent" représente la valeur effective de la donnée technique. C’est cette donnée qui sera associée au champ technique XIMF créé (cf. attribut technicalHeaderName de l’élément "header".
** L’attribut "separator" définit le caractère de séparation entre deux valeurs.
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "contentPositionEnd" impose de positionner le contenu de l’élément "compstring" après les valeurs des éléments fils : valuefils1,valuefils2 : valuecompstring.
** L’attribut "technicalPositionEnd" impose de positionner le contenu de l’élément "compstring" après les valeurs des éléments fils.
** L’attribut "contentFactorise" impose d’utiliser le contenu de l’élément "compstring" comme facteur des éléments fils : valuecompstring(valuefils1,valuefils2).

L’élément "compstring" peut contenir un élément "string" ou "set" ou "multiset" ou plusieurs éléments "compstring".

<ximf:compstring
ilk="ilk-special"
content="SPECIAL"
technicalContent="1.3.4"
separator=" "
technicalSeparator=".">
<ximf:set id="ilk-special-op " maxItem="64">
<ximf:string ilk="ilk-special-op1" content="OP1" technicalContent="1" />
<ximf:string ilk="ilk-special-op2" content="OP2" technicalContent="2" />
<ximf:string ilk="ilk-special-op3" content="OP3" technicalContent="3" />
</ximf:set>
</ximf:compstring>

==== Element set ====
L’élément "set" décrit un conteneur de ressources de même type. Cet élément autorise la sélection de plusieurs ressources mais chaque ressource est sélectionnée une seule fois.
Douze attributs précisent la description de la balise "set" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", e.g.,

<ximf:set id="value-categories" ref="value-mentions" maxItem="64" separator=";" />

* Détails sur les attributs de l'élément "set" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "ximf:set".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role|élément rôle]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut "description" permet d’associer un commentaire sur cette donnée.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs

L’élément "set" peut contenir un ou plusieurs éléments "string" ou un ou plusieurs éléments "compstring".

<ximf:set id="value-categories" minItem="1" maxItem="64" separator=";">
<ximf:string ilk="ilk-releasable-to" content="RELEASABLE TO " />
<ximf:string ilk="ilk-eyes-only" content=" EYES ONLY"/>
<ximf:string ilk="ilk-use-only" content=" USE ONLY"/>
</ximf:set>

<div style="color:red;">'''TODO :'''
* Y a-t-il une définition des fichiers associés aux instances XIMF (e.g, le fichier attribution-list.xml utilisé dans l'instance Caterpillar) ?
* Comment le parseur d'instance ximf sait qu'un élément est une "attribution-list" ?
</div>

==== Element multiset ====
L’élément "multiset" décrit un conteneur de ressources de même type. Cet élément autorise la sélection de plusieurs ressources et chaque ressource peut être sélectionnée plusieurs fois.
Douze attributs précisent la description de la balise "multiset" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", e.g.,

<ximf:multiset
id="value-restricted"
ilk=" value-restricted-otan"
maxItem="64"
separator=";" />

* Détails sur les attributs de l'élément "multiset" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "multiset".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role|élément rôle]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut "description" permet d’associer un commentaire sur cette donnée.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs

L’élément "multiset" peut contenir un ou plusieurs éléments "string" ou un ou plusieurs éléments "compstring".

<ximf:multiset id="value-restricted-otan-categories" minItem="1" maxItem="64" separator=";" >
<ximf:string ilk="ilk-releasable-to" content="RELEASABLE TO "/>
<ximf:string ilk="ilk-eyes-only" content=" EYES ONLY"/>
<ximf:string ilk="ilk-use-only" content=" USE ONLY"/>
</ximf:multiset>

<span style="color:red;">'''TODO :''' Comment sont gérées les règles associées aux champs multivaleurs (disposant par exemple des attributs minItem/maxItem ou les champs multiset) ?</span>

==== Element linkedValue ====
<div style="color: red;">'''TODO ''': L'élément linkedValue indique quelle ressource utiliser lors de la sélection d'un élément particulier mais il n'indique pas où la ressource devra être utilisée.
* Est-ce que cela correspond toujours au header suivant ?
* Pourquoi avoir fait ce choix au lieu d'ajouter un attribut supplémentaire ?
</div>

L’élément "linkedValue" définit une référence sur une ressource de type conteneur ("set", "multiset") ou "string". Cette ressource devrait être utilisée si la ressource contenant "linkedValue" (noeud parent) est sélectionnée.
Un attribut précise la balise "linkvalue" : "ref", e.g.,

<ximf:linkedValue ref="value-restricted-otan-classification-id" />

* Détails sur les attributs de l'élément "linkedValue" :
** L’attribut "ref" précise la valeur de l’attribut "id" de la ressource cible. Cet attribut est obligatoire.

=== Fichier rules ===
Le fichier rules définit les règles de contrôles d’entêtes XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui peut contenir des éléments "ximf:rule".

==== Element rule ====
<div style="color:red">
'''TODO :''' Mettre à jour la documentation :
* Les éléments autorisés dans un élément « rule » ne sont plus à jour. La présente documentation spécifie 12 éléments : AliasHeader, AliasValue, Compatibility, Association, SecureHeaders, SecurityLabel, Constraint, Assignment, Processing, Accessibility, Role et Custom. Le schéma XML fourni avec le mail en spécifie 5 : Constraint, Processing, Compatibility, Policy et Custom et place les autres en tant qu'extentions des 5 éléments cités précédemment.
* Les éléments SecureHeaders et SecurityLabel associés à l'élément « rule » dans la version ci-dessus ne figurent plus dans la nouvelle version. On les retrouve dans les fichiers rules-*.xml mais les éléments sont commentés. En revanche, ils sont bien présents dans une autre instance : s'agit-il d'une fonctionnalité non-documentée ou plus documentée ?
* L'élément ximf:classificationPictures n'est pas documenté. De plus, il serait bon d'avoir des précisions sur la raison qui a motivé l'ajout de cet élément dans les fichiers de règles (alors qu'il semblerait être plus adapté au fichier headers-*.xml).
</div>
L’élément "rule" est le conteneur principal de description d’un comportement particulier à appliquer sur un ensemble d’entêtes XIMF.
Trois attributs précisent la balise "rule" : "id", "agent", "description", e.g.,
<ximf:rule id="compatibility-rule" description="Règle sur la compatibilité X-SMTP / XIMF" >

* Détails sur les attributs de l'élément "rule" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "rule". Cet attribut est obligatoire.
** L’attribut "agent" indique l’équipement cible devant analyser et appliquer le contenu de cet élément.
** L’attribut "description" autorise l’auteur d’ajouter un commentaire sur cet élément.

L’élément "rule" contient un ou plusieurs mêmes éléments de spécialisation de la règle "contraint", "assignement", "processing", "compatibility", "accessibility", "custom",…, e.g.,

<ximf:rule id="precedence-rule" agent="mua" description="Règle sur les priorités">
<ximf:constraint
left="header-primary-precedence"
operator="equalOrGreaterThan"
right="header-copy-precedence" />
</ximf:rule>

==== Element aliasHeader ====
L’élément "aliasHeader" permet de définir le nom de l’entête sur lequel la règle précisée est appliquée
Deux attributs précisent la balise "aliasHeader" : "headerName" et "headerRef", e.g.,

<ximf:aliasHeader headerName ="X-P772-Version" headerRef="X-XIMF-VERSION" />

* Détails sur les attributs de l'élément "aliasHeader" :
* L’attribut "headerName" définit le nom XIMF de l’entête modifié par la règle. Cet attribut est obligatoire.
* L’attribut "headerRef" définit le nom d’un entête XIMF de référence qui est le point d’entrée de l’application de la règle sur l’entête définit par "headerName". Cela permet de lier deux entêtes de messages où l’utilisation de l’un des entêtes influe sur le comportement de l’autre.

L’élément "aliasHeader" peut contenir des éléments "aliasValue",e.g ,

<ximf:aliasHeader headerName="X-P772-Version" />
<ximf:aliasValue vame="1.0"/>
<ximf:aliasHeader>

==== Element aliasValue ====
L’élément "aliasValue" contient une valeur à associer à l’entête XIMF contrôlé par la règle. Il est utile lorsque deux entêtes sont liées (utilisation de l’attribut headerRef dans l’élément aliasHeader) et que les valeurs de l’entêtes de référence permettent de préciser celles de l’entête contrôlé.
Deux attributs précisent la balise "aliasValue" : "valueName", "valueRef", e.g.,

<ximf:aliasValue valueName="2" valueRef ="flash" />

* Détails sur les attributs de l'élément "aliasValue" :
** L’attribut "valueName" définit la valeur de l’entête à créer. Cet attribut est obligatoire.
** L’attribut "valueRef" définit la valeur de l’entête XIMF de référence pour utiliser valueName.
<span style="color:red;">'''TODO :''' L'attribut valueRef est-il obligatoire ?</span>

==== Element compatibility ====
L’élément "compatibility" est utilisé pour associer à un entête respectant la norme XIMF un entête respectant une autre norme que XIMF (XSMTP par exemple).
Deux attributs précisent la balise "compatibility" : "targetName", "targetVersion", e.g.,

<ximf:compatibility targetName="X-SMTP" targetVersion="1.1">
<ximf:aliasValue headerName="X-P772-Version" content="1.1" />
<ximf:aliasValue
headerName="X-P772-Primary-Precedence"
headerRef="header-primary-precedence"
dataRef="data-priority-xsmtp"/>
</ximf:compatibility>

* Détails sur les attributs de l'élément "compatibility" :
** L’attribut "targetName" définit la norme de l’entête à associer à l’entête XIMF. Cet attribut est obligatoire.
** L’attribut "targetVersion" définit le numéro de version de la norme de l’entête à associer à l’entête XIMF. Cet attribut est obligatoire.

L’élément "compatibility" contient au moins un élément "aliasHeader".

<u>Pour illustrer cette règle :</u>
Le format XSMTP est déjà supporté par certains équipements. Afin de rendre ceux-ci inter opérables avec le nouveau format XIMF, cette règle permet d’associer un entête XSMTP contenant les mêmes informations qu’un entête XIMF.

L’élément Association : dépendance entre entêtes
L’élément "association" définie les valeurs autorisées pour un entête XIMF en fonction d’une valeur définie pour un autre entête XIMF.

<ximf:association>
<ximf:aliasHeader
headerName="X-XIMF-Primary-Precedence"
headerRef="X-XIMF-Correspondence-Type">
<ximf:aliasValue valueName="routine" valueRef="private" />
<ximf:aliasValue valueName="routine,priority" valueRef="professional" />
<ximf:aliasValue valueName="routine,priority,immediate,flash" valueRef="operational" />
<ximf:aliasValue valueName="routine,priority,immediate" valueRef="official" />
</ximf:aliasHeader>
</ximf:association>

==== Element secureHeaders ====
<div style="color:red;">'''TODO :''' Les éléments SecureHeaders et SecurityLabel associés à l'élément « rule » dans la version ci-dessus ne figurent plus dans le shéma xml. On les retrouve dans les fichiers rules-*.xml mais les éléments sont commentés. En revanche, ils sont bien présents dans une autre instance : s'agit-il d'une fonctionnalité non-documentée ou plus documentée ?</div>
L’élément "secureHeaders" définie la liste des entêtes à intégrer dans la signature d’un message. Cette règle s’applique sur les équipements proposant un algorithme de signature des messages.

Un élément "secureHeaders" contient un ou plusieurs éléments "aliasHeaders" où chaque élément décrit un entête à intégrer dans la signature et complété d’un attribut "status".

<ximf:secureHeaders targetName="SecureHeaders">
<ximf:aliasHeader headerName="X-XIMF-Primary-Precedence" status="0" />
<ximf:aliasHeader headerName="X-XIMF-Copy-Precedence" status="0" />
</ximf:secureHeaders>

==== Element securityLabel ====
L’élément "securityLabel" définie la liste des entêtes à intégrer dans la signature d’un message. Cette règle s’applique sur les équipements proposant un algorithme de signature des messages selon la norme RFC.

Un élément "securityLabel" contient un ou plusieurs éléments "aliasHeaders" où chaque élément décrit un entête à intégrer dans la signature et complété d’un attribut "status".

<ximf:securityLabel targetName="SecurityLabel" id="Amoco">
<ximf:aliasHeader
headerName="SecurityPolicyIdentifier"
headerRef="X-XIMF-Security-Policy-Identifier" />
<ximf:aliasHeader
headerName="SecurityClassification"
headerRef="X-XIMF-Security-Classification-Identifier" />
<ximf:aliasHeader
headerName="ESSPrivacyMark"
headerRef="X-XIMF-Privacy-Mark" />
<ximf:aliasHeader
headerName="SecurityCategory"
headerRef="X-XIMF-Security-Categories-Identifier"
type="2" />
</ximf:securityLabel>

==== Element constraint ====
L’élément "constraint" est utilisé pour définir une règle de construction de deux entêtes partageant des "datas" identiques.
Trois attributs précisent la balise "constraint" : "left", "right", "operator", e.g.,

<ximf:constraint
left="header-primary-precedence"
operator="equalOrGreaterThan"
right="header-copy-precedence" />

* Détails sur les attributs de l'élément "constraint" :
** L’attribut "left" désigne le premier élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "right" désigne le deuxième élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "operator" indique la règle de poids à appliquer sur la valeur des deux éléments "header", il peut être de type "greaterThan", "lowerThan", "equalOrGreaterThan", "equalOrLowerThan", "equal". Cet attribut est obligatoire.

* Détails sur les valeurs possibles de l'attribut "type" :
** Le type "greaterThan" signifie que la valeur de l’élément "left" doit être strictement supérieur à la valeur de l’élément "right".
** Le type "lowerThan" signifie que la valeur de l’élément "left" doit être strictement inférieur à la valeur de l’élément "right".
** Le type "equalOrGreaterThan" signifie que la valeur de l’élément "left" doit être supérieur ou égale à la valeur de l’élément "right".
** Le type "equalOrLowerThan" signifie que la valeur de l’élément "left" doit être inférieur ou égale à la valeur de l’élément "right".
** Le type "equal" signifie que la valeur de l’élément "left" et de l’élément "right" doivent être identiques.

==== Element assignment ====
<div style="color:red;">'''TODO :''' L'élément assignment n'apparaît pas dans le shéma xml qui avait été envoyé.</div>

L’élément "assignement" est utilisé pour affecter une valeur créée en fonction d’une règle de comparaison sur les valeurs de deux éléments "header".
Quatre attributs précisent la balise "assignement" : "left", "right", "operator", "result", e.g.,

<ximf:assignment
left="header-primary-precedence"
operator="equal"
right="data-routine-precedence"
result="86400" />

* Détails sur les attributs de l'élément "assignment" :
** L’attribut "left" désigne le premier élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "right" désigne le deuxième élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "operator" indique la règle de comparaison entre les valeurs des deux éléments "header", il peut être de type "greaterThan", "lowerThan", "equalOrGreaterThan", "equalOrLowerThan", "equal". Cet attribut est obligatoire.
** L’attribut "result" représente la valeur à utiliser si la règle de comparaison entre les deux éléments est satisfaite. Cet attribut est obligatoire.

==== Element processing ====
L’élément "processing" regroupe des règles de traitement à effectuer sur des entêtes formatés.
L’attribut "type" précise le type de traitement à effectuer sur ces valeurs. Cet attribut est obligatoire, il est de type : "sign-header-value", "encrypt-header-value", "capitalize-header-value", e.g.,

<ximf:processing type="sign-header-value">
<ximf:refHeader>header-primary-precedence</ximf:refheader>
<ximf:refHeader>header-copy-precedence</ximf:refheader>
<ximf:refHeader>header-echange-type</ximf:refheader>
</ximf:processing>

* Détails sur les valeurs possibles de l'attribut "type" :
** Le type "sign-header-value" définit un traitement de signature des entêtes définis dans la balise.
** Le type "encrypt-header-value" définit un traitement de chiffrement des entêtes définis dans la balise.
** Le type "capitalize-header-value" définit un traitement de capitalisation des entêtes définis dans la balise.

L’élément "processing" contient au moins un élément "refHeader".
<div style="color:red;">'''TODO :'''L'élément refHeader n'est pas documenté, s'agit-il en fait de l'élément headerRef ?</div>

==== Element accessibility ====
<div style="color:red;">'''TODO :''' L'élément accessibility n'apparaît pas dans le shéma xml qui avait été envoyé.</div>
L’élément "accessibility" définit un ensemble de règles de droit d’accès aux éléments d’une instance pour une cible déterminée (utilisateur, routeur…).
Cet élément contient un ou plusieurs éléments "role".

<ximf:accessibility>
<ximf:role id="role-flash-allowed" aclLevel="100" />
<ximf:role id="role-flash-prohibited" aclLevel="50" />
</ximf:accessibility>

==== Element role ====
L’élément "role" positionne une valeur d’accès à pour une entité définit.
Deux attributs complètent l’élément "role" : "id", "aclLevel", e.g.,

<ximf:role id="role-flash-allowed" aclLevel="100" />

* Détails sur les attributs de l'élément "role" :
** L’attribut "id" précise l’entité accessible en fonction d’une valeur déterminée.
** L’attribut "aclLevel" précise la valeur seuil d’accès à l’entité.

==== Element custom ====
L’élément "custom" permet à l’auteur de créer des nouvelles règles personnalisées.
Trois attributs précisent la balise "custom" : "id", "provider", "description", e.g.,

<ximf:custom
id="custom-display"
provider="EADS"
description="Affichage de la composition du message" >
<node1><node2><node3></node3></node2></node1>
</ximf:custom>

* Détails sur les attributs de l'élément "custom" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "custom" et formaté selon la syntaxe "custom-xxx". Cet attribut est obligatoire.
** L’attribut "provider" identifie l’auteur de la règle. Cet attribut est obligatoire.
** L’attribut "description" permet d’ajouter un commentaire sur cet élément.

L’élément "custom" peut contenir tous les éléments possibles en respectant les standards XML.

XIMF XML tags/fr

2011-03-02T07:06:08Z

Anthonyjuge : /* Element dictionary */

== Introduction ==
Ce document propose un modèle de description, via eXtensible Markup Language (XML), d’entêtes de messages électroniques respectant la norme XIMF. Ce document a deux objectifs :
# Décrire les éléments et attributs de représentation XML pour construire des entêtes de messages électroniques de format XIMF.
# Fournir un modèle de représentation XIMF/XML.

<u>Rappel :</u>
* Un "élément" fait référence à tous les caractères situés entre une balise de départ et un balise de fin, e.g.,
<exemple> texte et/ou éléments fils </exemple>
* Un "attribut" est une composante d’un élément. Il est positionné dans la balise de départ, e.g.,
<exemple nom='value'>

Tous les éléments décrits dans cette documentation paragraphe sont validés dans l’espace de nom "ximf".

<pre>
xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://eads.org/ximf/ximf.xsd"
</pre>

== Description détaillée des balises XML ==

Voici, par ordre d'apparition et en fonction des fichiers, les balises génériques associées aux différents fichiers XML.

=== Fichier ximfmail-profile ===

<div style="color:red;">'''TODO''' :
* Combien d'éléments ihm sont autorisés dans un élément instance ?
* La documentation des fichiers ximfmail-profile.xml n'est pas disponible. Est-il possible d'avoir accès au fichier ximf_profile.xsd mentionné dans les ximfmail-profile.xml ?
</div>

Un fichier xpi peut contenir plusieurs instances XIMF, celles-ci sont alors regroupées dans une même catégorie. Le fichier ximfmail-profile contient des informations sur toutes les instances contenues dans le xpi, notamment leur nom, leur chemin d'accès, ainsi que les noms des fichiers associés à chaque instance.

==== Element instance ====
L’élément "instance" identifie l’ensemble des entêtes à décrire selon la norme XIMF. C’est le conteneur principal d’une instance XIMF/XML. Cinq attributs précisent la balise "instance" : "ximfVersion", "version", "author", "creation", "name", e.g.,
<ximf:instance name="myInstance" version="1.0" ximfVersion="2.0" >

* Détails sur les attributs de l'élément "instance" :
** L’attribut "name" définit le nom de l’instance décrite. Cet attribut est obligatoire.
** L’attribut "ximfVersion" définit le numéro de version des entêtes XIMF utilisés pour cette représentation. Cet attribut est obligatoire.
** L’attribut "version" définit le numéro de version de l’instance décrite. Cet attribut est obligatoire.
** L’attribut "author" renseigne sur le nom de l’auteur de cette instance.
** L’attribut "creationDate" précise la date de création de cette instance.

L’élément "instance" peut contenir un ou plusieurs éléments "schema", un ou plusieurs éléments "rule", un élément "ihm" et un élément "dictionary".

==== Element dictionary ====
L'élément dictionary contient le chemin vers le fichier spécifiant les données d'internationalisation (Cf. [[#Fichier_dictionary|Fichier dictionary]]).

==== Element schema ====
L'élément shema contient le chemin vers le fichier spécifiant les entêtes XIMF (Cf. [[#Fichier_headers|Fichier headers]]).

==== Element ihm ====
L'élément ihm contient le chemin vers le fichier spécifiant la disposition de l'interface des formulaires XIMF (Cf. [[#Fichier_ihm|Fichier ihm]]).

==== Element rule ====
L'élément rule contient le chemin vers le fichier spécifiant les règles associées aux valeurs des champs XIMF (Cf. [[#Fichier_rules|Fichier rules]]).

=== Fichier dictionary ===
Le fichier dictionnary permet de mettre en œuvre l’internationalisation d’une instance XIMF. Il défini des dictionnaires qui servent à traduire les éléments de l'instance XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient un élément "ximf:dictionnary".

==== Element dictionary ====
<div style="color:red;">'''TODO''' :
* Quel est l'intérêt de renseigner un attribut "id" à l'élément "dictionary" (étant donné qu'un seul élément "dictionary est autorisé dans l'élément "instance") ?</div>

L’élément "dictionary" contient toutes les informations devant être interprétées selon le pays d’utilisation.
L’élément "dictionary" contient un ou plusieurs mêmes éléments "locale", e.g.,

<ximf:dictionary>
<ximf:locale lang="fr-FR" />
<ximf:locale lang="en-US" />
</ximf:dictionary>

==== Element locale ====
L’élément "locale" contient toutes les informations pour un pays et/ou langue désignée.
L’élément "locale" contient un ou plusieurs mêmes éléments "ilk", e.g.,

<ximf:locale lang="fr-FR" >
<ximf:ilk entity="a"/>
<ximf:ilk entity="b"/>
</ximf:locale>

* Détails sur les attributs de la balise "locale" :
** L’attribut "lang" définit le code pays de ce conteneur. Il devrai être construit selon le format défini par la RFC1766 (fr, en, ja, es, …).

==== Element ilk ====
L’élément "ilk" contient une unique information correspondant à une donnée traduite selon le code pays de l’élément père. Cette information est au format chaîne de caractère. Un attribut obligatoire précise la balise "ilk".

<ximf:ilk entity="ilk-lang-ihm">langue</ximf:ilk>

* Détails sur les attributs de la balise "ilk" :
** L’attribut "entity" définit la référence d’entrée pour récupérer le contenu de l’élément selon le code pays souhaité.

Finalement, le fichier "dictionary" pourra contenir :
<ximf:instance name="Whirlpool">
<ximf:dictionary>
<ximf:locale lang="fr-FR" >
<ximf:ilk entity="ilk-lang-ihm">Français</ximf:ilk>
<ximf:ilk entity="ilk-exemple-general">Général</ximf:ilk>
</ximf:locale>
<ximf:locale lang="en-US" >
<ximf:ilk entity="ilk-lang-ihm">English (US)</ximf:ilk>
<ximf:ilk entity="ilk-exemple-general">General</ximf:ilk>
</ximf:locale>
</ximf:dictionary>
</ximf:instance>

=== Fichier ihm ===
<span style="color:red;">'''TODO''' : La documentation originale ne décrit pas le fichier ihm, les informations ci-dessous ont seulement été présumées. Merci de les vérifier/compléter.
</span>

Le fichier ihm spécifie l'agencement de l'interface des formulaires XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient un élément "ximf:ihm".

==== Element ihm ====
L'élément "ihm" contient un ou plusieurs éléments "panel" et un élément "treeRcv".

==== Element panel ====
Un élément ximf:panel correspond à un onglet du formulaire XIMF construit.
Deux attributs précisent la balise "panel" : "id" et "ilk", eg.
<ximf:panel id="pane_security" ilk="ilk-priority-panel" />

* Détails sur les attributs de l'élément "panel" :
** L’attribut "id" définit le nom de l'onglet, il doit être unique pour chaque élément "ximf:panel" et est formaté selon la syntaxe "pane-xxx". Cet attribut est obligatoire.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.

L'élément "ximf:panel" contient au moins un éléments "ximf:groupbox".

==== Element groupbox ====
Un élément groupbox correspond à une sous catégorie d'un onglet du formulaire XIMF.
La structure "groupbox" détaille l’ordre d’affichage des entêtes dans un message.
Deux attributs précisent la balise "ximf:groupbox" : "id" et "ilk", eg.
<ximf:groupbox id="group-classification" ilk="ilk-secu-box" />

* Détails sur les attributs de l'élément "groupbox" :
** L’attribut "id" définit le nom de l'onglet, il doit être unique pour chaque élément "ximf:panel" et est formaté selon la syntaxe "pane-xxx". Cet attribut est obligatoire.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.

L'élément "groupbox" contient au moins un éléments "headerRef".

==== Element treeRcv ====
L'élément "treeRcv" permet de spécifier quelles sont les colonnes susceptibles d'être ajoutées dans le panneau principal du client de messagerie qui contient la liste des messages d’un dossier.

L'élément "treeRcv" peut contenir des éléments "headerRef".

==== Element headerRef ====
L'élément headerRef spécifie les champs associés à chaque sous-groupe d'onglet de formulaire ou les champs qu'il est possible d'afficher dans la liste des messages.
Aucun attribut ne vient compléter la balise "headerRef", eg.
<ximf:headerRef>header-classification</ximf:headerRef>

Finalement, le fichier "ihm" pourra contenir :
<pre>
<ximf:instance name="Amoco">
<ximf:ihm>
<ximf:panel id="pane_security" ilk="ilk-priority-panel">
<ximf:groupbox id="group-classification" ilk="ilk-secu-box">
<ximf:headerRef>header-correspondance-type</ximf:headerRef>
<ximf:headerRef>header-classification</ximf:headerRef>
</ximf:groupbox>
</ximf:panel>
<ximf:treeRcv>
<ximf:headerRef>header-classification</ximf:headerRef>
</ximf:treeRcv>
</ximf:ihm>
</ximf:instance>
</pre>

=== Fichier headers ===
Le fichier headers spécifie les types des champs de l'interface des formulaires XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient des éléments "header".

<div style="color:red">'''TODO :'''
Il semble que les fichiers headers définissent des entêtes devant être envoyées alors que ces mêmes entêtes ne sont pas spécifiés dans le fichier ihm. Ce comportement est logique (l'utilisateur n'a pas forcément besoin de savoir tout ce qui est envoyé via le formulaire. Cependant, comment est-il possible de savoir quels entêtes doivent être envoyés ?
</div>

==== Element header ====
Chaque élément "header" décrit un entête de message de format XIMF.
Huit attributs précisent la balise "header" : "headerName", "id", "technicalHeaderName", "type", "technicalType", "isMandatory", "ilk", "description", e.g.,

<div style="color:red;">'''TODO :'''
Comment est effectuée la vérification de l'attribut isMandatory et quelles sont les conditions de fonctionnement de celui-ci ? Est-il possible, par exemple, de spécifier l'attribut isMandatory=true d'un élément header si le contenu de celui-ci est un élément « set » qui dispose des attributs minItem et maxItem ?Actuellement, lorsque l'on crée un élément set avec les attributs minItem et maxItem, le champ du formulaire associé ne peux pas être validé (Est-ce un bug ?) : e.g.,
<ximf:set id="value-amoco-classification" minItem="1" maxItem="64" separator=";" technicalSeparator=".">
</div>

<ximf:header id="header-primary-precedence"
headerName="X-XIMF-Primary-Precedence"
ilk="ilk-primary-precedence"
isMandatory="true"
description="entête d’urgence"
type="string" />

* Détails sur les attributs de l'élément "header" :
** L’attribut "headerName" définit le nom du champ XIMF. Cet attribut est obligatoire.
** L’attribut "id" définit un identifiant de champ, il doit être unique pour chaque élément "header" et est formaté selon la syntaxe "header-xxx". Cet attribut est obligatoire.
** L’attribut "isMandatory" précise si ce champ doit être obligatoirement présent dans le message intégrant les entêtes selon cette description.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.
** L’attribut "type" précise le format des données associées à cet élément. Ce format peut être une date, une chaîne, une adresse mail, un O.I.D.
** L’attribut "technicalHeaderName" permet de compléter l’entête décrit par un autre entête.
** L’attribut "technicalType" précise le format des données associées à l’élément technicalHeaderName.
** L’attribut "description" permet d’ajouter une information sur cet élément.

L’élément "header" contient obligatoirement un élément "set", "multiset", "string", ou "compstring", e.g.,

<ximf:header id="header-reply-by"
headerName="X-XIMF-Reply-By"
ilk="ilk-reply-by"
isMandatory="false" >
<ximf:string id="value-reply-by" editable="true" />
</ximf:header>

<div style="color:red;">
'''TODO :''' Quelles sont les contraintes associées à l'attribut type d'un élément header ?
</div>

==== Element string ====
L’élément "string" précise le contenu d’une ressource de type chaîne de caractères imprimables (a-z, A-Z, 1-9,…)
Quinze attributs complètent l’élément "string" : "id", "ref", "ilk", "aclLevel", "index", "description", "editable", "content", "technicalContent","maxItem", "minItem", "maxLength", "minLength", "separator", "technicalSeparator", e.g.,

<ximf:string ilk="ilk-france" content="FRA" />

* Détails sur les attributs de l'élément "string" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "string".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role| élément role]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut " description " permet d’associer un commentaire sur cette donnée.
** L’attribut "editable" définit une valeur de saisie (champ libre). Cet attribut est de type booléen.
** L’attribut "content" représente la valeur effective de la donnée. C’est cette donnée qui sera associée au champ XIMF créé.
** L’attribut "technicalContent" représente la valeur effective de la donnée technique. C’est cette donnée qui sera associée au champ technique XIMF créé (cf. attribut technicalHeaderName de l’élément "header".
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.

L’élément "string" peut contenir plusieurs éléments "linkedValue".

<ximf:string ilk="ilk-non-protege" content="NON PROTEGE" technicalContent="1" >
<ximf:linkedValue ref="value-non-protege-france " />
</ximf:string>

==== Element compstring ====
<div style="color:red;">
'''TODO :''' L'attribut de l'élément « compstring » nommé « contentFactorise » devrait s'appeler « contentFactorize ».
</div>
L’élément "compstring" décrit un conteneur de concaténation des éléments fils. Il permet notamment de créer des valeurs d’entêtes composées.
Dix-sept attributs complètent l’élément "compstring" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", "content", "technicalContent", "contentPositionEnd", "contentFactorise", "technicalPositionEnd", e.g.,

<ximf:compstring
ilk="ilk-special"
content="SPECIAL"
technicalContent="1.3.4"
separator=" "
technicalSeparator=".">

* Détails sur les attributs de l'élément "compstring" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "compstring".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (cf. [[#Element_role| élément "role"]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut " description " permet d’associer un commentaire sur cette donnée.
** L’attribut "content" représente la valeur effective de la donnée. C’est cette donnée qui sera associée au champ XIMF créé.
** L’attribut "technicalContent" représente la valeur effective de la donnée technique. C’est cette donnée qui sera associée au champ technique XIMF créé (cf. attribut technicalHeaderName de l’élément "header".
** L’attribut "separator" définit le caractère de séparation entre deux valeurs.
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "contentPositionEnd" impose de positionner le contenu de l’élément "compstring" après les valeurs des éléments fils : valuefils1,valuefils2 : valuecompstring.
** L’attribut "technicalPositionEnd" impose de positionner le contenu de l’élément "compstring" après les valeurs des éléments fils.
** L’attribut "contentFactorise" impose d’utiliser le contenu de l’élément "compstring" comme facteur des éléments fils : valuecompstring(valuefils1,valuefils2).

L’élément "compstring" peut contenir un élément "string" ou "set" ou "multiset" ou plusieurs éléments "compstring".

<ximf:compstring
ilk="ilk-special"
content="SPECIAL"
technicalContent="1.3.4"
separator=" "
technicalSeparator=".">
<ximf:set id="ilk-special-op " maxItem="64">
<ximf:string ilk="ilk-special-op1" content="OP1" technicalContent="1" />
<ximf:string ilk="ilk-special-op2" content="OP2" technicalContent="2" />
<ximf:string ilk="ilk-special-op3" content="OP3" technicalContent="3" />
</ximf:set>
</ximf:compstring>

==== Element set ====
L’élément "set" décrit un conteneur de ressources de même type. Cet élément autorise la sélection de plusieurs ressources mais chaque ressource est sélectionnée une seule fois.
Douze attributs précisent la description de la balise "set" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", e.g.,

<ximf:set id="value-categories" ref="value-mentions" maxItem="64" separator=";" />

* Détails sur les attributs de l'élément "set" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "ximf:set".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role|élément rôle]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut "description" permet d’associer un commentaire sur cette donnée.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs

L’élément "set" peut contenir un ou plusieurs éléments "string" ou un ou plusieurs éléments "compstring".

<ximf:set id="value-categories" minItem="1" maxItem="64" separator=";">
<ximf:string ilk="ilk-releasable-to" content="RELEASABLE TO " />
<ximf:string ilk="ilk-eyes-only" content=" EYES ONLY"/>
<ximf:string ilk="ilk-use-only" content=" USE ONLY"/>
</ximf:set>

<div style="color:red;">'''TODO :'''
* Y a-t-il une définition des fichiers associés aux instances XIMF (e.g, le fichier attribution-list.xml utilisé dans l'instance Caterpillar) ?
* Comment le parseur d'instance ximf sait qu'un élément est une "attribution-list" ?
</div>

==== Element multiset ====
L’élément "multiset" décrit un conteneur de ressources de même type. Cet élément autorise la sélection de plusieurs ressources et chaque ressource peut être sélectionnée plusieurs fois.
Douze attributs précisent la description de la balise "multiset" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", e.g.,

<ximf:multiset
id="value-restricted"
ilk=" value-restricted-otan"
maxItem="64"
separator=";" />

* Détails sur les attributs de l'élément "multiset" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "multiset".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role|élément rôle]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut "description" permet d’associer un commentaire sur cette donnée.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs

L’élément "multiset" peut contenir un ou plusieurs éléments "string" ou un ou plusieurs éléments "compstring".

<ximf:multiset id="value-restricted-otan-categories" minItem="1" maxItem="64" separator=";" >
<ximf:string ilk="ilk-releasable-to" content="RELEASABLE TO "/>
<ximf:string ilk="ilk-eyes-only" content=" EYES ONLY"/>
<ximf:string ilk="ilk-use-only" content=" USE ONLY"/>
</ximf:multiset>

<span style="color:red;">'''TODO :''' Comment sont gérées les règles associées aux champs multivaleurs (disposant par exemple des attributs minItem/maxItem ou les champs multiset) ?</span>

==== Element linkedValue ====
<div style="color: red;">'''TODO ''': L'élément linkedValue indique quelle ressource utiliser lors de la sélection d'un élément particulier mais il n'indique pas où la ressource devra être utilisée.
* Est-ce que cela correspond toujours au header suivant ?
* Pourquoi avoir fait ce choix au lieu d'ajouter un attribut supplémentaire ?
</div>

L’élément "linkedValue" définit une référence sur une ressource de type conteneur ("set", "multiset") ou "string". Cette ressource devrait être utilisée si la ressource contenant "linkedValue" (noeud parent) est sélectionnée.
Un attribut précise la balise "linkvalue" : "ref", e.g.,

<ximf:linkedValue ref="value-restricted-otan-classification-id" />

* Détails sur les attributs de l'élément "linkedValue" :
** L’attribut "ref" précise la valeur de l’attribut "id" de la ressource cible. Cet attribut est obligatoire.

=== Fichier rules ===
Le fichier rules définit les règles de contrôles d’entêtes XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui peut contenir des éléments "ximf:rule".

==== Element rule ====
<div style="color:red">
'''TODO :''' Mettre à jour la documentation :
* Les éléments autorisés dans un élément « rule » ne sont plus à jour. La présente documentation spécifie 12 éléments : AliasHeader, AliasValue, Compatibility, Association, SecureHeaders, SecurityLabel, Constraint, Assignment, Processing, Accessibility, Role et Custom. Le schéma XML fourni avec le mail en spécifie 5 : Constraint, Processing, Compatibility, Policy et Custom et place les autres en tant qu'extentions des 5 éléments cités précédemment.
* Les éléments SecureHeaders et SecurityLabel associés à l'élément « rule » dans la version ci-dessus ne figurent plus dans la nouvelle version. On les retrouve dans les fichiers rules-*.xml mais les éléments sont commentés. En revanche, ils sont bien présents dans une autre instance : s'agit-il d'une fonctionnalité non-documentée ou plus documentée ?
* L'élément ximf:classificationPictures n'est pas documenté. De plus, il serait bon d'avoir des précisions sur la raison qui a motivé l'ajout de cet élément dans les fichiers de règles (alors qu'il semblerait être plus adapté au fichier headers-*.xml).
</div>
L’élément "rule" est le conteneur principal de description d’un comportement particulier à appliquer sur un ensemble d’entêtes XIMF.
Trois attributs précisent la balise "rule" : "id", "agent", "description", e.g.,
<ximf:rule id="compatibility-rule" description="Règle sur la compatibilité X-SMTP / XIMF" >

* Détails sur les attributs de l'élément "rule" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "rule". Cet attribut est obligatoire.
** L’attribut "agent" indique l’équipement cible devant analyser et appliquer le contenu de cet élément.
** L’attribut "description" autorise l’auteur d’ajouter un commentaire sur cet élément.

L’élément "rule" contient un ou plusieurs mêmes éléments de spécialisation de la règle "contraint", "assignement", "processing", "compatibility", "accessibility", "custom",…, e.g.,

<ximf:rule id="precedence-rule" agent="mua" description="Règle sur les priorités">
<ximf:constraint
left="header-primary-precedence"
operator="equalOrGreaterThan"
right="header-copy-precedence" />
</ximf:rule>

==== Element aliasHeader ====
L’élément "aliasHeader" permet de définir le nom de l’entête sur lequel la règle précisée est appliquée
Deux attributs précisent la balise "aliasHeader" : "headerName" et "headerRef", e.g.,

<ximf:aliasHeader headerName ="X-P772-Version" headerRef="X-XIMF-VERSION" />

* Détails sur les attributs de l'élément "aliasHeader" :
* L’attribut "headerName" définit le nom XIMF de l’entête modifié par la règle. Cet attribut est obligatoire.
* L’attribut "headerRef" définit le nom d’un entête XIMF de référence qui est le point d’entrée de l’application de la règle sur l’entête définit par "headerName". Cela permet de lier deux entêtes de messages où l’utilisation de l’un des entêtes influe sur le comportement de l’autre.

L’élément "aliasHeader" peut contenir des éléments "aliasValue",e.g ,

<ximf:aliasHeader headerName="X-P772-Version" />
<ximf:aliasValue vame="1.0"/>
<ximf:aliasHeader>

==== Element aliasValue ====
L’élément "aliasValue" contient une valeur à associer à l’entête XIMF contrôlé par la règle. Il est utile lorsque deux entêtes sont liées (utilisation de l’attribut headerRef dans l’élément aliasHeader) et que les valeurs de l’entêtes de référence permettent de préciser celles de l’entête contrôlé.
Deux attributs précisent la balise "aliasValue" : "valueName", "valueRef", e.g.,

<ximf:aliasValue valueName="2" valueRef ="flash" />

* Détails sur les attributs de l'élément "aliasValue" :
** L’attribut "valueName" définit la valeur de l’entête à créer. Cet attribut est obligatoire.
** L’attribut "valueRef" définit la valeur de l’entête XIMF de référence pour utiliser valueName.
<span style="color:red;">'''TODO :''' L'attribut valueRef est-il obligatoire ?</span>

==== Element compatibility ====
L’élément "compatibility" est utilisé pour associer à un entête respectant la norme XIMF un entête respectant une autre norme que XIMF (XSMTP par exemple).
Deux attributs précisent la balise "compatibility" : "targetName", "targetVersion", e.g.,

<ximf:compatibility targetName="X-SMTP" targetVersion="1.1">
<ximf:aliasValue headerName="X-P772-Version" content="1.1" />
<ximf:aliasValue
headerName="X-P772-Primary-Precedence"
headerRef="header-primary-precedence"
dataRef="data-priority-xsmtp"/>
</ximf:compatibility>

* Détails sur les attributs de l'élément "compatibility" :
** L’attribut "targetName" définit la norme de l’entête à associer à l’entête XIMF. Cet attribut est obligatoire.
** L’attribut "targetVersion" définit le numéro de version de la norme de l’entête à associer à l’entête XIMF. Cet attribut est obligatoire.

L’élément "compatibility" contient au moins un élément "aliasHeader".

<u>Pour illustrer cette règle :</u>
Le format XSMTP est déjà supporté par certains équipements. Afin de rendre ceux-ci inter opérables avec le nouveau format XIMF, cette règle permet d’associer un entête XSMTP contenant les mêmes informations qu’un entête XIMF.

L’élément Association : dépendance entre entêtes
L’élément "association" définie les valeurs autorisées pour un entête XIMF en fonction d’une valeur définie pour un autre entête XIMF.

<ximf:association>
<ximf:aliasHeader
headerName="X-XIMF-Primary-Precedence"
headerRef="X-XIMF-Correspondence-Type">
<ximf:aliasValue valueName="routine" valueRef="private" />
<ximf:aliasValue valueName="routine,priority" valueRef="professional" />
<ximf:aliasValue valueName="routine,priority,immediate,flash" valueRef="operational" />
<ximf:aliasValue valueName="routine,priority,immediate" valueRef="official" />
</ximf:aliasHeader>
</ximf:association>

==== Element secureHeaders ====
<div style="color:red;">'''TODO :''' Les éléments SecureHeaders et SecurityLabel associés à l'élément « rule » dans la version ci-dessus ne figurent plus dans le shéma xml. On les retrouve dans les fichiers rules-*.xml mais les éléments sont commentés. En revanche, ils sont bien présents dans une autre instance : s'agit-il d'une fonctionnalité non-documentée ou plus documentée ?</div>
L’élément "secureHeaders" définie la liste des entêtes à intégrer dans la signature d’un message. Cette règle s’applique sur les équipements proposant un algorithme de signature des messages.

Un élément "secureHeaders" contient un ou plusieurs éléments "aliasHeaders" où chaque élément décrit un entête à intégrer dans la signature et complété d’un attribut "status".

<ximf:secureHeaders targetName="SecureHeaders">
<ximf:aliasHeader headerName="X-XIMF-Primary-Precedence" status="0" />
<ximf:aliasHeader headerName="X-XIMF-Copy-Precedence" status="0" />
</ximf:secureHeaders>

==== Element securityLabel ====
L’élément "securityLabel" définie la liste des entêtes à intégrer dans la signature d’un message. Cette règle s’applique sur les équipements proposant un algorithme de signature des messages selon la norme RFC.

Un élément "securityLabel" contient un ou plusieurs éléments "aliasHeaders" où chaque élément décrit un entête à intégrer dans la signature et complété d’un attribut "status".

<ximf:securityLabel targetName="SecurityLabel" id="Amoco">
<ximf:aliasHeader
headerName="SecurityPolicyIdentifier"
headerRef="X-XIMF-Security-Policy-Identifier" />
<ximf:aliasHeader
headerName="SecurityClassification"
headerRef="X-XIMF-Security-Classification-Identifier" />
<ximf:aliasHeader
headerName="ESSPrivacyMark"
headerRef="X-XIMF-Privacy-Mark" />
<ximf:aliasHeader
headerName="SecurityCategory"
headerRef="X-XIMF-Security-Categories-Identifier"
type="2" />
</ximf:securityLabel>

==== Element constraint ====
L’élément "constraint" est utilisé pour définir une règle de construction de deux entêtes partageant des "datas" identiques.
Trois attributs précisent la balise "constraint" : "left", "right", "operator", e.g.,

<ximf:constraint
left="header-primary-precedence"
operator="equalOrGreaterThan"
right="header-copy-precedence" />

* Détails sur les attributs de l'élément "constraint" :
** L’attribut "left" désigne le premier élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "right" désigne le deuxième élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "operator" indique la règle de poids à appliquer sur la valeur des deux éléments "header", il peut être de type "greaterThan", "lowerThan", "equalOrGreaterThan", "equalOrLowerThan", "equal". Cet attribut est obligatoire.

* Détails sur les valeurs possibles de l'attribut "type" :
** Le type "greaterThan" signifie que la valeur de l’élément "left" doit être strictement supérieur à la valeur de l’élément "right".
** Le type "lowerThan" signifie que la valeur de l’élément "left" doit être strictement inférieur à la valeur de l’élément "right".
** Le type "equalOrGreaterThan" signifie que la valeur de l’élément "left" doit être supérieur ou égale à la valeur de l’élément "right".
** Le type "equalOrLowerThan" signifie que la valeur de l’élément "left" doit être inférieur ou égale à la valeur de l’élément "right".
** Le type "equal" signifie que la valeur de l’élément "left" et de l’élément "right" doivent être identiques.

==== Element assignment ====
<div style="color:red;">'''TODO :''' L'élément assignment n'apparaît pas dans le shéma xml qui avait été envoyé.</div>

L’élément "assignement" est utilisé pour affecter une valeur créée en fonction d’une règle de comparaison sur les valeurs de deux éléments "header".
Quatre attributs précisent la balise "assignement" : "left", "right", "operator", "result", e.g.,

<ximf:assignment
left="header-primary-precedence"
operator="equal"
right="data-routine-precedence"
result="86400" />

* Détails sur les attributs de l'élément "assignment" :
** L’attribut "left" désigne le premier élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "right" désigne le deuxième élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "operator" indique la règle de comparaison entre les valeurs des deux éléments "header", il peut être de type "greaterThan", "lowerThan", "equalOrGreaterThan", "equalOrLowerThan", "equal". Cet attribut est obligatoire.
** L’attribut "result" représente la valeur à utiliser si la règle de comparaison entre les deux éléments est satisfaite. Cet attribut est obligatoire.

==== Element processing ====
L’élément "processing" regroupe des règles de traitement à effectuer sur des entêtes formatés.
L’attribut "type" précise le type de traitement à effectuer sur ces valeurs. Cet attribut est obligatoire, il est de type : "sign-header-value", "encrypt-header-value", "capitalize-header-value", e.g.,

<ximf:processing type="sign-header-value">
<ximf:refHeader>header-primary-precedence</ximf:refheader>
<ximf:refHeader>header-copy-precedence</ximf:refheader>
<ximf:refHeader>header-echange-type</ximf:refheader>
</ximf:processing>

* Détails sur les valeurs possibles de l'attribut "type" :
** Le type "sign-header-value" définit un traitement de signature des entêtes définis dans la balise.
** Le type "encrypt-header-value" définit un traitement de chiffrement des entêtes définis dans la balise.
** Le type "capitalize-header-value" définit un traitement de capitalisation des entêtes définis dans la balise.

L’élément "processing" contient au moins un élément "refHeader".
<div style="color:red;">'''TODO :'''L'élément refHeader n'est pas documenté, s'agit-il en fait de l'élément headerRef ?</div>

==== Element accessibility ====
<div style="color:red;">'''TODO :''' L'élément accessibility n'apparaît pas dans le shéma xml qui avait été envoyé.</div>
L’élément "accessibility" définit un ensemble de règles de droit d’accès aux éléments d’une instance pour une cible déterminée (utilisateur, routeur…).
Cet élément contient un ou plusieurs éléments "role".

<ximf:accessibility>
<ximf:role id="role-flash-allowed" aclLevel="100" />
<ximf:role id="role-flash-prohibited" aclLevel="50" />
</ximf:accessibility>

==== Element role ====
L’élément "role" positionne une valeur d’accès à pour une entité définit.
Deux attributs complètent l’élément "role" : "id", "aclLevel", e.g.,

<ximf:role id="role-flash-allowed" aclLevel="100" />

* Détails sur les attributs de l'élément "role" :
** L’attribut "id" précise l’entité accessible en fonction d’une valeur déterminée.
** L’attribut "aclLevel" précise la valeur seuil d’accès à l’entité.

==== Element custom ====
L’élément "custom" permet à l’auteur de créer des nouvelles règles personnalisées.
Trois attributs précisent la balise "custom" : "id", "provider", "description", e.g.,

<ximf:custom
id="custom-display"
provider="EADS"
description="Affichage de la composition du message" >
<node1><node2><node3></node3></node2></node1>
</ximf:custom>

* Détails sur les attributs de l'élément "custom" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "custom" et formaté selon la syntaxe "custom-xxx". Cet attribut est obligatoire.
** L’attribut "provider" identifie l’auteur de la règle. Cet attribut est obligatoire.
** L’attribut "description" permet d’ajouter un commentaire sur cet élément.

L’élément "custom" peut contenir tous les éléments possibles en respectant les standards XML.

XIMF XML tags/fr

2011-02-28T08:28:17Z

Anthonyjuge : /* Element string */

== Introduction ==
Ce document propose un modèle de description, via eXtensible Markup Language (XML), d’entêtes de messages électroniques respectant la norme XIMF. Ce document a deux objectifs :
# Décrire les éléments et attributs de représentation XML pour construire des entêtes de messages électroniques de format XIMF.
# Fournir un modèle de représentation XIMF/XML.

<u>Rappel :</u>
* Un "élément" fait référence à tous les caractères situés entre une balise de départ et un balise de fin, e.g.,
<exemple> texte et/ou éléments fils </exemple>
* Un "attribut" est une composante d’un élément. Il est positionné dans la balise de départ, e.g.,
<exemple nom='value'>

Tous les éléments décrits dans cette documentation paragraphe sont validés dans l’espace de nom "ximf".

<pre>
xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://eads.org/ximf/ximf.xsd"
</pre>

== Description détaillée des balises XML ==

Voici, par ordre d'apparition et en fonction des fichiers, les balises génériques associées aux différents fichiers XML.

=== Fichier ximfmail-profile ===

<div style="color:red;">'''TODO''' :
* Combien d'éléments ihm sont autorisés dans un élément instance ?
* La documentation des fichiers ximfmail-profile.xml n'est pas disponible. Est-il possible d'avoir accès au fichier ximf_profile.xsd mentionné dans les ximfmail-profile.xml ?
</div>

Un fichier xpi peut contenir plusieurs instances XIMF, celles-ci sont alors regroupées dans une même catégorie. Le fichier ximfmail-profile contient des informations sur toutes les instances contenues dans le xpi, notamment leur nom, leur chemin d'accès, ainsi que les noms des fichiers associés à chaque instance.

==== Element instance ====
L’élément "instance" identifie l’ensemble des entêtes à décrire selon la norme XIMF. C’est le conteneur principal d’une instance XIMF/XML. Cinq attributs précisent la balise "instance" : "ximfVersion", "version", "author", "creation", "name", e.g.,
<ximf:instance name="myInstance" version="1.0" ximfVersion="2.0" >

* Détails sur les attributs de l'élément "instance" :
** L’attribut "name" définit le nom de l’instance décrite. Cet attribut est obligatoire.
** L’attribut "ximfVersion" définit le numéro de version des entêtes XIMF utilisés pour cette représentation. Cet attribut est obligatoire.
** L’attribut "version" définit le numéro de version de l’instance décrite. Cet attribut est obligatoire.
** L’attribut "author" renseigne sur le nom de l’auteur de cette instance.
** L’attribut "creationDate" précise la date de création de cette instance.

L’élément "instance" peut contenir un ou plusieurs éléments "schema", un ou plusieurs éléments "rule", un élément "ihm" et un élément "dictionary".

==== Element dictionary ====
L'élément dictionary contient le chemin vers le fichier spécifiant les données d'internationalisation (Cf. [[#Fichier_dictionary|Fichier dictionary]]).

==== Element schema ====
L'élément shema contient le chemin vers le fichier spécifiant les entêtes XIMF (Cf. [[#Fichier_headers|Fichier headers]]).

==== Element ihm ====
L'élément ihm contient le chemin vers le fichier spécifiant la disposition de l'interface des formulaires XIMF (Cf. [[#Fichier_ihm|Fichier ihm]]).

==== Element rule ====
L'élément rule contient le chemin vers le fichier spécifiant les règles associées aux valeurs des champs XIMF (Cf. [[#Fichier_rules|Fichier rules]]).

=== Fichier dictionary ===
Le fichier dictionnary permet de mettre en œuvre l’internationalisation d’une instance XIMF. Il défini des dictionnaires qui servent à traduire les éléments de l'instance XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient un élément "ximf:dictionnary".

==== Element dictionary ====
<div style="color:red;">'''TODO''' :
* Est-il obligé de renseigner les données d'internationalisation pour <u>tous</u> les labels ? (ce n'est actuellement pas le cas dans l'instance Whirlpool)
* Quel est l'intérêt de renseigner un attribut "id" à l'élément "dictionary" (étant donné qu'un seul élément "dictionary n'est autorisé dans l'élément "instance") ?</div>

L’élément "dictionary" contient toutes les informations devant être interprétées selon le pays d’utilisation.
L’élément "dictionary" contient un ou plusieurs mêmes éléments "locale", e.g.,

<ximf:dictionary>
<ximf:locale lang="fr-FR" />
<ximf:locale lang="en-US" />
</ximf:dictionary>

==== Element locale ====
L’élément "locale" contient toutes les informations pour un pays et/ou langue désignée.
L’élément "locale" contient un ou plusieurs mêmes éléments "ilk", e.g.,

<ximf:locale lang="fr-FR" >
<ximf:ilk entity="a"/>
<ximf:ilk entity="b"/>
</ximf:locale>

* Détails sur les attributs de la balise "locale" :
** L’attribut "lang" définit le code pays de ce conteneur. Il devrai être construit selon le format défini par la RFC1766 (fr, en, ja, es, …).

==== Element ilk ====
L’élément "ilk" contient une unique information correspondant à une donnée traduite selon le code pays de l’élément père. Cette information est au format chaîne de caractère. Un attribut obligatoire précise la balise "ilk".

<ximf:ilk entity="ilk-lang-ihm">langue</ximf:ilk>

* Détails sur les attributs de la balise "ilk" :
** L’attribut "entity" définit la référence d’entrée pour récupérer le contenu de l’élément selon le code pays souhaité.

Finalement, le fichier "dictionary" pourra contenir :
<ximf:instance name="Whirlpool">
<ximf:dictionary>
<ximf:locale lang="fr-FR" >
<ximf:ilk entity="ilk-lang-ihm">Français</ximf:ilk>
<ximf:ilk entity="ilk-exemple-general">Général</ximf:ilk>
</ximf:locale>
<ximf:locale lang="en-US" >
<ximf:ilk entity="ilk-lang-ihm">English (US)</ximf:ilk>
<ximf:ilk entity="ilk-exemple-general">General</ximf:ilk>
</ximf:locale>
</ximf:dictionary>
</ximf:instance>

=== Fichier ihm ===
<span style="color:red;">'''TODO''' : La documentation originale ne décrit pas le fichier ihm, les informations ci-dessous ont seulement été présumées. Merci de les vérifier/compléter.
</span>

Le fichier ihm spécifie l'agencement de l'interface des formulaires XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient un élément "ximf:ihm".

==== Element ihm ====
L'élément "ihm" contient un ou plusieurs éléments "panel" et un élément "treeRcv".

==== Element panel ====
Un élément ximf:panel correspond à un onglet du formulaire XIMF construit.
Deux attributs précisent la balise "panel" : "id" et "ilk", eg.
<ximf:panel id="pane_security" ilk="ilk-priority-panel" />

* Détails sur les attributs de l'élément "panel" :
** L’attribut "id" définit le nom de l'onglet, il doit être unique pour chaque élément "ximf:panel" et est formaté selon la syntaxe "pane-xxx". Cet attribut est obligatoire.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.

L'élément "ximf:panel" contient au moins un éléments "ximf:groupbox".

==== Element groupbox ====
Un élément groupbox correspond à une sous catégorie d'un onglet du formulaire XIMF.
La structure "groupbox" détaille l’ordre d’affichage des entêtes dans un message.
Deux attributs précisent la balise "ximf:groupbox" : "id" et "ilk", eg.
<ximf:groupbox id="group-classification" ilk="ilk-secu-box" />

* Détails sur les attributs de l'élément "groupbox" :
** L’attribut "id" définit le nom de l'onglet, il doit être unique pour chaque élément "ximf:panel" et est formaté selon la syntaxe "pane-xxx". Cet attribut est obligatoire.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.

L'élément "groupbox" contient au moins un éléments "headerRef".

==== Element treeRcv ====
L'élément "treeRcv" permet de spécifier quelles sont les colonnes susceptibles d'être ajoutées dans le panneau principal du client de messagerie qui contient la liste des messages d’un dossier.

L'élément "treeRcv" peut contenir des éléments "headerRef".

==== Element headerRef ====
L'élément headerRef spécifie les champs associés à chaque sous-groupe d'onglet de formulaire ou les champs qu'il est possible d'afficher dans la liste des messages.
Aucun attribut ne vient compléter la balise "headerRef", eg.
<ximf:headerRef>header-classification</ximf:headerRef>

Finalement, le fichier "ihm" pourra contenir :
<pre>
<ximf:instance name="Amoco">
<ximf:ihm>
<ximf:panel id="pane_security" ilk="ilk-priority-panel">
<ximf:groupbox id="group-classification" ilk="ilk-secu-box">
<ximf:headerRef>header-correspondance-type</ximf:headerRef>
<ximf:headerRef>header-classification</ximf:headerRef>
</ximf:groupbox>
</ximf:panel>
<ximf:treeRcv>
<ximf:headerRef>header-classification</ximf:headerRef>
</ximf:treeRcv>
</ximf:ihm>
</ximf:instance>
</pre>

=== Fichier headers ===
Le fichier headers spécifie les types des champs de l'interface des formulaires XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient des éléments "header".

<div style="color:red">'''TODO :'''
Il semble que les fichiers headers définissent des entêtes devant être envoyées alors que ces mêmes entêtes ne sont pas spécifiés dans le fichier ihm. Ce comportement est logique (l'utilisateur n'a pas forcément besoin de savoir tout ce qui est envoyé via le formulaire. Cependant, comment est-il possible de savoir quels entêtes doivent être envoyés ?
</div>

==== Element header ====
Chaque élément "header" décrit un entête de message de format XIMF.
Huit attributs précisent la balise "header" : "headerName", "id", "technicalHeaderName", "type", "technicalType", "isMandatory", "ilk", "description", e.g.,

<div style="color:red;">'''TODO :'''
Comment est effectuée la vérification de l'attribut isMandatory et quelles sont les conditions de fonctionnement de celui-ci ? Est-il possible, par exemple, de spécifier l'attribut isMandatory=true d'un élément header si le contenu de celui-ci est un élément « set » qui dispose des attributs minItem et maxItem ?Actuellement, lorsque l'on crée un élément set avec les attributs minItem et maxItem, le champ du formulaire associé ne peux pas être validé (Est-ce un bug ?) : e.g.,
<ximf:set id="value-amoco-classification" minItem="1" maxItem="64" separator=";" technicalSeparator=".">
</div>

<ximf:header id="header-primary-precedence"
headerName="X-XIMF-Primary-Precedence"
ilk="ilk-primary-precedence"
isMandatory="true"
description="entête d’urgence"
type="string" />

* Détails sur les attributs de l'élément "header" :
** L’attribut "headerName" définit le nom du champ XIMF. Cet attribut est obligatoire.
** L’attribut "id" définit un identifiant de champ, il doit être unique pour chaque élément "header" et est formaté selon la syntaxe "header-xxx". Cet attribut est obligatoire.
** L’attribut "isMandatory" précise si ce champ doit être obligatoirement présent dans le message intégrant les entêtes selon cette description.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.
** L’attribut "type" précise le format des données associées à cet élément. Ce format peut être une date, une chaîne, une adresse mail, un O.I.D.
** L’attribut "technicalHeaderName" permet de compléter l’entête décrit par un autre entête.
** L’attribut "technicalType" précise le format des données associées à l’élément technicalHeaderName.
** L’attribut "description" permet d’ajouter une information sur cet élément.

L’élément "header" contient obligatoirement un élément "set", "multiset", "string", ou "compstring", e.g.,

<ximf:header id="header-reply-by"
headerName="X-XIMF-Reply-By"
ilk="ilk-reply-by"
isMandatory="false" >
<ximf:string id="value-reply-by" editable="true" />
</ximf:header>

<div style="color:red;">
'''TODO :''' Quelles sont les contraintes associées à l'attribut type d'un élément header ?
</div>

==== Element string ====
L’élément "string" précise le contenu d’une ressource de type chaîne de caractères imprimables (a-z, A-Z, 1-9,…)
Quinze attributs complètent l’élément "string" : "id", "ref", "ilk", "aclLevel", "index", "description", "editable", "content", "technicalContent","maxItem", "minItem", "maxLength", "minLength", "separator", "technicalSeparator", e.g.,

<ximf:string ilk="ilk-france" content="FRA" />

* Détails sur les attributs de l'élément "string" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "string".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role| élément role]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut " description " permet d’associer un commentaire sur cette donnée.
** L’attribut "editable" définit une valeur de saisie (champ libre). Cet attribut est de type booléen.
** L’attribut "content" représente la valeur effective de la donnée. C’est cette donnée qui sera associée au champ XIMF créé.
** L’attribut "technicalContent" représente la valeur effective de la donnée technique. C’est cette donnée qui sera associée au champ technique XIMF créé (cf. attribut technicalHeaderName de l’élément "header".
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.

L’élément "string" peut contenir plusieurs éléments "linkedValue".

<ximf:string ilk="ilk-non-protege" content="NON PROTEGE" technicalContent="1" >
<ximf:linkedValue ref="value-non-protege-france " />
</ximf:string>

==== Element compstring ====
<div style="color:red;">
'''TODO :''' L'attribut de l'élément « compstring » nommé « contentFactorise » devrait s'appeler « contentFactorize ».
</div>
L’élément "compstring" décrit un conteneur de concaténation des éléments fils. Il permet notamment de créer des valeurs d’entêtes composées.
Dix-sept attributs complètent l’élément "compstring" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", "content", "technicalContent", "contentPositionEnd", "contentFactorise", "technicalPositionEnd", e.g.,

<ximf:compstring
ilk="ilk-special"
content="SPECIAL"
technicalContent="1.3.4"
separator=" "
technicalSeparator=".">

* Détails sur les attributs de l'élément "compstring" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "compstring".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (cf. [[#Element_role| élément "role"]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut " description " permet d’associer un commentaire sur cette donnée.
** L’attribut "content" représente la valeur effective de la donnée. C’est cette donnée qui sera associée au champ XIMF créé.
** L’attribut "technicalContent" représente la valeur effective de la donnée technique. C’est cette donnée qui sera associée au champ technique XIMF créé (cf. attribut technicalHeaderName de l’élément "header".
** L’attribut "separator" définit le caractère de séparation entre deux valeurs.
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "contentPositionEnd" impose de positionner le contenu de l’élément "compstring" après les valeurs des éléments fils : valuefils1,valuefils2 : valuecompstring.
** L’attribut "technicalPositionEnd" impose de positionner le contenu de l’élément "compstring" après les valeurs des éléments fils.
** L’attribut "contentFactorise" impose d’utiliser le contenu de l’élément "compstring" comme facteur des éléments fils : valuecompstring(valuefils1,valuefils2).

L’élément "compstring" peut contenir un élément "string" ou "set" ou "multiset" ou plusieurs éléments "compstring".

<ximf:compstring
ilk="ilk-special"
content="SPECIAL"
technicalContent="1.3.4"
separator=" "
technicalSeparator=".">
<ximf:set id="ilk-special-op " maxItem="64">
<ximf:string ilk="ilk-special-op1" content="OP1" technicalContent="1" />
<ximf:string ilk="ilk-special-op2" content="OP2" technicalContent="2" />
<ximf:string ilk="ilk-special-op3" content="OP3" technicalContent="3" />
</ximf:set>
</ximf:compstring>

==== Element set ====
L’élément "set" décrit un conteneur de ressources de même type. Cet élément autorise la sélection de plusieurs ressources mais chaque ressource est sélectionnée une seule fois.
Douze attributs précisent la description de la balise "set" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", e.g.,

<ximf:set id="value-categories" ref="value-mentions" maxItem="64" separator=";" />

* Détails sur les attributs de l'élément "set" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "ximf:set".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role|élément rôle]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut "description" permet d’associer un commentaire sur cette donnée.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs

L’élément "set" peut contenir un ou plusieurs éléments "string" ou un ou plusieurs éléments "compstring".

<ximf:set id="value-categories" minItem="1" maxItem="64" separator=";">
<ximf:string ilk="ilk-releasable-to" content="RELEASABLE TO " />
<ximf:string ilk="ilk-eyes-only" content=" EYES ONLY"/>
<ximf:string ilk="ilk-use-only" content=" USE ONLY"/>
</ximf:set>

<div style="color:red;">'''TODO :'''
* Y a-t-il une définition des fichiers associés aux instances XIMF (e.g, le fichier attribution-list.xml utilisé dans l'instance Caterpillar) ?
* Comment le parseur d'instance ximf sait qu'un élément est une "attribution-list" ?
</div>

==== Element multiset ====
L’élément "multiset" décrit un conteneur de ressources de même type. Cet élément autorise la sélection de plusieurs ressources et chaque ressource peut être sélectionnée plusieurs fois.
Douze attributs précisent la description de la balise "multiset" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", e.g.,

<ximf:multiset
id="value-restricted"
ilk=" value-restricted-otan"
maxItem="64"
separator=";" />

* Détails sur les attributs de l'élément "multiset" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "multiset".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role|élément rôle]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut "description" permet d’associer un commentaire sur cette donnée.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs

L’élément "multiset" peut contenir un ou plusieurs éléments "string" ou un ou plusieurs éléments "compstring".

<ximf:multiset id="value-restricted-otan-categories" minItem="1" maxItem="64" separator=";" >
<ximf:string ilk="ilk-releasable-to" content="RELEASABLE TO "/>
<ximf:string ilk="ilk-eyes-only" content=" EYES ONLY"/>
<ximf:string ilk="ilk-use-only" content=" USE ONLY"/>
</ximf:multiset>

<span style="color:red;">'''TODO :''' Comment sont gérées les règles associées aux champs multivaleurs (disposant par exemple des attributs minItem/maxItem ou les champs multiset) ?</span>

==== Element linkedValue ====
<div style="color: red;">'''TODO ''': L'élément linkedValue indique quelle ressource utiliser lors de la sélection d'un élément particulier mais il n'indique pas où la ressource devra être utilisée.
* Est-ce que cela correspond toujours au header suivant ?
* Pourquoi avoir fait ce choix au lieu d'ajouter un attribut supplémentaire ?
</div>

L’élément "linkedValue" définit une référence sur une ressource de type conteneur ("set", "multiset") ou "string". Cette ressource devrait être utilisée si la ressource contenant "linkedValue" (noeud parent) est sélectionnée.
Un attribut précise la balise "linkvalue" : "ref", e.g.,

<ximf:linkedValue ref="value-restricted-otan-classification-id" />

* Détails sur les attributs de l'élément "linkedValue" :
** L’attribut "ref" précise la valeur de l’attribut "id" de la ressource cible. Cet attribut est obligatoire.

=== Fichier rules ===
Le fichier rules définit les règles de contrôles d’entêtes XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui peut contenir des éléments "ximf:rule".

==== Element rule ====
<div style="color:red">
'''TODO :''' Mettre à jour la documentation :
* Les éléments autorisés dans un élément « rule » ne sont plus à jour. La présente documentation spécifie 12 éléments : AliasHeader, AliasValue, Compatibility, Association, SecureHeaders, SecurityLabel, Constraint, Assignment, Processing, Accessibility, Role et Custom. Le schéma XML fourni avec le mail en spécifie 5 : Constraint, Processing, Compatibility, Policy et Custom et place les autres en tant qu'extentions des 5 éléments cités précédemment.
* Les éléments SecureHeaders et SecurityLabel associés à l'élément « rule » dans la version ci-dessus ne figurent plus dans la nouvelle version. On les retrouve dans les fichiers rules-*.xml mais les éléments sont commentés. En revanche, ils sont bien présents dans une autre instance : s'agit-il d'une fonctionnalité non-documentée ou plus documentée ?
* L'élément ximf:classificationPictures n'est pas documenté. De plus, il serait bon d'avoir des précisions sur la raison qui a motivé l'ajout de cet élément dans les fichiers de règles (alors qu'il semblerait être plus adapté au fichier headers-*.xml).
</div>
L’élément "rule" est le conteneur principal de description d’un comportement particulier à appliquer sur un ensemble d’entêtes XIMF.
Trois attributs précisent la balise "rule" : "id", "agent", "description", e.g.,
<ximf:rule id="compatibility-rule" description="Règle sur la compatibilité X-SMTP / XIMF" >

* Détails sur les attributs de l'élément "rule" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "rule". Cet attribut est obligatoire.
** L’attribut "agent" indique l’équipement cible devant analyser et appliquer le contenu de cet élément.
** L’attribut "description" autorise l’auteur d’ajouter un commentaire sur cet élément.

L’élément "rule" contient un ou plusieurs mêmes éléments de spécialisation de la règle "contraint", "assignement", "processing", "compatibility", "accessibility", "custom",…, e.g.,

<ximf:rule id="precedence-rule" agent="mua" description="Règle sur les priorités">
<ximf:constraint
left="header-primary-precedence"
operator="equalOrGreaterThan"
right="header-copy-precedence" />
</ximf:rule>

==== Element aliasHeader ====
L’élément "aliasHeader" permet de définir le nom de l’entête sur lequel la règle précisée est appliquée
Deux attributs précisent la balise "aliasHeader" : "headerName" et "headerRef", e.g.,

<ximf:aliasHeader headerName ="X-P772-Version" headerRef="X-XIMF-VERSION" />

* Détails sur les attributs de l'élément "aliasHeader" :
* L’attribut "headerName" définit le nom XIMF de l’entête modifié par la règle. Cet attribut est obligatoire.
* L’attribut "headerRef" définit le nom d’un entête XIMF de référence qui est le point d’entrée de l’application de la règle sur l’entête définit par "headerName". Cela permet de lier deux entêtes de messages où l’utilisation de l’un des entêtes influe sur le comportement de l’autre.

L’élément "aliasHeader" peut contenir des éléments "aliasValue",e.g ,

<ximf:aliasHeader headerName="X-P772-Version" />
<ximf:aliasValue vame="1.0"/>
<ximf:aliasHeader>

==== Element aliasValue ====
L’élément "aliasValue" contient une valeur à associer à l’entête XIMF contrôlé par la règle. Il est utile lorsque deux entêtes sont liées (utilisation de l’attribut headerRef dans l’élément aliasHeader) et que les valeurs de l’entêtes de référence permettent de préciser celles de l’entête contrôlé.
Deux attributs précisent la balise "aliasValue" : "valueName", "valueRef", e.g.,

<ximf:aliasValue valueName="2" valueRef ="flash" />

* Détails sur les attributs de l'élément "aliasValue" :
** L’attribut "valueName" définit la valeur de l’entête à créer. Cet attribut est obligatoire.
** L’attribut "valueRef" définit la valeur de l’entête XIMF de référence pour utiliser valueName.
<span style="color:red;">'''TODO :''' L'attribut valueRef est-il obligatoire ?</span>

==== Element compatibility ====
L’élément "compatibility" est utilisé pour associer à un entête respectant la norme XIMF un entête respectant une autre norme que XIMF (XSMTP par exemple).
Deux attributs précisent la balise "compatibility" : "targetName", "targetVersion", e.g.,

<ximf:compatibility targetName="X-SMTP" targetVersion="1.1">
<ximf:aliasValue headerName="X-P772-Version" content="1.1" />
<ximf:aliasValue
headerName="X-P772-Primary-Precedence"
headerRef="header-primary-precedence"
dataRef="data-priority-xsmtp"/>
</ximf:compatibility>

* Détails sur les attributs de l'élément "compatibility" :
** L’attribut "targetName" définit la norme de l’entête à associer à l’entête XIMF. Cet attribut est obligatoire.
** L’attribut "targetVersion" définit le numéro de version de la norme de l’entête à associer à l’entête XIMF. Cet attribut est obligatoire.

L’élément "compatibility" contient au moins un élément "aliasHeader".

<u>Pour illustrer cette règle :</u>
Le format XSMTP est déjà supporté par certains équipements. Afin de rendre ceux-ci inter opérables avec le nouveau format XIMF, cette règle permet d’associer un entête XSMTP contenant les mêmes informations qu’un entête XIMF.

L’élément Association : dépendance entre entêtes
L’élément "association" définie les valeurs autorisées pour un entête XIMF en fonction d’une valeur définie pour un autre entête XIMF.

<ximf:association>
<ximf:aliasHeader
headerName="X-XIMF-Primary-Precedence"
headerRef="X-XIMF-Correspondence-Type">
<ximf:aliasValue valueName="routine" valueRef="private" />
<ximf:aliasValue valueName="routine,priority" valueRef="professional" />
<ximf:aliasValue valueName="routine,priority,immediate,flash" valueRef="operational" />
<ximf:aliasValue valueName="routine,priority,immediate" valueRef="official" />
</ximf:aliasHeader>
</ximf:association>

==== Element secureHeaders ====
<div style="color:red;">'''TODO :''' Les éléments SecureHeaders et SecurityLabel associés à l'élément « rule » dans la version ci-dessus ne figurent plus dans le shéma xml. On les retrouve dans les fichiers rules-*.xml mais les éléments sont commentés. En revanche, ils sont bien présents dans une autre instance : s'agit-il d'une fonctionnalité non-documentée ou plus documentée ?</div>
L’élément "secureHeaders" définie la liste des entêtes à intégrer dans la signature d’un message. Cette règle s’applique sur les équipements proposant un algorithme de signature des messages.

Un élément "secureHeaders" contient un ou plusieurs éléments "aliasHeaders" où chaque élément décrit un entête à intégrer dans la signature et complété d’un attribut "status".

<ximf:secureHeaders targetName="SecureHeaders">
<ximf:aliasHeader headerName="X-XIMF-Primary-Precedence" status="0" />
<ximf:aliasHeader headerName="X-XIMF-Copy-Precedence" status="0" />
</ximf:secureHeaders>

==== Element securityLabel ====
L’élément "securityLabel" définie la liste des entêtes à intégrer dans la signature d’un message. Cette règle s’applique sur les équipements proposant un algorithme de signature des messages selon la norme RFC.

Un élément "securityLabel" contient un ou plusieurs éléments "aliasHeaders" où chaque élément décrit un entête à intégrer dans la signature et complété d’un attribut "status".

<ximf:securityLabel targetName="SecurityLabel" id="Amoco">
<ximf:aliasHeader
headerName="SecurityPolicyIdentifier"
headerRef="X-XIMF-Security-Policy-Identifier" />
<ximf:aliasHeader
headerName="SecurityClassification"
headerRef="X-XIMF-Security-Classification-Identifier" />
<ximf:aliasHeader
headerName="ESSPrivacyMark"
headerRef="X-XIMF-Privacy-Mark" />
<ximf:aliasHeader
headerName="SecurityCategory"
headerRef="X-XIMF-Security-Categories-Identifier"
type="2" />
</ximf:securityLabel>

==== Element constraint ====
L’élément "constraint" est utilisé pour définir une règle de construction de deux entêtes partageant des "datas" identiques.
Trois attributs précisent la balise "constraint" : "left", "right", "operator", e.g.,

<ximf:constraint
left="header-primary-precedence"
operator="equalOrGreaterThan"
right="header-copy-precedence" />

* Détails sur les attributs de l'élément "constraint" :
** L’attribut "left" désigne le premier élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "right" désigne le deuxième élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "operator" indique la règle de poids à appliquer sur la valeur des deux éléments "header", il peut être de type "greaterThan", "lowerThan", "equalOrGreaterThan", "equalOrLowerThan", "equal". Cet attribut est obligatoire.

* Détails sur les valeurs possibles de l'attribut "type" :
** Le type "greaterThan" signifie que la valeur de l’élément "left" doit être strictement supérieur à la valeur de l’élément "right".
** Le type "lowerThan" signifie que la valeur de l’élément "left" doit être strictement inférieur à la valeur de l’élément "right".
** Le type "equalOrGreaterThan" signifie que la valeur de l’élément "left" doit être supérieur ou égale à la valeur de l’élément "right".
** Le type "equalOrLowerThan" signifie que la valeur de l’élément "left" doit être inférieur ou égale à la valeur de l’élément "right".
** Le type "equal" signifie que la valeur de l’élément "left" et de l’élément "right" doivent être identiques.

==== Element assignment ====
<div style="color:red;">'''TODO :''' L'élément assignment n'apparaît pas dans le shéma xml qui avait été envoyé.</div>

L’élément "assignement" est utilisé pour affecter une valeur créée en fonction d’une règle de comparaison sur les valeurs de deux éléments "header".
Quatre attributs précisent la balise "assignement" : "left", "right", "operator", "result", e.g.,

<ximf:assignment
left="header-primary-precedence"
operator="equal"
right="data-routine-precedence"
result="86400" />

* Détails sur les attributs de l'élément "assignment" :
** L’attribut "left" désigne le premier élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "right" désigne le deuxième élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "operator" indique la règle de comparaison entre les valeurs des deux éléments "header", il peut être de type "greaterThan", "lowerThan", "equalOrGreaterThan", "equalOrLowerThan", "equal". Cet attribut est obligatoire.
** L’attribut "result" représente la valeur à utiliser si la règle de comparaison entre les deux éléments est satisfaite. Cet attribut est obligatoire.

==== Element processing ====
L’élément "processing" regroupe des règles de traitement à effectuer sur des entêtes formatés.
L’attribut "type" précise le type de traitement à effectuer sur ces valeurs. Cet attribut est obligatoire, il est de type : "sign-header-value", "encrypt-header-value", "capitalize-header-value", e.g.,

<ximf:processing type="sign-header-value">
<ximf:refHeader>header-primary-precedence</ximf:refheader>
<ximf:refHeader>header-copy-precedence</ximf:refheader>
<ximf:refHeader>header-echange-type</ximf:refheader>
</ximf:processing>

* Détails sur les valeurs possibles de l'attribut "type" :
** Le type "sign-header-value" définit un traitement de signature des entêtes définis dans la balise.
** Le type "encrypt-header-value" définit un traitement de chiffrement des entêtes définis dans la balise.
** Le type "capitalize-header-value" définit un traitement de capitalisation des entêtes définis dans la balise.

L’élément "processing" contient au moins un élément "refHeader".
<div style="color:red;">'''TODO :'''L'élément refHeader n'est pas documenté, s'agit-il en fait de l'élément headerRef ?</div>

==== Element accessibility ====
<div style="color:red;">'''TODO :''' L'élément accessibility n'apparaît pas dans le shéma xml qui avait été envoyé.</div>
L’élément "accessibility" définit un ensemble de règles de droit d’accès aux éléments d’une instance pour une cible déterminée (utilisateur, routeur…).
Cet élément contient un ou plusieurs éléments "role".

<ximf:accessibility>
<ximf:role id="role-flash-allowed" aclLevel="100" />
<ximf:role id="role-flash-prohibited" aclLevel="50" />
</ximf:accessibility>

==== Element role ====
L’élément "role" positionne une valeur d’accès à pour une entité définit.
Deux attributs complètent l’élément "role" : "id", "aclLevel", e.g.,

<ximf:role id="role-flash-allowed" aclLevel="100" />

* Détails sur les attributs de l'élément "role" :
** L’attribut "id" précise l’entité accessible en fonction d’une valeur déterminée.
** L’attribut "aclLevel" précise la valeur seuil d’accès à l’entité.

==== Element custom ====
L’élément "custom" permet à l’auteur de créer des nouvelles règles personnalisées.
Trois attributs précisent la balise "custom" : "id", "provider", "description", e.g.,

<ximf:custom
id="custom-display"
provider="EADS"
description="Affichage de la composition du message" >
<node1><node2><node3></node3></node2></node1>
</ximf:custom>

* Détails sur les attributs de l'élément "custom" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "custom" et formaté selon la syntaxe "custom-xxx". Cet attribut est obligatoire.
** L’attribut "provider" identifie l’auteur de la règle. Cet attribut est obligatoire.
** L’attribut "description" permet d’ajouter un commentaire sur cet élément.

L’élément "custom" peut contenir tous les éléments possibles en respectant les standards XML.

XIMF XML tags/fr

2011-02-25T13:34:25Z

Anthonyjuge :

== Introduction ==
Ce document propose un modèle de description, via eXtensible Markup Language (XML), d’entêtes de messages électroniques respectant la norme XIMF. Ce document a deux objectifs :
# Décrire les éléments et attributs de représentation XML pour construire des entêtes de messages électroniques de format XIMF.
# Fournir un modèle de représentation XIMF/XML.

<u>Rappel :</u>
* Un "élément" fait référence à tous les caractères situés entre une balise de départ et un balise de fin, e.g.,
<exemple> texte et/ou éléments fils </exemple>
* Un "attribut" est une composante d’un élément. Il est positionné dans la balise de départ, e.g.,
<exemple nom='value'>

Tous les éléments décrits dans cette documentation paragraphe sont validés dans l’espace de nom "ximf".

<pre>
xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://eads.org/ximf/ximf.xsd"
</pre>

== Description détaillée des balises XML ==

Voici, par ordre d'apparition et en fonction des fichiers, les balises génériques associées aux différents fichiers XML.

=== Fichier ximfmail-profile ===

<div style="color:red;">'''TODO''' :
* Combien d'éléments ihm sont autorisés dans un élément instance ?
* La documentation des fichiers ximfmail-profile.xml n'est pas disponible. Est-il possible d'avoir accès au fichier ximf_profile.xsd mentionné dans les ximfmail-profile.xml ?
</div>

Un fichier xpi peut contenir plusieurs instances XIMF, celles-ci sont alors regroupées dans une même catégorie. Le fichier ximfmail-profile contient des informations sur toutes les instances contenues dans le xpi, notamment leur nom, leur chemin d'accès, ainsi que les noms des fichiers associés à chaque instance.

==== Element instance ====
L’élément "instance" identifie l’ensemble des entêtes à décrire selon la norme XIMF. C’est le conteneur principal d’une instance XIMF/XML. Cinq attributs précisent la balise "instance" : "ximfVersion", "version", "author", "creation", "name", e.g.,
<ximf:instance name="myInstance" version="1.0" ximfVersion="2.0" >

* Détails sur les attributs de l'élément "instance" :
** L’attribut "name" définit le nom de l’instance décrite. Cet attribut est obligatoire.
** L’attribut "ximfVersion" définit le numéro de version des entêtes XIMF utilisés pour cette représentation. Cet attribut est obligatoire.
** L’attribut "version" définit le numéro de version de l’instance décrite. Cet attribut est obligatoire.
** L’attribut "author" renseigne sur le nom de l’auteur de cette instance.
** L’attribut "creationDate" précise la date de création de cette instance.

L’élément "instance" peut contenir un ou plusieurs éléments "schema", un ou plusieurs éléments "rule", un élément "ihm" et un élément "dictionary".

==== Element dictionary ====
L'élément dictionary contient le chemin vers le fichier spécifiant les données d'internationalisation (Cf. [[#Fichier_dictionary|Fichier dictionary]]).

==== Element schema ====
L'élément shema contient le chemin vers le fichier spécifiant les entêtes XIMF (Cf. [[#Fichier_headers|Fichier headers]]).

==== Element ihm ====
L'élément ihm contient le chemin vers le fichier spécifiant la disposition de l'interface des formulaires XIMF (Cf. [[#Fichier_ihm|Fichier ihm]]).

==== Element rule ====
L'élément rule contient le chemin vers le fichier spécifiant les règles associées aux valeurs des champs XIMF (Cf. [[#Fichier_rules|Fichier rules]]).

=== Fichier dictionary ===
Le fichier dictionnary permet de mettre en œuvre l’internationalisation d’une instance XIMF. Il défini des dictionnaires qui servent à traduire les éléments de l'instance XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient un élément "ximf:dictionnary".

==== Element dictionary ====
<div style="color:red;">'''TODO''' :
* Est-il obligé de renseigner les données d'internationalisation pour <u>tous</u> les labels ? (ce n'est actuellement pas le cas dans l'instance Whirlpool)
* Quel est l'intérêt de renseigner un attribut "id" à l'élément "dictionary" (étant donné qu'un seul élément "dictionary n'est autorisé dans l'élément "instance") ?</div>

L’élément "dictionary" contient toutes les informations devant être interprétées selon le pays d’utilisation.
L’élément "dictionary" contient un ou plusieurs mêmes éléments "locale", e.g.,

<ximf:dictionary>
<ximf:locale lang="fr-FR" />
<ximf:locale lang="en-US" />
</ximf:dictionary>

==== Element locale ====
L’élément "locale" contient toutes les informations pour un pays et/ou langue désignée.
L’élément "locale" contient un ou plusieurs mêmes éléments "ilk", e.g.,

<ximf:locale lang="fr-FR" >
<ximf:ilk entity="a"/>
<ximf:ilk entity="b"/>
</ximf:locale>

* Détails sur les attributs de la balise "locale" :
** L’attribut "lang" définit le code pays de ce conteneur. Il devrai être construit selon le format défini par la RFC1766 (fr, en, ja, es, …).

==== Element ilk ====
L’élément "ilk" contient une unique information correspondant à une donnée traduite selon le code pays de l’élément père. Cette information est au format chaîne de caractère. Un attribut obligatoire précise la balise "ilk".

<ximf:ilk entity="ilk-lang-ihm">langue</ximf:ilk>

* Détails sur les attributs de la balise "ilk" :
** L’attribut "entity" définit la référence d’entrée pour récupérer le contenu de l’élément selon le code pays souhaité.

Finalement, le fichier "dictionary" pourra contenir :
<ximf:instance name="Whirlpool">
<ximf:dictionary>
<ximf:locale lang="fr-FR" >
<ximf:ilk entity="ilk-lang-ihm">Français</ximf:ilk>
<ximf:ilk entity="ilk-exemple-general">Général</ximf:ilk>
</ximf:locale>
<ximf:locale lang="en-US" >
<ximf:ilk entity="ilk-lang-ihm">English (US)</ximf:ilk>
<ximf:ilk entity="ilk-exemple-general">General</ximf:ilk>
</ximf:locale>
</ximf:dictionary>
</ximf:instance>

=== Fichier ihm ===
<span style="color:red;">'''TODO''' : La documentation originale ne décrit pas le fichier ihm, les informations ci-dessous ont seulement été présumées. Merci de les vérifier/compléter.
</span>

Le fichier ihm spécifie l'agencement de l'interface des formulaires XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient un élément "ximf:ihm".

==== Element ihm ====
L'élément "ihm" contient un ou plusieurs éléments "panel" et un élément "treeRcv".

==== Element panel ====
Un élément ximf:panel correspond à un onglet du formulaire XIMF construit.
Deux attributs précisent la balise "panel" : "id" et "ilk", eg.
<ximf:panel id="pane_security" ilk="ilk-priority-panel" />

* Détails sur les attributs de l'élément "panel" :
** L’attribut "id" définit le nom de l'onglet, il doit être unique pour chaque élément "ximf:panel" et est formaté selon la syntaxe "pane-xxx". Cet attribut est obligatoire.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.

L'élément "ximf:panel" contient au moins un éléments "ximf:groupbox".

==== Element groupbox ====
Un élément groupbox correspond à une sous catégorie d'un onglet du formulaire XIMF.
La structure "groupbox" détaille l’ordre d’affichage des entêtes dans un message.
Deux attributs précisent la balise "ximf:groupbox" : "id" et "ilk", eg.
<ximf:groupbox id="group-classification" ilk="ilk-secu-box" />

* Détails sur les attributs de l'élément "groupbox" :
** L’attribut "id" définit le nom de l'onglet, il doit être unique pour chaque élément "ximf:panel" et est formaté selon la syntaxe "pane-xxx". Cet attribut est obligatoire.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.

L'élément "groupbox" contient au moins un éléments "headerRef".

==== Element treeRcv ====
L'élément "treeRcv" permet de spécifier quelles sont les colonnes susceptibles d'être ajoutées dans le panneau principal du client de messagerie qui contient la liste des messages d’un dossier.

L'élément "treeRcv" peut contenir des éléments "headerRef".

==== Element headerRef ====
L'élément headerRef spécifie les champs associés à chaque sous-groupe d'onglet de formulaire ou les champs qu'il est possible d'afficher dans la liste des messages.
Aucun attribut ne vient compléter la balise "headerRef", eg.
<ximf:headerRef>header-classification</ximf:headerRef>

Finalement, le fichier "ihm" pourra contenir :
<pre>
<ximf:instance name="Amoco">
<ximf:ihm>
<ximf:panel id="pane_security" ilk="ilk-priority-panel">
<ximf:groupbox id="group-classification" ilk="ilk-secu-box">
<ximf:headerRef>header-correspondance-type</ximf:headerRef>
<ximf:headerRef>header-classification</ximf:headerRef>
</ximf:groupbox>
</ximf:panel>
<ximf:treeRcv>
<ximf:headerRef>header-classification</ximf:headerRef>
</ximf:treeRcv>
</ximf:ihm>
</ximf:instance>
</pre>

=== Fichier headers ===
Le fichier headers spécifie les types des champs de l'interface des formulaires XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient des éléments "header".

<div style="color:red">'''TODO :'''
Il semble que les fichiers headers définissent des entêtes devant être envoyées alors que ces mêmes entêtes ne sont pas spécifiés dans le fichier ihm. Ce comportement est logique (l'utilisateur n'a pas forcément besoin de savoir tout ce qui est envoyé via le formulaire. Cependant, comment est-il possible de savoir quels entêtes doivent être envoyés ?
</div>

==== Element header ====
Chaque élément "header" décrit un entête de message de format XIMF.
Huit attributs précisent la balise "header" : "headerName", "id", "technicalHeaderName", "type", "technicalType", "isMandatory", "ilk", "description", e.g.,

<div style="color:red;">'''TODO :'''
Comment est effectuée la vérification de l'attribut isMandatory et quelles sont les conditions de fonctionnement de celui-ci ? Est-il possible, par exemple, de spécifier l'attribut isMandatory=true d'un élément header si le contenu de celui-ci est un élément « set » qui dispose des attributs minItem et maxItem ?Actuellement, lorsque l'on crée un élément set avec les attributs minItem et maxItem, le champ du formulaire associé ne peux pas être validé (Est-ce un bug ?) : e.g.,
<ximf:set id="value-amoco-classification" minItem="1" maxItem="64" separator=";" technicalSeparator=".">
</div>

<ximf:header id="header-primary-precedence"
headerName="X-XIMF-Primary-Precedence"
ilk="ilk-primary-precedence"
isMandatory="true"
description="entête d’urgence"
type="string" />

* Détails sur les attributs de l'élément "header" :
** L’attribut "headerName" définit le nom du champ XIMF. Cet attribut est obligatoire.
** L’attribut "id" définit un identifiant de champ, il doit être unique pour chaque élément "header" et est formaté selon la syntaxe "header-xxx". Cet attribut est obligatoire.
** L’attribut "isMandatory" précise si ce champ doit être obligatoirement présent dans le message intégrant les entêtes selon cette description.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.
** L’attribut "type" précise le format des données associées à cet élément. Ce format peut être une date, une chaîne, une adresse mail, un O.I.D.
** L’attribut "technicalHeaderName" permet de compléter l’entête décrit par un autre entête.
** L’attribut "technicalType" précise le format des données associées à l’élément technicalHeaderName.
** L’attribut "description" permet d’ajouter une information sur cet élément.

L’élément "header" contient obligatoirement un élément "set", "multiset", "string", ou "compstring", e.g.,

<ximf:header id="header-reply-by"
headerName="X-XIMF-Reply-By"
ilk="ilk-reply-by"
isMandatory="false" >
<ximf:string id="value-reply-by" editable="true" />
</ximf:header>

<div style="color:red;">
'''TODO :''' Quelles sont les contraintes associées à l'attribut type d'un élément header ?
</div>

==== Element string ====
L’élément "string" précise le contenu d’une ressource de type chaîne de caractères imprimables (a-z, A-Z, 1-9,…)
Quinze attributs complètent l’élément "string" : "id", "ref", "ilk", "aclLevel", "index", "description", "editable", "content", "technicalContent","maxItem", "minItem", "maxLength", "minLength", "separator", "technicalSeparator", e.g.,

<ximf:string ilk="ilk-france" content="FRA" />

* Détails sur les attributs de l'élément "string" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "string".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_ximf:role| élément role]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut " description " permet d’associer un commentaire sur cette donnée.
** L’attribut "editable" définit une valeur de saisie (champ libre). Cet attribut est de type booléen.
** L’attribut "content" représente la valeur effective de la donnée. C’est cette donnée qui sera associée au champ XIMF créé.
** L’attribut "technicalContent" représente la valeur effective de la donnée technique. C’est cette donnée qui sera associée au champ technique XIMF créé (cf. attribut technicalHeaderName de l’élément "header".
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.

L’élément "string" peut contenir plusieurs éléments "linkedValue".

<ximf:string ilk="ilk-non-protege" content="NON PROTEGE" technicalContent="1" >
<ximf:linkedValue ref="value-non-protege-france " />
</ximf:string>

==== Element compstring ====
<div style="color:red;">
'''TODO :''' L'attribut de l'élément « compstring » nommé « contentFactorise » devrait s'appeler « contentFactorize ».
</div>
L’élément "compstring" décrit un conteneur de concaténation des éléments fils. Il permet notamment de créer des valeurs d’entêtes composées.
Dix-sept attributs complètent l’élément "compstring" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", "content", "technicalContent", "contentPositionEnd", "contentFactorise", "technicalPositionEnd", e.g.,

<ximf:compstring
ilk="ilk-special"
content="SPECIAL"
technicalContent="1.3.4"
separator=" "
technicalSeparator=".">

* Détails sur les attributs de l'élément "compstring" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "compstring".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (cf. [[#Element_role| élément "role"]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut " description " permet d’associer un commentaire sur cette donnée.
** L’attribut "content" représente la valeur effective de la donnée. C’est cette donnée qui sera associée au champ XIMF créé.
** L’attribut "technicalContent" représente la valeur effective de la donnée technique. C’est cette donnée qui sera associée au champ technique XIMF créé (cf. attribut technicalHeaderName de l’élément "header".
** L’attribut "separator" définit le caractère de séparation entre deux valeurs.
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "contentPositionEnd" impose de positionner le contenu de l’élément "compstring" après les valeurs des éléments fils : valuefils1,valuefils2 : valuecompstring.
** L’attribut "technicalPositionEnd" impose de positionner le contenu de l’élément "compstring" après les valeurs des éléments fils.
** L’attribut "contentFactorise" impose d’utiliser le contenu de l’élément "compstring" comme facteur des éléments fils : valuecompstring(valuefils1,valuefils2).

L’élément "compstring" peut contenir un élément "string" ou "set" ou "multiset" ou plusieurs éléments "compstring".

<ximf:compstring
ilk="ilk-special"
content="SPECIAL"
technicalContent="1.3.4"
separator=" "
technicalSeparator=".">
<ximf:set id="ilk-special-op " maxItem="64">
<ximf:string ilk="ilk-special-op1" content="OP1" technicalContent="1" />
<ximf:string ilk="ilk-special-op2" content="OP2" technicalContent="2" />
<ximf:string ilk="ilk-special-op3" content="OP3" technicalContent="3" />
</ximf:set>
</ximf:compstring>

==== Element set ====
L’élément "set" décrit un conteneur de ressources de même type. Cet élément autorise la sélection de plusieurs ressources mais chaque ressource est sélectionnée une seule fois.
Douze attributs précisent la description de la balise "set" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", e.g.,

<ximf:set id="value-categories" ref="value-mentions" maxItem="64" separator=";" />

* Détails sur les attributs de l'élément "set" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "ximf:set".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role|élément rôle]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut "description" permet d’associer un commentaire sur cette donnée.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs

L’élément "set" peut contenir un ou plusieurs éléments "string" ou un ou plusieurs éléments "compstring".

<ximf:set id="value-categories" minItem="1" maxItem="64" separator=";">
<ximf:string ilk="ilk-releasable-to" content="RELEASABLE TO " />
<ximf:string ilk="ilk-eyes-only" content=" EYES ONLY"/>
<ximf:string ilk="ilk-use-only" content=" USE ONLY"/>
</ximf:set>

<div style="color:red;">'''TODO :'''
* Y a-t-il une définition des fichiers associés aux instances XIMF (e.g, le fichier attribution-list.xml utilisé dans l'instance Caterpillar) ?
* Comment le parseur d'instance ximf sait qu'un élément est une "attribution-list" ?
</div>

==== Element multiset ====
L’élément "multiset" décrit un conteneur de ressources de même type. Cet élément autorise la sélection de plusieurs ressources et chaque ressource peut être sélectionnée plusieurs fois.
Douze attributs précisent la description de la balise "multiset" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", e.g.,

<ximf:multiset
id="value-restricted"
ilk=" value-restricted-otan"
maxItem="64"
separator=";" />

* Détails sur les attributs de l'élément "multiset" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "multiset".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role|élément rôle]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut "description" permet d’associer un commentaire sur cette donnée.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs

L’élément "multiset" peut contenir un ou plusieurs éléments "string" ou un ou plusieurs éléments "compstring".

<ximf:multiset id="value-restricted-otan-categories" minItem="1" maxItem="64" separator=";" >
<ximf:string ilk="ilk-releasable-to" content="RELEASABLE TO "/>
<ximf:string ilk="ilk-eyes-only" content=" EYES ONLY"/>
<ximf:string ilk="ilk-use-only" content=" USE ONLY"/>
</ximf:multiset>

<span style="color:red;">'''TODO :''' Comment sont gérées les règles associées aux champs multivaleurs (disposant par exemple des attributs minItem/maxItem ou les champs multiset) ?</span>

==== Element linkedValue ====
<div style="color: red;">'''TODO ''': L'élément linkedValue indique quelle ressource utiliser lors de la sélection d'un élément particulier mais il n'indique pas où la ressource devra être utilisée.
* Est-ce que cela correspond toujours au header suivant ?
* Pourquoi avoir fait ce choix au lieu d'ajouter un attribut supplémentaire ?
</div>

L’élément "linkedValue" définit une référence sur une ressource de type conteneur ("set", "multiset") ou "string". Cette ressource devrait être utilisée si la ressource contenant "linkedValue" (noeud parent) est sélectionnée.
Un attribut précise la balise "linkvalue" : "ref", e.g.,

<ximf:linkedValue ref="value-restricted-otan-classification-id" />

* Détails sur les attributs de l'élément "linkedValue" :
** L’attribut "ref" précise la valeur de l’attribut "id" de la ressource cible. Cet attribut est obligatoire.

=== Fichier rules ===
Le fichier rules définit les règles de contrôles d’entêtes XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui peut contenir des éléments "ximf:rule".

==== Element rule ====
<div style="color:red">
'''TODO :''' Mettre à jour la documentation :
* Les éléments autorisés dans un élément « rule » ne sont plus à jour. La présente documentation spécifie 12 éléments : AliasHeader, AliasValue, Compatibility, Association, SecureHeaders, SecurityLabel, Constraint, Assignment, Processing, Accessibility, Role et Custom. Le schéma XML fourni avec le mail en spécifie 5 : Constraint, Processing, Compatibility, Policy et Custom et place les autres en tant qu'extentions des 5 éléments cités précédemment.
* Les éléments SecureHeaders et SecurityLabel associés à l'élément « rule » dans la version ci-dessus ne figurent plus dans la nouvelle version. On les retrouve dans les fichiers rules-*.xml mais les éléments sont commentés. En revanche, ils sont bien présents dans une autre instance : s'agit-il d'une fonctionnalité non-documentée ou plus documentée ?
* L'élément ximf:classificationPictures n'est pas documenté. De plus, il serait bon d'avoir des précisions sur la raison qui a motivé l'ajout de cet élément dans les fichiers de règles (alors qu'il semblerait être plus adapté au fichier headers-*.xml).
</div>
L’élément "rule" est le conteneur principal de description d’un comportement particulier à appliquer sur un ensemble d’entêtes XIMF.
Trois attributs précisent la balise "rule" : "id", "agent", "description", e.g.,
<ximf:rule id="compatibility-rule" description="Règle sur la compatibilité X-SMTP / XIMF" >

* Détails sur les attributs de l'élément "rule" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "rule". Cet attribut est obligatoire.
** L’attribut "agent" indique l’équipement cible devant analyser et appliquer le contenu de cet élément.
** L’attribut "description" autorise l’auteur d’ajouter un commentaire sur cet élément.

L’élément "rule" contient un ou plusieurs mêmes éléments de spécialisation de la règle "contraint", "assignement", "processing", "compatibility", "accessibility", "custom",…, e.g.,

<ximf:rule id="precedence-rule" agent="mua" description="Règle sur les priorités">
<ximf:constraint
left="header-primary-precedence"
operator="equalOrGreaterThan"
right="header-copy-precedence" />
</ximf:rule>

==== Element aliasHeader ====
L’élément "aliasHeader" permet de définir le nom de l’entête sur lequel la règle précisée est appliquée
Deux attributs précisent la balise "aliasHeader" : "headerName" et "headerRef", e.g.,

<ximf:aliasHeader headerName ="X-P772-Version" headerRef="X-XIMF-VERSION" />

* Détails sur les attributs de l'élément "aliasHeader" :
* L’attribut "headerName" définit le nom XIMF de l’entête modifié par la règle. Cet attribut est obligatoire.
* L’attribut "headerRef" définit le nom d’un entête XIMF de référence qui est le point d’entrée de l’application de la règle sur l’entête définit par "headerName". Cela permet de lier deux entêtes de messages où l’utilisation de l’un des entêtes influe sur le comportement de l’autre.

L’élément "aliasHeader" peut contenir des éléments "aliasValue",e.g ,

<ximf:aliasHeader headerName="X-P772-Version" />
<ximf:aliasValue vame="1.0"/>
<ximf:aliasHeader>

==== Element aliasValue ====
L’élément "aliasValue" contient une valeur à associer à l’entête XIMF contrôlé par la règle. Il est utile lorsque deux entêtes sont liées (utilisation de l’attribut headerRef dans l’élément aliasHeader) et que les valeurs de l’entêtes de référence permettent de préciser celles de l’entête contrôlé.
Deux attributs précisent la balise "aliasValue" : "valueName", "valueRef", e.g.,

<ximf:aliasValue valueName="2" valueRef ="flash" />

* Détails sur les attributs de l'élément "aliasValue" :
** L’attribut "valueName" définit la valeur de l’entête à créer. Cet attribut est obligatoire.
** L’attribut "valueRef" définit la valeur de l’entête XIMF de référence pour utiliser valueName.
<span style="color:red;">'''TODO :''' L'attribut valueRef est-il obligatoire ?</span>

==== Element compatibility ====
L’élément "compatibility" est utilisé pour associer à un entête respectant la norme XIMF un entête respectant une autre norme que XIMF (XSMTP par exemple).
Deux attributs précisent la balise "compatibility" : "targetName", "targetVersion", e.g.,

<ximf:compatibility targetName="X-SMTP" targetVersion="1.1">
<ximf:aliasValue headerName="X-P772-Version" content="1.1" />
<ximf:aliasValue
headerName="X-P772-Primary-Precedence"
headerRef="header-primary-precedence"
dataRef="data-priority-xsmtp"/>
</ximf:compatibility>

* Détails sur les attributs de l'élément "compatibility" :
** L’attribut "targetName" définit la norme de l’entête à associer à l’entête XIMF. Cet attribut est obligatoire.
** L’attribut "targetVersion" définit le numéro de version de la norme de l’entête à associer à l’entête XIMF. Cet attribut est obligatoire.

L’élément "compatibility" contient au moins un élément "aliasHeader".

<u>Pour illustrer cette règle :</u>
Le format XSMTP est déjà supporté par certains équipements. Afin de rendre ceux-ci inter opérables avec le nouveau format XIMF, cette règle permet d’associer un entête XSMTP contenant les mêmes informations qu’un entête XIMF.

L’élément Association : dépendance entre entêtes
L’élément "association" définie les valeurs autorisées pour un entête XIMF en fonction d’une valeur définie pour un autre entête XIMF.

<ximf:association>
<ximf:aliasHeader
headerName="X-XIMF-Primary-Precedence"
headerRef="X-XIMF-Correspondence-Type">
<ximf:aliasValue valueName="routine" valueRef="private" />
<ximf:aliasValue valueName="routine,priority" valueRef="professional" />
<ximf:aliasValue valueName="routine,priority,immediate,flash" valueRef="operational" />
<ximf:aliasValue valueName="routine,priority,immediate" valueRef="official" />
</ximf:aliasHeader>
</ximf:association>

==== Element secureHeaders ====
<div style="color:red;">'''TODO :''' Les éléments SecureHeaders et SecurityLabel associés à l'élément « rule » dans la version ci-dessus ne figurent plus dans le shéma xml. On les retrouve dans les fichiers rules-*.xml mais les éléments sont commentés. En revanche, ils sont bien présents dans une autre instance : s'agit-il d'une fonctionnalité non-documentée ou plus documentée ?</div>
L’élément "secureHeaders" définie la liste des entêtes à intégrer dans la signature d’un message. Cette règle s’applique sur les équipements proposant un algorithme de signature des messages.

Un élément "secureHeaders" contient un ou plusieurs éléments "aliasHeaders" où chaque élément décrit un entête à intégrer dans la signature et complété d’un attribut "status".

<ximf:secureHeaders targetName="SecureHeaders">
<ximf:aliasHeader headerName="X-XIMF-Primary-Precedence" status="0" />
<ximf:aliasHeader headerName="X-XIMF-Copy-Precedence" status="0" />
</ximf:secureHeaders>

==== Element securityLabel ====
L’élément "securityLabel" définie la liste des entêtes à intégrer dans la signature d’un message. Cette règle s’applique sur les équipements proposant un algorithme de signature des messages selon la norme RFC.

Un élément "securityLabel" contient un ou plusieurs éléments "aliasHeaders" où chaque élément décrit un entête à intégrer dans la signature et complété d’un attribut "status".

<ximf:securityLabel targetName="SecurityLabel" id="Amoco">
<ximf:aliasHeader
headerName="SecurityPolicyIdentifier"
headerRef="X-XIMF-Security-Policy-Identifier" />
<ximf:aliasHeader
headerName="SecurityClassification"
headerRef="X-XIMF-Security-Classification-Identifier" />
<ximf:aliasHeader
headerName="ESSPrivacyMark"
headerRef="X-XIMF-Privacy-Mark" />
<ximf:aliasHeader
headerName="SecurityCategory"
headerRef="X-XIMF-Security-Categories-Identifier"
type="2" />
</ximf:securityLabel>

==== Element constraint ====
L’élément "constraint" est utilisé pour définir une règle de construction de deux entêtes partageant des "datas" identiques.
Trois attributs précisent la balise "constraint" : "left", "right", "operator", e.g.,

<ximf:constraint
left="header-primary-precedence"
operator="equalOrGreaterThan"
right="header-copy-precedence" />

* Détails sur les attributs de l'élément "constraint" :
** L’attribut "left" désigne le premier élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "right" désigne le deuxième élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "operator" indique la règle de poids à appliquer sur la valeur des deux éléments "header", il peut être de type "greaterThan", "lowerThan", "equalOrGreaterThan", "equalOrLowerThan", "equal". Cet attribut est obligatoire.

* Détails sur les valeurs possibles de l'attribut "type" :
** Le type "greaterThan" signifie que la valeur de l’élément "left" doit être strictement supérieur à la valeur de l’élément "right".
** Le type "lowerThan" signifie que la valeur de l’élément "left" doit être strictement inférieur à la valeur de l’élément "right".
** Le type "equalOrGreaterThan" signifie que la valeur de l’élément "left" doit être supérieur ou égale à la valeur de l’élément "right".
** Le type "equalOrLowerThan" signifie que la valeur de l’élément "left" doit être inférieur ou égale à la valeur de l’élément "right".
** Le type "equal" signifie que la valeur de l’élément "left" et de l’élément "right" doivent être identiques.

==== Element assignment ====
<div style="color:red;">'''TODO :''' L'élément assignment n'apparaît pas dans le shéma xml qui avait été envoyé.</div>

L’élément "assignement" est utilisé pour affecter une valeur créée en fonction d’une règle de comparaison sur les valeurs de deux éléments "header".
Quatre attributs précisent la balise "assignement" : "left", "right", "operator", "result", e.g.,

<ximf:assignment
left="header-primary-precedence"
operator="equal"
right="data-routine-precedence"
result="86400" />

* Détails sur les attributs de l'élément "assignment" :
** L’attribut "left" désigne le premier élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "right" désigne le deuxième élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "operator" indique la règle de comparaison entre les valeurs des deux éléments "header", il peut être de type "greaterThan", "lowerThan", "equalOrGreaterThan", "equalOrLowerThan", "equal". Cet attribut est obligatoire.
** L’attribut "result" représente la valeur à utiliser si la règle de comparaison entre les deux éléments est satisfaite. Cet attribut est obligatoire.

==== Element processing ====
L’élément "processing" regroupe des règles de traitement à effectuer sur des entêtes formatés.
L’attribut "type" précise le type de traitement à effectuer sur ces valeurs. Cet attribut est obligatoire, il est de type : "sign-header-value", "encrypt-header-value", "capitalize-header-value", e.g.,

<ximf:processing type="sign-header-value">
<ximf:refHeader>header-primary-precedence</ximf:refheader>
<ximf:refHeader>header-copy-precedence</ximf:refheader>
<ximf:refHeader>header-echange-type</ximf:refheader>
</ximf:processing>

* Détails sur les valeurs possibles de l'attribut "type" :
** Le type "sign-header-value" définit un traitement de signature des entêtes définis dans la balise.
** Le type "encrypt-header-value" définit un traitement de chiffrement des entêtes définis dans la balise.
** Le type "capitalize-header-value" définit un traitement de capitalisation des entêtes définis dans la balise.

L’élément "processing" contient au moins un élément "refHeader".
<div style="color:red;">'''TODO :'''L'élément refHeader n'est pas documenté, s'agit-il en fait de l'élément headerRef ?</div>

==== Element accessibility ====
<div style="color:red;">'''TODO :''' L'élément accessibility n'apparaît pas dans le shéma xml qui avait été envoyé.</div>
L’élément "accessibility" définit un ensemble de règles de droit d’accès aux éléments d’une instance pour une cible déterminée (utilisateur, routeur…).
Cet élément contient un ou plusieurs éléments "role".

<ximf:accessibility>
<ximf:role id="role-flash-allowed" aclLevel="100" />
<ximf:role id="role-flash-prohibited" aclLevel="50" />
</ximf:accessibility>

==== Element role ====
L’élément "role" positionne une valeur d’accès à pour une entité définit.
Deux attributs complètent l’élément "role" : "id", "aclLevel", e.g.,

<ximf:role id="role-flash-allowed" aclLevel="100" />

* Détails sur les attributs de l'élément "role" :
** L’attribut "id" précise l’entité accessible en fonction d’une valeur déterminée.
** L’attribut "aclLevel" précise la valeur seuil d’accès à l’entité.

==== Element custom ====
L’élément "custom" permet à l’auteur de créer des nouvelles règles personnalisées.
Trois attributs précisent la balise "custom" : "id", "provider", "description", e.g.,

<ximf:custom
id="custom-display"
provider="EADS"
description="Affichage de la composition du message" >
<node1><node2><node3></node3></node2></node1>
</ximf:custom>

* Détails sur les attributs de l'élément "custom" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "custom" et formaté selon la syntaxe "custom-xxx". Cet attribut est obligatoire.
** L’attribut "provider" identifie l’auteur de la règle. Cet attribut est obligatoire.
** L’attribut "description" permet d’ajouter un commentaire sur cet élément.

L’élément "custom" peut contenir tous les éléments possibles en respectant les standards XML.

XIMF XML tags/fr

2011-02-25T12:56:14Z

Anthonyjuge : /* Element header */

== Introduction ==
Ce document propose un modèle de description, via eXtensible Markup Language (XML), d’entêtes de messages électroniques respectant la norme XIMF. Ce document a deux objectifs :
# Décrire les éléments et attributs de représentation XML pour construire des entêtes de messages électroniques de format XIMF.
# Fournir un modèle de représentation XIMF/XML.

<u>Rappel :</u>
* Un "élément" fait référence à tous les caractères situés entre une balise de départ et un balise de fin, e.g.,
<exemple> texte et/ou éléments fils </exemple>
* Un "attribut" est une composante d’un élément. Il est positionné dans la balise de départ, e.g.,
<exemple nom='value'>

Tous les éléments décrits dans cette documentation paragraphe sont validés dans l’espace de nom "ximf".

<pre>
xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://eads.org/ximf/ximf.xsd"
</pre>

== Description détaillée des balises XML ==

Voici, par ordre d'apparition et en fonction des fichiers, les balises génériques associées aux différents fichiers XML.

=== Fichier ximfmail-profile ===

<div style="color:red;">'''TODO''' :
* Combien d'éléments ihm sont autorisés dans un élément instance ?
* La documentation des fichiers ximfmail-profile.xml n'est pas disponible. Est-il possible d'avoir accès au fichier ximf_profile.xsd mentionné dans les ximfmail-profile.xml ?
</div>

Un fichier xpi peut contenir plusieurs instances XIMF, celles-ci sont alors regroupées dans une même catégorie. Le fichier ximfmail-profile contient des informations sur toutes les instances contenues dans le xpi, notamment leur nom, leur chemin d'accès, ainsi que les noms des fichiers associés à chaque instance.

==== Element instance ====
L’élément "instance" identifie l’ensemble des entêtes à décrire selon la norme XIMF. C’est le conteneur principal d’une instance XIMF/XML. Cinq attributs précisent la balise "instance" : "ximfVersion", "version", "author", "creation", "name", e.g.,
<ximf:instance name="myInstance" version="1.0" ximfVersion="2.0" >

* Détails sur les attributs de l'élément "instance" :
** L’attribut "name" définit le nom de l’instance décrite. Cet attribut est obligatoire.
** L’attribut "ximfVersion" définit le numéro de version des entêtes XIMF utilisés pour cette représentation. Cet attribut est obligatoire.
** L’attribut "version" définit le numéro de version de l’instance décrite. Cet attribut est obligatoire.
** L’attribut "author" renseigne sur le nom de l’auteur de cette instance.
** L’attribut "creationDate" précise la date de création de cette instance.

L’élément "instance" peut contenir un ou plusieurs éléments "schema", un ou plusieurs éléments "rule", un élément "ihm" et un élément "dictionary".

==== Element dictionary ====
L'élément dictionary contient le chemin vers le fichier spécifiant les données d'internationalisation (Cf. [[#Fichier_dictionary|Fichier dictionary]]).

==== Element schema ====
L'élément shema contient le chemin vers le fichier spécifiant les entêtes XIMF (Cf. [[#Fichier_headers|Fichier headers]]).

==== Element ihm ====
L'élément ihm contient le chemin vers le fichier spécifiant la disposition de l'interface des formulaires XIMF (Cf. [[#Fichier_ihm|Fichier ihm]]).

==== Element rule ====
L'élément rule contient le chemin vers le fichier spécifiant les règles associées aux valeurs des champs XIMF (Cf. [[#Fichier_rules|Fichier rules]]).

=== Fichier dictionary ===
Le fichier dictionnary permet de mettre en œuvre l’internationalisation d’une instance XIMF. Il défini des dictionnaires qui servent à traduire les éléments de l'instance XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient un élément "ximf:dictionnary".

==== Element dictionary ====
<div style="color:red;">'''TODO''' :
* Est-il obligé de renseigner les données d'internationalisation pour <u>tous</u> les labels ? (ce n'est actuellement pas le cas dans l'instance Whirlpool)
* Quel est l'intérêt de renseigner un attribut "id" à l'élément "dictionary" (étant donné qu'un seul élément "dictionary n'est autorisé dans l'élément "instance") ?</div>

L’élément "dictionary" contient toutes les informations devant être interprétées selon le pays d’utilisation.
L’élément "dictionary" contient un ou plusieurs mêmes éléments "locale", e.g.,

<ximf:dictionary>
<ximf:locale lang="fr-FR" />
<ximf:locale lang="en-US" />
</ximf:dictionary>

==== Element locale ====
L’élément "locale" contient toutes les informations pour un pays et/ou langue désignée.
L’élément "locale" contient un ou plusieurs mêmes éléments "ilk", e.g.,

<ximf:locale lang="fr-FR" >
<ximf:ilk entity="a"/>
<ximf:ilk entity="b"/>
</ximf:locale>

* Détails sur les attributs de la balise "locale" :
** L’attribut "lang" définit le code pays de ce conteneur. Il devrai être construit selon le format défini par la RFC1766 (fr, en, ja, es, …).

==== Element ilk ====
L’élément "ilk" contient une unique information correspondant à une donnée traduite selon le code pays de l’élément père. Cette information est au format chaîne de caractère. Un attribut obligatoire précise la balise "ilk".

<ximf:ilk entity="ilk-lang-ihm">langue</ximf:ilk>

* Détails sur les attributs de la balise "ilk" :
** L’attribut "entity" définit la référence d’entrée pour récupérer le contenu de l’élément selon le code pays souhaité.

Finalement, le fichier "dictionary" pourra contenir :
<ximf:instance name="Whirlpool">
<ximf:dictionary>
<ximf:locale lang="fr-FR" >
<ximf:ilk entity="ilk-lang-ihm">Français</ximf:ilk>
<ximf:ilk entity="ilk-exemple-general">Général</ximf:ilk>
</ximf:locale>
<ximf:locale lang="en-US" >
<ximf:ilk entity="ilk-lang-ihm">English (US)</ximf:ilk>
<ximf:ilk entity="ilk-exemple-general">General</ximf:ilk>
</ximf:locale>
</ximf:dictionary>
</ximf:instance>

=== Fichier ihm ===
<span style="color:red;">'''TODO''' : La documentation originale ne décrit pas le fichier ihm, les informations ci-dessous ont seulement été présumées. Merci de les vérifier/compléter.
</span>

Le fichier ihm spécifie l'agencement de l'interface des formulaires XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient un élément "ximf:ihm".

==== Element ihm ====
L'élément "ihm" contient un ou plusieurs éléments "panel" et un élément "treeRcv".

==== Element panel ====
Un élément ximf:panel correspond à un onglet du formulaire XIMF construit.
Deux attributs précisent la balise "panel" : "id" et "ilk", eg.
<ximf:panel id="pane_security" ilk="ilk-priority-panel" />

* Détails sur les attributs de l'élément "panel" :
** L’attribut "id" définit le nom de l'onglet, il doit être unique pour chaque élément "ximf:panel" et est formaté selon la syntaxe "pane-xxx". Cet attribut est obligatoire.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.

L'élément "ximf:panel" contient au moins un éléments "ximf:groupbox".

==== Element groupbox ====
Un élément groupbox correspond à une sous catégorie d'un onglet du formulaire XIMF.
La structure "groupbox" détaille l’ordre d’affichage des entêtes dans un message.
Deux attributs précisent la balise "ximf:groupbox" : "id" et "ilk", eg.
<ximf:groupbox id="group-classification" ilk="ilk-secu-box" />

* Détails sur les attributs de l'élément "groupbox" :
** L’attribut "id" définit le nom de l'onglet, il doit être unique pour chaque élément "ximf:panel" et est formaté selon la syntaxe "pane-xxx". Cet attribut est obligatoire.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.

L'élément "groupbox" contient au moins un éléments "headerRef".

==== Element treeRcv ====
L'élément "treeRcv" permet de spécifier quelles sont les colonnes susceptibles d'être ajoutées dans le panneau principal du client de messagerie qui contient la liste des messages d’un dossier.

L'élément "treeRcv" peut contenir des éléments "headerRef".

==== Element headerRef ====
L'élément headerRef spécifie les champs associés à chaque sous-groupe d'onglet de formulaire ou les champs qu'il est possible d'afficher dans la liste des messages.
Aucun attribut ne vient compléter la balise "headerRef", eg.
<ximf:headerRef>header-classification</ximf:headerRef>

Finalement, le fichier "ihm" pourra contenir :
<pre>
<ximf:instance name="Amoco">
<ximf:ihm>
<ximf:panel id="pane_security" ilk="ilk-priority-panel">
<ximf:groupbox id="group-classification" ilk="ilk-secu-box">
<ximf:headerRef>header-correspondance-type</ximf:headerRef>
<ximf:headerRef>header-classification</ximf:headerRef>
</ximf:groupbox>
</ximf:panel>
<ximf:treeRcv>
<ximf:headerRef>header-classification</ximf:headerRef>
</ximf:treeRcv>
</ximf:ihm>
</ximf:instance>
</pre>

=== Fichier headers ===
Le fichier headers spécifie les types des champs de l'interface des formulaires XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient des éléments "header".

==== Element header ====
Chaque élément "header" décrit un entête de message de format XIMF.
Huit attributs précisent la balise "header" : "headerName", "id", "technicalHeaderName", "type", "technicalType", "isMandatory", "ilk", "description", e.g.,

<div style="color:red;">'''TODO :'''
Comment est effectuée la vérification de l'attribut isMandatory et quelles sont les conditions de fonctionnement de celui-ci ? Est-il possible, par exemple, de spécifier l'attribut isMandatory=true d'un élément header si le contenu de celui-ci est un élément « set » qui dispose des attributs minItem et maxItem ?Actuellement, lorsque l'on crée un élément set avec les attributs minItem et maxItem, le champ du formulaire associé ne peux pas être validé (Est-ce un bug ?) : e.g.,
<ximf:set id="value-amoco-classification" minItem="1" maxItem="64" separator=";" technicalSeparator=".">
</div>

<ximf:header id="header-primary-precedence"
headerName="X-XIMF-Primary-Precedence"
ilk="ilk-primary-precedence"
isMandatory="true"
description="entête d’urgence"
type="string" />

* Détails sur les attributs de l'élément "header" :
** L’attribut "headerName" définit le nom du champ XIMF. Cet attribut est obligatoire.
** L’attribut "id" définit un identifiant de champ, il doit être unique pour chaque élément "header" et est formaté selon la syntaxe "header-xxx". Cet attribut est obligatoire.
** L’attribut "isMandatory" précise si ce champ doit être obligatoirement présent dans le message intégrant les entêtes selon cette description.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.
** L’attribut "type" précise le format des données associées à cet élément. Ce format peut être une date, une chaîne, une adresse mail, un O.I.D.
** L’attribut "technicalHeaderName" permet de compléter l’entête décrit par un autre entête.
** L’attribut "technicalType" précise le format des données associées à l’élément technicalHeaderName.
** L’attribut "description" permet d’ajouter une information sur cet élément.

L’élément "header" contient obligatoirement un élément "set", "multiset", "string", ou "compstring", e.g.,

<ximf:header id="header-reply-by"
headerName="X-XIMF-Reply-By"
ilk="ilk-reply-by"
isMandatory="false" >
<ximf:string id="value-reply-by" editable="true" />
</ximf:header>

<div style="color:red;">
'''TODO :''' Quelles sont les contraintes associées à l'attribut type d'un élément header ?
</div>

==== Element string ====
L’élément "string" précise le contenu d’une ressource de type chaîne de caractères imprimables (a-z, A-Z, 1-9,…)
Quinze attributs complètent l’élément "string" : "id", "ref", "ilk", "aclLevel", "index", "description", "editable", "content", "technicalContent","maxItem", "minItem", "maxLength", "minLength", "separator", "technicalSeparator", e.g.,

<ximf:string ilk="ilk-france" content="FRA" />

* Détails sur les attributs de l'élément "string" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "string".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_ximf:role| élément role]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut " description " permet d’associer un commentaire sur cette donnée.
** L’attribut "editable" définit une valeur de saisie (champ libre). Cet attribut est de type booléen.
** L’attribut "content" représente la valeur effective de la donnée. C’est cette donnée qui sera associée au champ XIMF créé.
** L’attribut "technicalContent" représente la valeur effective de la donnée technique. C’est cette donnée qui sera associée au champ technique XIMF créé (cf. attribut technicalHeaderName de l’élément "header".
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.

L’élément "string" peut contenir plusieurs éléments "linkedValue".

<ximf:string ilk="ilk-non-protege" content="NON PROTEGE" technicalContent="1" >
<ximf:linkedValue ref="value-non-protege-france " />
</ximf:string>

==== Element compstring ====
<div style="color:red;">
'''TODO :''' L'attribut de l'élément « compstring » nommé « contentFactorise » devrait s'appeler « contentFactorize ».
</div>
L’élément "compstring" décrit un conteneur de concaténation des éléments fils. Il permet notamment de créer des valeurs d’entêtes composées.
Dix-sept attributs complètent l’élément "compstring" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", "content", "technicalContent", "contentPositionEnd", "contentFactorise", "technicalPositionEnd", e.g.,

<ximf:compstring
ilk="ilk-special"
content="SPECIAL"
technicalContent="1.3.4"
separator=" "
technicalSeparator=".">

* Détails sur les attributs de l'élément "compstring" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "compstring".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (cf. [[#Element_role| élément "role"]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut " description " permet d’associer un commentaire sur cette donnée.
** L’attribut "content" représente la valeur effective de la donnée. C’est cette donnée qui sera associée au champ XIMF créé.
** L’attribut "technicalContent" représente la valeur effective de la donnée technique. C’est cette donnée qui sera associée au champ technique XIMF créé (cf. attribut technicalHeaderName de l’élément "header".
** L’attribut "separator" définit le caractère de séparation entre deux valeurs.
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "contentPositionEnd" impose de positionner le contenu de l’élément "compstring" après les valeurs des éléments fils : valuefils1,valuefils2 : valuecompstring.
** L’attribut "technicalPositionEnd" impose de positionner le contenu de l’élément "compstring" après les valeurs des éléments fils.
** L’attribut "contentFactorise" impose d’utiliser le contenu de l’élément "compstring" comme facteur des éléments fils : valuecompstring(valuefils1,valuefils2).

L’élément "compstring" peut contenir un élément "string" ou "set" ou "multiset" ou plusieurs éléments "compstring".

<ximf:compstring
ilk="ilk-special"
content="SPECIAL"
technicalContent="1.3.4"
separator=" "
technicalSeparator=".">
<ximf:set id="ilk-special-op " maxItem="64">
<ximf:string ilk="ilk-special-op1" content="OP1" technicalContent="1" />
<ximf:string ilk="ilk-special-op2" content="OP2" technicalContent="2" />
<ximf:string ilk="ilk-special-op3" content="OP3" technicalContent="3" />
</ximf:set>
</ximf:compstring>

==== Element set ====
L’élément "set" décrit un conteneur de ressources de même type. Cet élément autorise la sélection de plusieurs ressources mais chaque ressource est sélectionnée une seule fois.
Douze attributs précisent la description de la balise "set" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", e.g.,

<ximf:set id="value-categories" ref="value-mentions" maxItem="64" separator=";" />

* Détails sur les attributs de l'élément "set" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "ximf:set".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role|élément rôle]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut "description" permet d’associer un commentaire sur cette donnée.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs

L’élément "set" peut contenir un ou plusieurs éléments "string" ou un ou plusieurs éléments "compstring".

<ximf:set id="value-categories" minItem="1" maxItem="64" separator=";">
<ximf:string ilk="ilk-releasable-to" content="RELEASABLE TO " />
<ximf:string ilk="ilk-eyes-only" content=" EYES ONLY"/>
<ximf:string ilk="ilk-use-only" content=" USE ONLY"/>
</ximf:set>

<div style="color:red;">'''TODO :'''
* Y a-t-il une définition des fichiers associés aux instances XIMF (e.g, le fichier attribution-list.xml utilisé dans l'instance Caterpillar) ?
* Comment le parseur d'instance ximf sait qu'un élément est une "attribution-list" ?
</div>

==== Element multiset ====
L’élément "multiset" décrit un conteneur de ressources de même type. Cet élément autorise la sélection de plusieurs ressources et chaque ressource peut être sélectionnée plusieurs fois.
Douze attributs précisent la description de la balise "multiset" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", e.g.,

<ximf:multiset
id="value-restricted"
ilk=" value-restricted-otan"
maxItem="64"
separator=";" />

* Détails sur les attributs de l'élément "multiset" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "multiset".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role|élément rôle]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut "description" permet d’associer un commentaire sur cette donnée.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs

L’élément "multiset" peut contenir un ou plusieurs éléments "string" ou un ou plusieurs éléments "compstring".

<ximf:multiset id="value-restricted-otan-categories" minItem="1" maxItem="64" separator=";" >
<ximf:string ilk="ilk-releasable-to" content="RELEASABLE TO "/>
<ximf:string ilk="ilk-eyes-only" content=" EYES ONLY"/>
<ximf:string ilk="ilk-use-only" content=" USE ONLY"/>
</ximf:multiset>

<span style="color:red;">'''TODO :''' Comment sont gérées les règles associées aux champs multivaleurs (disposant par exemple des attributs minItem/maxItem ou les champs multiset) ?</span>

==== Element linkedValue ====
<div style="color: red;">'''TODO ''': L'élément linkedValue indique quelle ressource utiliser lors de la sélection d'un élément particulier mais il n'indique pas où la ressource devra être utilisée.
* Est-ce que cela correspond toujours au header suivant ?
* Pourquoi avoir fait ce choix au lieu d'ajouter un attribut supplémentaire ?
</div>

L’élément "linkedValue" définit une référence sur une ressource de type conteneur ("set", "multiset") ou "string". Cette ressource devrait être utilisée si la ressource contenant "linkedValue" (noeud parent) est sélectionnée.
Un attribut précise la balise "linkvalue" : "ref", e.g.,

<ximf:linkedValue ref="value-restricted-otan-classification-id" />

* Détails sur les attributs de l'élément "linkedValue" :
** L’attribut "ref" précise la valeur de l’attribut "id" de la ressource cible. Cet attribut est obligatoire.

=== Fichier rules ===
Le fichier rules définit les règles de contrôles d’entêtes XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui peut contenir des éléments "ximf:rule".

==== Element rule ====
<div style="color:red">
'''TODO :''' Mettre à jour la documentation :
* Les éléments autorisés dans un élément « rule » ne sont plus à jour. La présente documentation spécifie 12 éléments : AliasHeader, AliasValue, Compatibility, Association, SecureHeaders, SecurityLabel, Constraint, Assignment, Processing, Accessibility, Role et Custom. Le schéma XML fourni avec le mail en spécifie 5 : Constraint, Processing, Compatibility, Policy et Custom et place les autres en tant qu'extentions des 5 éléments cités précédemment.
* Les éléments SecureHeaders et SecurityLabel associés à l'élément « rule » dans la version ci-dessus ne figurent plus dans la nouvelle version. On les retrouve dans les fichiers rules-*.xml mais les éléments sont commentés. En revanche, ils sont bien présents dans une autre instance : s'agit-il d'une fonctionnalité non-documentée ou plus documentée ?
* L'élément ximf:classificationPictures n'est pas documenté. De plus, il serait bon d'avoir des précisions sur la raison qui a motivé l'ajout de cet élément dans les fichiers de règles (alors qu'il semblerait être plus adapté au fichier headers-*.xml).
</div>
L’élément "rule" est le conteneur principal de description d’un comportement particulier à appliquer sur un ensemble d’entêtes XIMF.
Trois attributs précisent la balise "rule" : "id", "agent", "description", e.g.,
<ximf:rule id="compatibility-rule" description="Règle sur la compatibilité X-SMTP / XIMF" >

* Détails sur les attributs de l'élément "rule" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "rule". Cet attribut est obligatoire.
** L’attribut "agent" indique l’équipement cible devant analyser et appliquer le contenu de cet élément.
** L’attribut "description" autorise l’auteur d’ajouter un commentaire sur cet élément.

L’élément "rule" contient un ou plusieurs mêmes éléments de spécialisation de la règle "contraint", "assignement", "processing", "compatibility", "accessibility", "custom",…, e.g.,

<ximf:rule id="precedence-rule" agent="mua" description="Règle sur les priorités">
<ximf:constraint
left="header-primary-precedence"
operator="equalOrGreaterThan"
right="header-copy-precedence" />
</ximf:rule>

==== Element aliasHeader ====
L’élément "aliasHeader" permet de définir le nom de l’entête sur lequel la règle précisée est appliquée
Deux attributs précisent la balise "aliasHeader" : "headerName" et "headerRef", e.g.,

<ximf:aliasHeader headerName ="X-P772-Version" headerRef="X-XIMF-VERSION" />

* Détails sur les attributs de l'élément "aliasHeader" :
* L’attribut "headerName" définit le nom XIMF de l’entête modifié par la règle. Cet attribut est obligatoire.
* L’attribut "headerRef" définit le nom d’un entête XIMF de référence qui est le point d’entrée de l’application de la règle sur l’entête définit par "headerName". Cela permet de lier deux entêtes de messages où l’utilisation de l’un des entêtes influe sur le comportement de l’autre.

L’élément "aliasHeader" peut contenir des éléments "aliasValue",e.g ,

<ximf:aliasHeader headerName="X-P772-Version" />
<ximf:aliasValue vame="1.0"/>
<ximf:aliasHeader>

==== Element aliasValue ====
L’élément "aliasValue" contient une valeur à associer à l’entête XIMF contrôlé par la règle. Il est utile lorsque deux entêtes sont liées (utilisation de l’attribut headerRef dans l’élément aliasHeader) et que les valeurs de l’entêtes de référence permettent de préciser celles de l’entête contrôlé.
Deux attributs précisent la balise "aliasValue" : "valueName", "valueRef", e.g.,

<ximf:aliasValue valueName="2" valueRef ="flash" />

* Détails sur les attributs de l'élément "aliasValue" :
** L’attribut "valueName" définit la valeur de l’entête à créer. Cet attribut est obligatoire.
** L’attribut "valueRef" définit la valeur de l’entête XIMF de référence pour utiliser valueName.
<span style="color:red;">'''TODO :''' L'attribut valueRef est-il obligatoire ?</span>

==== Element compatibility ====
L’élément "compatibility" est utilisé pour associer à un entête respectant la norme XIMF un entête respectant une autre norme que XIMF (XSMTP par exemple).
Deux attributs précisent la balise "compatibility" : "targetName", "targetVersion", e.g.,

<ximf:compatibility targetName="X-SMTP" targetVersion="1.1">
<ximf:aliasValue headerName="X-P772-Version" content="1.1" />
<ximf:aliasValue
headerName="X-P772-Primary-Precedence"
headerRef="header-primary-precedence"
dataRef="data-priority-xsmtp"/>
</ximf:compatibility>

* Détails sur les attributs de l'élément "compatibility" :
** L’attribut "targetName" définit la norme de l’entête à associer à l’entête XIMF. Cet attribut est obligatoire.
** L’attribut "targetVersion" définit le numéro de version de la norme de l’entête à associer à l’entête XIMF. Cet attribut est obligatoire.

L’élément "compatibility" contient au moins un élément "aliasHeader".

<u>Pour illustrer cette règle :</u>
Le format XSMTP est déjà supporté par certains équipements. Afin de rendre ceux-ci inter opérables avec le nouveau format XIMF, cette règle permet d’associer un entête XSMTP contenant les mêmes informations qu’un entête XIMF.

L’élément Association : dépendance entre entêtes
L’élément "association" définie les valeurs autorisées pour un entête XIMF en fonction d’une valeur définie pour un autre entête XIMF.

<ximf:association>
<ximf:aliasHeader
headerName="X-XIMF-Primary-Precedence"
headerRef="X-XIMF-Correspondence-Type">
<ximf:aliasValue valueName="routine" valueRef="private" />
<ximf:aliasValue valueName="routine,priority" valueRef="professional" />
<ximf:aliasValue valueName="routine,priority,immediate,flash" valueRef="operational" />
<ximf:aliasValue valueName="routine,priority,immediate" valueRef="official" />
</ximf:aliasHeader>
</ximf:association>

==== Element secureHeaders ====
<div style="color:red;">'''TODO :''' Les éléments SecureHeaders et SecurityLabel associés à l'élément « rule » dans la version ci-dessus ne figurent plus dans le shéma xml. On les retrouve dans les fichiers rules-*.xml mais les éléments sont commentés. En revanche, ils sont bien présents dans une autre instance : s'agit-il d'une fonctionnalité non-documentée ou plus documentée ?</div>
L’élément "secureHeaders" définie la liste des entêtes à intégrer dans la signature d’un message. Cette règle s’applique sur les équipements proposant un algorithme de signature des messages.

Un élément "secureHeaders" contient un ou plusieurs éléments "aliasHeaders" où chaque élément décrit un entête à intégrer dans la signature et complété d’un attribut "status".

<ximf:secureHeaders targetName="SecureHeaders">
<ximf:aliasHeader headerName="X-XIMF-Primary-Precedence" status="0" />
<ximf:aliasHeader headerName="X-XIMF-Copy-Precedence" status="0" />
</ximf:secureHeaders>

==== Element securityLabel ====
L’élément "securityLabel" définie la liste des entêtes à intégrer dans la signature d’un message. Cette règle s’applique sur les équipements proposant un algorithme de signature des messages selon la norme RFC.

Un élément "securityLabel" contient un ou plusieurs éléments "aliasHeaders" où chaque élément décrit un entête à intégrer dans la signature et complété d’un attribut "status".

<ximf:securityLabel targetName="SecurityLabel" id="Amoco">
<ximf:aliasHeader
headerName="SecurityPolicyIdentifier"
headerRef="X-XIMF-Security-Policy-Identifier" />
<ximf:aliasHeader
headerName="SecurityClassification"
headerRef="X-XIMF-Security-Classification-Identifier" />
<ximf:aliasHeader
headerName="ESSPrivacyMark"
headerRef="X-XIMF-Privacy-Mark" />
<ximf:aliasHeader
headerName="SecurityCategory"
headerRef="X-XIMF-Security-Categories-Identifier"
type="2" />
</ximf:securityLabel>

==== Element constraint ====
L’élément "constraint" est utilisé pour définir une règle de construction de deux entêtes partageant des "datas" identiques.
Trois attributs précisent la balise "constraint" : "left", "right", "operator", e.g.,

<ximf:constraint
left="header-primary-precedence"
operator="equalOrGreaterThan"
right="header-copy-precedence" />

* Détails sur les attributs de l'élément "constraint" :
** L’attribut "left" désigne le premier élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "right" désigne le deuxième élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "operator" indique la règle de poids à appliquer sur la valeur des deux éléments "header", il peut être de type "greaterThan", "lowerThan", "equalOrGreaterThan", "equalOrLowerThan", "equal". Cet attribut est obligatoire.

* Détails sur les valeurs possibles de l'attribut "type" :
** Le type "greaterThan" signifie que la valeur de l’élément "left" doit être strictement supérieur à la valeur de l’élément "right".
** Le type "lowerThan" signifie que la valeur de l’élément "left" doit être strictement inférieur à la valeur de l’élément "right".
** Le type "equalOrGreaterThan" signifie que la valeur de l’élément "left" doit être supérieur ou égale à la valeur de l’élément "right".
** Le type "equalOrLowerThan" signifie que la valeur de l’élément "left" doit être inférieur ou égale à la valeur de l’élément "right".
** Le type "equal" signifie que la valeur de l’élément "left" et de l’élément "right" doivent être identiques.

==== Element assignment ====
<div style="color:red;">'''TODO :''' L'élément assignment n'apparaît pas dans le shéma xml qui avait été envoyé.</div>

L’élément "assignement" est utilisé pour affecter une valeur créée en fonction d’une règle de comparaison sur les valeurs de deux éléments "header".
Quatre attributs précisent la balise "assignement" : "left", "right", "operator", "result", e.g.,

<ximf:assignment
left="header-primary-precedence"
operator="equal"
right="data-routine-precedence"
result="86400" />

* Détails sur les attributs de l'élément "assignment" :
** L’attribut "left" désigne le premier élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "right" désigne le deuxième élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "operator" indique la règle de comparaison entre les valeurs des deux éléments "header", il peut être de type "greaterThan", "lowerThan", "equalOrGreaterThan", "equalOrLowerThan", "equal". Cet attribut est obligatoire.
** L’attribut "result" représente la valeur à utiliser si la règle de comparaison entre les deux éléments est satisfaite. Cet attribut est obligatoire.

==== Element processing ====
L’élément "processing" regroupe des règles de traitement à effectuer sur des entêtes formatés.
L’attribut "type" précise le type de traitement à effectuer sur ces valeurs. Cet attribut est obligatoire, il est de type : "sign-header-value", "encrypt-header-value", "capitalize-header-value", e.g.,

<ximf:processing type="sign-header-value">
<ximf:refHeader>header-primary-precedence</ximf:refheader>
<ximf:refHeader>header-copy-precedence</ximf:refheader>
<ximf:refHeader>header-echange-type</ximf:refheader>
</ximf:processing>

* Détails sur les valeurs possibles de l'attribut "type" :
** Le type "sign-header-value" définit un traitement de signature des entêtes définis dans la balise.
** Le type "encrypt-header-value" définit un traitement de chiffrement des entêtes définis dans la balise.
** Le type "capitalize-header-value" définit un traitement de capitalisation des entêtes définis dans la balise.

L’élément "processing" contient au moins un élément "refHeader".
<div style="color:red;">'''TODO :'''L'élément refHeader n'est pas documenté, s'agit-il en fait de l'élément headerRef ?</div>

==== Element accessibility ====
<div style="color:red;">'''TODO :''' L'élément accessibility n'apparaît pas dans le shéma xml qui avait été envoyé.</div>
L’élément "accessibility" définit un ensemble de règles de droit d’accès aux éléments d’une instance pour une cible déterminée (utilisateur, routeur…).
Cet élément contient un ou plusieurs éléments "role".

<ximf:accessibility>
<ximf:role id="role-flash-allowed" aclLevel="100" />
<ximf:role id="role-flash-prohibited" aclLevel="50" />
</ximf:accessibility>

==== Element role ====
L’élément "role" positionne une valeur d’accès à pour une entité définit.
Deux attributs complètent l’élément "role" : "id", "aclLevel", e.g.,

<ximf:role id="role-flash-allowed" aclLevel="100" />

* Détails sur les attributs de l'élément "role" :
** L’attribut "id" précise l’entité accessible en fonction d’une valeur déterminée.
** L’attribut "aclLevel" précise la valeur seuil d’accès à l’entité.

==== Element custom ====
L’élément "custom" permet à l’auteur de créer des nouvelles règles personnalisées.
Trois attributs précisent la balise "custom" : "id", "provider", "description", e.g.,

<ximf:custom
id="custom-display"
provider="EADS"
description="Affichage de la composition du message" >
<node1><node2><node3></node3></node2></node1>
</ximf:custom>

* Détails sur les attributs de l'élément "custom" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "custom" et formaté selon la syntaxe "custom-xxx". Cet attribut est obligatoire.
** L’attribut "provider" identifie l’auteur de la règle. Cet attribut est obligatoire.
** L’attribut "description" permet d’ajouter un commentaire sur cet élément.

L’élément "custom" peut contenir tous les éléments possibles en respectant les standards XML.

XIMF XML tags/fr

2011-02-25T09:28:16Z

Anthonyjuge : /* Element string */

== Introduction ==
Ce document propose un modèle de description, via eXtensible Markup Language (XML), d’entêtes de messages électroniques respectant la norme XIMF. Ce document a deux objectifs :
# Décrire les éléments et attributs de représentation XML pour construire des entêtes de messages électroniques de format XIMF.
# Fournir un modèle de représentation XIMF/XML.

<u>Rappel :</u>
* Un "élément" fait référence à tous les caractères situés entre une balise de départ et un balise de fin, e.g.,
<exemple> texte et/ou éléments fils </exemple>
* Un "attribut" est une composante d’un élément. Il est positionné dans la balise de départ, e.g.,
<exemple nom='value'>

Tous les éléments décrits dans cette documentation paragraphe sont validés dans l’espace de nom "ximf".

<pre>
xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://eads.org/ximf/ximf.xsd"
</pre>

== Description détaillée des balises XML ==

Voici, par ordre d'apparition et en fonction des fichiers, les balises génériques associées aux différents fichiers XML.

=== Fichier ximfmail-profile ===

<div style="color:red;">'''TODO''' :
* Combien d'éléments ihm sont autorisés dans un élément instance ?
* La documentation des fichiers ximfmail-profile.xml n'est pas disponible. Est-il possible d'avoir accès au fichier ximf_profile.xsd mentionné dans les ximfmail-profile.xml ?
</div>

Un fichier xpi peut contenir plusieurs instances XIMF, celles-ci sont alors regroupées dans une même catégorie. Le fichier ximfmail-profile contient des informations sur toutes les instances contenues dans le xpi, notamment leur nom, leur chemin d'accès, ainsi que les noms des fichiers associés à chaque instance.

==== Element instance ====
L’élément "instance" identifie l’ensemble des entêtes à décrire selon la norme XIMF. C’est le conteneur principal d’une instance XIMF/XML. Cinq attributs précisent la balise "instance" : "ximfVersion", "version", "author", "creation", "name", e.g.,
<ximf:instance name="myInstance" version="1.0" ximfVersion="2.0" >

* Détails sur les attributs de l'élément "instance" :
** L’attribut "name" définit le nom de l’instance décrite. Cet attribut est obligatoire.
** L’attribut "ximfVersion" définit le numéro de version des entêtes XIMF utilisés pour cette représentation. Cet attribut est obligatoire.
** L’attribut "version" définit le numéro de version de l’instance décrite. Cet attribut est obligatoire.
** L’attribut "author" renseigne sur le nom de l’auteur de cette instance.
** L’attribut "creationDate" précise la date de création de cette instance.

L’élément "instance" peut contenir un ou plusieurs éléments "schema", un ou plusieurs éléments "rule", un élément "ihm" et un élément "dictionary".

==== Element dictionary ====
L'élément dictionary contient le chemin vers le fichier spécifiant les données d'internationalisation (Cf. [[#Fichier_dictionary|Fichier dictionary]]).

==== Element schema ====
L'élément shema contient le chemin vers le fichier spécifiant les entêtes XIMF (Cf. [[#Fichier_headers|Fichier headers]]).

==== Element ihm ====
L'élément ihm contient le chemin vers le fichier spécifiant la disposition de l'interface des formulaires XIMF (Cf. [[#Fichier_ihm|Fichier ihm]]).

==== Element rule ====
L'élément rule contient le chemin vers le fichier spécifiant les règles associées aux valeurs des champs XIMF (Cf. [[#Fichier_rules|Fichier rules]]).

=== Fichier dictionary ===
Le fichier dictionnary permet de mettre en œuvre l’internationalisation d’une instance XIMF. Il défini des dictionnaires qui servent à traduire les éléments de l'instance XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient un élément "ximf:dictionnary".

==== Element dictionary ====
<div style="color:red;">'''TODO''' :
* Est-il obligé de renseigner les données d'internationalisation pour <u>tous</u> les labels ? (ce n'est actuellement pas le cas dans l'instance Whirlpool)
* Quel est l'intérêt de renseigner un attribut "id" à l'élément "dictionary" (étant donné qu'un seul élément "dictionary n'est autorisé dans l'élément "instance") ?</div>

L’élément "dictionary" contient toutes les informations devant être interprétées selon le pays d’utilisation.
L’élément "dictionary" contient un ou plusieurs mêmes éléments "locale", e.g.,

<ximf:dictionary>
<ximf:locale lang="fr-FR" />
<ximf:locale lang="en-US" />
</ximf:dictionary>

==== Element locale ====
L’élément "locale" contient toutes les informations pour un pays et/ou langue désignée.
L’élément "locale" contient un ou plusieurs mêmes éléments "ilk", e.g.,

<ximf:locale lang="fr-FR" >
<ximf:ilk entity="a"/>
<ximf:ilk entity="b"/>
</ximf:locale>

* Détails sur les attributs de la balise "locale" :
** L’attribut "lang" définit le code pays de ce conteneur. Il devrai être construit selon le format défini par la RFC1766 (fr, en, ja, es, …).

==== Element ilk ====
L’élément "ilk" contient une unique information correspondant à une donnée traduite selon le code pays de l’élément père. Cette information est au format chaîne de caractère. Un attribut obligatoire précise la balise "ilk".

<ximf:ilk entity="ilk-lang-ihm">langue</ximf:ilk>

* Détails sur les attributs de la balise "ilk" :
** L’attribut "entity" définit la référence d’entrée pour récupérer le contenu de l’élément selon le code pays souhaité.

Finalement, le fichier "dictionary" pourra contenir :
<ximf:instance name="Whirlpool">
<ximf:dictionary>
<ximf:locale lang="fr-FR" >
<ximf:ilk entity="ilk-lang-ihm">Français</ximf:ilk>
<ximf:ilk entity="ilk-exemple-general">Général</ximf:ilk>
</ximf:locale>
<ximf:locale lang="en-US" >
<ximf:ilk entity="ilk-lang-ihm">English (US)</ximf:ilk>
<ximf:ilk entity="ilk-exemple-general">General</ximf:ilk>
</ximf:locale>
</ximf:dictionary>
</ximf:instance>

=== Fichier ihm ===
<span style="color:red;">'''TODO''' : La documentation originale ne décrit pas le fichier ihm, les informations ci-dessous ont seulement été présumées. Merci de les vérifier/compléter.
</span>

Le fichier ihm spécifie l'agencement de l'interface des formulaires XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient un élément "ximf:ihm".

==== Element ihm ====
L'élément "ihm" contient un ou plusieurs éléments "panel" et un élément "treeRcv".

==== Element panel ====
Un élément ximf:panel correspond à un onglet du formulaire XIMF construit.
Deux attributs précisent la balise "panel" : "id" et "ilk", eg.
<ximf:panel id="pane_security" ilk="ilk-priority-panel" />

* Détails sur les attributs de l'élément "panel" :
** L’attribut "id" définit le nom de l'onglet, il doit être unique pour chaque élément "ximf:panel" et est formaté selon la syntaxe "pane-xxx". Cet attribut est obligatoire.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.

L'élément "ximf:panel" contient au moins un éléments "ximf:groupbox".

==== Element groupbox ====
Un élément groupbox correspond à une sous catégorie d'un onglet du formulaire XIMF.
La structure "groupbox" détaille l’ordre d’affichage des entêtes dans un message.
Deux attributs précisent la balise "ximf:groupbox" : "id" et "ilk", eg.
<ximf:groupbox id="group-classification" ilk="ilk-secu-box" />

* Détails sur les attributs de l'élément "groupbox" :
** L’attribut "id" définit le nom de l'onglet, il doit être unique pour chaque élément "ximf:panel" et est formaté selon la syntaxe "pane-xxx". Cet attribut est obligatoire.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.

L'élément "groupbox" contient au moins un éléments "headerRef".

==== Element treeRcv ====
L'élément "treeRcv" permet de spécifier quelles sont les colonnes susceptibles d'être ajoutées dans le panneau principal du client de messagerie qui contient la liste des messages d’un dossier.

L'élément "treeRcv" peut contenir des éléments "headerRef".

==== Element headerRef ====
L'élément headerRef spécifie les champs associés à chaque sous-groupe d'onglet de formulaire ou les champs qu'il est possible d'afficher dans la liste des messages.
Aucun attribut ne vient compléter la balise "headerRef", eg.
<ximf:headerRef>header-classification</ximf:headerRef>

Finalement, le fichier "ihm" pourra contenir :
<pre>
<ximf:instance name="Amoco">
<ximf:ihm>
<ximf:panel id="pane_security" ilk="ilk-priority-panel">
<ximf:groupbox id="group-classification" ilk="ilk-secu-box">
<ximf:headerRef>header-correspondance-type</ximf:headerRef>
<ximf:headerRef>header-classification</ximf:headerRef>
</ximf:groupbox>
</ximf:panel>
<ximf:treeRcv>
<ximf:headerRef>header-classification</ximf:headerRef>
</ximf:treeRcv>
</ximf:ihm>
</ximf:instance>
</pre>

=== Fichier headers ===
Le fichier headers spécifie les types des champs de l'interface des formulaires XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient des éléments "header".

==== Element header ====
Chaque élément "header" décrit un entête de message de format XIMF.
Huit attributs précisent la balise "header" : "headerName", "id", "technicalHeaderName", "type", "technicalType", "isMandatory", "ilk", "description", e.g.,

<div style="color:red;">'''TODO :'''
Comment est effectuée la vérification de l'attribut isMandatory et quelles sont les conditions de fonctionnement de celui-ci ? Est-il possible, par exemple, de spécifier l'attribut isMandatory=true d'un élément header si le contenu de celui-ci est un élément « set » qui dispose des attributs minItem et maxItem ?Actuellement, lorsque l'on crée un élément set avec les attributs minItem et maxItem, le champ du formulaire associé ne peux pas être validé : e.g.,
<ximf:set id="value-amoco-classification" minItem="1" maxItem="64" separator=";" technicalSeparator=".">
Est-ce un bug ?
</div>

<ximf:header id="header-primary-precedence"
headerName="X-XIMF-Primary-Precedence"
ilk="ilk-primary-precedence"
isMandatory="true"
description="entête d’urgence"
type="string" />

* Détails sur les attributs de l'élément "header" :
** L’attribut "headerName" définit le nom du champ XIMF. Cet attribut est obligatoire.
** L’attribut "id" définit un identifiant de champ, il doit être unique pour chaque élément "header" et est formaté selon la syntaxe "header-xxx". Cet attribut est obligatoire.
** L’attribut "isMandatory" précise si ce champ doit être obligatoirement présent dans le message intégrant les entêtes selon cette description.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.
** L’attribut "type" précise le format des données associées à cet élément. Ce format peut être une date, une chaîne, une adresse mail, un O.I.D.
** L’attribut "technicalHeaderName" permet de compléter l’entête décrit par un autre entête.
** L’attribut "technicalType" précise le format des données associées à l’élément technicalHeaderName.
** L’attribut "description" permet d’ajouter une information sur cet élément.

L’élément "header" contient obligatoirement un élément "set", "multiset", "string", ou "compstring", e.g.,

<ximf:header id="header-reply-by"
headerName="X-XIMF-Reply-By"
ilk="ilk-reply-by"
isMandatory="false" >
<ximf:string id="value-reply-by" editable="true" />
</ximf:header>

<div style="color:red;">
'''TODO :''' Quelles sont les contraintes associées à l'attribut type d'un élément header ?
</div>

==== Element string ====
L’élément "string" précise le contenu d’une ressource de type chaîne de caractères imprimables (a-z, A-Z, 1-9,…)
Quinze attributs complètent l’élément "string" : "id", "ref", "ilk", "aclLevel", "index", "description", "editable", "content", "technicalContent","maxItem", "minItem", "maxLength", "minLength", "separator", "technicalSeparator", e.g.,

<ximf:string ilk="ilk-france" content="FRA" />

* Détails sur les attributs de l'élément "string" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "string".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_ximf:role| élément role]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut " description " permet d’associer un commentaire sur cette donnée.
** L’attribut "editable" définit une valeur de saisie (champ libre). Cet attribut est de type booléen.
** L’attribut "content" représente la valeur effective de la donnée. C’est cette donnée qui sera associée au champ XIMF créé.
** L’attribut "technicalContent" représente la valeur effective de la donnée technique. C’est cette donnée qui sera associée au champ technique XIMF créé (cf. attribut technicalHeaderName de l’élément "header".
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.

L’élément "string" peut contenir plusieurs éléments "linkedValue".

<ximf:string ilk="ilk-non-protege" content="NON PROTEGE" technicalContent="1" >
<ximf:linkedValue ref="value-non-protege-france " />
</ximf:string>

==== Element compstring ====
<div style="color:red;">
'''TODO :''' L'attribut de l'élément « compstring » nommé « contentFactorise » devrait s'appeler « contentFactorize ».
</div>
L’élément "compstring" décrit un conteneur de concaténation des éléments fils. Il permet notamment de créer des valeurs d’entêtes composées.
Dix-sept attributs complètent l’élément "compstring" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", "content", "technicalContent", "contentPositionEnd", "contentFactorise", "technicalPositionEnd", e.g.,

<ximf:compstring
ilk="ilk-special"
content="SPECIAL"
technicalContent="1.3.4"
separator=" "
technicalSeparator=".">

* Détails sur les attributs de l'élément "compstring" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "compstring".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (cf. [[#Element_role| élément "role"]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut " description " permet d’associer un commentaire sur cette donnée.
** L’attribut "content" représente la valeur effective de la donnée. C’est cette donnée qui sera associée au champ XIMF créé.
** L’attribut "technicalContent" représente la valeur effective de la donnée technique. C’est cette donnée qui sera associée au champ technique XIMF créé (cf. attribut technicalHeaderName de l’élément "header".
** L’attribut "separator" définit le caractère de séparation entre deux valeurs.
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "contentPositionEnd" impose de positionner le contenu de l’élément "compstring" après les valeurs des éléments fils : valuefils1,valuefils2 : valuecompstring.
** L’attribut "technicalPositionEnd" impose de positionner le contenu de l’élément "compstring" après les valeurs des éléments fils.
** L’attribut "contentFactorise" impose d’utiliser le contenu de l’élément "compstring" comme facteur des éléments fils : valuecompstring(valuefils1,valuefils2).

L’élément "compstring" peut contenir un élément "string" ou "set" ou "multiset" ou plusieurs éléments "compstring".

<ximf:compstring
ilk="ilk-special"
content="SPECIAL"
technicalContent="1.3.4"
separator=" "
technicalSeparator=".">
<ximf:set id="ilk-special-op " maxItem="64">
<ximf:string ilk="ilk-special-op1" content="OP1" technicalContent="1" />
<ximf:string ilk="ilk-special-op2" content="OP2" technicalContent="2" />
<ximf:string ilk="ilk-special-op3" content="OP3" technicalContent="3" />
</ximf:set>
</ximf:compstring>

==== Element set ====
L’élément "set" décrit un conteneur de ressources de même type. Cet élément autorise la sélection de plusieurs ressources mais chaque ressource est sélectionnée une seule fois.
Douze attributs précisent la description de la balise "set" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", e.g.,

<ximf:set id="value-categories" ref="value-mentions" maxItem="64" separator=";" />

* Détails sur les attributs de l'élément "set" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "ximf:set".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role|élément rôle]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut "description" permet d’associer un commentaire sur cette donnée.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs

L’élément "set" peut contenir un ou plusieurs éléments "string" ou un ou plusieurs éléments "compstring".

<ximf:set id="value-categories" minItem="1" maxItem="64" separator=";">
<ximf:string ilk="ilk-releasable-to" content="RELEASABLE TO " />
<ximf:string ilk="ilk-eyes-only" content=" EYES ONLY"/>
<ximf:string ilk="ilk-use-only" content=" USE ONLY"/>
</ximf:set>

<div style="color:red;">'''TODO :'''
* Y a-t-il une définition des fichiers associés aux instances XIMF (e.g, le fichier attribution-list.xml utilisé dans l'instance Caterpillar) ?
* Comment le parseur d'instance ximf sait qu'un élément est une "attribution-list" ?
</div>

==== Element multiset ====
L’élément "multiset" décrit un conteneur de ressources de même type. Cet élément autorise la sélection de plusieurs ressources et chaque ressource peut être sélectionnée plusieurs fois.
Douze attributs précisent la description de la balise "multiset" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", e.g.,

<ximf:multiset
id="value-restricted"
ilk=" value-restricted-otan"
maxItem="64"
separator=";" />

* Détails sur les attributs de l'élément "multiset" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "multiset".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role|élément rôle]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut "description" permet d’associer un commentaire sur cette donnée.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs

L’élément "multiset" peut contenir un ou plusieurs éléments "string" ou un ou plusieurs éléments "compstring".

<ximf:multiset id="value-restricted-otan-categories" minItem="1" maxItem="64" separator=";" >
<ximf:string ilk="ilk-releasable-to" content="RELEASABLE TO "/>
<ximf:string ilk="ilk-eyes-only" content=" EYES ONLY"/>
<ximf:string ilk="ilk-use-only" content=" USE ONLY"/>
</ximf:multiset>

<span style="color:red;">'''TODO :''' Comment sont gérées les règles associées aux champs multivaleurs (disposant par exemple des attributs minItem/maxItem ou les champs multiset) ?</span>

==== Element linkedValue ====
<div style="color: red;">'''TODO ''': L'élément linkedValue indique quelle ressource utiliser lors de la sélection d'un élément particulier mais il n'indique pas où la ressource devra être utilisée.
* Est-ce que cela correspond toujours au header suivant ?
* Pourquoi avoir fait ce choix au lieu d'ajouter un attribut supplémentaire ?
</div>

L’élément "linkedValue" définit une référence sur une ressource de type conteneur ("set", "multiset") ou "string". Cette ressource devrait être utilisée si la ressource contenant "linkedValue" (noeud parent) est sélectionnée.
Un attribut précise la balise "linkvalue" : "ref", e.g.,

<ximf:linkedValue ref="value-restricted-otan-classification-id" />

* Détails sur les attributs de l'élément "linkedValue" :
** L’attribut "ref" précise la valeur de l’attribut "id" de la ressource cible. Cet attribut est obligatoire.

=== Fichier rules ===
Le fichier rules définit les règles de contrôles d’entêtes XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui peut contenir des éléments "ximf:rule".

==== Element rule ====
<div style="color:red">
'''TODO :''' Mettre à jour la documentation :
* Les éléments autorisés dans un élément « rule » ne sont plus à jour. La présente documentation spécifie 12 éléments : AliasHeader, AliasValue, Compatibility, Association, SecureHeaders, SecurityLabel, Constraint, Assignment, Processing, Accessibility, Role et Custom. Le schéma XML fourni avec le mail en spécifie 5 : Constraint, Processing, Compatibility, Policy et Custom et place les autres en tant qu'extentions des 5 éléments cités précédemment.
* Les éléments SecureHeaders et SecurityLabel associés à l'élément « rule » dans la version ci-dessus ne figurent plus dans la nouvelle version. On les retrouve dans les fichiers rules-*.xml mais les éléments sont commentés. En revanche, ils sont bien présents dans une autre instance : s'agit-il d'une fonctionnalité non-documentée ou plus documentée ?
* L'élément ximf:classificationPictures n'est pas documenté. De plus, il serait bon d'avoir des précisions sur la raison qui a motivé l'ajout de cet élément dans les fichiers de règles (alors qu'il semblerait être plus adapté au fichier headers-*.xml).
</div>
L’élément "rule" est le conteneur principal de description d’un comportement particulier à appliquer sur un ensemble d’entêtes XIMF.
Trois attributs précisent la balise "rule" : "id", "agent", "description", e.g.,
<ximf:rule id="compatibility-rule" description="Règle sur la compatibilité X-SMTP / XIMF" >

* Détails sur les attributs de l'élément "rule" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "rule". Cet attribut est obligatoire.
** L’attribut "agent" indique l’équipement cible devant analyser et appliquer le contenu de cet élément.
** L’attribut "description" autorise l’auteur d’ajouter un commentaire sur cet élément.

L’élément "rule" contient un ou plusieurs mêmes éléments de spécialisation de la règle "contraint", "assignement", "processing", "compatibility", "accessibility", "custom",…, e.g.,

<ximf:rule id="precedence-rule" agent="mua" description="Règle sur les priorités">
<ximf:constraint
left="header-primary-precedence"
operator="equalOrGreaterThan"
right="header-copy-precedence" />
</ximf:rule>

==== Element aliasHeader ====
L’élément "aliasHeader" permet de définir le nom de l’entête sur lequel la règle précisée est appliquée
Deux attributs précisent la balise "aliasHeader" : "headerName" et "headerRef", e.g.,

<ximf:aliasHeader headerName ="X-P772-Version" headerRef="X-XIMF-VERSION" />

* Détails sur les attributs de l'élément "aliasHeader" :
* L’attribut "headerName" définit le nom XIMF de l’entête modifié par la règle. Cet attribut est obligatoire.
* L’attribut "headerRef" définit le nom d’un entête XIMF de référence qui est le point d’entrée de l’application de la règle sur l’entête définit par "headerName". Cela permet de lier deux entêtes de messages où l’utilisation de l’un des entêtes influe sur le comportement de l’autre.

L’élément "aliasHeader" peut contenir des éléments "aliasValue",e.g ,

<ximf:aliasHeader headerName="X-P772-Version" />
<ximf:aliasValue vame="1.0"/>
<ximf:aliasHeader>

==== Element aliasValue ====
L’élément "aliasValue" contient une valeur à associer à l’entête XIMF contrôlé par la règle. Il est utile lorsque deux entêtes sont liées (utilisation de l’attribut headerRef dans l’élément aliasHeader) et que les valeurs de l’entêtes de référence permettent de préciser celles de l’entête contrôlé.
Deux attributs précisent la balise "aliasValue" : "valueName", "valueRef", e.g.,

<ximf:aliasValue valueName="2" valueRef ="flash" />

* Détails sur les attributs de l'élément "aliasValue" :
** L’attribut "valueName" définit la valeur de l’entête à créer. Cet attribut est obligatoire.
** L’attribut "valueRef" définit la valeur de l’entête XIMF de référence pour utiliser valueName.
<span style="color:red;">'''TODO :''' L'attribut valueRef est-il obligatoire ?</span>

==== Element compatibility ====
L’élément "compatibility" est utilisé pour associer à un entête respectant la norme XIMF un entête respectant une autre norme que XIMF (XSMTP par exemple).
Deux attributs précisent la balise "compatibility" : "targetName", "targetVersion", e.g.,

<ximf:compatibility targetName="X-SMTP" targetVersion="1.1">
<ximf:aliasValue headerName="X-P772-Version" content="1.1" />
<ximf:aliasValue
headerName="X-P772-Primary-Precedence"
headerRef="header-primary-precedence"
dataRef="data-priority-xsmtp"/>
</ximf:compatibility>

* Détails sur les attributs de l'élément "compatibility" :
** L’attribut "targetName" définit la norme de l’entête à associer à l’entête XIMF. Cet attribut est obligatoire.
** L’attribut "targetVersion" définit le numéro de version de la norme de l’entête à associer à l’entête XIMF. Cet attribut est obligatoire.

L’élément "compatibility" contient au moins un élément "aliasHeader".

<u>Pour illustrer cette règle :</u>
Le format XSMTP est déjà supporté par certains équipements. Afin de rendre ceux-ci inter opérables avec le nouveau format XIMF, cette règle permet d’associer un entête XSMTP contenant les mêmes informations qu’un entête XIMF.

L’élément Association : dépendance entre entêtes
L’élément "association" définie les valeurs autorisées pour un entête XIMF en fonction d’une valeur définie pour un autre entête XIMF.

<ximf:association>
<ximf:aliasHeader
headerName="X-XIMF-Primary-Precedence"
headerRef="X-XIMF-Correspondence-Type">
<ximf:aliasValue valueName="routine" valueRef="private" />
<ximf:aliasValue valueName="routine,priority" valueRef="professional" />
<ximf:aliasValue valueName="routine,priority,immediate,flash" valueRef="operational" />
<ximf:aliasValue valueName="routine,priority,immediate" valueRef="official" />
</ximf:aliasHeader>
</ximf:association>

==== Element secureHeaders ====
<div style="color:red;">'''TODO :''' Les éléments SecureHeaders et SecurityLabel associés à l'élément « rule » dans la version ci-dessus ne figurent plus dans le shéma xml. On les retrouve dans les fichiers rules-*.xml mais les éléments sont commentés. En revanche, ils sont bien présents dans une autre instance : s'agit-il d'une fonctionnalité non-documentée ou plus documentée ?</div>
L’élément "secureHeaders" définie la liste des entêtes à intégrer dans la signature d’un message. Cette règle s’applique sur les équipements proposant un algorithme de signature des messages.

Un élément "secureHeaders" contient un ou plusieurs éléments "aliasHeaders" où chaque élément décrit un entête à intégrer dans la signature et complété d’un attribut "status".

<ximf:secureHeaders targetName="SecureHeaders">
<ximf:aliasHeader headerName="X-XIMF-Primary-Precedence" status="0" />
<ximf:aliasHeader headerName="X-XIMF-Copy-Precedence" status="0" />
</ximf:secureHeaders>

==== Element securityLabel ====
L’élément "securityLabel" définie la liste des entêtes à intégrer dans la signature d’un message. Cette règle s’applique sur les équipements proposant un algorithme de signature des messages selon la norme RFC.

Un élément "securityLabel" contient un ou plusieurs éléments "aliasHeaders" où chaque élément décrit un entête à intégrer dans la signature et complété d’un attribut "status".

<ximf:securityLabel targetName="SecurityLabel" id="Amoco">
<ximf:aliasHeader
headerName="SecurityPolicyIdentifier"
headerRef="X-XIMF-Security-Policy-Identifier" />
<ximf:aliasHeader
headerName="SecurityClassification"
headerRef="X-XIMF-Security-Classification-Identifier" />
<ximf:aliasHeader
headerName="ESSPrivacyMark"
headerRef="X-XIMF-Privacy-Mark" />
<ximf:aliasHeader
headerName="SecurityCategory"
headerRef="X-XIMF-Security-Categories-Identifier"
type="2" />
</ximf:securityLabel>

==== Element constraint ====
L’élément "constraint" est utilisé pour définir une règle de construction de deux entêtes partageant des "datas" identiques.
Trois attributs précisent la balise "constraint" : "left", "right", "operator", e.g.,

<ximf:constraint
left="header-primary-precedence"
operator="equalOrGreaterThan"
right="header-copy-precedence" />

* Détails sur les attributs de l'élément "constraint" :
** L’attribut "left" désigne le premier élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "right" désigne le deuxième élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "operator" indique la règle de poids à appliquer sur la valeur des deux éléments "header", il peut être de type "greaterThan", "lowerThan", "equalOrGreaterThan", "equalOrLowerThan", "equal". Cet attribut est obligatoire.

* Détails sur les valeurs possibles de l'attribut "type" :
** Le type "greaterThan" signifie que la valeur de l’élément "left" doit être strictement supérieur à la valeur de l’élément "right".
** Le type "lowerThan" signifie que la valeur de l’élément "left" doit être strictement inférieur à la valeur de l’élément "right".
** Le type "equalOrGreaterThan" signifie que la valeur de l’élément "left" doit être supérieur ou égale à la valeur de l’élément "right".
** Le type "equalOrLowerThan" signifie que la valeur de l’élément "left" doit être inférieur ou égale à la valeur de l’élément "right".
** Le type "equal" signifie que la valeur de l’élément "left" et de l’élément "right" doivent être identiques.

==== Element assignment ====
<div style="color:red;">'''TODO :''' L'élément assignment n'apparaît pas dans le shéma xml qui avait été envoyé.</div>

L’élément "assignement" est utilisé pour affecter une valeur créée en fonction d’une règle de comparaison sur les valeurs de deux éléments "header".
Quatre attributs précisent la balise "assignement" : "left", "right", "operator", "result", e.g.,

<ximf:assignment
left="header-primary-precedence"
operator="equal"
right="data-routine-precedence"
result="86400" />

* Détails sur les attributs de l'élément "assignment" :
** L’attribut "left" désigne le premier élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "right" désigne le deuxième élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "operator" indique la règle de comparaison entre les valeurs des deux éléments "header", il peut être de type "greaterThan", "lowerThan", "equalOrGreaterThan", "equalOrLowerThan", "equal". Cet attribut est obligatoire.
** L’attribut "result" représente la valeur à utiliser si la règle de comparaison entre les deux éléments est satisfaite. Cet attribut est obligatoire.

==== Element processing ====
L’élément "processing" regroupe des règles de traitement à effectuer sur des entêtes formatés.
L’attribut "type" précise le type de traitement à effectuer sur ces valeurs. Cet attribut est obligatoire, il est de type : "sign-header-value", "encrypt-header-value", "capitalize-header-value", e.g.,

<ximf:processing type="sign-header-value">
<ximf:refHeader>header-primary-precedence</ximf:refheader>
<ximf:refHeader>header-copy-precedence</ximf:refheader>
<ximf:refHeader>header-echange-type</ximf:refheader>
</ximf:processing>

* Détails sur les valeurs possibles de l'attribut "type" :
** Le type "sign-header-value" définit un traitement de signature des entêtes définis dans la balise.
** Le type "encrypt-header-value" définit un traitement de chiffrement des entêtes définis dans la balise.
** Le type "capitalize-header-value" définit un traitement de capitalisation des entêtes définis dans la balise.

L’élément "processing" contient au moins un élément "refHeader".
<div style="color:red;">'''TODO :'''L'élément refHeader n'est pas documenté, s'agit-il en fait de l'élément headerRef ?</div>

==== Element accessibility ====
<div style="color:red;">'''TODO :''' L'élément accessibility n'apparaît pas dans le shéma xml qui avait été envoyé.</div>
L’élément "accessibility" définit un ensemble de règles de droit d’accès aux éléments d’une instance pour une cible déterminée (utilisateur, routeur…).
Cet élément contient un ou plusieurs éléments "role".

<ximf:accessibility>
<ximf:role id="role-flash-allowed" aclLevel="100" />
<ximf:role id="role-flash-prohibited" aclLevel="50" />
</ximf:accessibility>

==== Element role ====
L’élément "role" positionne une valeur d’accès à pour une entité définit.
Deux attributs complètent l’élément "role" : "id", "aclLevel", e.g.,

<ximf:role id="role-flash-allowed" aclLevel="100" />

* Détails sur les attributs de l'élément "role" :
** L’attribut "id" précise l’entité accessible en fonction d’une valeur déterminée.
** L’attribut "aclLevel" précise la valeur seuil d’accès à l’entité.

==== Element custom ====
L’élément "custom" permet à l’auteur de créer des nouvelles règles personnalisées.
Trois attributs précisent la balise "custom" : "id", "provider", "description", e.g.,

<ximf:custom
id="custom-display"
provider="EADS"
description="Affichage de la composition du message" >
<node1><node2><node3></node3></node2></node1>
</ximf:custom>

* Détails sur les attributs de l'élément "custom" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "custom" et formaté selon la syntaxe "custom-xxx". Cet attribut est obligatoire.
** L’attribut "provider" identifie l’auteur de la règle. Cet attribut est obligatoire.
** L’attribut "description" permet d’ajouter un commentaire sur cet élément.

L’élément "custom" peut contenir tous les éléments possibles en respectant les standards XML.

XIMF XML tags/fr

2011-02-25T07:44:56Z

Anthonyjuge : /* Element compstring */

== Introduction ==
Ce document propose un modèle de description, via eXtensible Markup Language (XML), d’entêtes de messages électroniques respectant la norme XIMF. Ce document a deux objectifs :
# Décrire les éléments et attributs de représentation XML pour construire des entêtes de messages électroniques de format XIMF.
# Fournir un modèle de représentation XIMF/XML.

<u>Rappel :</u>
* Un "élément" fait référence à tous les caractères situés entre une balise de départ et un balise de fin, e.g.,
<exemple> texte et/ou éléments fils </exemple>
* Un "attribut" est une composante d’un élément. Il est positionné dans la balise de départ, e.g.,
<exemple nom='value'>

Tous les éléments décrits dans cette documentation paragraphe sont validés dans l’espace de nom "ximf".

<pre>
xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://eads.org/ximf/ximf.xsd"
</pre>

== Description détaillée des balises XML ==

Voici, par ordre d'apparition et en fonction des fichiers, les balises génériques associées aux différents fichiers XML.

=== Fichier ximfmail-profile ===

<div style="color:red;">'''TODO''' :
* Combien d'éléments ihm sont autorisés dans un élément instance ?
* La documentation des fichiers ximfmail-profile.xml n'est pas disponible. Est-il possible d'avoir accès au fichier ximf_profile.xsd mentionné dans les ximfmail-profile.xml ?
</div>

Un fichier xpi peut contenir plusieurs instances XIMF, celles-ci sont alors regroupées dans une même catégorie. Le fichier ximfmail-profile contient des informations sur toutes les instances contenues dans le xpi, notamment leur nom, leur chemin d'accès, ainsi que les noms des fichiers associés à chaque instance.

==== Element instance ====
L’élément "instance" identifie l’ensemble des entêtes à décrire selon la norme XIMF. C’est le conteneur principal d’une instance XIMF/XML. Cinq attributs précisent la balise "instance" : "ximfVersion", "version", "author", "creation", "name", e.g.,
<ximf:instance name="myInstance" version="1.0" ximfVersion="2.0" >

* Détails sur les attributs de l'élément "instance" :
** L’attribut "name" définit le nom de l’instance décrite. Cet attribut est obligatoire.
** L’attribut "ximfVersion" définit le numéro de version des entêtes XIMF utilisés pour cette représentation. Cet attribut est obligatoire.
** L’attribut "version" définit le numéro de version de l’instance décrite. Cet attribut est obligatoire.
** L’attribut "author" renseigne sur le nom de l’auteur de cette instance.
** L’attribut "creationDate" précise la date de création de cette instance.

L’élément "instance" peut contenir un ou plusieurs éléments "schema", un ou plusieurs éléments "rule", un élément "ihm" et un élément "dictionary".

==== Element dictionary ====
L'élément dictionary contient le chemin vers le fichier spécifiant les données d'internationalisation (Cf. [[#Fichier_dictionary|Fichier dictionary]]).

==== Element schema ====
L'élément shema contient le chemin vers le fichier spécifiant les entêtes XIMF (Cf. [[#Fichier_headers|Fichier headers]]).

==== Element ihm ====
L'élément ihm contient le chemin vers le fichier spécifiant la disposition de l'interface des formulaires XIMF (Cf. [[#Fichier_ihm|Fichier ihm]]).

==== Element rule ====
L'élément rule contient le chemin vers le fichier spécifiant les règles associées aux valeurs des champs XIMF (Cf. [[#Fichier_rules|Fichier rules]]).

=== Fichier dictionary ===
Le fichier dictionnary permet de mettre en œuvre l’internationalisation d’une instance XIMF. Il défini des dictionnaires qui servent à traduire les éléments de l'instance XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient un élément "ximf:dictionnary".

==== Element dictionary ====
<div style="color:red;">'''TODO''' :
* Est-il obligé de renseigner les données d'internationalisation pour <u>tous</u> les labels ? (ce n'est actuellement pas le cas dans l'instance Whirlpool)
* Quel est l'intérêt de renseigner un attribut "id" à l'élément "dictionary" (étant donné qu'un seul élément "dictionary n'est autorisé dans l'élément "instance") ?</div>

L’élément "dictionary" contient toutes les informations devant être interprétées selon le pays d’utilisation.
L’élément "dictionary" contient un ou plusieurs mêmes éléments "locale", e.g.,

<ximf:dictionary>
<ximf:locale lang="fr-FR" />
<ximf:locale lang="en-US" />
</ximf:dictionary>

==== Element locale ====
L’élément "locale" contient toutes les informations pour un pays et/ou langue désignée.
L’élément "locale" contient un ou plusieurs mêmes éléments "ilk", e.g.,

<ximf:locale lang="fr-FR" >
<ximf:ilk entity="a"/>
<ximf:ilk entity="b"/>
</ximf:locale>

* Détails sur les attributs de la balise "locale" :
** L’attribut "lang" définit le code pays de ce conteneur. Il devrai être construit selon le format défini par la RFC1766 (fr, en, ja, es, …).

==== Element ilk ====
L’élément "ilk" contient une unique information correspondant à une donnée traduite selon le code pays de l’élément père. Cette information est au format chaîne de caractère. Un attribut obligatoire précise la balise "ilk".

<ximf:ilk entity="ilk-lang-ihm">langue</ximf:ilk>

* Détails sur les attributs de la balise "ilk" :
** L’attribut "entity" définit la référence d’entrée pour récupérer le contenu de l’élément selon le code pays souhaité.

Finalement, le fichier "dictionary" pourra contenir :
<ximf:instance name="Whirlpool">
<ximf:dictionary>
<ximf:locale lang="fr-FR" >
<ximf:ilk entity="ilk-lang-ihm">Français</ximf:ilk>
<ximf:ilk entity="ilk-exemple-general">Général</ximf:ilk>
</ximf:locale>
<ximf:locale lang="en-US" >
<ximf:ilk entity="ilk-lang-ihm">English (US)</ximf:ilk>
<ximf:ilk entity="ilk-exemple-general">General</ximf:ilk>
</ximf:locale>
</ximf:dictionary>
</ximf:instance>

=== Fichier ihm ===
<span style="color:red;">'''TODO''' : La documentation originale ne décrit pas le fichier ihm, les informations ci-dessous ont seulement été présumées. Merci de les vérifier/compléter.
</span>

Le fichier ihm spécifie l'agencement de l'interface des formulaires XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient un élément "ximf:ihm".

==== Element ihm ====
L'élément "ihm" contient un ou plusieurs éléments "panel" et un élément "treeRcv".

==== Element panel ====
Un élément ximf:panel correspond à un onglet du formulaire XIMF construit.
Deux attributs précisent la balise "panel" : "id" et "ilk", eg.
<ximf:panel id="pane_security" ilk="ilk-priority-panel" />

* Détails sur les attributs de l'élément "panel" :
** L’attribut "id" définit le nom de l'onglet, il doit être unique pour chaque élément "ximf:panel" et est formaté selon la syntaxe "pane-xxx". Cet attribut est obligatoire.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.

L'élément "ximf:panel" contient au moins un éléments "ximf:groupbox".

==== Element groupbox ====
Un élément groupbox correspond à une sous catégorie d'un onglet du formulaire XIMF.
La structure "groupbox" détaille l’ordre d’affichage des entêtes dans un message.
Deux attributs précisent la balise "ximf:groupbox" : "id" et "ilk", eg.
<ximf:groupbox id="group-classification" ilk="ilk-secu-box" />

* Détails sur les attributs de l'élément "groupbox" :
** L’attribut "id" définit le nom de l'onglet, il doit être unique pour chaque élément "ximf:panel" et est formaté selon la syntaxe "pane-xxx". Cet attribut est obligatoire.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.

L'élément "groupbox" contient au moins un éléments "headerRef".

==== Element treeRcv ====
L'élément "treeRcv" permet de spécifier quelles sont les colonnes susceptibles d'être ajoutées dans le panneau principal du client de messagerie qui contient la liste des messages d’un dossier.

L'élément "treeRcv" peut contenir des éléments "headerRef".

==== Element headerRef ====
L'élément headerRef spécifie les champs associés à chaque sous-groupe d'onglet de formulaire ou les champs qu'il est possible d'afficher dans la liste des messages.
Aucun attribut ne vient compléter la balise "headerRef", eg.
<ximf:headerRef>header-classification</ximf:headerRef>

Finalement, le fichier "ihm" pourra contenir :
<pre>
<ximf:instance name="Amoco">
<ximf:ihm>
<ximf:panel id="pane_security" ilk="ilk-priority-panel">
<ximf:groupbox id="group-classification" ilk="ilk-secu-box">
<ximf:headerRef>header-correspondance-type</ximf:headerRef>
<ximf:headerRef>header-classification</ximf:headerRef>
</ximf:groupbox>
</ximf:panel>
<ximf:treeRcv>
<ximf:headerRef>header-classification</ximf:headerRef>
</ximf:treeRcv>
</ximf:ihm>
</ximf:instance>
</pre>

=== Fichier headers ===
Le fichier headers spécifie les types des champs de l'interface des formulaires XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient des éléments "header".

==== Element header ====
Chaque élément "header" décrit un entête de message de format XIMF.
Huit attributs précisent la balise "header" : "headerName", "id", "technicalHeaderName", "type", "technicalType", "isMandatory", "ilk", "description", e.g.,

<div style="color:red;">'''TODO :'''
Comment est effectuée la vérification de l'attribut isMandatory et quelles sont les conditions de fonctionnement de celui-ci ? Est-il possible, par exemple, de spécifier l'attribut isMandatory=true d'un élément header si le contenu de celui-ci est un élément « set » qui dispose des attributs minItem et maxItem ?Actuellement, lorsque l'on crée un élément set avec les attributs minItem et maxItem, le champ du formulaire associé ne peux pas être validé : e.g.,
<ximf:set id="value-amoco-classification" minItem="1" maxItem="64" separator=";" technicalSeparator=".">
Est-ce un bug ?
</div>

<ximf:header id="header-primary-precedence"
headerName="X-XIMF-Primary-Precedence"
ilk="ilk-primary-precedence"
isMandatory="true"
description="entête d’urgence"
type="string" />

* Détails sur les attributs de l'élément "header" :
** L’attribut "headerName" définit le nom du champ XIMF. Cet attribut est obligatoire.
** L’attribut "id" définit un identifiant de champ, il doit être unique pour chaque élément "header" et est formaté selon la syntaxe "header-xxx". Cet attribut est obligatoire.
** L’attribut "isMandatory" précise si ce champ doit être obligatoirement présent dans le message intégrant les entêtes selon cette description.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.
** L’attribut "type" précise le format des données associées à cet élément. Ce format peut être une date, une chaîne, une adresse mail, un O.I.D.
** L’attribut "technicalHeaderName" permet de compléter l’entête décrit par un autre entête.
** L’attribut "technicalType" précise le format des données associées à l’élément technicalHeaderName.
** L’attribut "description" permet d’ajouter une information sur cet élément.

L’élément "header" contient obligatoirement un élément "set", "multiset", "string", ou "compstring", e.g.,

<ximf:header id="header-reply-by"
headerName="X-XIMF-Reply-By"
ilk="ilk-reply-by"
isMandatory="false" >
<ximf:string id="value-reply-by" editable="true" />
</ximf:header>

<div style="color:red;">
'''TODO :''' Quelles sont les contraintes associées à l'attribut type d'un élément header ?
</div>

==== Element string ====
L’élément "string" précise le contenu d’une ressource de type chaîne de caractères imprimables (a-z, A-Z, 1-9,…)
Quinze attributs complètent l’élément "string" : "id", "ref", "ilk", "aclLevel", "index", "description", "editable", "content", "technicalContent","maxItem", "minItem", "maxLength", "minLength", "separator", "technicalSeparator", e.g.,

<ximf:string ilk="ilk-france" content="FRA" />

* Détails sur les attributs de l'élément "string" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "string".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[Element_ximf:role| élément role]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut " description " permet d’associer un commentaire sur cette donnée.
** L’attribut "editable" définit une valeur de saisie (champ libre). Cet attribut est de type booléen.
** L’attribut "content" représente la valeur effective de la donnée. C’est cette donnée qui sera associée au champ XIMF créé.
** L’attribut "technicalContent" représente la valeur effective de la donnée technique. C’est cette donnée qui sera associée au champ technique XIMF créé (cf. attribut technicalHeaderName de l’élément "header".
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.

L’élément "string" peut contenir plusieurs éléments "linkedValue".

<ximf:string ilk="ilk-non-protege" content="NON PROTEGE" technicalContent="1" >
<ximf:linkedValue ref="value-non-protege-france " />
</ximf:string>

==== Element compstring ====
<div style="color:red;">
'''TODO :''' L'attribut de l'élément « compstring » nommé « contentFactorise » devrait s'appeler « contentFactorize ».
</div>
L’élément "compstring" décrit un conteneur de concaténation des éléments fils. Il permet notamment de créer des valeurs d’entêtes composées.
Dix-sept attributs complètent l’élément "compstring" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", "content", "technicalContent", "contentPositionEnd", "contentFactorise", "technicalPositionEnd", e.g.,

<ximf:compstring
ilk="ilk-special"
content="SPECIAL"
technicalContent="1.3.4"
separator=" "
technicalSeparator=".">

* Détails sur les attributs de l'élément "compstring" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "compstring".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (cf. [[#Element_role| élément "role"]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut " description " permet d’associer un commentaire sur cette donnée.
** L’attribut "content" représente la valeur effective de la donnée. C’est cette donnée qui sera associée au champ XIMF créé.
** L’attribut "technicalContent" représente la valeur effective de la donnée technique. C’est cette donnée qui sera associée au champ technique XIMF créé (cf. attribut technicalHeaderName de l’élément "header".
** L’attribut "separator" définit le caractère de séparation entre deux valeurs.
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "contentPositionEnd" impose de positionner le contenu de l’élément "compstring" après les valeurs des éléments fils : valuefils1,valuefils2 : valuecompstring.
** L’attribut "technicalPositionEnd" impose de positionner le contenu de l’élément "compstring" après les valeurs des éléments fils.
** L’attribut "contentFactorise" impose d’utiliser le contenu de l’élément "compstring" comme facteur des éléments fils : valuecompstring(valuefils1,valuefils2).

L’élément "compstring" peut contenir un élément "string" ou "set" ou "multiset" ou plusieurs éléments "compstring".

<ximf:compstring
ilk="ilk-special"
content="SPECIAL"
technicalContent="1.3.4"
separator=" "
technicalSeparator=".">
<ximf:set id="ilk-special-op " maxItem="64">
<ximf:string ilk="ilk-special-op1" content="OP1" technicalContent="1" />
<ximf:string ilk="ilk-special-op2" content="OP2" technicalContent="2" />
<ximf:string ilk="ilk-special-op3" content="OP3" technicalContent="3" />
</ximf:set>
</ximf:compstring>

==== Element set ====
L’élément "set" décrit un conteneur de ressources de même type. Cet élément autorise la sélection de plusieurs ressources mais chaque ressource est sélectionnée une seule fois.
Douze attributs précisent la description de la balise "set" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", e.g.,

<ximf:set id="value-categories" ref="value-mentions" maxItem="64" separator=";" />

* Détails sur les attributs de l'élément "set" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "ximf:set".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role|élément rôle]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut "description" permet d’associer un commentaire sur cette donnée.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs

L’élément "set" peut contenir un ou plusieurs éléments "string" ou un ou plusieurs éléments "compstring".

<ximf:set id="value-categories" minItem="1" maxItem="64" separator=";">
<ximf:string ilk="ilk-releasable-to" content="RELEASABLE TO " />
<ximf:string ilk="ilk-eyes-only" content=" EYES ONLY"/>
<ximf:string ilk="ilk-use-only" content=" USE ONLY"/>
</ximf:set>

<div style="color:red;">'''TODO :'''
* Y a-t-il une définition des fichiers associés aux instances XIMF (e.g, le fichier attribution-list.xml utilisé dans l'instance Caterpillar) ?
* Comment le parseur d'instance ximf sait qu'un élément est une "attribution-list" ?
</div>

==== Element multiset ====
L’élément "multiset" décrit un conteneur de ressources de même type. Cet élément autorise la sélection de plusieurs ressources et chaque ressource peut être sélectionnée plusieurs fois.
Douze attributs précisent la description de la balise "multiset" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", e.g.,

<ximf:multiset
id="value-restricted"
ilk=" value-restricted-otan"
maxItem="64"
separator=";" />

* Détails sur les attributs de l'élément "multiset" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "multiset".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role|élément rôle]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut "description" permet d’associer un commentaire sur cette donnée.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs

L’élément "multiset" peut contenir un ou plusieurs éléments "string" ou un ou plusieurs éléments "compstring".

<ximf:multiset id="value-restricted-otan-categories" minItem="1" maxItem="64" separator=";" >
<ximf:string ilk="ilk-releasable-to" content="RELEASABLE TO "/>
<ximf:string ilk="ilk-eyes-only" content=" EYES ONLY"/>
<ximf:string ilk="ilk-use-only" content=" USE ONLY"/>
</ximf:multiset>

<span style="color:red;">'''TODO :''' Comment sont gérées les règles associées aux champs multivaleurs (disposant par exemple des attributs minItem/maxItem ou les champs multiset) ?</span>

==== Element linkedValue ====
<div style="color: red;">'''TODO ''': L'élément linkedValue indique quelle ressource utiliser lors de la sélection d'un élément particulier mais il n'indique pas où la ressource devra être utilisée.
* Est-ce que cela correspond toujours au header suivant ?
* Pourquoi avoir fait ce choix au lieu d'ajouter un attribut supplémentaire ?
</div>

L’élément "linkedValue" définit une référence sur une ressource de type conteneur ("set", "multiset") ou "string". Cette ressource devrait être utilisée si la ressource contenant "linkedValue" (noeud parent) est sélectionnée.
Un attribut précise la balise "linkvalue" : "ref", e.g.,

<ximf:linkedValue ref="value-restricted-otan-classification-id" />

* Détails sur les attributs de l'élément "linkedValue" :
** L’attribut "ref" précise la valeur de l’attribut "id" de la ressource cible. Cet attribut est obligatoire.

=== Fichier rules ===
Le fichier rules définit les règles de contrôles d’entêtes XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui peut contenir des éléments "ximf:rule".

==== Element rule ====
<div style="color:red">
'''TODO :''' Mettre à jour la documentation :
* Les éléments autorisés dans un élément « rule » ne sont plus à jour. La présente documentation spécifie 12 éléments : AliasHeader, AliasValue, Compatibility, Association, SecureHeaders, SecurityLabel, Constraint, Assignment, Processing, Accessibility, Role et Custom. Le schéma XML fourni avec le mail en spécifie 5 : Constraint, Processing, Compatibility, Policy et Custom et place les autres en tant qu'extentions des 5 éléments cités précédemment.
* Les éléments SecureHeaders et SecurityLabel associés à l'élément « rule » dans la version ci-dessus ne figurent plus dans la nouvelle version. On les retrouve dans les fichiers rules-*.xml mais les éléments sont commentés. En revanche, ils sont bien présents dans une autre instance : s'agit-il d'une fonctionnalité non-documentée ou plus documentée ?
* L'élément ximf:classificationPictures n'est pas documenté. De plus, il serait bon d'avoir des précisions sur la raison qui a motivé l'ajout de cet élément dans les fichiers de règles (alors qu'il semblerait être plus adapté au fichier headers-*.xml).
</div>
L’élément "rule" est le conteneur principal de description d’un comportement particulier à appliquer sur un ensemble d’entêtes XIMF.
Trois attributs précisent la balise "rule" : "id", "agent", "description", e.g.,
<ximf:rule id="compatibility-rule" description="Règle sur la compatibilité X-SMTP / XIMF" >

* Détails sur les attributs de l'élément "rule" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "rule". Cet attribut est obligatoire.
** L’attribut "agent" indique l’équipement cible devant analyser et appliquer le contenu de cet élément.
** L’attribut "description" autorise l’auteur d’ajouter un commentaire sur cet élément.

L’élément "rule" contient un ou plusieurs mêmes éléments de spécialisation de la règle "contraint", "assignement", "processing", "compatibility", "accessibility", "custom",…, e.g.,

<ximf:rule id="precedence-rule" agent="mua" description="Règle sur les priorités">
<ximf:constraint
left="header-primary-precedence"
operator="equalOrGreaterThan"
right="header-copy-precedence" />
</ximf:rule>

==== Element aliasHeader ====
L’élément "aliasHeader" permet de définir le nom de l’entête sur lequel la règle précisée est appliquée
Deux attributs précisent la balise "aliasHeader" : "headerName" et "headerRef", e.g.,

<ximf:aliasHeader headerName ="X-P772-Version" headerRef="X-XIMF-VERSION" />

* Détails sur les attributs de l'élément "aliasHeader" :
* L’attribut "headerName" définit le nom XIMF de l’entête modifié par la règle. Cet attribut est obligatoire.
* L’attribut "headerRef" définit le nom d’un entête XIMF de référence qui est le point d’entrée de l’application de la règle sur l’entête définit par "headerName". Cela permet de lier deux entêtes de messages où l’utilisation de l’un des entêtes influe sur le comportement de l’autre.

L’élément "aliasHeader" peut contenir des éléments "aliasValue",e.g ,

<ximf:aliasHeader headerName="X-P772-Version" />
<ximf:aliasValue vame="1.0"/>
<ximf:aliasHeader>

==== Element aliasValue ====
L’élément "aliasValue" contient une valeur à associer à l’entête XIMF contrôlé par la règle. Il est utile lorsque deux entêtes sont liées (utilisation de l’attribut headerRef dans l’élément aliasHeader) et que les valeurs de l’entêtes de référence permettent de préciser celles de l’entête contrôlé.
Deux attributs précisent la balise "aliasValue" : "valueName", "valueRef", e.g.,

<ximf:aliasValue valueName="2" valueRef ="flash" />

* Détails sur les attributs de l'élément "aliasValue" :
** L’attribut "valueName" définit la valeur de l’entête à créer. Cet attribut est obligatoire.
** L’attribut "valueRef" définit la valeur de l’entête XIMF de référence pour utiliser valueName.
<span style="color:red;">'''TODO :''' L'attribut valueRef est-il obligatoire ?</span>

==== Element compatibility ====
L’élément "compatibility" est utilisé pour associer à un entête respectant la norme XIMF un entête respectant une autre norme que XIMF (XSMTP par exemple).
Deux attributs précisent la balise "compatibility" : "targetName", "targetVersion", e.g.,

<ximf:compatibility targetName="X-SMTP" targetVersion="1.1">
<ximf:aliasValue headerName="X-P772-Version" content="1.1" />
<ximf:aliasValue
headerName="X-P772-Primary-Precedence"
headerRef="header-primary-precedence"
dataRef="data-priority-xsmtp"/>
</ximf:compatibility>

* Détails sur les attributs de l'élément "compatibility" :
** L’attribut "targetName" définit la norme de l’entête à associer à l’entête XIMF. Cet attribut est obligatoire.
** L’attribut "targetVersion" définit le numéro de version de la norme de l’entête à associer à l’entête XIMF. Cet attribut est obligatoire.

L’élément "compatibility" contient au moins un élément "aliasHeader".

<u>Pour illustrer cette règle :</u>
Le format XSMTP est déjà supporté par certains équipements. Afin de rendre ceux-ci inter opérables avec le nouveau format XIMF, cette règle permet d’associer un entête XSMTP contenant les mêmes informations qu’un entête XIMF.

L’élément Association : dépendance entre entêtes
L’élément "association" définie les valeurs autorisées pour un entête XIMF en fonction d’une valeur définie pour un autre entête XIMF.

<ximf:association>
<ximf:aliasHeader
headerName="X-XIMF-Primary-Precedence"
headerRef="X-XIMF-Correspondence-Type">
<ximf:aliasValue valueName="routine" valueRef="private" />
<ximf:aliasValue valueName="routine,priority" valueRef="professional" />
<ximf:aliasValue valueName="routine,priority,immediate,flash" valueRef="operational" />
<ximf:aliasValue valueName="routine,priority,immediate" valueRef="official" />
</ximf:aliasHeader>
</ximf:association>

==== Element secureHeaders ====
<div style="color:red;">'''TODO :''' Les éléments SecureHeaders et SecurityLabel associés à l'élément « rule » dans la version ci-dessus ne figurent plus dans le shéma xml. On les retrouve dans les fichiers rules-*.xml mais les éléments sont commentés. En revanche, ils sont bien présents dans une autre instance : s'agit-il d'une fonctionnalité non-documentée ou plus documentée ?</div>
L’élément "secureHeaders" définie la liste des entêtes à intégrer dans la signature d’un message. Cette règle s’applique sur les équipements proposant un algorithme de signature des messages.

Un élément "secureHeaders" contient un ou plusieurs éléments "aliasHeaders" où chaque élément décrit un entête à intégrer dans la signature et complété d’un attribut "status".

<ximf:secureHeaders targetName="SecureHeaders">
<ximf:aliasHeader headerName="X-XIMF-Primary-Precedence" status="0" />
<ximf:aliasHeader headerName="X-XIMF-Copy-Precedence" status="0" />
</ximf:secureHeaders>

==== Element securityLabel ====
L’élément "securityLabel" définie la liste des entêtes à intégrer dans la signature d’un message. Cette règle s’applique sur les équipements proposant un algorithme de signature des messages selon la norme RFC.

Un élément "securityLabel" contient un ou plusieurs éléments "aliasHeaders" où chaque élément décrit un entête à intégrer dans la signature et complété d’un attribut "status".

<ximf:securityLabel targetName="SecurityLabel" id="Amoco">
<ximf:aliasHeader
headerName="SecurityPolicyIdentifier"
headerRef="X-XIMF-Security-Policy-Identifier" />
<ximf:aliasHeader
headerName="SecurityClassification"
headerRef="X-XIMF-Security-Classification-Identifier" />
<ximf:aliasHeader
headerName="ESSPrivacyMark"
headerRef="X-XIMF-Privacy-Mark" />
<ximf:aliasHeader
headerName="SecurityCategory"
headerRef="X-XIMF-Security-Categories-Identifier"
type="2" />
</ximf:securityLabel>

==== Element constraint ====
L’élément "constraint" est utilisé pour définir une règle de construction de deux entêtes partageant des "datas" identiques.
Trois attributs précisent la balise "constraint" : "left", "right", "operator", e.g.,

<ximf:constraint
left="header-primary-precedence"
operator="equalOrGreaterThan"
right="header-copy-precedence" />

* Détails sur les attributs de l'élément "constraint" :
** L’attribut "left" désigne le premier élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "right" désigne le deuxième élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "operator" indique la règle de poids à appliquer sur la valeur des deux éléments "header", il peut être de type "greaterThan", "lowerThan", "equalOrGreaterThan", "equalOrLowerThan", "equal". Cet attribut est obligatoire.

* Détails sur les valeurs possibles de l'attribut "type" :
** Le type "greaterThan" signifie que la valeur de l’élément "left" doit être strictement supérieur à la valeur de l’élément "right".
** Le type "lowerThan" signifie que la valeur de l’élément "left" doit être strictement inférieur à la valeur de l’élément "right".
** Le type "equalOrGreaterThan" signifie que la valeur de l’élément "left" doit être supérieur ou égale à la valeur de l’élément "right".
** Le type "equalOrLowerThan" signifie que la valeur de l’élément "left" doit être inférieur ou égale à la valeur de l’élément "right".
** Le type "equal" signifie que la valeur de l’élément "left" et de l’élément "right" doivent être identiques.

==== Element assignment ====
<div style="color:red;">'''TODO :''' L'élément assignment n'apparaît pas dans le shéma xml qui avait été envoyé.</div>

L’élément "assignement" est utilisé pour affecter une valeur créée en fonction d’une règle de comparaison sur les valeurs de deux éléments "header".
Quatre attributs précisent la balise "assignement" : "left", "right", "operator", "result", e.g.,

<ximf:assignment
left="header-primary-precedence"
operator="equal"
right="data-routine-precedence"
result="86400" />

* Détails sur les attributs de l'élément "assignment" :
** L’attribut "left" désigne le premier élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "right" désigne le deuxième élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "operator" indique la règle de comparaison entre les valeurs des deux éléments "header", il peut être de type "greaterThan", "lowerThan", "equalOrGreaterThan", "equalOrLowerThan", "equal". Cet attribut est obligatoire.
** L’attribut "result" représente la valeur à utiliser si la règle de comparaison entre les deux éléments est satisfaite. Cet attribut est obligatoire.

==== Element processing ====
L’élément "processing" regroupe des règles de traitement à effectuer sur des entêtes formatés.
L’attribut "type" précise le type de traitement à effectuer sur ces valeurs. Cet attribut est obligatoire, il est de type : "sign-header-value", "encrypt-header-value", "capitalize-header-value", e.g.,

<ximf:processing type="sign-header-value">
<ximf:refHeader>header-primary-precedence</ximf:refheader>
<ximf:refHeader>header-copy-precedence</ximf:refheader>
<ximf:refHeader>header-echange-type</ximf:refheader>
</ximf:processing>

* Détails sur les valeurs possibles de l'attribut "type" :
** Le type "sign-header-value" définit un traitement de signature des entêtes définis dans la balise.
** Le type "encrypt-header-value" définit un traitement de chiffrement des entêtes définis dans la balise.
** Le type "capitalize-header-value" définit un traitement de capitalisation des entêtes définis dans la balise.

L’élément "processing" contient au moins un élément "refHeader".
<div style="color:red;">'''TODO :'''L'élément refHeader n'est pas documenté, s'agit-il en fait de l'élément headerRef ?</div>

==== Element accessibility ====
<div style="color:red;">'''TODO :''' L'élément accessibility n'apparaît pas dans le shéma xml qui avait été envoyé.</div>
L’élément "accessibility" définit un ensemble de règles de droit d’accès aux éléments d’une instance pour une cible déterminée (utilisateur, routeur…).
Cet élément contient un ou plusieurs éléments "role".

<ximf:accessibility>
<ximf:role id="role-flash-allowed" aclLevel="100" />
<ximf:role id="role-flash-prohibited" aclLevel="50" />
</ximf:accessibility>

==== Element role ====
L’élément "role" positionne une valeur d’accès à pour une entité définit.
Deux attributs complètent l’élément "role" : "id", "aclLevel", e.g.,

<ximf:role id="role-flash-allowed" aclLevel="100" />

* Détails sur les attributs de l'élément "role" :
** L’attribut "id" précise l’entité accessible en fonction d’une valeur déterminée.
** L’attribut "aclLevel" précise la valeur seuil d’accès à l’entité.

==== Element custom ====
L’élément "custom" permet à l’auteur de créer des nouvelles règles personnalisées.
Trois attributs précisent la balise "custom" : "id", "provider", "description", e.g.,

<ximf:custom
id="custom-display"
provider="EADS"
description="Affichage de la composition du message" >
<node1><node2><node3></node3></node2></node1>
</ximf:custom>

* Détails sur les attributs de l'élément "custom" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "custom" et formaté selon la syntaxe "custom-xxx". Cet attribut est obligatoire.
** L’attribut "provider" identifie l’auteur de la règle. Cet attribut est obligatoire.
** L’attribut "description" permet d’ajouter un commentaire sur cet élément.

L’élément "custom" peut contenir tous les éléments possibles en respectant les standards XML.

XIMF XML tags/fr

2011-02-25T07:44:24Z

Anthonyjuge : /* Element compstring */

== Introduction ==
Ce document propose un modèle de description, via eXtensible Markup Language (XML), d’entêtes de messages électroniques respectant la norme XIMF. Ce document a deux objectifs :
# Décrire les éléments et attributs de représentation XML pour construire des entêtes de messages électroniques de format XIMF.
# Fournir un modèle de représentation XIMF/XML.

<u>Rappel :</u>
* Un "élément" fait référence à tous les caractères situés entre une balise de départ et un balise de fin, e.g.,
<exemple> texte et/ou éléments fils </exemple>
* Un "attribut" est une composante d’un élément. Il est positionné dans la balise de départ, e.g.,
<exemple nom='value'>

Tous les éléments décrits dans cette documentation paragraphe sont validés dans l’espace de nom "ximf".

<pre>
xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://eads.org/ximf/ximf.xsd"
</pre>

== Description détaillée des balises XML ==

Voici, par ordre d'apparition et en fonction des fichiers, les balises génériques associées aux différents fichiers XML.

=== Fichier ximfmail-profile ===

<div style="color:red;">'''TODO''' :
* Combien d'éléments ihm sont autorisés dans un élément instance ?
* La documentation des fichiers ximfmail-profile.xml n'est pas disponible. Est-il possible d'avoir accès au fichier ximf_profile.xsd mentionné dans les ximfmail-profile.xml ?
</div>

Un fichier xpi peut contenir plusieurs instances XIMF, celles-ci sont alors regroupées dans une même catégorie. Le fichier ximfmail-profile contient des informations sur toutes les instances contenues dans le xpi, notamment leur nom, leur chemin d'accès, ainsi que les noms des fichiers associés à chaque instance.

==== Element instance ====
L’élément "instance" identifie l’ensemble des entêtes à décrire selon la norme XIMF. C’est le conteneur principal d’une instance XIMF/XML. Cinq attributs précisent la balise "instance" : "ximfVersion", "version", "author", "creation", "name", e.g.,
<ximf:instance name="myInstance" version="1.0" ximfVersion="2.0" >

* Détails sur les attributs de l'élément "instance" :
** L’attribut "name" définit le nom de l’instance décrite. Cet attribut est obligatoire.
** L’attribut "ximfVersion" définit le numéro de version des entêtes XIMF utilisés pour cette représentation. Cet attribut est obligatoire.
** L’attribut "version" définit le numéro de version de l’instance décrite. Cet attribut est obligatoire.
** L’attribut "author" renseigne sur le nom de l’auteur de cette instance.
** L’attribut "creationDate" précise la date de création de cette instance.

L’élément "instance" peut contenir un ou plusieurs éléments "schema", un ou plusieurs éléments "rule", un élément "ihm" et un élément "dictionary".

==== Element dictionary ====
L'élément dictionary contient le chemin vers le fichier spécifiant les données d'internationalisation (Cf. [[#Fichier_dictionary|Fichier dictionary]]).

==== Element schema ====
L'élément shema contient le chemin vers le fichier spécifiant les entêtes XIMF (Cf. [[#Fichier_headers|Fichier headers]]).

==== Element ihm ====
L'élément ihm contient le chemin vers le fichier spécifiant la disposition de l'interface des formulaires XIMF (Cf. [[#Fichier_ihm|Fichier ihm]]).

==== Element rule ====
L'élément rule contient le chemin vers le fichier spécifiant les règles associées aux valeurs des champs XIMF (Cf. [[#Fichier_rules|Fichier rules]]).

=== Fichier dictionary ===
Le fichier dictionnary permet de mettre en œuvre l’internationalisation d’une instance XIMF. Il défini des dictionnaires qui servent à traduire les éléments de l'instance XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient un élément "ximf:dictionnary".

==== Element dictionary ====
<div style="color:red;">'''TODO''' :
* Est-il obligé de renseigner les données d'internationalisation pour <u>tous</u> les labels ? (ce n'est actuellement pas le cas dans l'instance Whirlpool)
* Quel est l'intérêt de renseigner un attribut "id" à l'élément "dictionary" (étant donné qu'un seul élément "dictionary n'est autorisé dans l'élément "instance") ?</div>

L’élément "dictionary" contient toutes les informations devant être interprétées selon le pays d’utilisation.
L’élément "dictionary" contient un ou plusieurs mêmes éléments "locale", e.g.,

<ximf:dictionary>
<ximf:locale lang="fr-FR" />
<ximf:locale lang="en-US" />
</ximf:dictionary>

==== Element locale ====
L’élément "locale" contient toutes les informations pour un pays et/ou langue désignée.
L’élément "locale" contient un ou plusieurs mêmes éléments "ilk", e.g.,

<ximf:locale lang="fr-FR" >
<ximf:ilk entity="a"/>
<ximf:ilk entity="b"/>
</ximf:locale>

* Détails sur les attributs de la balise "locale" :
** L’attribut "lang" définit le code pays de ce conteneur. Il devrai être construit selon le format défini par la RFC1766 (fr, en, ja, es, …).

==== Element ilk ====
L’élément "ilk" contient une unique information correspondant à une donnée traduite selon le code pays de l’élément père. Cette information est au format chaîne de caractère. Un attribut obligatoire précise la balise "ilk".

<ximf:ilk entity="ilk-lang-ihm">langue</ximf:ilk>

* Détails sur les attributs de la balise "ilk" :
** L’attribut "entity" définit la référence d’entrée pour récupérer le contenu de l’élément selon le code pays souhaité.

Finalement, le fichier "dictionary" pourra contenir :
<ximf:instance name="Whirlpool">
<ximf:dictionary>
<ximf:locale lang="fr-FR" >
<ximf:ilk entity="ilk-lang-ihm">Français</ximf:ilk>
<ximf:ilk entity="ilk-exemple-general">Général</ximf:ilk>
</ximf:locale>
<ximf:locale lang="en-US" >
<ximf:ilk entity="ilk-lang-ihm">English (US)</ximf:ilk>
<ximf:ilk entity="ilk-exemple-general">General</ximf:ilk>
</ximf:locale>
</ximf:dictionary>
</ximf:instance>

=== Fichier ihm ===
<span style="color:red;">'''TODO''' : La documentation originale ne décrit pas le fichier ihm, les informations ci-dessous ont seulement été présumées. Merci de les vérifier/compléter.
</span>

Le fichier ihm spécifie l'agencement de l'interface des formulaires XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient un élément "ximf:ihm".

==== Element ihm ====
L'élément "ihm" contient un ou plusieurs éléments "panel" et un élément "treeRcv".

==== Element panel ====
Un élément ximf:panel correspond à un onglet du formulaire XIMF construit.
Deux attributs précisent la balise "panel" : "id" et "ilk", eg.
<ximf:panel id="pane_security" ilk="ilk-priority-panel" />

* Détails sur les attributs de l'élément "panel" :
** L’attribut "id" définit le nom de l'onglet, il doit être unique pour chaque élément "ximf:panel" et est formaté selon la syntaxe "pane-xxx". Cet attribut est obligatoire.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.

L'élément "ximf:panel" contient au moins un éléments "ximf:groupbox".

==== Element groupbox ====
Un élément groupbox correspond à une sous catégorie d'un onglet du formulaire XIMF.
La structure "groupbox" détaille l’ordre d’affichage des entêtes dans un message.
Deux attributs précisent la balise "ximf:groupbox" : "id" et "ilk", eg.
<ximf:groupbox id="group-classification" ilk="ilk-secu-box" />

* Détails sur les attributs de l'élément "groupbox" :
** L’attribut "id" définit le nom de l'onglet, il doit être unique pour chaque élément "ximf:panel" et est formaté selon la syntaxe "pane-xxx". Cet attribut est obligatoire.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.

L'élément "groupbox" contient au moins un éléments "headerRef".

==== Element treeRcv ====
L'élément "treeRcv" permet de spécifier quelles sont les colonnes susceptibles d'être ajoutées dans le panneau principal du client de messagerie qui contient la liste des messages d’un dossier.

L'élément "treeRcv" peut contenir des éléments "headerRef".

==== Element headerRef ====
L'élément headerRef spécifie les champs associés à chaque sous-groupe d'onglet de formulaire ou les champs qu'il est possible d'afficher dans la liste des messages.
Aucun attribut ne vient compléter la balise "headerRef", eg.
<ximf:headerRef>header-classification</ximf:headerRef>

Finalement, le fichier "ihm" pourra contenir :
<pre>
<ximf:instance name="Amoco">
<ximf:ihm>
<ximf:panel id="pane_security" ilk="ilk-priority-panel">
<ximf:groupbox id="group-classification" ilk="ilk-secu-box">
<ximf:headerRef>header-correspondance-type</ximf:headerRef>
<ximf:headerRef>header-classification</ximf:headerRef>
</ximf:groupbox>
</ximf:panel>
<ximf:treeRcv>
<ximf:headerRef>header-classification</ximf:headerRef>
</ximf:treeRcv>
</ximf:ihm>
</ximf:instance>
</pre>

=== Fichier headers ===
Le fichier headers spécifie les types des champs de l'interface des formulaires XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient des éléments "header".

==== Element header ====
Chaque élément "header" décrit un entête de message de format XIMF.
Huit attributs précisent la balise "header" : "headerName", "id", "technicalHeaderName", "type", "technicalType", "isMandatory", "ilk", "description", e.g.,

<div style="color:red;">'''TODO :'''
Comment est effectuée la vérification de l'attribut isMandatory et quelles sont les conditions de fonctionnement de celui-ci ? Est-il possible, par exemple, de spécifier l'attribut isMandatory=true d'un élément header si le contenu de celui-ci est un élément « set » qui dispose des attributs minItem et maxItem ?Actuellement, lorsque l'on crée un élément set avec les attributs minItem et maxItem, le champ du formulaire associé ne peux pas être validé : e.g.,
<ximf:set id="value-amoco-classification" minItem="1" maxItem="64" separator=";" technicalSeparator=".">
Est-ce un bug ?
</div>

<ximf:header id="header-primary-precedence"
headerName="X-XIMF-Primary-Precedence"
ilk="ilk-primary-precedence"
isMandatory="true"
description="entête d’urgence"
type="string" />

* Détails sur les attributs de l'élément "header" :
** L’attribut "headerName" définit le nom du champ XIMF. Cet attribut est obligatoire.
** L’attribut "id" définit un identifiant de champ, il doit être unique pour chaque élément "header" et est formaté selon la syntaxe "header-xxx". Cet attribut est obligatoire.
** L’attribut "isMandatory" précise si ce champ doit être obligatoirement présent dans le message intégrant les entêtes selon cette description.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.
** L’attribut "type" précise le format des données associées à cet élément. Ce format peut être une date, une chaîne, une adresse mail, un O.I.D.
** L’attribut "technicalHeaderName" permet de compléter l’entête décrit par un autre entête.
** L’attribut "technicalType" précise le format des données associées à l’élément technicalHeaderName.
** L’attribut "description" permet d’ajouter une information sur cet élément.

L’élément "header" contient obligatoirement un élément "set", "multiset", "string", ou "compstring", e.g.,

<ximf:header id="header-reply-by"
headerName="X-XIMF-Reply-By"
ilk="ilk-reply-by"
isMandatory="false" >
<ximf:string id="value-reply-by" editable="true" />
</ximf:header>

<div style="color:red;">
'''TODO :''' Quelles sont les contraintes associées à l'attribut type d'un élément header ?
</div>

==== Element string ====
L’élément "string" précise le contenu d’une ressource de type chaîne de caractères imprimables (a-z, A-Z, 1-9,…)
Quinze attributs complètent l’élément "string" : "id", "ref", "ilk", "aclLevel", "index", "description", "editable", "content", "technicalContent","maxItem", "minItem", "maxLength", "minLength", "separator", "technicalSeparator", e.g.,

<ximf:string ilk="ilk-france" content="FRA" />

* Détails sur les attributs de l'élément "string" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "string".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[Element_ximf:role| élément role]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut " description " permet d’associer un commentaire sur cette donnée.
** L’attribut "editable" définit une valeur de saisie (champ libre). Cet attribut est de type booléen.
** L’attribut "content" représente la valeur effective de la donnée. C’est cette donnée qui sera associée au champ XIMF créé.
** L’attribut "technicalContent" représente la valeur effective de la donnée technique. C’est cette donnée qui sera associée au champ technique XIMF créé (cf. attribut technicalHeaderName de l’élément "header".
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.

L’élément "string" peut contenir plusieurs éléments "linkedValue".

<ximf:string ilk="ilk-non-protege" content="NON PROTEGE" technicalContent="1" >
<ximf:linkedValue ref="value-non-protege-france " />
</ximf:string>

==== Element compstring ====
<div style="color:red;">
'''TODO :''' L'attribut de l'élément « compstring » nommé « contentFactorise » devrait s'appeler « contentFactorize ».
</div>
L’élément "compstring" décrit un conteneur de concaténation des éléments fils. Il permet notamment de créer des valeurs d’entêtes composées.
Dix-sept attributs complètent l’élément "compstring" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", "content", "technicalContent", "contentPositionEnd", "contentFactorise", "technicalPositionEnd", e.g.,

<ximf:compstring
ilk="ilk-special"
content="SPECIAL"
technicalContent="1.3.4"
separator=" "
technicalSeparator=".">

* Détails sur les attributs de l'élément "compstring" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "compstring".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (cf. [[Element_role | élément "role"]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut " description " permet d’associer un commentaire sur cette donnée.
** L’attribut "content" représente la valeur effective de la donnée. C’est cette donnée qui sera associée au champ XIMF créé.
** L’attribut "technicalContent" représente la valeur effective de la donnée technique. C’est cette donnée qui sera associée au champ technique XIMF créé (cf. attribut technicalHeaderName de l’élément "header".
** L’attribut "separator" définit le caractère de séparation entre deux valeurs.
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "contentPositionEnd" impose de positionner le contenu de l’élément "compstring" après les valeurs des éléments fils : valuefils1,valuefils2 : valuecompstring.
** L’attribut "technicalPositionEnd" impose de positionner le contenu de l’élément "compstring" après les valeurs des éléments fils.
** L’attribut "contentFactorise" impose d’utiliser le contenu de l’élément "compstring" comme facteur des éléments fils : valuecompstring(valuefils1,valuefils2).

L’élément "compstring" peut contenir un élément "string" ou "set" ou "multiset" ou plusieurs éléments "compstring".

<ximf:compstring
ilk="ilk-special"
content="SPECIAL"
technicalContent="1.3.4"
separator=" "
technicalSeparator=".">
<ximf:set id="ilk-special-op " maxItem="64">
<ximf:string ilk="ilk-special-op1" content="OP1" technicalContent="1" />
<ximf:string ilk="ilk-special-op2" content="OP2" technicalContent="2" />
<ximf:string ilk="ilk-special-op3" content="OP3" technicalContent="3" />
</ximf:set>
</ximf:compstring>

==== Element set ====
L’élément "set" décrit un conteneur de ressources de même type. Cet élément autorise la sélection de plusieurs ressources mais chaque ressource est sélectionnée une seule fois.
Douze attributs précisent la description de la balise "set" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", e.g.,

<ximf:set id="value-categories" ref="value-mentions" maxItem="64" separator=";" />

* Détails sur les attributs de l'élément "set" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "ximf:set".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role|élément rôle]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut "description" permet d’associer un commentaire sur cette donnée.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs

L’élément "set" peut contenir un ou plusieurs éléments "string" ou un ou plusieurs éléments "compstring".

<ximf:set id="value-categories" minItem="1" maxItem="64" separator=";">
<ximf:string ilk="ilk-releasable-to" content="RELEASABLE TO " />
<ximf:string ilk="ilk-eyes-only" content=" EYES ONLY"/>
<ximf:string ilk="ilk-use-only" content=" USE ONLY"/>
</ximf:set>

<div style="color:red;">'''TODO :'''
* Y a-t-il une définition des fichiers associés aux instances XIMF (e.g, le fichier attribution-list.xml utilisé dans l'instance Caterpillar) ?
* Comment le parseur d'instance ximf sait qu'un élément est une "attribution-list" ?
</div>

==== Element multiset ====
L’élément "multiset" décrit un conteneur de ressources de même type. Cet élément autorise la sélection de plusieurs ressources et chaque ressource peut être sélectionnée plusieurs fois.
Douze attributs précisent la description de la balise "multiset" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", e.g.,

<ximf:multiset
id="value-restricted"
ilk=" value-restricted-otan"
maxItem="64"
separator=";" />

* Détails sur les attributs de l'élément "multiset" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "multiset".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role|élément rôle]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut "description" permet d’associer un commentaire sur cette donnée.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs

L’élément "multiset" peut contenir un ou plusieurs éléments "string" ou un ou plusieurs éléments "compstring".

<ximf:multiset id="value-restricted-otan-categories" minItem="1" maxItem="64" separator=";" >
<ximf:string ilk="ilk-releasable-to" content="RELEASABLE TO "/>
<ximf:string ilk="ilk-eyes-only" content=" EYES ONLY"/>
<ximf:string ilk="ilk-use-only" content=" USE ONLY"/>
</ximf:multiset>

<span style="color:red;">'''TODO :''' Comment sont gérées les règles associées aux champs multivaleurs (disposant par exemple des attributs minItem/maxItem ou les champs multiset) ?</span>

==== Element linkedValue ====
<div style="color: red;">'''TODO ''': L'élément linkedValue indique quelle ressource utiliser lors de la sélection d'un élément particulier mais il n'indique pas où la ressource devra être utilisée.
* Est-ce que cela correspond toujours au header suivant ?
* Pourquoi avoir fait ce choix au lieu d'ajouter un attribut supplémentaire ?
</div>

L’élément "linkedValue" définit une référence sur une ressource de type conteneur ("set", "multiset") ou "string". Cette ressource devrait être utilisée si la ressource contenant "linkedValue" (noeud parent) est sélectionnée.
Un attribut précise la balise "linkvalue" : "ref", e.g.,

<ximf:linkedValue ref="value-restricted-otan-classification-id" />

* Détails sur les attributs de l'élément "linkedValue" :
** L’attribut "ref" précise la valeur de l’attribut "id" de la ressource cible. Cet attribut est obligatoire.

=== Fichier rules ===
Le fichier rules définit les règles de contrôles d’entêtes XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui peut contenir des éléments "ximf:rule".

==== Element rule ====
<div style="color:red">
'''TODO :''' Mettre à jour la documentation :
* Les éléments autorisés dans un élément « rule » ne sont plus à jour. La présente documentation spécifie 12 éléments : AliasHeader, AliasValue, Compatibility, Association, SecureHeaders, SecurityLabel, Constraint, Assignment, Processing, Accessibility, Role et Custom. Le schéma XML fourni avec le mail en spécifie 5 : Constraint, Processing, Compatibility, Policy et Custom et place les autres en tant qu'extentions des 5 éléments cités précédemment.
* Les éléments SecureHeaders et SecurityLabel associés à l'élément « rule » dans la version ci-dessus ne figurent plus dans la nouvelle version. On les retrouve dans les fichiers rules-*.xml mais les éléments sont commentés. En revanche, ils sont bien présents dans une autre instance : s'agit-il d'une fonctionnalité non-documentée ou plus documentée ?
* L'élément ximf:classificationPictures n'est pas documenté. De plus, il serait bon d'avoir des précisions sur la raison qui a motivé l'ajout de cet élément dans les fichiers de règles (alors qu'il semblerait être plus adapté au fichier headers-*.xml).
</div>
L’élément "rule" est le conteneur principal de description d’un comportement particulier à appliquer sur un ensemble d’entêtes XIMF.
Trois attributs précisent la balise "rule" : "id", "agent", "description", e.g.,
<ximf:rule id="compatibility-rule" description="Règle sur la compatibilité X-SMTP / XIMF" >

* Détails sur les attributs de l'élément "rule" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "rule". Cet attribut est obligatoire.
** L’attribut "agent" indique l’équipement cible devant analyser et appliquer le contenu de cet élément.
** L’attribut "description" autorise l’auteur d’ajouter un commentaire sur cet élément.

L’élément "rule" contient un ou plusieurs mêmes éléments de spécialisation de la règle "contraint", "assignement", "processing", "compatibility", "accessibility", "custom",…, e.g.,

<ximf:rule id="precedence-rule" agent="mua" description="Règle sur les priorités">
<ximf:constraint
left="header-primary-precedence"
operator="equalOrGreaterThan"
right="header-copy-precedence" />
</ximf:rule>

==== Element aliasHeader ====
L’élément "aliasHeader" permet de définir le nom de l’entête sur lequel la règle précisée est appliquée
Deux attributs précisent la balise "aliasHeader" : "headerName" et "headerRef", e.g.,

<ximf:aliasHeader headerName ="X-P772-Version" headerRef="X-XIMF-VERSION" />

* Détails sur les attributs de l'élément "aliasHeader" :
* L’attribut "headerName" définit le nom XIMF de l’entête modifié par la règle. Cet attribut est obligatoire.
* L’attribut "headerRef" définit le nom d’un entête XIMF de référence qui est le point d’entrée de l’application de la règle sur l’entête définit par "headerName". Cela permet de lier deux entêtes de messages où l’utilisation de l’un des entêtes influe sur le comportement de l’autre.

L’élément "aliasHeader" peut contenir des éléments "aliasValue",e.g ,

<ximf:aliasHeader headerName="X-P772-Version" />
<ximf:aliasValue vame="1.0"/>
<ximf:aliasHeader>

==== Element aliasValue ====
L’élément "aliasValue" contient une valeur à associer à l’entête XIMF contrôlé par la règle. Il est utile lorsque deux entêtes sont liées (utilisation de l’attribut headerRef dans l’élément aliasHeader) et que les valeurs de l’entêtes de référence permettent de préciser celles de l’entête contrôlé.
Deux attributs précisent la balise "aliasValue" : "valueName", "valueRef", e.g.,

<ximf:aliasValue valueName="2" valueRef ="flash" />

* Détails sur les attributs de l'élément "aliasValue" :
** L’attribut "valueName" définit la valeur de l’entête à créer. Cet attribut est obligatoire.
** L’attribut "valueRef" définit la valeur de l’entête XIMF de référence pour utiliser valueName.
<span style="color:red;">'''TODO :''' L'attribut valueRef est-il obligatoire ?</span>

==== Element compatibility ====
L’élément "compatibility" est utilisé pour associer à un entête respectant la norme XIMF un entête respectant une autre norme que XIMF (XSMTP par exemple).
Deux attributs précisent la balise "compatibility" : "targetName", "targetVersion", e.g.,

<ximf:compatibility targetName="X-SMTP" targetVersion="1.1">
<ximf:aliasValue headerName="X-P772-Version" content="1.1" />
<ximf:aliasValue
headerName="X-P772-Primary-Precedence"
headerRef="header-primary-precedence"
dataRef="data-priority-xsmtp"/>
</ximf:compatibility>

* Détails sur les attributs de l'élément "compatibility" :
** L’attribut "targetName" définit la norme de l’entête à associer à l’entête XIMF. Cet attribut est obligatoire.
** L’attribut "targetVersion" définit le numéro de version de la norme de l’entête à associer à l’entête XIMF. Cet attribut est obligatoire.

L’élément "compatibility" contient au moins un élément "aliasHeader".

<u>Pour illustrer cette règle :</u>
Le format XSMTP est déjà supporté par certains équipements. Afin de rendre ceux-ci inter opérables avec le nouveau format XIMF, cette règle permet d’associer un entête XSMTP contenant les mêmes informations qu’un entête XIMF.

L’élément Association : dépendance entre entêtes
L’élément "association" définie les valeurs autorisées pour un entête XIMF en fonction d’une valeur définie pour un autre entête XIMF.

<ximf:association>
<ximf:aliasHeader
headerName="X-XIMF-Primary-Precedence"
headerRef="X-XIMF-Correspondence-Type">
<ximf:aliasValue valueName="routine" valueRef="private" />
<ximf:aliasValue valueName="routine,priority" valueRef="professional" />
<ximf:aliasValue valueName="routine,priority,immediate,flash" valueRef="operational" />
<ximf:aliasValue valueName="routine,priority,immediate" valueRef="official" />
</ximf:aliasHeader>
</ximf:association>

==== Element secureHeaders ====
<div style="color:red;">'''TODO :''' Les éléments SecureHeaders et SecurityLabel associés à l'élément « rule » dans la version ci-dessus ne figurent plus dans le shéma xml. On les retrouve dans les fichiers rules-*.xml mais les éléments sont commentés. En revanche, ils sont bien présents dans une autre instance : s'agit-il d'une fonctionnalité non-documentée ou plus documentée ?</div>
L’élément "secureHeaders" définie la liste des entêtes à intégrer dans la signature d’un message. Cette règle s’applique sur les équipements proposant un algorithme de signature des messages.

Un élément "secureHeaders" contient un ou plusieurs éléments "aliasHeaders" où chaque élément décrit un entête à intégrer dans la signature et complété d’un attribut "status".

<ximf:secureHeaders targetName="SecureHeaders">
<ximf:aliasHeader headerName="X-XIMF-Primary-Precedence" status="0" />
<ximf:aliasHeader headerName="X-XIMF-Copy-Precedence" status="0" />
</ximf:secureHeaders>

==== Element securityLabel ====
L’élément "securityLabel" définie la liste des entêtes à intégrer dans la signature d’un message. Cette règle s’applique sur les équipements proposant un algorithme de signature des messages selon la norme RFC.

Un élément "securityLabel" contient un ou plusieurs éléments "aliasHeaders" où chaque élément décrit un entête à intégrer dans la signature et complété d’un attribut "status".

<ximf:securityLabel targetName="SecurityLabel" id="Amoco">
<ximf:aliasHeader
headerName="SecurityPolicyIdentifier"
headerRef="X-XIMF-Security-Policy-Identifier" />
<ximf:aliasHeader
headerName="SecurityClassification"
headerRef="X-XIMF-Security-Classification-Identifier" />
<ximf:aliasHeader
headerName="ESSPrivacyMark"
headerRef="X-XIMF-Privacy-Mark" />
<ximf:aliasHeader
headerName="SecurityCategory"
headerRef="X-XIMF-Security-Categories-Identifier"
type="2" />
</ximf:securityLabel>

==== Element constraint ====
L’élément "constraint" est utilisé pour définir une règle de construction de deux entêtes partageant des "datas" identiques.
Trois attributs précisent la balise "constraint" : "left", "right", "operator", e.g.,

<ximf:constraint
left="header-primary-precedence"
operator="equalOrGreaterThan"
right="header-copy-precedence" />

* Détails sur les attributs de l'élément "constraint" :
** L’attribut "left" désigne le premier élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "right" désigne le deuxième élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "operator" indique la règle de poids à appliquer sur la valeur des deux éléments "header", il peut être de type "greaterThan", "lowerThan", "equalOrGreaterThan", "equalOrLowerThan", "equal". Cet attribut est obligatoire.

* Détails sur les valeurs possibles de l'attribut "type" :
** Le type "greaterThan" signifie que la valeur de l’élément "left" doit être strictement supérieur à la valeur de l’élément "right".
** Le type "lowerThan" signifie que la valeur de l’élément "left" doit être strictement inférieur à la valeur de l’élément "right".
** Le type "equalOrGreaterThan" signifie que la valeur de l’élément "left" doit être supérieur ou égale à la valeur de l’élément "right".
** Le type "equalOrLowerThan" signifie que la valeur de l’élément "left" doit être inférieur ou égale à la valeur de l’élément "right".
** Le type "equal" signifie que la valeur de l’élément "left" et de l’élément "right" doivent être identiques.

==== Element assignment ====
<div style="color:red;">'''TODO :''' L'élément assignment n'apparaît pas dans le shéma xml qui avait été envoyé.</div>

L’élément "assignement" est utilisé pour affecter une valeur créée en fonction d’une règle de comparaison sur les valeurs de deux éléments "header".
Quatre attributs précisent la balise "assignement" : "left", "right", "operator", "result", e.g.,

<ximf:assignment
left="header-primary-precedence"
operator="equal"
right="data-routine-precedence"
result="86400" />

* Détails sur les attributs de l'élément "assignment" :
** L’attribut "left" désigne le premier élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "right" désigne le deuxième élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "operator" indique la règle de comparaison entre les valeurs des deux éléments "header", il peut être de type "greaterThan", "lowerThan", "equalOrGreaterThan", "equalOrLowerThan", "equal". Cet attribut est obligatoire.
** L’attribut "result" représente la valeur à utiliser si la règle de comparaison entre les deux éléments est satisfaite. Cet attribut est obligatoire.

==== Element processing ====
L’élément "processing" regroupe des règles de traitement à effectuer sur des entêtes formatés.
L’attribut "type" précise le type de traitement à effectuer sur ces valeurs. Cet attribut est obligatoire, il est de type : "sign-header-value", "encrypt-header-value", "capitalize-header-value", e.g.,

<ximf:processing type="sign-header-value">
<ximf:refHeader>header-primary-precedence</ximf:refheader>
<ximf:refHeader>header-copy-precedence</ximf:refheader>
<ximf:refHeader>header-echange-type</ximf:refheader>
</ximf:processing>

* Détails sur les valeurs possibles de l'attribut "type" :
** Le type "sign-header-value" définit un traitement de signature des entêtes définis dans la balise.
** Le type "encrypt-header-value" définit un traitement de chiffrement des entêtes définis dans la balise.
** Le type "capitalize-header-value" définit un traitement de capitalisation des entêtes définis dans la balise.

L’élément "processing" contient au moins un élément "refHeader".
<div style="color:red;">'''TODO :'''L'élément refHeader n'est pas documenté, s'agit-il en fait de l'élément headerRef ?</div>

==== Element accessibility ====
<div style="color:red;">'''TODO :''' L'élément accessibility n'apparaît pas dans le shéma xml qui avait été envoyé.</div>
L’élément "accessibility" définit un ensemble de règles de droit d’accès aux éléments d’une instance pour une cible déterminée (utilisateur, routeur…).
Cet élément contient un ou plusieurs éléments "role".

<ximf:accessibility>
<ximf:role id="role-flash-allowed" aclLevel="100" />
<ximf:role id="role-flash-prohibited" aclLevel="50" />
</ximf:accessibility>

==== Element role ====
L’élément "role" positionne une valeur d’accès à pour une entité définit.
Deux attributs complètent l’élément "role" : "id", "aclLevel", e.g.,

<ximf:role id="role-flash-allowed" aclLevel="100" />

* Détails sur les attributs de l'élément "role" :
** L’attribut "id" précise l’entité accessible en fonction d’une valeur déterminée.
** L’attribut "aclLevel" précise la valeur seuil d’accès à l’entité.

==== Element custom ====
L’élément "custom" permet à l’auteur de créer des nouvelles règles personnalisées.
Trois attributs précisent la balise "custom" : "id", "provider", "description", e.g.,

<ximf:custom
id="custom-display"
provider="EADS"
description="Affichage de la composition du message" >
<node1><node2><node3></node3></node2></node1>
</ximf:custom>

* Détails sur les attributs de l'élément "custom" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "custom" et formaté selon la syntaxe "custom-xxx". Cet attribut est obligatoire.
** L’attribut "provider" identifie l’auteur de la règle. Cet attribut est obligatoire.
** L’attribut "description" permet d’ajouter un commentaire sur cet élément.

L’élément "custom" peut contenir tous les éléments possibles en respectant les standards XML.

XIMF XML tags/fr

2011-02-24T13:45:49Z

Anthonyjuge : /* Element dictionary */

== Introduction ==
Ce document propose un modèle de description, via eXtensible Markup Language (XML), d’entêtes de messages électroniques respectant la norme XIMF. Ce document a deux objectifs :
# Décrire les éléments et attributs de représentation XML pour construire des entêtes de messages électroniques de format XIMF.
# Fournir un modèle de représentation XIMF/XML.

<u>Rappel :</u>
* Un "élément" fait référence à tous les caractères situés entre une balise de départ et un balise de fin, e.g.,
<exemple> texte et/ou éléments fils </exemple>
* Un "attribut" est une composante d’un élément. Il est positionné dans la balise de départ, e.g.,
<exemple nom='value'>

Tous les éléments décrits dans cette documentation paragraphe sont validés dans l’espace de nom "ximf".

<pre>
xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://eads.org/ximf/ximf.xsd"
</pre>

== Description détaillée des balises XML ==

Voici, par ordre d'apparition et en fonction des fichiers, les balises génériques associées aux différents fichiers XML.

=== Fichier ximfmail-profile ===

<div style="color:red;">'''TODO''' :
* Combien d'éléments ihm sont autorisés dans un élément instance ?
* La documentation des fichiers ximfmail-profile.xml n'est pas disponible. Est-il possible d'avoir accès au fichier ximf_profile.xsd mentionné dans les ximfmail-profile.xml ?
</div>

Un fichier xpi peut contenir plusieurs instances XIMF, celles-ci sont alors regroupées dans une même catégorie. Le fichier ximfmail-profile contient des informations sur toutes les instances contenues dans le xpi, notamment leur nom, leur chemin d'accès, ainsi que les noms des fichiers associés à chaque instance.

==== Element instance ====
L’élément "instance" identifie l’ensemble des entêtes à décrire selon la norme XIMF. C’est le conteneur principal d’une instance XIMF/XML. Cinq attributs précisent la balise "instance" : "ximfVersion", "version", "author", "creation", "name", e.g.,
<ximf:instance name="myInstance" version="1.0" ximfVersion="2.0" >

* Détails sur les attributs de l'élément "instance" :
** L’attribut "name" définit le nom de l’instance décrite. Cet attribut est obligatoire.
** L’attribut "ximfVersion" définit le numéro de version des entêtes XIMF utilisés pour cette représentation. Cet attribut est obligatoire.
** L’attribut "version" définit le numéro de version de l’instance décrite. Cet attribut est obligatoire.
** L’attribut "author" renseigne sur le nom de l’auteur de cette instance.
** L’attribut "creationDate" précise la date de création de cette instance.

L’élément "instance" peut contenir un ou plusieurs éléments "schema", un ou plusieurs éléments "rule", un élément "ihm" et un élément "dictionary".

==== Element dictionary ====
L'élément dictionary contient le chemin vers le fichier spécifiant les données d'internationalisation (Cf. [[#Fichier_dictionary|Fichier dictionary]]).

==== Element schema ====
L'élément shema contient le chemin vers le fichier spécifiant les entêtes XIMF (Cf. [[#Fichier_headers|Fichier headers]]).

==== Element ihm ====
L'élément ihm contient le chemin vers le fichier spécifiant la disposition de l'interface des formulaires XIMF (Cf. [[#Fichier_ihm|Fichier ihm]]).

==== Element rule ====
L'élément rule contient le chemin vers le fichier spécifiant les règles associées aux valeurs des champs XIMF (Cf. [[#Fichier_rules|Fichier rules]]).

=== Fichier dictionary ===
Le fichier dictionnary permet de mettre en œuvre l’internationalisation d’une instance XIMF. Il défini des dictionnaires qui servent à traduire les éléments de l'instance XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient un élément "ximf:dictionnary".

==== Element dictionary ====
<div style="color:red;">'''TODO''' :
* Est-il obligé de renseigner les données d'internationalisation pour <u>tous</u> les labels ? (ce n'est actuellement pas le cas dans l'instance Whirlpool)
* Quel est l'intérêt de renseigner un attribut "id" à l'élément "dictionary" (étant donné qu'un seul élément "dictionary n'est autorisé dans l'élément "instance") ?</div>

L’élément "dictionary" contient toutes les informations devant être interprétées selon le pays d’utilisation.
L’élément "dictionary" contient un ou plusieurs mêmes éléments "locale", e.g.,

<ximf:dictionary>
<ximf:locale lang="fr-FR" />
<ximf:locale lang="en-US" />
</ximf:dictionary>

==== Element locale ====
L’élément "locale" contient toutes les informations pour un pays et/ou langue désignée.
L’élément "locale" contient un ou plusieurs mêmes éléments "ilk", e.g.,

<ximf:locale lang="fr-FR" >
<ximf:ilk entity="a"/>
<ximf:ilk entity="b"/>
</ximf:locale>

* Détails sur les attributs de la balise "locale" :
** L’attribut "lang" définit le code pays de ce conteneur. Il devrai être construit selon le format défini par la RFC1766 (fr, en, ja, es, …).

==== Element ilk ====
L’élément "ilk" contient une unique information correspondant à une donnée traduite selon le code pays de l’élément père. Cette information est au format chaîne de caractère. Un attribut obligatoire précise la balise "ilk".

<ximf:ilk entity="ilk-lang-ihm">langue</ximf:ilk>

* Détails sur les attributs de la balise "ilk" :
** L’attribut "entity" définit la référence d’entrée pour récupérer le contenu de l’élément selon le code pays souhaité.

Finalement, le fichier "dictionary" pourra contenir :
<ximf:instance name="Whirlpool">
<ximf:dictionary>
<ximf:locale lang="fr-FR" >
<ximf:ilk entity="ilk-lang-ihm">Français</ximf:ilk>
<ximf:ilk entity="ilk-exemple-general">Général</ximf:ilk>
</ximf:locale>
<ximf:locale lang="en-US" >
<ximf:ilk entity="ilk-lang-ihm">English (US)</ximf:ilk>
<ximf:ilk entity="ilk-exemple-general">General</ximf:ilk>
</ximf:locale>
</ximf:dictionary>
</ximf:instance>

=== Fichier ihm ===
<span style="color:red;">'''TODO''' : La documentation originale ne décrit pas le fichier ihm, les informations ci-dessous ont seulement été présumées. Merci de les vérifier/compléter.
</span>

Le fichier ihm spécifie l'agencement de l'interface des formulaires XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient un élément "ximf:ihm".

==== Element ihm ====
L'élément "ihm" contient un ou plusieurs éléments "panel" et un élément "treeRcv".

==== Element panel ====
Un élément ximf:panel correspond à un onglet du formulaire XIMF construit.
Deux attributs précisent la balise "panel" : "id" et "ilk", eg.
<ximf:panel id="pane_security" ilk="ilk-priority-panel" />

* Détails sur les attributs de l'élément "panel" :
** L’attribut "id" définit le nom de l'onglet, il doit être unique pour chaque élément "ximf:panel" et est formaté selon la syntaxe "pane-xxx". Cet attribut est obligatoire.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.

L'élément "ximf:panel" contient au moins un éléments "ximf:groupbox".

==== Element groupbox ====
Un élément groupbox correspond à une sous catégorie d'un onglet du formulaire XIMF.
La structure "groupbox" détaille l’ordre d’affichage des entêtes dans un message.
Deux attributs précisent la balise "ximf:groupbox" : "id" et "ilk", eg.
<ximf:groupbox id="group-classification" ilk="ilk-secu-box" />

* Détails sur les attributs de l'élément "groupbox" :
** L’attribut "id" définit le nom de l'onglet, il doit être unique pour chaque élément "ximf:panel" et est formaté selon la syntaxe "pane-xxx". Cet attribut est obligatoire.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.

L'élément "groupbox" contient au moins un éléments "headerRef".

==== Element treeRcv ====
L'élément "treeRcv" permet de spécifier quelles sont les colonnes susceptibles d'être ajoutées dans le panneau principal du client de messagerie qui contient la liste des messages d’un dossier.

L'élément "treeRcv" peut contenir des éléments "headerRef".

==== Element headerRef ====
L'élément headerRef spécifie les champs associés à chaque sous-groupe d'onglet de formulaire ou les champs qu'il est possible d'afficher dans la liste des messages.
Aucun attribut ne vient compléter la balise "headerRef", eg.
<ximf:headerRef>header-classification</ximf:headerRef>

Finalement, le fichier "ihm" pourra contenir :
<pre>
<ximf:instance name="Amoco">
<ximf:ihm>
<ximf:panel id="pane_security" ilk="ilk-priority-panel">
<ximf:groupbox id="group-classification" ilk="ilk-secu-box">
<ximf:headerRef>header-correspondance-type</ximf:headerRef>
<ximf:headerRef>header-classification</ximf:headerRef>
</ximf:groupbox>
</ximf:panel>
<ximf:treeRcv>
<ximf:headerRef>header-classification</ximf:headerRef>
</ximf:treeRcv>
</ximf:ihm>
</ximf:instance>
</pre>

=== Fichier headers ===
Le fichier headers spécifie les types des champs de l'interface des formulaires XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient des éléments "header".

==== Element header ====
Chaque élément "header" décrit un entête de message de format XIMF.
Huit attributs précisent la balise "header" : "headerName", "id", "technicalHeaderName", "type", "technicalType", "isMandatory", "ilk", "description", e.g.,

<div style="color:red;">'''TODO :'''
Comment est effectuée la vérification de l'attribut isMandatory et quelles sont les conditions de fonctionnement de celui-ci ? Est-il possible, par exemple, de spécifier l'attribut isMandatory=true d'un élément header si le contenu de celui-ci est un élément « set » qui dispose des attributs minItem et maxItem ?Actuellement, lorsque l'on crée un élément set avec les attributs minItem et maxItem, le champ du formulaire associé ne peux pas être validé : e.g.,
<ximf:set id="value-amoco-classification" minItem="1" maxItem="64" separator=";" technicalSeparator=".">
Est-ce un bug ?
</div>

<ximf:header id="header-primary-precedence"
headerName="X-XIMF-Primary-Precedence"
ilk="ilk-primary-precedence"
isMandatory="true"
description="entête d’urgence"
type="string" />

* Détails sur les attributs de l'élément "header" :
** L’attribut "headerName" définit le nom du champ XIMF. Cet attribut est obligatoire.
** L’attribut "id" définit un identifiant de champ, il doit être unique pour chaque élément "header" et est formaté selon la syntaxe "header-xxx". Cet attribut est obligatoire.
** L’attribut "isMandatory" précise si ce champ doit être obligatoirement présent dans le message intégrant les entêtes selon cette description.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.
** L’attribut "type" précise le format des données associées à cet élément. Ce format peut être une date, une chaîne, une adresse mail, un O.I.D.
** L’attribut "technicalHeaderName" permet de compléter l’entête décrit par un autre entête.
** L’attribut "technicalType" précise le format des données associées à l’élément technicalHeaderName.
** L’attribut "description" permet d’ajouter une information sur cet élément.

L’élément "header" contient obligatoirement un élément "set", "multiset", "string", ou "compstring", e.g.,

<ximf:header id="header-reply-by"
headerName="X-XIMF-Reply-By"
ilk="ilk-reply-by"
isMandatory="false" >
<ximf:string id="value-reply-by" editable="true" />
</ximf:header>

<div style="color:red;">
'''TODO :''' Quelles sont les contraintes associées à l'attribut type d'un élément header ?
</div>

==== Element string ====
L’élément "string" précise le contenu d’une ressource de type chaîne de caractères imprimables (a-z, A-Z, 1-9,…)
Quinze attributs complètent l’élément "string" : "id", "ref", "ilk", "aclLevel", "index", "description", "editable", "content", "technicalContent","maxItem", "minItem", "maxLength", "minLength", "separator", "technicalSeparator", e.g.,

<ximf:string ilk="ilk-france" content="FRA" />

* Détails sur les attributs de l'élément "string" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "string".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[Element_ximf:role| élément role]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut " description " permet d’associer un commentaire sur cette donnée.
** L’attribut "editable" définit une valeur de saisie (champ libre). Cet attribut est de type booléen.
** L’attribut "content" représente la valeur effective de la donnée. C’est cette donnée qui sera associée au champ XIMF créé.
** L’attribut "technicalContent" représente la valeur effective de la donnée technique. C’est cette donnée qui sera associée au champ technique XIMF créé (cf. attribut technicalHeaderName de l’élément "header".
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.

L’élément "string" peut contenir plusieurs éléments "linkedValue".

<ximf:string ilk="ilk-non-protege" content="NON PROTEGE" technicalContent="1" >
<ximf:linkedValue ref="value-non-protege-france " />
</ximf:string>

==== Element compstring ====
<div style="color:red;">
'''TODO :''' L'attribut de l'élément « compstring » nommé « contentFactorise » devrait s'appeler « contentFactorize ».
</div>
L’élément "compstring" décrit un conteneur de concaténation des éléments fils. Il permet notamment de créer des valeurs d’entêtes composées.
Dix-sept attributs complètent l’élément "compstring" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", "content", "technicalContent", "contentPositionEnd", "contentFactorise", "technicalPositionEnd", e.g.,

<ximf:compstring
ilk="ilk-special"
content="SPECIAL"
technicalContent="1.3.4"
separator=" "
technicalSeparator=".">

* Détails sur les attributs de l'élément "compstring" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "compstring".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (cf. élément "role").
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut " description " permet d’associer un commentaire sur cette donnée.
** L’attribut "content" représente la valeur effective de la donnée. C’est cette donnée qui sera associée au champ XIMF créé.
** L’attribut "technicalContent" représente la valeur effective de la donnée technique. C’est cette donnée qui sera associée au champ technique XIMF créé (cf. attribut technicalHeaderName de l’élément "header".
** L’attribut "separator" définit le caractère de séparation entre deux valeurs.
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "contentPositionEnd" impose de positionner le contenu de l’élément "compstring" après les valeurs des éléments fils : valuefils1,valuefils2 : valuecompstring.
** L’attribut "technicalPositionEnd" impose de positionner le contenu de l’élément "compstring" après les valeurs des éléments fils.
** L’attribut "contentFactorise" impose d’utiliser le contenu de l’élément "compstring" comme facteur des éléments fils : valuecompstring(valuefils1,valuefils2).

L’élément "compstring" peut contenir un élément "string" ou "set" ou "multiset" ou plusieurs éléments "compstring".

<ximf:compstring
ilk="ilk-special"
content="SPECIAL"
technicalContent="1.3.4"
separator=" "
technicalSeparator=".">
<ximf:set id="ilk-special-op " maxItem="64">
<ximf:string ilk="ilk-special-op1" content="OP1" technicalContent="1" />
<ximf:string ilk="ilk-special-op2" content="OP2" technicalContent="2" />
<ximf:string ilk="ilk-special-op3" content="OP3" technicalContent="3" />
</ximf:set>
</ximf:compstring>

==== Element set ====
L’élément "set" décrit un conteneur de ressources de même type. Cet élément autorise la sélection de plusieurs ressources mais chaque ressource est sélectionnée une seule fois.
Douze attributs précisent la description de la balise "set" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", e.g.,

<ximf:set id="value-categories" ref="value-mentions" maxItem="64" separator=";" />

* Détails sur les attributs de l'élément "set" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "ximf:set".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role|élément rôle]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut "description" permet d’associer un commentaire sur cette donnée.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs

L’élément "set" peut contenir un ou plusieurs éléments "string" ou un ou plusieurs éléments "compstring".

<ximf:set id="value-categories" minItem="1" maxItem="64" separator=";">
<ximf:string ilk="ilk-releasable-to" content="RELEASABLE TO " />
<ximf:string ilk="ilk-eyes-only" content=" EYES ONLY"/>
<ximf:string ilk="ilk-use-only" content=" USE ONLY"/>
</ximf:set>

<div style="color:red;">'''TODO :'''
* Y a-t-il une définition des fichiers associés aux instances XIMF (e.g, le fichier attribution-list.xml utilisé dans l'instance Caterpillar) ?
* Comment le parseur d'instance ximf sait qu'un élément est une "attribution-list" ?
</div>

==== Element multiset ====
L’élément "multiset" décrit un conteneur de ressources de même type. Cet élément autorise la sélection de plusieurs ressources et chaque ressource peut être sélectionnée plusieurs fois.
Douze attributs précisent la description de la balise "multiset" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", e.g.,

<ximf:multiset
id="value-restricted"
ilk=" value-restricted-otan"
maxItem="64"
separator=";" />

* Détails sur les attributs de l'élément "multiset" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "multiset".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role|élément rôle]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut "description" permet d’associer un commentaire sur cette donnée.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs

L’élément "multiset" peut contenir un ou plusieurs éléments "string" ou un ou plusieurs éléments "compstring".

<ximf:multiset id="value-restricted-otan-categories" minItem="1" maxItem="64" separator=";" >
<ximf:string ilk="ilk-releasable-to" content="RELEASABLE TO "/>
<ximf:string ilk="ilk-eyes-only" content=" EYES ONLY"/>
<ximf:string ilk="ilk-use-only" content=" USE ONLY"/>
</ximf:multiset>

<span style="color:red;">'''TODO :''' Comment sont gérées les règles associées aux champs multivaleurs (disposant par exemple des attributs minItem/maxItem ou les champs multiset) ?</span>

==== Element linkedValue ====
<div style="color: red;">'''TODO ''': L'élément linkedValue indique quelle ressource utiliser lors de la sélection d'un élément particulier mais il n'indique pas où la ressource devra être utilisée.
* Est-ce que cela correspond toujours au header suivant ?
* Pourquoi avoir fait ce choix au lieu d'ajouter un attribut supplémentaire ?
</div>

L’élément "linkedValue" définit une référence sur une ressource de type conteneur ("set", "multiset") ou "string". Cette ressource devrait être utilisée si la ressource contenant "linkedValue" (noeud parent) est sélectionnée.
Un attribut précise la balise "linkvalue" : "ref", e.g.,

<ximf:linkedValue ref="value-restricted-otan-classification-id" />

* Détails sur les attributs de l'élément "linkedValue" :
** L’attribut "ref" précise la valeur de l’attribut "id" de la ressource cible. Cet attribut est obligatoire.

=== Fichier rules ===
Le fichier rules définit les règles de contrôles d’entêtes XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui peut contenir des éléments "ximf:rule".

==== Element rule ====
<div style="color:red">
'''TODO :''' Mettre à jour la documentation :
* Les éléments autorisés dans un élément « rule » ne sont plus à jour. La présente documentation spécifie 12 éléments : AliasHeader, AliasValue, Compatibility, Association, SecureHeaders, SecurityLabel, Constraint, Assignment, Processing, Accessibility, Role et Custom. Le schéma XML fourni avec le mail en spécifie 5 : Constraint, Processing, Compatibility, Policy et Custom et place les autres en tant qu'extentions des 5 éléments cités précédemment.
* Les éléments SecureHeaders et SecurityLabel associés à l'élément « rule » dans la version ci-dessus ne figurent plus dans la nouvelle version. On les retrouve dans les fichiers rules-*.xml mais les éléments sont commentés. En revanche, ils sont bien présents dans une autre instance : s'agit-il d'une fonctionnalité non-documentée ou plus documentée ?
* L'élément ximf:classificationPictures n'est pas documenté. De plus, il serait bon d'avoir des précisions sur la raison qui a motivé l'ajout de cet élément dans les fichiers de règles (alors qu'il semblerait être plus adapté au fichier headers-*.xml).
</div>
L’élément "rule" est le conteneur principal de description d’un comportement particulier à appliquer sur un ensemble d’entêtes XIMF.
Trois attributs précisent la balise "rule" : "id", "agent", "description", e.g.,
<ximf:rule id="compatibility-rule" description="Règle sur la compatibilité X-SMTP / XIMF" >

* Détails sur les attributs de l'élément "rule" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "rule". Cet attribut est obligatoire.
** L’attribut "agent" indique l’équipement cible devant analyser et appliquer le contenu de cet élément.
** L’attribut "description" autorise l’auteur d’ajouter un commentaire sur cet élément.

L’élément "rule" contient un ou plusieurs mêmes éléments de spécialisation de la règle "contraint", "assignement", "processing", "compatibility", "accessibility", "custom",…, e.g.,

<ximf:rule id="precedence-rule" agent="mua" description="Règle sur les priorités">
<ximf:constraint
left="header-primary-precedence"
operator="equalOrGreaterThan"
right="header-copy-precedence" />
</ximf:rule>

==== Element aliasHeader ====
L’élément "aliasHeader" permet de définir le nom de l’entête sur lequel la règle précisée est appliquée
Deux attributs précisent la balise "aliasHeader" : "headerName" et "headerRef", e.g.,

<ximf:aliasHeader headerName ="X-P772-Version" headerRef="X-XIMF-VERSION" />

* Détails sur les attributs de l'élément "aliasHeader" :
* L’attribut "headerName" définit le nom XIMF de l’entête modifié par la règle. Cet attribut est obligatoire.
* L’attribut "headerRef" définit le nom d’un entête XIMF de référence qui est le point d’entrée de l’application de la règle sur l’entête définit par "headerName". Cela permet de lier deux entêtes de messages où l’utilisation de l’un des entêtes influe sur le comportement de l’autre.

L’élément "aliasHeader" peut contenir des éléments "aliasValue",e.g ,

<ximf:aliasHeader headerName="X-P772-Version" />
<ximf:aliasValue vame="1.0"/>
<ximf:aliasHeader>

==== Element aliasValue ====
L’élément "aliasValue" contient une valeur à associer à l’entête XIMF contrôlé par la règle. Il est utile lorsque deux entêtes sont liées (utilisation de l’attribut headerRef dans l’élément aliasHeader) et que les valeurs de l’entêtes de référence permettent de préciser celles de l’entête contrôlé.
Deux attributs précisent la balise "aliasValue" : "valueName", "valueRef", e.g.,

<ximf:aliasValue valueName="2" valueRef ="flash" />

* Détails sur les attributs de l'élément "aliasValue" :
** L’attribut "valueName" définit la valeur de l’entête à créer. Cet attribut est obligatoire.
** L’attribut "valueRef" définit la valeur de l’entête XIMF de référence pour utiliser valueName.
<span style="color:red;">'''TODO :''' L'attribut valueRef est-il obligatoire ?</span>

==== Element compatibility ====
L’élément "compatibility" est utilisé pour associer à un entête respectant la norme XIMF un entête respectant une autre norme que XIMF (XSMTP par exemple).
Deux attributs précisent la balise "compatibility" : "targetName", "targetVersion", e.g.,

<ximf:compatibility targetName="X-SMTP" targetVersion="1.1">
<ximf:aliasValue headerName="X-P772-Version" content="1.1" />
<ximf:aliasValue
headerName="X-P772-Primary-Precedence"
headerRef="header-primary-precedence"
dataRef="data-priority-xsmtp"/>
</ximf:compatibility>

* Détails sur les attributs de l'élément "compatibility" :
** L’attribut "targetName" définit la norme de l’entête à associer à l’entête XIMF. Cet attribut est obligatoire.
** L’attribut "targetVersion" définit le numéro de version de la norme de l’entête à associer à l’entête XIMF. Cet attribut est obligatoire.

L’élément "compatibility" contient au moins un élément "aliasHeader".

<u>Pour illustrer cette règle :</u>
Le format XSMTP est déjà supporté par certains équipements. Afin de rendre ceux-ci inter opérables avec le nouveau format XIMF, cette règle permet d’associer un entête XSMTP contenant les mêmes informations qu’un entête XIMF.

L’élément Association : dépendance entre entêtes
L’élément "association" définie les valeurs autorisées pour un entête XIMF en fonction d’une valeur définie pour un autre entête XIMF.

<ximf:association>
<ximf:aliasHeader
headerName="X-XIMF-Primary-Precedence"
headerRef="X-XIMF-Correspondence-Type">
<ximf:aliasValue valueName="routine" valueRef="private" />
<ximf:aliasValue valueName="routine,priority" valueRef="professional" />
<ximf:aliasValue valueName="routine,priority,immediate,flash" valueRef="operational" />
<ximf:aliasValue valueName="routine,priority,immediate" valueRef="official" />
</ximf:aliasHeader>
</ximf:association>

==== Element secureHeaders ====
<div style="color:red;">'''TODO :''' Les éléments SecureHeaders et SecurityLabel associés à l'élément « rule » dans la version ci-dessus ne figurent plus dans le shéma xml. On les retrouve dans les fichiers rules-*.xml mais les éléments sont commentés. En revanche, ils sont bien présents dans une autre instance : s'agit-il d'une fonctionnalité non-documentée ou plus documentée ?</div>
L’élément "secureHeaders" définie la liste des entêtes à intégrer dans la signature d’un message. Cette règle s’applique sur les équipements proposant un algorithme de signature des messages.

Un élément "secureHeaders" contient un ou plusieurs éléments "aliasHeaders" où chaque élément décrit un entête à intégrer dans la signature et complété d’un attribut "status".

<ximf:secureHeaders targetName="SecureHeaders">
<ximf:aliasHeader headerName="X-XIMF-Primary-Precedence" status="0" />
<ximf:aliasHeader headerName="X-XIMF-Copy-Precedence" status="0" />
</ximf:secureHeaders>

==== Element securityLabel ====
L’élément "securityLabel" définie la liste des entêtes à intégrer dans la signature d’un message. Cette règle s’applique sur les équipements proposant un algorithme de signature des messages selon la norme RFC.

Un élément "securityLabel" contient un ou plusieurs éléments "aliasHeaders" où chaque élément décrit un entête à intégrer dans la signature et complété d’un attribut "status".

<ximf:securityLabel targetName="SecurityLabel" id="Amoco">
<ximf:aliasHeader
headerName="SecurityPolicyIdentifier"
headerRef="X-XIMF-Security-Policy-Identifier" />
<ximf:aliasHeader
headerName="SecurityClassification"
headerRef="X-XIMF-Security-Classification-Identifier" />
<ximf:aliasHeader
headerName="ESSPrivacyMark"
headerRef="X-XIMF-Privacy-Mark" />
<ximf:aliasHeader
headerName="SecurityCategory"
headerRef="X-XIMF-Security-Categories-Identifier"
type="2" />
</ximf:securityLabel>

==== Element constraint ====
L’élément "constraint" est utilisé pour définir une règle de construction de deux entêtes partageant des "datas" identiques.
Trois attributs précisent la balise "constraint" : "left", "right", "operator", e.g.,

<ximf:constraint
left="header-primary-precedence"
operator="equalOrGreaterThan"
right="header-copy-precedence" />

* Détails sur les attributs de l'élément "constraint" :
** L’attribut "left" désigne le premier élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "right" désigne le deuxième élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "operator" indique la règle de poids à appliquer sur la valeur des deux éléments "header", il peut être de type "greaterThan", "lowerThan", "equalOrGreaterThan", "equalOrLowerThan", "equal". Cet attribut est obligatoire.

* Détails sur les valeurs possibles de l'attribut "type" :
** Le type "greaterThan" signifie que la valeur de l’élément "left" doit être strictement supérieur à la valeur de l’élément "right".
** Le type "lowerThan" signifie que la valeur de l’élément "left" doit être strictement inférieur à la valeur de l’élément "right".
** Le type "equalOrGreaterThan" signifie que la valeur de l’élément "left" doit être supérieur ou égale à la valeur de l’élément "right".
** Le type "equalOrLowerThan" signifie que la valeur de l’élément "left" doit être inférieur ou égale à la valeur de l’élément "right".
** Le type "equal" signifie que la valeur de l’élément "left" et de l’élément "right" doivent être identiques.

==== Element assignment ====
<div style="color:red;">'''TODO :''' L'élément assignment n'apparaît pas dans le shéma xml qui avait été envoyé.</div>

L’élément "assignement" est utilisé pour affecter une valeur créée en fonction d’une règle de comparaison sur les valeurs de deux éléments "header".
Quatre attributs précisent la balise "assignement" : "left", "right", "operator", "result", e.g.,

<ximf:assignment
left="header-primary-precedence"
operator="equal"
right="data-routine-precedence"
result="86400" />

* Détails sur les attributs de l'élément "assignment" :
** L’attribut "left" désigne le premier élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "right" désigne le deuxième élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "operator" indique la règle de comparaison entre les valeurs des deux éléments "header", il peut être de type "greaterThan", "lowerThan", "equalOrGreaterThan", "equalOrLowerThan", "equal". Cet attribut est obligatoire.
** L’attribut "result" représente la valeur à utiliser si la règle de comparaison entre les deux éléments est satisfaite. Cet attribut est obligatoire.

==== Element processing ====
L’élément "processing" regroupe des règles de traitement à effectuer sur des entêtes formatés.
L’attribut "type" précise le type de traitement à effectuer sur ces valeurs. Cet attribut est obligatoire, il est de type : "sign-header-value", "encrypt-header-value", "capitalize-header-value", e.g.,

<ximf:processing type="sign-header-value">
<ximf:refHeader>header-primary-precedence</ximf:refheader>
<ximf:refHeader>header-copy-precedence</ximf:refheader>
<ximf:refHeader>header-echange-type</ximf:refheader>
</ximf:processing>

* Détails sur les valeurs possibles de l'attribut "type" :
** Le type "sign-header-value" définit un traitement de signature des entêtes définis dans la balise.
** Le type "encrypt-header-value" définit un traitement de chiffrement des entêtes définis dans la balise.
** Le type "capitalize-header-value" définit un traitement de capitalisation des entêtes définis dans la balise.

L’élément "processing" contient au moins un élément "refHeader".
<div style="color:red;">'''TODO :'''L'élément refHeader n'est pas documenté, s'agit-il en fait de l'élément headerRef ?</div>

==== Element accessibility ====
<div style="color:red;">'''TODO :''' L'élément accessibility n'apparaît pas dans le shéma xml qui avait été envoyé.</div>
L’élément "accessibility" définit un ensemble de règles de droit d’accès aux éléments d’une instance pour une cible déterminée (utilisateur, routeur…).
Cet élément contient un ou plusieurs éléments "role".

<ximf:accessibility>
<ximf:role id="role-flash-allowed" aclLevel="100" />
<ximf:role id="role-flash-prohibited" aclLevel="50" />
</ximf:accessibility>

==== Element role ====
L’élément "role" positionne une valeur d’accès à pour une entité définit.
Deux attributs complètent l’élément "role" : "id", "aclLevel", e.g.,

<ximf:role id="role-flash-allowed" aclLevel="100" />

* Détails sur les attributs de l'élément "role" :
** L’attribut "id" précise l’entité accessible en fonction d’une valeur déterminée.
** L’attribut "aclLevel" précise la valeur seuil d’accès à l’entité.

==== Element custom ====
L’élément "custom" permet à l’auteur de créer des nouvelles règles personnalisées.
Trois attributs précisent la balise "custom" : "id", "provider", "description", e.g.,

<ximf:custom
id="custom-display"
provider="EADS"
description="Affichage de la composition du message" >
<node1><node2><node3></node3></node2></node1>
</ximf:custom>

* Détails sur les attributs de l'élément "custom" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "custom" et formaté selon la syntaxe "custom-xxx". Cet attribut est obligatoire.
** L’attribut "provider" identifie l’auteur de la règle. Cet attribut est obligatoire.
** L’attribut "description" permet d’ajouter un commentaire sur cet élément.

L’élément "custom" peut contenir tous les éléments possibles en respectant les standards XML.

Instance Amoco

2011-02-24T12:34:35Z

Anthonyjuge : /* Fichier rules-amoco */

== Instance Amoco ==
<div style="color:red;">'''TODO :'''
* Mettre à jour les schemaLocation décrivant les fichiers.
* Comment est vérifiée la valeur de l'attribut "isMandatory=true" dans le cas d'une liste multi-sélection ?
</div>

Cette instance comporte un onglet contenant des sous-groupes disposant de champs aux types variés :
* deux listes déroulantes
* un champ texte
* un champ date

De plus, une contrainte est appliquée entre les deux listes déroulantes du premier onglet : certaines valeurs de la seconde liste ne sont pas disponible en fonction de la valeur sélectionnée sur la première liste.

[[Fichier:Instance_amoco.png|frame|center|''Affichage final de l'instance dans la langue : en-US.'']]

[[Fichier:Instance_amoco_selection.png|frame|center|''Règle XIMF de contrainte entre deux listes déroulante : certains éléments de la deuxième liste sont grisés en fonction de la valeur de la première liste.'']]

Voici les fichiers qui la définissent.

=== Fichier ximfmail-profile ===
Le fichier ximfmail-profile.xml devra contenir les renseignements sur les chemins vers les fichiers associés à l'instance.

<?xml version="1.0" encoding="utf-8"?>
<profile>
<theme name="Company Def"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="D:\DOC\DOC_THUN_INTRACED\ximf_profile.xsd">
<instance id="idExampleDefinition"
ximfVersion="2.0"
version="1.0"
name="Amoco"
directory="/chemin/vers/instance/Amoco/" author="Ximfmail">
<schema name="amoco">headers-Amoco.xml</schema>
<dictionary>dictionary-moco.xml</dictionary>
<ihm>ihm-amoco.xml</ihm>
<rule>rules-amoco.xml</rule>
</instance>
</theme>
</profile>

=== Fichier dictionary-amoco ===
Le fichier dictionary-amoco.xml contient des renseignement de toutes les données d'internationalisation pour les langues : fr-FR et en-US.

<?xml version="1.0" encoding="UTF-8"?>
<ximf:instance
name="Amoco"
version="1.0"
ximfVersion="2.0"
xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://eads.org/ximf/ ximf.xsd">
<ximf:dictionary id="OneDico">
<ximf:locale lang="fr-FR">
<ximf:ilk entity="ilk-info-box">Information</ximf:ilk>
<ximf:ilk entity="ilk-security-panel">Securité</ximf:ilk>
<ximf:ilk entity="ilk-originator-reference">Réferences d'origine</ximf:ilk>
<ximf:ilk entity="ilk-reply-before">Répondre avant</ximf:ilk>
<ximf:ilk entity="ilk-classification-panel">Classification</ximf:ilk>
<ximf:ilk entity="ilk-classification">Classification de sécurité</ximf:ilk>
<ximf:ilk entity="ilk-privacy-mark">Marque privée</ximf:ilk>
<ximf:ilk entity="ilk-general">Général</ximf:ilk>
<ximf:ilk entity="ilk-confidential">Confidentiel</ximf:ilk>
<ximf:ilk entity="ilk-highly-confidential">Très confidentiel</ximf:ilk>
<ximf:ilk entity="ilk-minimum">Minimum</ximf:ilk>
<ximf:ilk entity="ilk-medium">Moyen</ximf:ilk>
<ximf:ilk entity="ilk-maximum">Maximum</ximf:ilk>
<ximf:ilk entity="ilk-critical">Critique</ximf:ilk>
</ximf:locale>
<ximf:locale lang="en-US">
<ximf:ilk entity="ilk-info-box">Information</ximf:ilk>
<ximf:ilk entity="ilk-security-panel">Security</ximf:ilk>
<ximf:ilk entity="ilk-reply-before">Reply before</ximf:ilk>
<ximf:ilk entity="ilk-originator-reference">Origin references</ximf:ilk>
<ximf:ilk entity="ilk-classification-panel">Classification</ximf:ilk>
<ximf:ilk entity="ilk-classification">Security classification</ximf:ilk>
<ximf:ilk entity="ilk-privacy-mark">Privacy mark</ximf:ilk>
<ximf:ilk entity="ilk-general">General</ximf:ilk>
<ximf:ilk entity="ilk-confidential">Confidential</ximf:ilk>
<ximf:ilk entity="ilk-highly-confidential">Highly Confidential</ximf:ilk>
<ximf:ilk entity="ilk-minimum">Minimum</ximf:ilk>
<ximf:ilk entity="ilk-medium">Medium</ximf:ilk>
<ximf:ilk entity="ilk-maximum">Maximum</ximf:ilk>
<ximf:ilk entity="ilk-critical">Critical</ximf:ilk>
</ximf:locale>
</ximf:dictionary>
</ximf:instance>

=== Fichier ihm-amoco ===
* Le fichier ihm-amoco.xml contient des renseignements sur l'agencement du formulaire : un onglet "pane_security" contient deux sous-catégories "group-classification" et "group-info".
** La sous-catégorie "group-classification" contient les champs "header-classification" et "header-privacy-mark" décrits dans le fichier headers-amoco.xml.
** La sous-catégorie "group-info" contient les champs "header-originator-reference" et "header-reply-before" décrits dans le fichier headers-amoco.xml.
* Le champ "header-classification" et "header-privacy-mark" pourront être ajouté dans l'affichage des e-mails dans le client associé.

<?xml version="1.0" encoding="UTF-8"?>
<ximf:instance
name="Amoco"
version="1.0"
ximfVersion="2.0"
xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://eads.org/ximf/ ximf.xsd">
<ximf:ihm xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ximf:panel id="pane_security" ilk="ilk-classification-panel">
<ximf:groupbox id="group-classification" ilk="ilk-security-panel">
<ximf:headerRef>header-classification</ximf:headerRef>
<ximf:headerRef>header-privacy-mark</ximf:headerRef>
</ximf:groupbox>
<ximf:groupbox id="group-info" ilk="ilk-info-box">
<ximf:headerRef>header-originator-reference</ximf:headerRef>
<ximf:headerRef>header-reply-before</ximf:headerRef>
</ximf:groupbox>
</ximf:panel>
<ximf:treeRcv>
<ximf:headerRef>header-classification</ximf:headerRef>
<ximf:headerRef>header-privacy-mark</ximf:headerRef>
</ximf:treeRcv>
</ximf:ihm>
</ximf:instance>

=== Fichier headers-amoco ===
Le fichier headers-amoco.xml contient des renseignements sur les types de champs de l'instance XIMF et la façon dont les entêtes envoyées devront être formatées.
* Le header portant l'identifiant "header-classification" est une liste déroulante qui comporte trois choix. Cet élément comporte un attribut "technicalHeaderName" ce qui signifie que la valeur réellement envoyé dans les entêtes XIMF n'est pas celle qui est affichée à l'utilisateur.
* Le header portant l'identifiant "header-privacy-mark" est une liste déroulante qui comporte quatre choix.
* Le header portant l'identifiant "header-reply-before" est une date, lorsque le champs est sélectionné, un calendrier apparaît pour permettre la sélection de la date et de l'heure voulue.
* Le header portant l'identifiant "header-originator-reference" est un simple champ texte qui devra être rempli manuellement.

<u>Note :</u> Il est possible de spécifier des headers qui ne seront pas affichés dans le formulaire XIMF (e.g. OID Amoco).

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="ximftoxul.xsl"?>
<ximf:instance
name="Amoco"
version="1.0"
ximfVersion="2.0"
xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://eads.org/ximf/ ximf.xsd">


<ximf:header id="header-policy-identifier" headerName="X-XIMF-Security-Policy-Identifier" >
<ximf:string content="1.2.840.113549.1.9.16.7.1"/>
</ximf:header>
<ximf:header id="header-classification"
headerName="X-XIMF-Security-Classification"
technicalHeaderName="X-XIMF-Security-Classification-Identifier"
type="string"
technicalType="oid"
ilk="ilk-classification"
isMandatory="true">
<ximf:set id="value-amoco-classification" separator=";" technicalSeparator=".">
<ximf:string
ilk="ilk-general"
content="amoco-general"
technicalContent="6" />
<ximf:string
ilk="ilk-confidential"
content="amoco-confidential"
technicalContent="7" />
<ximf:string
ilk="ilk-highly-confidential"
content="amoco-highly-confidential"
technicalContent="8" />
</ximf:set>
</ximf:header>
<ximf:header
id="header-privacy-mark"
headerName="X-XIMF-Privacy-Mark"
ilk="ilk-privacy-mark"
isMandatory="true">
<ximf:set id="value-privacy-mark">
<ximf:string ilk="ilk-minimum" content="amoco-minimum" />
<ximf:string ilk="ilk-medium" content="amoco-medium" />
<ximf:string ilk="ilk-maximum" content="amoco-maximum" />
<ximf:string ilk="ilk-critical" content="amoco-critical" />
</ximf:set>
</ximf:header>
<ximf:header
id="header-reply-before"
headerName="X-XIMF-Reply-Before"
ilk="ilk-reply-before"
isMandatory="false"
type="date">
<ximf:string id="value-reply-before" editable="true" />
</ximf:header>
<ximf:header
id="header-originator-reference"
headerName="X-XIMF-Originator-Reference"
ilk="ilk-originator-reference"
isMandatory="false"
type="string">
<ximf:string id="value-originator-reference" maxItem="5" editable="true" separator=";"/>
</ximf:header>
</ximf:instance>

=== Fichier rules-amoco ===
Le fichier rules-amoco.xml contient une règle d'association entre les deux listes déroulantes.
* Lorsque la valeur "amoco-general" est sélectionnée dans la première liste, les valeurs possibles pour la deuxième liste sont : "amoco-minimum" et "amoco-medium".
* Lorsque la valeur "amoco-confidential" est sélectionnée dans la première liste, les valeurs possibles pour la deuxième liste sont : "amoco-minimum", "amoco-medium" et "amoco-maximum".
* Lorsque la valeur "amoco-highly-confidential" est sélectionnée dans la première liste, les valeurs possibles pour la deuxième liste sont : "amoco-minimum", "amoco-medium", "amoco-maximum" et "amoco-critical".

<?xml version="1.0" encoding="UTF-8"?>
<ximf:instance
name="Amoco"
version="1.0"
ximfVersion="2.0"
xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://eads.org/ximf/ ximf.xsd">
<ximf:rule id="association-rule" description="Règle d'associations de valeurs" >
<ximf:association>
<ximf:aliasHeader
headerName="X-XIMF-Privacy-Mark"
headerRef="X-XIMF-Security-Classification">
<ximf:aliasValue
valueName="amoco-minimum,amoco-medium"
valueRef="amoco-general" />
<ximf:aliasValue
valueName="amoco-minimum,amoco-medium,amoco-maximum"
valueRef="amoco-confidential" />
<ximf:aliasValue
valueName="amoco-minimum,amoco-medium,amoco-maximum,amoco-critical"
valueRef="amoco-highly-confidential" />
</ximf:aliasHeader>
</ximf:association>
</ximf:rule>
</ximf:instance>

Instance Amoco

2011-02-24T12:33:57Z

Anthonyjuge : /* Instance Amoco */

== Instance Amoco ==
<div style="color:red;">'''TODO :'''
* Mettre à jour les schemaLocation décrivant les fichiers.
* Comment est vérifiée la valeur de l'attribut "isMandatory=true" dans le cas d'une liste multi-sélection ?
</div>

Cette instance comporte un onglet contenant des sous-groupes disposant de champs aux types variés :
* deux listes déroulantes
* un champ texte
* un champ date

De plus, une contrainte est appliquée entre les deux listes déroulantes du premier onglet : certaines valeurs de la seconde liste ne sont pas disponible en fonction de la valeur sélectionnée sur la première liste.

[[Fichier:Instance_amoco.png|frame|center|''Affichage final de l'instance dans la langue : en-US.'']]

[[Fichier:Instance_amoco_selection.png|frame|center|''Règle XIMF de contrainte entre deux listes déroulante : certains éléments de la deuxième liste sont grisés en fonction de la valeur de la première liste.'']]

Voici les fichiers qui la définissent.

=== Fichier ximfmail-profile ===
Le fichier ximfmail-profile.xml devra contenir les renseignements sur les chemins vers les fichiers associés à l'instance.

<?xml version="1.0" encoding="utf-8"?>
<profile>
<theme name="Company Def"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="D:\DOC\DOC_THUN_INTRACED\ximf_profile.xsd">
<instance id="idExampleDefinition"
ximfVersion="2.0"
version="1.0"
name="Amoco"
directory="/chemin/vers/instance/Amoco/" author="Ximfmail">
<schema name="amoco">headers-Amoco.xml</schema>
<dictionary>dictionary-moco.xml</dictionary>
<ihm>ihm-amoco.xml</ihm>
<rule>rules-amoco.xml</rule>
</instance>
</theme>
</profile>

=== Fichier dictionary-amoco ===
Le fichier dictionary-amoco.xml contient des renseignement de toutes les données d'internationalisation pour les langues : fr-FR et en-US.

<?xml version="1.0" encoding="UTF-8"?>
<ximf:instance
name="Amoco"
version="1.0"
ximfVersion="2.0"
xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://eads.org/ximf/ ximf.xsd">
<ximf:dictionary id="OneDico">
<ximf:locale lang="fr-FR">
<ximf:ilk entity="ilk-info-box">Information</ximf:ilk>
<ximf:ilk entity="ilk-security-panel">Securité</ximf:ilk>
<ximf:ilk entity="ilk-originator-reference">Réferences d'origine</ximf:ilk>
<ximf:ilk entity="ilk-reply-before">Répondre avant</ximf:ilk>
<ximf:ilk entity="ilk-classification-panel">Classification</ximf:ilk>
<ximf:ilk entity="ilk-classification">Classification de sécurité</ximf:ilk>
<ximf:ilk entity="ilk-privacy-mark">Marque privée</ximf:ilk>
<ximf:ilk entity="ilk-general">Général</ximf:ilk>
<ximf:ilk entity="ilk-confidential">Confidentiel</ximf:ilk>
<ximf:ilk entity="ilk-highly-confidential">Très confidentiel</ximf:ilk>
<ximf:ilk entity="ilk-minimum">Minimum</ximf:ilk>
<ximf:ilk entity="ilk-medium">Moyen</ximf:ilk>
<ximf:ilk entity="ilk-maximum">Maximum</ximf:ilk>
<ximf:ilk entity="ilk-critical">Critique</ximf:ilk>
</ximf:locale>
<ximf:locale lang="en-US">
<ximf:ilk entity="ilk-info-box">Information</ximf:ilk>
<ximf:ilk entity="ilk-security-panel">Security</ximf:ilk>
<ximf:ilk entity="ilk-reply-before">Reply before</ximf:ilk>
<ximf:ilk entity="ilk-originator-reference">Origin references</ximf:ilk>
<ximf:ilk entity="ilk-classification-panel">Classification</ximf:ilk>
<ximf:ilk entity="ilk-classification">Security classification</ximf:ilk>
<ximf:ilk entity="ilk-privacy-mark">Privacy mark</ximf:ilk>
<ximf:ilk entity="ilk-general">General</ximf:ilk>
<ximf:ilk entity="ilk-confidential">Confidential</ximf:ilk>
<ximf:ilk entity="ilk-highly-confidential">Highly Confidential</ximf:ilk>
<ximf:ilk entity="ilk-minimum">Minimum</ximf:ilk>
<ximf:ilk entity="ilk-medium">Medium</ximf:ilk>
<ximf:ilk entity="ilk-maximum">Maximum</ximf:ilk>
<ximf:ilk entity="ilk-critical">Critical</ximf:ilk>
</ximf:locale>
</ximf:dictionary>
</ximf:instance>

=== Fichier ihm-amoco ===
* Le fichier ihm-amoco.xml contient des renseignements sur l'agencement du formulaire : un onglet "pane_security" contient deux sous-catégories "group-classification" et "group-info".
** La sous-catégorie "group-classification" contient les champs "header-classification" et "header-privacy-mark" décrits dans le fichier headers-amoco.xml.
** La sous-catégorie "group-info" contient les champs "header-originator-reference" et "header-reply-before" décrits dans le fichier headers-amoco.xml.
* Le champ "header-classification" et "header-privacy-mark" pourront être ajouté dans l'affichage des e-mails dans le client associé.

<?xml version="1.0" encoding="UTF-8"?>
<ximf:instance
name="Amoco"
version="1.0"
ximfVersion="2.0"
xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://eads.org/ximf/ ximf.xsd">
<ximf:ihm xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ximf:panel id="pane_security" ilk="ilk-classification-panel">
<ximf:groupbox id="group-classification" ilk="ilk-security-panel">
<ximf:headerRef>header-classification</ximf:headerRef>
<ximf:headerRef>header-privacy-mark</ximf:headerRef>
</ximf:groupbox>
<ximf:groupbox id="group-info" ilk="ilk-info-box">
<ximf:headerRef>header-originator-reference</ximf:headerRef>
<ximf:headerRef>header-reply-before</ximf:headerRef>
</ximf:groupbox>
</ximf:panel>
<ximf:treeRcv>
<ximf:headerRef>header-classification</ximf:headerRef>
<ximf:headerRef>header-privacy-mark</ximf:headerRef>
</ximf:treeRcv>
</ximf:ihm>
</ximf:instance>

=== Fichier headers-amoco ===
Le fichier headers-amoco.xml contient des renseignements sur les types de champs de l'instance XIMF et la façon dont les entêtes envoyées devront être formatées.
* Le header portant l'identifiant "header-classification" est une liste déroulante qui comporte trois choix. Cet élément comporte un attribut "technicalHeaderName" ce qui signifie que la valeur réellement envoyé dans les entêtes XIMF n'est pas celle qui est affichée à l'utilisateur.
* Le header portant l'identifiant "header-privacy-mark" est une liste déroulante qui comporte quatre choix.
* Le header portant l'identifiant "header-reply-before" est une date, lorsque le champs est sélectionné, un calendrier apparaît pour permettre la sélection de la date et de l'heure voulue.
* Le header portant l'identifiant "header-originator-reference" est un simple champ texte qui devra être rempli manuellement.

<u>Note :</u> Il est possible de spécifier des headers qui ne seront pas affichés dans le formulaire XIMF (e.g. OID Amoco).

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="ximftoxul.xsl"?>
<ximf:instance
name="Amoco"
version="1.0"
ximfVersion="2.0"
xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://eads.org/ximf/ ximf.xsd">


<ximf:header id="header-policy-identifier" headerName="X-XIMF-Security-Policy-Identifier" >
<ximf:string content="1.2.840.113549.1.9.16.7.1"/>
</ximf:header>
<ximf:header id="header-classification"
headerName="X-XIMF-Security-Classification"
technicalHeaderName="X-XIMF-Security-Classification-Identifier"
type="string"
technicalType="oid"
ilk="ilk-classification"
isMandatory="true">
<ximf:set id="value-amoco-classification" separator=";" technicalSeparator=".">
<ximf:string
ilk="ilk-general"
content="amoco-general"
technicalContent="6" />
<ximf:string
ilk="ilk-confidential"
content="amoco-confidential"
technicalContent="7" />
<ximf:string
ilk="ilk-highly-confidential"
content="amoco-highly-confidential"
technicalContent="8" />
</ximf:set>
</ximf:header>
<ximf:header
id="header-privacy-mark"
headerName="X-XIMF-Privacy-Mark"
ilk="ilk-privacy-mark"
isMandatory="true">
<ximf:set id="value-privacy-mark">
<ximf:string ilk="ilk-minimum" content="amoco-minimum" />
<ximf:string ilk="ilk-medium" content="amoco-medium" />
<ximf:string ilk="ilk-maximum" content="amoco-maximum" />
<ximf:string ilk="ilk-critical" content="amoco-critical" />
</ximf:set>
</ximf:header>
<ximf:header
id="header-reply-before"
headerName="X-XIMF-Reply-Before"
ilk="ilk-reply-before"
isMandatory="false"
type="date">
<ximf:string id="value-reply-before" editable="true" />
</ximf:header>
<ximf:header
id="header-originator-reference"
headerName="X-XIMF-Originator-Reference"
ilk="ilk-originator-reference"
isMandatory="false"
type="string">
<ximf:string id="value-originator-reference" maxItem="5" editable="true" separator=";"/>
</ximf:header>
</ximf:instance>

=== Fichier rules-amoco ===
Le fichier rules-amoco.xml contient une règle d'association entre les deux listes déroulantes.
* Lorsque la valeur "amoco-general" est sélectionnée dans la première liste, les valeurs possibles pour la deuxième liste sont : "amoco-minimum" et "amoco-medium".
* Lorsque la valeur "amoco-confidential" est sélectionnée dans la première liste, les valeurs possibles pour la deuxième liste sont : "amoco-minimum", "amoco-medium" et "amoco-maximum".
* Lorsque la valeur "amoco-highly-confidential" est sélectionnée dans la première liste, les valeurs possibles pour la deuxième liste sont : "amoco-minimum", "amoco-medium", "amoco-maximum" et "amoco-critical".

<?xml version="1.0" encoding="UTF-8"?>
<ximf:instance
name="Amoco"
version="1.0"
ximfVersion="2.0"
xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://eads.org/ximf/ ximf.xsd">
<ximf:rule id="association-rule" description="Règle d'associations de valeurs" >
<ximf:association>
<ximf:aliasHeader headerName="X-XIMF-Privacy-Mark" headerRef="X-XIMF-Security-Classification">
<ximf:aliasValue
valueName="amoco-minimum,amoco-medium"
valueRef="amoco-general" />
<ximf:aliasValue
valueName="amoco-minimum,amoco-medium,amoco-maximum"
valueRef="amoco-confidential" />
<ximf:aliasValue
valueName="amoco-minimum,amoco-medium,amoco-maximum,amoco-critical"
valueRef="amoco-highly-confidential" />
</ximf:aliasHeader>
</ximf:association>
</ximf:rule>
</ximf:instance>

XIMF guide developpeur/fr

2011-02-24T12:25:12Z

Anthonyjuge : /* Structure de l'instance */

== Guide développeur ==

Possible de définir son instance avec des champs d'entête personnalisés mais également formulaires.

== Structure de l'instance ==
Une instance XIMF est composée de plusieurs fichiers xml :
* un fichier ihm définissant l'agencement de l'interface
* un ou plusieurs fichiers headers définissant les types des champs de l'interface
* un fichier dictionnaire définissant les données d'internationalisation
* un ou plusieurs fichiers de règles définissant les contraintes spécifiques associées aux champs du formulaire

Les informations concernant les fichiers utilisés par une instance ce situent dans un autre fichier : ximfmail-profile.xml.

== Glossaire des balises XIMF ==

Une [[XIMF_XML_tags/fr| description détaillée des balises XIMF]] est disponible.

== Exemples d'instances XIMF ==

Instance simple : [[Instance_Example1 | Example1]] (un seul champ : type de correspondance)

Instance simple : [[Instance_Amoco | Amoco]] (plusieurs champs aux types variés : nom de l'affaire, label, date limite ...)

Instance simple : lien vers l'instance simple Company (associée au RFC security label example)

instance intégrant les possibilités avancées de XIMF.

== Création d'un add-on XIMF ==

Génération d'un add-on au format XPI. lien vers documentation Mozilla pour les XPI

XIMF guide developpeur/fr

2011-02-24T12:24:06Z

Anthonyjuge : /* Structure de l'instance */

== Guide développeur ==

Possible de définir son instance avec des champs d'entête personnalisés mais également formulaires.

== Structure de l'instance ==
Une instance XIMF est composée de plusieurs fichiers xml :
* un fichier ihm définissant l'agencement de l'interface
* un ou plusieurs fichiers headers définissant les types des champs de l'interface
* un fichier dictionnaire définissant les données d'internationalisation
* un ou plusieurs fichiers de règles définissant les contraintes spécifiques associées aux champs du formulaire

== Glossaire des balises XIMF ==

Une [[XIMF_XML_tags/fr| description détaillée des balises XIMF]] est disponible.

== Exemples d'instances XIMF ==

Instance simple : [[Instance_Example1 | Example1]] (un seul champ : type de correspondance)

Instance simple : [[Instance_Amoco | Amoco]] (plusieurs champs aux types variés : nom de l'affaire, label, date limite ...)

Instance simple : lien vers l'instance simple Company (associée au RFC security label example)

instance intégrant les possibilités avancées de XIMF.

== Création d'un add-on XIMF ==

Génération d'un add-on au format XPI. lien vers documentation Mozilla pour les XPI

XIMF XML tags/fr

2011-02-24T11:03:28Z

Anthonyjuge : /* Element instance */

== Introduction ==
Ce document propose un modèle de description, via eXtensible Markup Language (XML), d’entêtes de messages électroniques respectant la norme XIMF. Ce document a deux objectifs :
# Décrire les éléments et attributs de représentation XML pour construire des entêtes de messages électroniques de format XIMF.
# Fournir un modèle de représentation XIMF/XML.

<u>Rappel :</u>
* Un "élément" fait référence à tous les caractères situés entre une balise de départ et un balise de fin, e.g.,
<exemple> texte et/ou éléments fils </exemple>
* Un "attribut" est une composante d’un élément. Il est positionné dans la balise de départ, e.g.,
<exemple nom='value'>

Tous les éléments décrits dans cette documentation paragraphe sont validés dans l’espace de nom "ximf".

<pre>
xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://eads.org/ximf/ximf.xsd"
</pre>

== Description détaillée des balises XML ==

Voici, par ordre d'apparition et en fonction des fichiers, les balises génériques associées aux différents fichiers XML.

=== Fichier ximfmail-profile ===

<div style="color:red;">'''TODO''' :
* Combien d'éléments ihm sont autorisés dans un élément instance ?
* La documentation des fichiers ximfmail-profile.xml n'est pas disponible. Est-il possible d'avoir accès au fichier ximf_profile.xsd mentionné dans les ximfmail-profile.xml ?
</div>

Un fichier xpi peut contenir plusieurs instances XIMF, celles-ci sont alors regroupées dans une même catégorie. Le fichier ximfmail-profile contient des informations sur toutes les instances contenues dans le xpi, notamment leur nom, leur chemin d'accès, ainsi que les noms des fichiers associés à chaque instance.

==== Element instance ====
L’élément "instance" identifie l’ensemble des entêtes à décrire selon la norme XIMF. C’est le conteneur principal d’une instance XIMF/XML. Cinq attributs précisent la balise "instance" : "ximfVersion", "version", "author", "creation", "name", e.g.,
<ximf:instance name="myInstance" version="1.0" ximfVersion="2.0" >

* Détails sur les attributs de l'élément "instance" :
** L’attribut "name" définit le nom de l’instance décrite. Cet attribut est obligatoire.
** L’attribut "ximfVersion" définit le numéro de version des entêtes XIMF utilisés pour cette représentation. Cet attribut est obligatoire.
** L’attribut "version" définit le numéro de version de l’instance décrite. Cet attribut est obligatoire.
** L’attribut "author" renseigne sur le nom de l’auteur de cette instance.
** L’attribut "creationDate" précise la date de création de cette instance.

L’élément "instance" peut contenir un ou plusieurs éléments "schema", un ou plusieurs éléments "rule", un élément "ihm" et un élément "dictionary".

==== Element dictionary ====
L'élément dictionary contient le chemin vers le fichier spécifiant les données d'internationalisation (Cf. [[#Fichier_dictionary|Fichier dictionary]]).

==== Element schema ====
L'élément shema contient le chemin vers le fichier spécifiant les entêtes XIMF (Cf. [[#Fichier_headers|Fichier headers]]).

==== Element ihm ====
L'élément ihm contient le chemin vers le fichier spécifiant la disposition de l'interface des formulaires XIMF (Cf. [[#Fichier_ihm|Fichier ihm]]).

==== Element rule ====
L'élément rule contient le chemin vers le fichier spécifiant les règles associées aux valeurs des champs XIMF (Cf. [[#Fichier_rules|Fichier rules]]).

=== Fichier dictionary ===
Le fichier dictionnary permet de mettre en œuvre l’internationalisation d’une instance XIMF. Il défini des dictionnaires qui servent à traduire les éléments de l'instance XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient un élément "ximf:dictionnary".

==== Element dictionary ====
<span style="color:red;">'''TODO''' : Quel est l'intérêt de renseigner un attribut "id" à l'élément "dictionary" (étant donné qu'un seul élément "dictionary n'est autorisé dans l'élément "instance") ?</span>

L’élément "dictionary" contient toutes les informations devant être interprétées selon le pays d’utilisation.
L’élément "dictionary" contient un ou plusieurs mêmes éléments "locale", e.g.,

<ximf:dictionary>
<ximf:locale lang="fr-FR" />
<ximf:locale lang="en-US" />
</ximf:dictionary>

==== Element locale ====
L’élément "locale" contient toutes les informations pour un pays et/ou langue désignée.
L’élément "locale" contient un ou plusieurs mêmes éléments "ilk", e.g.,

<ximf:locale lang="fr-FR" >
<ximf:ilk entity="a"/>
<ximf:ilk entity="b"/>
</ximf:locale>

* Détails sur les attributs de la balise "locale" :
** L’attribut "lang" définit le code pays de ce conteneur. Il devrai être construit selon le format défini par la RFC1766 (fr, en, ja, es, …).

==== Element ilk ====
L’élément "ilk" contient une unique information correspondant à une donnée traduite selon le code pays de l’élément père. Cette information est au format chaîne de caractère. Un attribut obligatoire précise la balise "ilk".

<ximf:ilk entity="ilk-lang-ihm">langue</ximf:ilk>

* Détails sur les attributs de la balise "ilk" :
** L’attribut "entity" définit la référence d’entrée pour récupérer le contenu de l’élément selon le code pays souhaité.

Finalement, le fichier "dictionary" pourra contenir :
<ximf:instance name="Whirlpool">
<ximf:dictionary>
<ximf:locale lang="fr-FR" >
<ximf:ilk entity="ilk-lang-ihm">Français</ximf:ilk>
<ximf:ilk entity="ilk-exemple-general">Général</ximf:ilk>
</ximf:locale>
<ximf:locale lang="en-US" >
<ximf:ilk entity="ilk-lang-ihm">English (US)</ximf:ilk>
<ximf:ilk entity="ilk-exemple-general">General</ximf:ilk>
</ximf:locale>
</ximf:dictionary>
</ximf:instance>

=== Fichier ihm ===
<span style="color:red;">'''TODO''' : La documentation originale ne décrit pas le fichier ihm, les informations ci-dessous ont seulement été présumées. Merci de les vérifier/compléter.
</span>

Le fichier ihm spécifie l'agencement de l'interface des formulaires XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient un élément "ximf:ihm".

==== Element ihm ====
L'élément "ihm" contient un ou plusieurs éléments "panel" et un élément "treeRcv".

==== Element panel ====
Un élément ximf:panel correspond à un onglet du formulaire XIMF construit.
Deux attributs précisent la balise "panel" : "id" et "ilk", eg.
<ximf:panel id="pane_security" ilk="ilk-priority-panel" />

* Détails sur les attributs de l'élément "panel" :
** L’attribut "id" définit le nom de l'onglet, il doit être unique pour chaque élément "ximf:panel" et est formaté selon la syntaxe "pane-xxx". Cet attribut est obligatoire.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.

L'élément "ximf:panel" contient au moins un éléments "ximf:groupbox".

==== Element groupbox ====
Un élément groupbox correspond à une sous catégorie d'un onglet du formulaire XIMF.
La structure "groupbox" détaille l’ordre d’affichage des entêtes dans un message.
Deux attributs précisent la balise "ximf:groupbox" : "id" et "ilk", eg.
<ximf:groupbox id="group-classification" ilk="ilk-secu-box" />

* Détails sur les attributs de l'élément "groupbox" :
** L’attribut "id" définit le nom de l'onglet, il doit être unique pour chaque élément "ximf:panel" et est formaté selon la syntaxe "pane-xxx". Cet attribut est obligatoire.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.

L'élément "groupbox" contient au moins un éléments "headerRef".

==== Element treeRcv ====
L'élément "treeRcv" permet de spécifier quelles sont les colonnes susceptibles d'être ajoutées dans le panneau principal du client de messagerie qui contient la liste des messages d’un dossier.

L'élément "treeRcv" peut contenir des éléments "headerRef".

==== Element headerRef ====
L'élément headerRef spécifie les champs associés à chaque sous-groupe d'onglet de formulaire ou les champs qu'il est possible d'afficher dans la liste des messages.
Aucun attribut ne vient compléter la balise "headerRef", eg.
<ximf:headerRef>header-classification</ximf:headerRef>

Finalement, le fichier "ihm" pourra contenir :
<pre>
<ximf:instance name="Amoco">
<ximf:ihm>
<ximf:panel id="pane_security" ilk="ilk-priority-panel">
<ximf:groupbox id="group-classification" ilk="ilk-secu-box">
<ximf:headerRef>header-correspondance-type</ximf:headerRef>
<ximf:headerRef>header-classification</ximf:headerRef>
</ximf:groupbox>
</ximf:panel>
<ximf:treeRcv>
<ximf:headerRef>header-classification</ximf:headerRef>
</ximf:treeRcv>
</ximf:ihm>
</ximf:instance>
</pre>

=== Fichier headers ===
Le fichier headers spécifie les types des champs de l'interface des formulaires XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui contient des éléments "header".

==== Element header ====
Chaque élément "header" décrit un entête de message de format XIMF.
Huit attributs précisent la balise "header" : "headerName", "id", "technicalHeaderName", "type", "technicalType", "isMandatory", "ilk", "description", e.g.,

<div style="color:red;">'''TODO :'''
Comment est effectuée la vérification de l'attribut isMandatory et quelles sont les conditions de fonctionnement de celui-ci ? Est-il possible, par exemple, de spécifier l'attribut isMandatory=true d'un élément header si le contenu de celui-ci est un élément « set » qui dispose des attributs minItem et maxItem ?Actuellement, lorsque l'on crée un élément set avec les attributs minItem et maxItem, le champ du formulaire associé ne peux pas être validé : e.g.,
<ximf:set id="value-amoco-classification" minItem="1" maxItem="64" separator=";" technicalSeparator=".">
Est-ce un bug ?
</div>

<ximf:header id="header-primary-precedence"
headerName="X-XIMF-Primary-Precedence"
ilk="ilk-primary-precedence"
isMandatory="true"
description="entête d’urgence"
type="string" />

* Détails sur les attributs de l'élément "header" :
** L’attribut "headerName" définit le nom du champ XIMF. Cet attribut est obligatoire.
** L’attribut "id" définit un identifiant de champ, il doit être unique pour chaque élément "header" et est formaté selon la syntaxe "header-xxx". Cet attribut est obligatoire.
** L’attribut "isMandatory" précise si ce champ doit être obligatoirement présent dans le message intégrant les entêtes selon cette description.
** L’attribut "ilk" définit une référence de label de présentation associé au champ XIMF.
** L’attribut "type" précise le format des données associées à cet élément. Ce format peut être une date, une chaîne, une adresse mail, un O.I.D.
** L’attribut "technicalHeaderName" permet de compléter l’entête décrit par un autre entête.
** L’attribut "technicalType" précise le format des données associées à l’élément technicalHeaderName.
** L’attribut "description" permet d’ajouter une information sur cet élément.

L’élément "header" contient obligatoirement un élément "set", "multiset", "string", ou "compstring", e.g.,

<ximf:header id="header-reply-by"
headerName="X-XIMF-Reply-By"
ilk="ilk-reply-by"
isMandatory="false" >
<ximf:string id="value-reply-by" editable="true" />
</ximf:header>

<div style="color:red;">
'''TODO :''' Quelles sont les contraintes associées à l'attribut type d'un élément header ?
</div>

==== Element string ====
L’élément "string" précise le contenu d’une ressource de type chaîne de caractères imprimables (a-z, A-Z, 1-9,…)
Quinze attributs complètent l’élément "string" : "id", "ref", "ilk", "aclLevel", "index", "description", "editable", "content", "technicalContent","maxItem", "minItem", "maxLength", "minLength", "separator", "technicalSeparator", e.g.,

<ximf:string ilk="ilk-france" content="FRA" />

* Détails sur les attributs de l'élément "string" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "string".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[Element_ximf:role| élément role]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut " description " permet d’associer un commentaire sur cette donnée.
** L’attribut "editable" définit une valeur de saisie (champ libre). Cet attribut est de type booléen.
** L’attribut "content" représente la valeur effective de la donnée. C’est cette donnée qui sera associée au champ XIMF créé.
** L’attribut "technicalContent" représente la valeur effective de la donnée technique. C’est cette donnée qui sera associée au champ technique XIMF créé (cf. attribut technicalHeaderName de l’élément "header".
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.

L’élément "string" peut contenir plusieurs éléments "linkedValue".

<ximf:string ilk="ilk-non-protege" content="NON PROTEGE" technicalContent="1" >
<ximf:linkedValue ref="value-non-protege-france " />
</ximf:string>

==== Element compstring ====
<div style="color:red;">
'''TODO :''' L'attribut de l'élément « compstring » nommé « contentFactorise » devrait s'appeler « contentFactorize ».
</div>
L’élément "compstring" décrit un conteneur de concaténation des éléments fils. Il permet notamment de créer des valeurs d’entêtes composées.
Dix-sept attributs complètent l’élément "compstring" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", "content", "technicalContent", "contentPositionEnd", "contentFactorise", "technicalPositionEnd", e.g.,

<ximf:compstring
ilk="ilk-special"
content="SPECIAL"
technicalContent="1.3.4"
separator=" "
technicalSeparator=".">

* Détails sur les attributs de l'élément "compstring" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "compstring".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (cf. élément "role").
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut " description " permet d’associer un commentaire sur cette donnée.
** L’attribut "content" représente la valeur effective de la donnée. C’est cette donnée qui sera associée au champ XIMF créé.
** L’attribut "technicalContent" représente la valeur effective de la donnée technique. C’est cette donnée qui sera associée au champ technique XIMF créé (cf. attribut technicalHeaderName de l’élément "header".
** L’attribut "separator" définit le caractère de séparation entre deux valeurs.
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "contentPositionEnd" impose de positionner le contenu de l’élément "compstring" après les valeurs des éléments fils : valuefils1,valuefils2 : valuecompstring.
** L’attribut "technicalPositionEnd" impose de positionner le contenu de l’élément "compstring" après les valeurs des éléments fils.
** L’attribut "contentFactorise" impose d’utiliser le contenu de l’élément "compstring" comme facteur des éléments fils : valuecompstring(valuefils1,valuefils2).

L’élément "compstring" peut contenir un élément "string" ou "set" ou "multiset" ou plusieurs éléments "compstring".

<ximf:compstring
ilk="ilk-special"
content="SPECIAL"
technicalContent="1.3.4"
separator=" "
technicalSeparator=".">
<ximf:set id="ilk-special-op " maxItem="64">
<ximf:string ilk="ilk-special-op1" content="OP1" technicalContent="1" />
<ximf:string ilk="ilk-special-op2" content="OP2" technicalContent="2" />
<ximf:string ilk="ilk-special-op3" content="OP3" technicalContent="3" />
</ximf:set>
</ximf:compstring>

==== Element set ====
L’élément "set" décrit un conteneur de ressources de même type. Cet élément autorise la sélection de plusieurs ressources mais chaque ressource est sélectionnée une seule fois.
Douze attributs précisent la description de la balise "set" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", e.g.,

<ximf:set id="value-categories" ref="value-mentions" maxItem="64" separator=";" />

* Détails sur les attributs de l'élément "set" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "ximf:set".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role|élément rôle]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut "description" permet d’associer un commentaire sur cette donnée.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs

L’élément "set" peut contenir un ou plusieurs éléments "string" ou un ou plusieurs éléments "compstring".

<ximf:set id="value-categories" minItem="1" maxItem="64" separator=";">
<ximf:string ilk="ilk-releasable-to" content="RELEASABLE TO " />
<ximf:string ilk="ilk-eyes-only" content=" EYES ONLY"/>
<ximf:string ilk="ilk-use-only" content=" USE ONLY"/>
</ximf:set>

<div style="color:red;">'''TODO :'''
* Y a-t-il une définition des fichiers associés aux instances XIMF (e.g, le fichier attribution-list.xml utilisé dans l'instance Caterpillar) ?
* Comment le parseur d'instance ximf sait qu'un élément est une "attribution-list" ?
</div>

==== Element multiset ====
L’élément "multiset" décrit un conteneur de ressources de même type. Cet élément autorise la sélection de plusieurs ressources et chaque ressource peut être sélectionnée plusieurs fois.
Douze attributs précisent la description de la balise "multiset" : "id", "ref", "ilk", "aclLevel", "index", "description", "maxLength", "minLength", "maxItem", "minItem", "separator", "technicalSeparator", e.g.,

<ximf:multiset
id="value-restricted"
ilk=" value-restricted-otan"
maxItem="64"
separator=";" />

* Détails sur les attributs de l'élément "multiset" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "multiset".
** L’attribut "ref" définit un identifiant de référence qui contient les valeurs à utiliser pour cet élément.
** L’attribut "ilk" définit une référence de label de présentation internationalisé.
** L’attribut "aclLevel" définit la valeur seuil d’accès à la donnée selon une règle de droit d’accès (Cf. [[#Element_role|élément rôle]]).
** L’attribut "index" permet de définir un ordre de présentation par rapport à aux autres valeurs définies dans le même conteneur.
** L’attribut "description" permet d’associer un commentaire sur cette donnée.
** L’attribut "maxLength" définit le nombre maximal de caractères de la chaîne définie ou construite.
** L’attribut "minLength" définit le nombre minimal de caractères de la chaîne définie ou construite.
** L’attribut "maxItem" définit le nombre maximal de données associées pouvant être concaténées.
** L’attribut "minItem" définit le nombre minimal de données associées pouvant être concaténées.
** L’attribut "separator" définit le caractère de séparation entre deux valeurs (utile si l’attribute editable est positionné).
** L’attribut "technicalseparator" définit le caractère de séparation entre deux valeurs

L’élément "multiset" peut contenir un ou plusieurs éléments "string" ou un ou plusieurs éléments "compstring".

<ximf:multiset id="value-restricted-otan-categories" minItem="1" maxItem="64" separator=";" >
<ximf:string ilk="ilk-releasable-to" content="RELEASABLE TO "/>
<ximf:string ilk="ilk-eyes-only" content=" EYES ONLY"/>
<ximf:string ilk="ilk-use-only" content=" USE ONLY"/>
</ximf:multiset>

<span style="color:red;">'''TODO :''' Comment sont gérées les règles associées aux champs multivaleurs (disposant par exemple des attributs minItem/maxItem ou les champs multiset) ?</span>

==== Element linkedValue ====
<div style="color: red;">'''TODO ''': L'élément linkedValue indique quelle ressource utiliser lors de la sélection d'un élément particulier mais il n'indique pas où la ressource devra être utilisée.
* Est-ce que cela correspond toujours au header suivant ?
* Pourquoi avoir fait ce choix au lieu d'ajouter un attribut supplémentaire ?
</div>

L’élément "linkedValue" définit une référence sur une ressource de type conteneur ("set", "multiset") ou "string". Cette ressource devrait être utilisée si la ressource contenant "linkedValue" (noeud parent) est sélectionnée.
Un attribut précise la balise "linkvalue" : "ref", e.g.,

<ximf:linkedValue ref="value-restricted-otan-classification-id" />

* Détails sur les attributs de l'élément "linkedValue" :
** L’attribut "ref" précise la valeur de l’attribut "id" de la ressource cible. Cet attribut est obligatoire.

=== Fichier rules ===
Le fichier rules définit les règles de contrôles d’entêtes XIMF.
On y retrouve un élément "instance" rappelant l'instance XIMF à laquelle il est rattaché et qui peut contenir des éléments "ximf:rule".

==== Element rule ====
<div style="color:red">
'''TODO :''' Mettre à jour la documentation :
* Les éléments autorisés dans un élément « rule » ne sont plus à jour. La présente documentation spécifie 12 éléments : AliasHeader, AliasValue, Compatibility, Association, SecureHeaders, SecurityLabel, Constraint, Assignment, Processing, Accessibility, Role et Custom. Le schéma XML fourni avec le mail en spécifie 5 : Constraint, Processing, Compatibility, Policy et Custom et place les autres en tant qu'extentions des 5 éléments cités précédemment.
* Les éléments SecureHeaders et SecurityLabel associés à l'élément « rule » dans la version ci-dessus ne figurent plus dans la nouvelle version. On les retrouve dans les fichiers rules-*.xml mais les éléments sont commentés. En revanche, ils sont bien présents dans une autre instance : s'agit-il d'une fonctionnalité non-documentée ou plus documentée ?
* L'élément ximf:classificationPictures n'est pas documenté. De plus, il serait bon d'avoir des précisions sur la raison qui a motivé l'ajout de cet élément dans les fichiers de règles (alors qu'il semblerait être plus adapté au fichier headers-*.xml).
</div>
L’élément "rule" est le conteneur principal de description d’un comportement particulier à appliquer sur un ensemble d’entêtes XIMF.
Trois attributs précisent la balise "rule" : "id", "agent", "description", e.g.,
<ximf:rule id="compatibility-rule" description="Règle sur la compatibilité X-SMTP / XIMF" >

* Détails sur les attributs de l'élément "rule" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "rule". Cet attribut est obligatoire.
** L’attribut "agent" indique l’équipement cible devant analyser et appliquer le contenu de cet élément.
** L’attribut "description" autorise l’auteur d’ajouter un commentaire sur cet élément.

L’élément "rule" contient un ou plusieurs mêmes éléments de spécialisation de la règle "contraint", "assignement", "processing", "compatibility", "accessibility", "custom",…, e.g.,

<ximf:rule id="precedence-rule" agent="mua" description="Règle sur les priorités">
<ximf:constraint
left="header-primary-precedence"
operator="equalOrGreaterThan"
right="header-copy-precedence" />
</ximf:rule>

==== Element aliasHeader ====
L’élément "aliasHeader" permet de définir le nom de l’entête sur lequel la règle précisée est appliquée
Deux attributs précisent la balise "aliasHeader" : "headerName" et "headerRef", e.g.,

<ximf:aliasHeader headerName ="X-P772-Version" headerRef="X-XIMF-VERSION" />

* Détails sur les attributs de l'élément "aliasHeader" :
* L’attribut "headerName" définit le nom XIMF de l’entête modifié par la règle. Cet attribut est obligatoire.
* L’attribut "headerRef" définit le nom d’un entête XIMF de référence qui est le point d’entrée de l’application de la règle sur l’entête définit par "headerName". Cela permet de lier deux entêtes de messages où l’utilisation de l’un des entêtes influe sur le comportement de l’autre.

L’élément "aliasHeader" peut contenir des éléments "aliasValue",e.g ,

<ximf:aliasHeader headerName="X-P772-Version" />
<ximf:aliasValue vame="1.0"/>
<ximf:aliasHeader>

==== Element aliasValue ====
L’élément "aliasValue" contient une valeur à associer à l’entête XIMF contrôlé par la règle. Il est utile lorsque deux entêtes sont liées (utilisation de l’attribut headerRef dans l’élément aliasHeader) et que les valeurs de l’entêtes de référence permettent de préciser celles de l’entête contrôlé.
Deux attributs précisent la balise "aliasValue" : "valueName", "valueRef", e.g.,

<ximf:aliasValue valueName="2" valueRef ="flash" />

* Détails sur les attributs de l'élément "aliasValue" :
** L’attribut "valueName" définit la valeur de l’entête à créer. Cet attribut est obligatoire.
** L’attribut "valueRef" définit la valeur de l’entête XIMF de référence pour utiliser valueName.
<span style="color:red;">'''TODO :''' L'attribut valueRef est-il obligatoire ?</span>

==== Element compatibility ====
L’élément "compatibility" est utilisé pour associer à un entête respectant la norme XIMF un entête respectant une autre norme que XIMF (XSMTP par exemple).
Deux attributs précisent la balise "compatibility" : "targetName", "targetVersion", e.g.,

<ximf:compatibility targetName="X-SMTP" targetVersion="1.1">
<ximf:aliasValue headerName="X-P772-Version" content="1.1" />
<ximf:aliasValue
headerName="X-P772-Primary-Precedence"
headerRef="header-primary-precedence"
dataRef="data-priority-xsmtp"/>
</ximf:compatibility>

* Détails sur les attributs de l'élément "compatibility" :
** L’attribut "targetName" définit la norme de l’entête à associer à l’entête XIMF. Cet attribut est obligatoire.
** L’attribut "targetVersion" définit le numéro de version de la norme de l’entête à associer à l’entête XIMF. Cet attribut est obligatoire.

L’élément "compatibility" contient au moins un élément "aliasHeader".

<u>Pour illustrer cette règle :</u>
Le format XSMTP est déjà supporté par certains équipements. Afin de rendre ceux-ci inter opérables avec le nouveau format XIMF, cette règle permet d’associer un entête XSMTP contenant les mêmes informations qu’un entête XIMF.

L’élément Association : dépendance entre entêtes
L’élément "association" définie les valeurs autorisées pour un entête XIMF en fonction d’une valeur définie pour un autre entête XIMF.

<ximf:association>
<ximf:aliasHeader
headerName="X-XIMF-Primary-Precedence"
headerRef="X-XIMF-Correspondence-Type">
<ximf:aliasValue valueName="routine" valueRef="private" />
<ximf:aliasValue valueName="routine,priority" valueRef="professional" />
<ximf:aliasValue valueName="routine,priority,immediate,flash" valueRef="operational" />
<ximf:aliasValue valueName="routine,priority,immediate" valueRef="official" />
</ximf:aliasHeader>
</ximf:association>

==== Element secureHeaders ====
<div style="color:red;">'''TODO :''' Les éléments SecureHeaders et SecurityLabel associés à l'élément « rule » dans la version ci-dessus ne figurent plus dans le shéma xml. On les retrouve dans les fichiers rules-*.xml mais les éléments sont commentés. En revanche, ils sont bien présents dans une autre instance : s'agit-il d'une fonctionnalité non-documentée ou plus documentée ?</div>
L’élément "secureHeaders" définie la liste des entêtes à intégrer dans la signature d’un message. Cette règle s’applique sur les équipements proposant un algorithme de signature des messages.

Un élément "secureHeaders" contient un ou plusieurs éléments "aliasHeaders" où chaque élément décrit un entête à intégrer dans la signature et complété d’un attribut "status".

<ximf:secureHeaders targetName="SecureHeaders">
<ximf:aliasHeader headerName="X-XIMF-Primary-Precedence" status="0" />
<ximf:aliasHeader headerName="X-XIMF-Copy-Precedence" status="0" />
</ximf:secureHeaders>

==== Element securityLabel ====
L’élément "securityLabel" définie la liste des entêtes à intégrer dans la signature d’un message. Cette règle s’applique sur les équipements proposant un algorithme de signature des messages selon la norme RFC.

Un élément "securityLabel" contient un ou plusieurs éléments "aliasHeaders" où chaque élément décrit un entête à intégrer dans la signature et complété d’un attribut "status".

<ximf:securityLabel targetName="SecurityLabel" id="Amoco">
<ximf:aliasHeader
headerName="SecurityPolicyIdentifier"
headerRef="X-XIMF-Security-Policy-Identifier" />
<ximf:aliasHeader
headerName="SecurityClassification"
headerRef="X-XIMF-Security-Classification-Identifier" />
<ximf:aliasHeader
headerName="ESSPrivacyMark"
headerRef="X-XIMF-Privacy-Mark" />
<ximf:aliasHeader
headerName="SecurityCategory"
headerRef="X-XIMF-Security-Categories-Identifier"
type="2" />
</ximf:securityLabel>

==== Element constraint ====
L’élément "constraint" est utilisé pour définir une règle de construction de deux entêtes partageant des "datas" identiques.
Trois attributs précisent la balise "constraint" : "left", "right", "operator", e.g.,

<ximf:constraint
left="header-primary-precedence"
operator="equalOrGreaterThan"
right="header-copy-precedence" />

* Détails sur les attributs de l'élément "constraint" :
** L’attribut "left" désigne le premier élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "right" désigne le deuxième élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "operator" indique la règle de poids à appliquer sur la valeur des deux éléments "header", il peut être de type "greaterThan", "lowerThan", "equalOrGreaterThan", "equalOrLowerThan", "equal". Cet attribut est obligatoire.

* Détails sur les valeurs possibles de l'attribut "type" :
** Le type "greaterThan" signifie que la valeur de l’élément "left" doit être strictement supérieur à la valeur de l’élément "right".
** Le type "lowerThan" signifie que la valeur de l’élément "left" doit être strictement inférieur à la valeur de l’élément "right".
** Le type "equalOrGreaterThan" signifie que la valeur de l’élément "left" doit être supérieur ou égale à la valeur de l’élément "right".
** Le type "equalOrLowerThan" signifie que la valeur de l’élément "left" doit être inférieur ou égale à la valeur de l’élément "right".
** Le type "equal" signifie que la valeur de l’élément "left" et de l’élément "right" doivent être identiques.

==== Element assignment ====
<div style="color:red;">'''TODO :''' L'élément assignment n'apparaît pas dans le shéma xml qui avait été envoyé.</div>

L’élément "assignement" est utilisé pour affecter une valeur créée en fonction d’une règle de comparaison sur les valeurs de deux éléments "header".
Quatre attributs précisent la balise "assignement" : "left", "right", "operator", "result", e.g.,

<ximf:assignment
left="header-primary-precedence"
operator="equal"
right="data-routine-precedence"
result="86400" />

* Détails sur les attributs de l'élément "assignment" :
** L’attribut "left" désigne le premier élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "right" désigne le deuxième élément "header" de comparaison. Cet attribut est obligatoire.
** L’attribut "operator" indique la règle de comparaison entre les valeurs des deux éléments "header", il peut être de type "greaterThan", "lowerThan", "equalOrGreaterThan", "equalOrLowerThan", "equal". Cet attribut est obligatoire.
** L’attribut "result" représente la valeur à utiliser si la règle de comparaison entre les deux éléments est satisfaite. Cet attribut est obligatoire.

==== Element processing ====
L’élément "processing" regroupe des règles de traitement à effectuer sur des entêtes formatés.
L’attribut "type" précise le type de traitement à effectuer sur ces valeurs. Cet attribut est obligatoire, il est de type : "sign-header-value", "encrypt-header-value", "capitalize-header-value", e.g.,

<ximf:processing type="sign-header-value">
<ximf:refHeader>header-primary-precedence</ximf:refheader>
<ximf:refHeader>header-copy-precedence</ximf:refheader>
<ximf:refHeader>header-echange-type</ximf:refheader>
</ximf:processing>

* Détails sur les valeurs possibles de l'attribut "type" :
** Le type "sign-header-value" définit un traitement de signature des entêtes définis dans la balise.
** Le type "encrypt-header-value" définit un traitement de chiffrement des entêtes définis dans la balise.
** Le type "capitalize-header-value" définit un traitement de capitalisation des entêtes définis dans la balise.

L’élément "processing" contient au moins un élément "refHeader".
<div style="color:red;">'''TODO :'''L'élément refHeader n'est pas documenté, s'agit-il en fait de l'élément headerRef ?</div>

==== Element accessibility ====
<div style="color:red;">'''TODO :''' L'élément accessibility n'apparaît pas dans le shéma xml qui avait été envoyé.</div>
L’élément "accessibility" définit un ensemble de règles de droit d’accès aux éléments d’une instance pour une cible déterminée (utilisateur, routeur…).
Cet élément contient un ou plusieurs éléments "role".

<ximf:accessibility>
<ximf:role id="role-flash-allowed" aclLevel="100" />
<ximf:role id="role-flash-prohibited" aclLevel="50" />
</ximf:accessibility>

==== Element role ====
L’élément "role" positionne une valeur d’accès à pour une entité définit.
Deux attributs complètent l’élément "role" : "id", "aclLevel", e.g.,

<ximf:role id="role-flash-allowed" aclLevel="100" />

* Détails sur les attributs de l'élément "role" :
** L’attribut "id" précise l’entité accessible en fonction d’une valeur déterminée.
** L’attribut "aclLevel" précise la valeur seuil d’accès à l’entité.

==== Element custom ====
L’élément "custom" permet à l’auteur de créer des nouvelles règles personnalisées.
Trois attributs précisent la balise "custom" : "id", "provider", "description", e.g.,

<ximf:custom
id="custom-display"
provider="EADS"
description="Affichage de la composition du message" >
<node1><node2><node3></node3></node2></node1>
</ximf:custom>

* Détails sur les attributs de l'élément "custom" :
** L’attribut "id" définit un identifiant d’élément, il doit être unique pour chaque élément "custom" et formaté selon la syntaxe "custom-xxx". Cet attribut est obligatoire.
** L’attribut "provider" identifie l’auteur de la règle. Cet attribut est obligatoire.
** L’attribut "description" permet d’ajouter un commentaire sur cet élément.

L’élément "custom" peut contenir tous les éléments possibles en respectant les standards XML.

Instance Amoco

2011-02-24T10:56:45Z

Anthonyjuge : /* Instance Amoco */

== Instance Amoco ==
<div style="color:red;">'''TODO :'''
* Mettre à jour les schemaLocation décrivant les fichiers.
* Comment est vérifiée la valeur de l'attribut "isMandatory=true" dans le cas d'une liste multi-sélection ?
</div>

Cette instance comporte un onglet contenant des sous-groupes disposant de champs aux types variés :
* deux listes déroulantes
* un champ texte
* un champ date

De plus, une contrainte est appliquée entre les deux listes déroulantes du premier onglet : certaines valeurs de la seconde liste ne sont pas disponible en fonction de la valeur sélectionnée sur la première liste.

[[Fichier:Instance_amoco.png|frame|center|''Affichage final de l'instance dans la langue : en-US.'']]

[[Fichier:Instance_amoco_selection.png|frame|center|''Règle XIMF de contrainte entre deux listes déroulante : certains éléments de la deuxième liste sont grisés en fonction de la valeur de la première liste.'']]

Voici les fichiers qui la définissent.

=== Fichier ximfmail-profile ===
Le fichier ximfmail-profile.xml devra contenir les renseignements sur les chemins vers les fichiers associés à l'instance.

<div style="font-size: 8px;">
<?xml version="1.0" encoding="utf-8"?>
<profile>
<theme name="Company Def"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="D:\DOC\DOC_THUN_INTRACED\ximf_profile.xsd">
<instance id="idExampleDefinition"
ximfVersion="2.0"
version="1.0"
name="Amoco"
directory="/chemin/vers/instance/Amoco/" author="Ximfmail">
<schema name="amoco">headers-Amoco.xml</schema>
<dictionary>dictionary-moco.xml</dictionary>
<ihm>ihm-amoco.xml</ihm>
<rule>rules-amoco.xml</rule>
</instance>
</theme>
</profile>
</div>

=== Fichier dictionary-amoco ===
Le fichier dictionary-amoco.xml contient des renseignement de toutes les données d'internationalisation pour les langues : fr-FR et en-US.

<div style="font-size: 8px;">
<?xml version="1.0" encoding="UTF-8"?>
<ximf:instance
name="Amoco"
version="1.0"
ximfVersion="2.0"
xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://eads.org/ximf/ ximf.xsd">
<ximf:dictionary id="OneDico">
<ximf:locale lang="fr-FR">
<ximf:ilk entity="ilk-info-box">Information</ximf:ilk>
<ximf:ilk entity="ilk-security-panel">Securité</ximf:ilk>
<ximf:ilk entity="ilk-originator-reference">Réferences d'origine</ximf:ilk>
<ximf:ilk entity="ilk-reply-before">Répondre avant</ximf:ilk>
<ximf:ilk entity="ilk-classification-panel">Classification</ximf:ilk>
<ximf:ilk entity="ilk-classification">Classification de sécurité</ximf:ilk>
<ximf:ilk entity="ilk-privacy-mark">Marque privée</ximf:ilk>
<ximf:ilk entity="ilk-general">Général</ximf:ilk>
<ximf:ilk entity="ilk-confidential">Confidentiel</ximf:ilk>
<ximf:ilk entity="ilk-highly-confidential">Très confidentiel</ximf:ilk>
<ximf:ilk entity="ilk-minimum">Minimum</ximf:ilk>
<ximf:ilk entity="ilk-medium">Moyen</ximf:ilk>
<ximf:ilk entity="ilk-maximum">Maximum</ximf:ilk>
<ximf:ilk entity="ilk-critical">Critique</ximf:ilk>
</ximf:locale>
<ximf:locale lang="en-US">
<ximf:ilk entity="ilk-info-box">Information</ximf:ilk>
<ximf:ilk entity="ilk-security-panel">Security</ximf:ilk>
<ximf:ilk entity="ilk-reply-before">Reply before</ximf:ilk>
<ximf:ilk entity="ilk-originator-reference">Origin references</ximf:ilk>
<ximf:ilk entity="ilk-classification-panel">Classification</ximf:ilk>
<ximf:ilk entity="ilk-classification">Security classification</ximf:ilk>
<ximf:ilk entity="ilk-privacy-mark">Privacy mark</ximf:ilk>
<ximf:ilk entity="ilk-general">General</ximf:ilk>
<ximf:ilk entity="ilk-confidential">Confidential</ximf:ilk>
<ximf:ilk entity="ilk-highly-confidential">Highly Confidential</ximf:ilk>
<ximf:ilk entity="ilk-minimum">Minimum</ximf:ilk>
<ximf:ilk entity="ilk-medium">Medium</ximf:ilk>
<ximf:ilk entity="ilk-maximum">Maximum</ximf:ilk>
<ximf:ilk entity="ilk-critical">Critical</ximf:ilk>
</ximf:locale>
</ximf:dictionary>
</ximf:instance>
</div>

=== Fichier ihm-amoco ===
* Le fichier ihm-amoco.xml contient des renseignements sur l'agencement du formulaire : un onglet "pane_security" contient deux sous-catégories "group-classification" et "group-info".
** La sous-catégorie "group-classification" contient les champs "header-classification" et "header-privacy-mark" décrits dans le fichier headers-amoco.xml.
** La sous-catégorie "group-info" contient les champs "header-originator-reference" et "header-reply-before" décrits dans le fichier headers-amoco.xml.
* Le champ "header-classification" et "header-privacy-mark" pourront être ajouté dans l'affichage des e-mails dans le client associé.

<div style="font-size: 8px;">
<?xml version="1.0" encoding="UTF-8"?>
<ximf:instance
name="Amoco"
version="1.0"
ximfVersion="2.0"
xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://eads.org/ximf/ ximf.xsd">
<ximf:ihm xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ximf:panel id="pane_security" ilk="ilk-classification-panel">
<ximf:groupbox id="group-classification" ilk="ilk-security-panel">
<ximf:headerRef>header-classification</ximf:headerRef>
<ximf:headerRef>header-privacy-mark</ximf:headerRef>
</ximf:groupbox>
<ximf:groupbox id="group-info" ilk="ilk-info-box">
<ximf:headerRef>header-originator-reference</ximf:headerRef>
<ximf:headerRef>header-reply-before</ximf:headerRef>
</ximf:groupbox>
</ximf:panel>
<ximf:treeRcv>
<ximf:headerRef>header-classification</ximf:headerRef>
<ximf:headerRef>header-privacy-mark</ximf:headerRef>
</ximf:treeRcv>
</ximf:ihm>
</ximf:instance>
</div>

=== Fichier headers-amoco ===
Le fichier headers-amoco.xml contient des renseignements sur les types de champs de l'instance XIMF et la façon dont les entêtes envoyées devront être formatées.
* Le header portant l'identifiant "header-classification" est une liste déroulante qui comporte trois choix. Cet élément comporte un attribut "technicalHeaderName" ce qui signifie que la valeur réellement envoyé dans les entêtes XIMF n'est pas celle qui est affichée à l'utilisateur.
* Le header portant l'identifiant "header-privacy-mark" est une liste déroulante qui comporte quatre choix.
* Le header portant l'identifiant "header-reply-before" est une date, lorsque le champs est sélectionné, un calendrier apparaît pour permettre la sélection de la date et de l'heure voulue.
* Le header portant l'identifiant "header-originator-reference" est un simple champ texte qui devra être rempli manuellement.

<u>Note :</u> Il est possible de spécifier des headers qui ne seront pas affichés dans le formulaire XIMF (e.g. OID Amoco).

<div style="font-size: 8px;">
<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="ximftoxul.xsl"?>
<ximf:instance
name="Amoco"
version="1.0"
ximfVersion="2.0"
xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://eads.org/ximf/ ximf.xsd">


<ximf:header id="header-policy-identifier" headerName="X-XIMF-Security-Policy-Identifier" >
<ximf:string content="1.2.840.113549.1.9.16.7.1"/>
</ximf:header>
<ximf:header id="header-classification"
headerName="X-XIMF-Security-Classification"
technicalHeaderName="X-XIMF-Security-Classification-Identifier"
type="string"
technicalType="oid"
ilk="ilk-classification"
isMandatory="true">
<ximf:set id="value-amoco-classification" separator=";" technicalSeparator=".">
<ximf:string ilk="ilk-general" content="amoco-general" technicalContent="6" />
<ximf:string ilk="ilk-confidential" content="amoco-confidential" technicalContent="7" />
<ximf:string ilk="ilk-highly-confidential" content="amoco-highly-confidential" technicalContent="8" />
</ximf:set>
</ximf:header>
<ximf:header id="header-privacy-mark" headerName="X-XIMF-Privacy-Mark" ilk="ilk-privacy-mark" isMandatory="true">
<ximf:set id="value-privacy-mark">
<ximf:string ilk="ilk-minimum" content="amoco-minimum" />
<ximf:string ilk="ilk-medium" content="amoco-medium" />
<ximf:string ilk="ilk-maximum" content="amoco-maximum" />
<ximf:string ilk="ilk-critical" content="amoco-critical" />
</ximf:set>
</ximf:header>
<ximf:header
id="header-reply-before"
headerName="X-XIMF-Reply-Before"
ilk="ilk-reply-before"
isMandatory="false"
type="date">
<ximf:string id="value-reply-before" editable="true" />
</ximf:header>
<ximf:header
id="header-originator-reference"
headerName="X-XIMF-Originator-Reference"
ilk="ilk-originator-reference"
isMandatory="false"
type="string">
<ximf:string id="value-originator-reference" maxItem="5" editable="true" separator=";"/>
</ximf:header>
</ximf:instance>
</div>

=== Fichier rules-amoco ===
Le fichier rules-amoco.xml contient une règle d'association entre les deux listes déroulantes.
* Lorsque la valeur "amoco-general" est sélectionnée dans la première liste, les valeurs possibles pour la deuxième liste sont : "amoco-minimum" et "amoco-medium".
* Lorsque la valeur "amoco-confidential" est sélectionnée dans la première liste, les valeurs possibles pour la deuxième liste sont : "amoco-minimum", "amoco-medium" et "amoco-maximum".
* Lorsque la valeur "amoco-highly-confidential" est sélectionnée dans la première liste, les valeurs possibles pour la deuxième liste sont : "amoco-minimum", "amoco-medium", "amoco-maximum" et "amoco-critical".

<div style="font-size:8px;">
<?xml version="1.0" encoding="UTF-8"?>
<ximf:instance
name="Amoco"
version="1.0"
ximfVersion="2.0"
xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://eads.org/ximf/ ximf.xsd">
<ximf:rule id="association-rule" description="Règle d'associations de valeurs" >
<ximf:association>
<ximf:aliasHeader headerName="X-XIMF-Privacy-Mark" headerRef="X-XIMF-Security-Classification">
<ximf:aliasValue valueName="amoco-minimum,amoco-medium" valueRef="amoco-general" />
<ximf:aliasValue valueName="amoco-minimum,amoco-medium,amoco-maximum" valueRef="amoco-confidential" />
<ximf:aliasValue
valueName="amoco-minimum,amoco-medium,amoco-maximum,amoco-critical"
valueRef="amoco-highly-confidential" />
</ximf:aliasHeader>
</ximf:association>
</ximf:rule>
</ximf:instance>
</div>

Instance Amoco

2011-02-24T10:54:53Z

Anthonyjuge : /* Fichier headers-amoco */

== Instance Amoco ==

Cette instance comporte un onglet contenant des sous-groupes disposant de champs aux types variés :
* deux listes déroulantes
* un champ texte
* un champ date

De plus, une contrainte est appliquée entre les deux listes déroulantes du premier onglet : certaines valeurs de la seconde liste ne sont pas disponible en fonction de la valeur sélectionnée sur la première liste.

[[Fichier:Instance_amoco.png|frame|center|''Affichage final de l'instance dans la langue : en-US.'']]

[[Fichier:Instance_amoco_selection.png|frame|center|''Règle XIMF de contrainte entre deux listes déroulante : certains éléments de la deuxième liste sont grisés en fonction de la valeur de la première liste.'']]

Voici les fichiers qui la définissent.
<div style="color:red;">'''TODO :''' Mettre à jour les schemaLocation décrivant les fichiers.</div>

=== Fichier ximfmail-profile ===
Le fichier ximfmail-profile.xml devra contenir les renseignements sur les chemins vers les fichiers associés à l'instance.

<div style="font-size: 8px;">
<?xml version="1.0" encoding="utf-8"?>
<profile>
<theme name="Company Def"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="D:\DOC\DOC_THUN_INTRACED\ximf_profile.xsd">
<instance id="idExampleDefinition"
ximfVersion="2.0"
version="1.0"
name="Amoco"
directory="/chemin/vers/instance/Amoco/" author="Ximfmail">
<schema name="amoco">headers-Amoco.xml</schema>
<dictionary>dictionary-moco.xml</dictionary>
<ihm>ihm-amoco.xml</ihm>
<rule>rules-amoco.xml</rule>
</instance>
</theme>
</profile>
</div>

=== Fichier dictionary-amoco ===
Le fichier dictionary-amoco.xml contient des renseignement de toutes les données d'internationalisation pour les langues : fr-FR et en-US.

<div style="font-size: 8px;">
<?xml version="1.0" encoding="UTF-8"?>
<ximf:instance
name="Amoco"
version="1.0"
ximfVersion="2.0"
xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://eads.org/ximf/ ximf.xsd">
<ximf:dictionary id="OneDico">
<ximf:locale lang="fr-FR">
<ximf:ilk entity="ilk-info-box">Information</ximf:ilk>
<ximf:ilk entity="ilk-security-panel">Securité</ximf:ilk>
<ximf:ilk entity="ilk-originator-reference">Réferences d'origine</ximf:ilk>
<ximf:ilk entity="ilk-reply-before">Répondre avant</ximf:ilk>
<ximf:ilk entity="ilk-classification-panel">Classification</ximf:ilk>
<ximf:ilk entity="ilk-classification">Classification de sécurité</ximf:ilk>
<ximf:ilk entity="ilk-privacy-mark">Marque privée</ximf:ilk>
<ximf:ilk entity="ilk-general">Général</ximf:ilk>
<ximf:ilk entity="ilk-confidential">Confidentiel</ximf:ilk>
<ximf:ilk entity="ilk-highly-confidential">Très confidentiel</ximf:ilk>
<ximf:ilk entity="ilk-minimum">Minimum</ximf:ilk>
<ximf:ilk entity="ilk-medium">Moyen</ximf:ilk>
<ximf:ilk entity="ilk-maximum">Maximum</ximf:ilk>
<ximf:ilk entity="ilk-critical">Critique</ximf:ilk>
</ximf:locale>
<ximf:locale lang="en-US">
<ximf:ilk entity="ilk-info-box">Information</ximf:ilk>
<ximf:ilk entity="ilk-security-panel">Security</ximf:ilk>
<ximf:ilk entity="ilk-reply-before">Reply before</ximf:ilk>
<ximf:ilk entity="ilk-originator-reference">Origin references</ximf:ilk>
<ximf:ilk entity="ilk-classification-panel">Classification</ximf:ilk>
<ximf:ilk entity="ilk-classification">Security classification</ximf:ilk>
<ximf:ilk entity="ilk-privacy-mark">Privacy mark</ximf:ilk>
<ximf:ilk entity="ilk-general">General</ximf:ilk>
<ximf:ilk entity="ilk-confidential">Confidential</ximf:ilk>
<ximf:ilk entity="ilk-highly-confidential">Highly Confidential</ximf:ilk>
<ximf:ilk entity="ilk-minimum">Minimum</ximf:ilk>
<ximf:ilk entity="ilk-medium">Medium</ximf:ilk>
<ximf:ilk entity="ilk-maximum">Maximum</ximf:ilk>
<ximf:ilk entity="ilk-critical">Critical</ximf:ilk>
</ximf:locale>
</ximf:dictionary>
</ximf:instance>
</div>

=== Fichier ihm-amoco ===
* Le fichier ihm-amoco.xml contient des renseignements sur l'agencement du formulaire : un onglet "pane_security" contient deux sous-catégories "group-classification" et "group-info".
** La sous-catégorie "group-classification" contient les champs "header-classification" et "header-privacy-mark" décrits dans le fichier headers-amoco.xml.
** La sous-catégorie "group-info" contient les champs "header-originator-reference" et "header-reply-before" décrits dans le fichier headers-amoco.xml.
* Le champ "header-classification" et "header-privacy-mark" pourront être ajouté dans l'affichage des e-mails dans le client associé.

<div style="font-size: 8px;">
<?xml version="1.0" encoding="UTF-8"?>
<ximf:instance
name="Amoco"
version="1.0"
ximfVersion="2.0"
xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://eads.org/ximf/ ximf.xsd">
<ximf:ihm xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ximf:panel id="pane_security" ilk="ilk-classification-panel">
<ximf:groupbox id="group-classification" ilk="ilk-security-panel">
<ximf:headerRef>header-classification</ximf:headerRef>
<ximf:headerRef>header-privacy-mark</ximf:headerRef>
</ximf:groupbox>
<ximf:groupbox id="group-info" ilk="ilk-info-box">
<ximf:headerRef>header-originator-reference</ximf:headerRef>
<ximf:headerRef>header-reply-before</ximf:headerRef>
</ximf:groupbox>
</ximf:panel>
<ximf:treeRcv>
<ximf:headerRef>header-classification</ximf:headerRef>
<ximf:headerRef>header-privacy-mark</ximf:headerRef>
</ximf:treeRcv>
</ximf:ihm>
</ximf:instance>
</div>

=== Fichier headers-amoco ===
Le fichier headers-amoco.xml contient des renseignements sur les types de champs de l'instance XIMF et la façon dont les entêtes envoyées devront être formatées.
* Le header portant l'identifiant "header-classification" est une liste déroulante qui comporte trois choix. Cet élément comporte un attribut "technicalHeaderName" ce qui signifie que la valeur réellement envoyé dans les entêtes XIMF n'est pas celle qui est affichée à l'utilisateur.
* Le header portant l'identifiant "header-privacy-mark" est une liste déroulante qui comporte quatre choix.
* Le header portant l'identifiant "header-reply-before" est une date, lorsque le champs est sélectionné, un calendrier apparaît pour permettre la sélection de la date et de l'heure voulue.
* Le header portant l'identifiant "header-originator-reference" est un simple champ texte qui devra être rempli manuellement.

<u>Note :</u> Il est possible de spécifier des headers qui ne seront pas affichés dans le formulaire XIMF (e.g. OID Amoco).

<div style="font-size: 8px;">
<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="ximftoxul.xsl"?>
<ximf:instance
name="Amoco"
version="1.0"
ximfVersion="2.0"
xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://eads.org/ximf/ ximf.xsd">


<ximf:header id="header-policy-identifier" headerName="X-XIMF-Security-Policy-Identifier" >
<ximf:string content="1.2.840.113549.1.9.16.7.1"/>
</ximf:header>
<ximf:header id="header-classification"
headerName="X-XIMF-Security-Classification"
technicalHeaderName="X-XIMF-Security-Classification-Identifier"
type="string"
technicalType="oid"
ilk="ilk-classification"
isMandatory="true">
<ximf:set id="value-amoco-classification" separator=";" technicalSeparator=".">
<ximf:string ilk="ilk-general" content="amoco-general" technicalContent="6" />
<ximf:string ilk="ilk-confidential" content="amoco-confidential" technicalContent="7" />
<ximf:string ilk="ilk-highly-confidential" content="amoco-highly-confidential" technicalContent="8" />
</ximf:set>
</ximf:header>
<ximf:header id="header-privacy-mark" headerName="X-XIMF-Privacy-Mark" ilk="ilk-privacy-mark" isMandatory="true">
<ximf:set id="value-privacy-mark">
<ximf:string ilk="ilk-minimum" content="amoco-minimum" />
<ximf:string ilk="ilk-medium" content="amoco-medium" />
<ximf:string ilk="ilk-maximum" content="amoco-maximum" />
<ximf:string ilk="ilk-critical" content="amoco-critical" />
</ximf:set>
</ximf:header>
<ximf:header
id="header-reply-before"
headerName="X-XIMF-Reply-Before"
ilk="ilk-reply-before"
isMandatory="false"
type="date">
<ximf:string id="value-reply-before" editable="true" />
</ximf:header>
<ximf:header
id="header-originator-reference"
headerName="X-XIMF-Originator-Reference"
ilk="ilk-originator-reference"
isMandatory="false"
type="string">
<ximf:string id="value-originator-reference" maxItem="5" editable="true" separator=";"/>
</ximf:header>
</ximf:instance>
</div>

=== Fichier rules-amoco ===
Le fichier rules-amoco.xml contient une règle d'association entre les deux listes déroulantes.
* Lorsque la valeur "amoco-general" est sélectionnée dans la première liste, les valeurs possibles pour la deuxième liste sont : "amoco-minimum" et "amoco-medium".
* Lorsque la valeur "amoco-confidential" est sélectionnée dans la première liste, les valeurs possibles pour la deuxième liste sont : "amoco-minimum", "amoco-medium" et "amoco-maximum".
* Lorsque la valeur "amoco-highly-confidential" est sélectionnée dans la première liste, les valeurs possibles pour la deuxième liste sont : "amoco-minimum", "amoco-medium", "amoco-maximum" et "amoco-critical".

<div style="font-size:8px;">
<?xml version="1.0" encoding="UTF-8"?>
<ximf:instance
name="Amoco"
version="1.0"
ximfVersion="2.0"
xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://eads.org/ximf/ ximf.xsd">
<ximf:rule id="association-rule" description="Règle d'associations de valeurs" >
<ximf:association>
<ximf:aliasHeader headerName="X-XIMF-Privacy-Mark" headerRef="X-XIMF-Security-Classification">
<ximf:aliasValue valueName="amoco-minimum,amoco-medium" valueRef="amoco-general" />
<ximf:aliasValue valueName="amoco-minimum,amoco-medium,amoco-maximum" valueRef="amoco-confidential" />
<ximf:aliasValue
valueName="amoco-minimum,amoco-medium,amoco-maximum,amoco-critical"
valueRef="amoco-highly-confidential" />
</ximf:aliasHeader>
</ximf:association>
</ximf:rule>
</ximf:instance>
</div>

Instance Amoco

2011-02-24T10:53:18Z

Anthonyjuge : /* Fichier headers-amoco */

== Instance Amoco ==

Cette instance comporte un onglet contenant des sous-groupes disposant de champs aux types variés :
* deux listes déroulantes
* un champ texte
* un champ date

De plus, une contrainte est appliquée entre les deux listes déroulantes du premier onglet : certaines valeurs de la seconde liste ne sont pas disponible en fonction de la valeur sélectionnée sur la première liste.

[[Fichier:Instance_amoco.png|frame|center|''Affichage final de l'instance dans la langue : en-US.'']]

[[Fichier:Instance_amoco_selection.png|frame|center|''Règle XIMF de contrainte entre deux listes déroulante : certains éléments de la deuxième liste sont grisés en fonction de la valeur de la première liste.'']]

Voici les fichiers qui la définissent.
<div style="color:red;">'''TODO :''' Mettre à jour les schemaLocation décrivant les fichiers.</div>

=== Fichier ximfmail-profile ===
Le fichier ximfmail-profile.xml devra contenir les renseignements sur les chemins vers les fichiers associés à l'instance.

<div style="font-size: 8px;">
<?xml version="1.0" encoding="utf-8"?>
<profile>
<theme name="Company Def"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="D:\DOC\DOC_THUN_INTRACED\ximf_profile.xsd">
<instance id="idExampleDefinition"
ximfVersion="2.0"
version="1.0"
name="Amoco"
directory="/chemin/vers/instance/Amoco/" author="Ximfmail">
<schema name="amoco">headers-Amoco.xml</schema>
<dictionary>dictionary-moco.xml</dictionary>
<ihm>ihm-amoco.xml</ihm>
<rule>rules-amoco.xml</rule>
</instance>
</theme>
</profile>
</div>

=== Fichier dictionary-amoco ===
Le fichier dictionary-amoco.xml contient des renseignement de toutes les données d'internationalisation pour les langues : fr-FR et en-US.

<div style="font-size: 8px;">
<?xml version="1.0" encoding="UTF-8"?>
<ximf:instance
name="Amoco"
version="1.0"
ximfVersion="2.0"
xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://eads.org/ximf/ ximf.xsd">
<ximf:dictionary id="OneDico">
<ximf:locale lang="fr-FR">
<ximf:ilk entity="ilk-info-box">Information</ximf:ilk>
<ximf:ilk entity="ilk-security-panel">Securité</ximf:ilk>
<ximf:ilk entity="ilk-originator-reference">Réferences d'origine</ximf:ilk>
<ximf:ilk entity="ilk-reply-before">Répondre avant</ximf:ilk>
<ximf:ilk entity="ilk-classification-panel">Classification</ximf:ilk>
<ximf:ilk entity="ilk-classification">Classification de sécurité</ximf:ilk>
<ximf:ilk entity="ilk-privacy-mark">Marque privée</ximf:ilk>
<ximf:ilk entity="ilk-general">Général</ximf:ilk>
<ximf:ilk entity="ilk-confidential">Confidentiel</ximf:ilk>
<ximf:ilk entity="ilk-highly-confidential">Très confidentiel</ximf:ilk>
<ximf:ilk entity="ilk-minimum">Minimum</ximf:ilk>
<ximf:ilk entity="ilk-medium">Moyen</ximf:ilk>
<ximf:ilk entity="ilk-maximum">Maximum</ximf:ilk>
<ximf:ilk entity="ilk-critical">Critique</ximf:ilk>
</ximf:locale>
<ximf:locale lang="en-US">
<ximf:ilk entity="ilk-info-box">Information</ximf:ilk>
<ximf:ilk entity="ilk-security-panel">Security</ximf:ilk>
<ximf:ilk entity="ilk-reply-before">Reply before</ximf:ilk>
<ximf:ilk entity="ilk-originator-reference">Origin references</ximf:ilk>
<ximf:ilk entity="ilk-classification-panel">Classification</ximf:ilk>
<ximf:ilk entity="ilk-classification">Security classification</ximf:ilk>
<ximf:ilk entity="ilk-privacy-mark">Privacy mark</ximf:ilk>
<ximf:ilk entity="ilk-general">General</ximf:ilk>
<ximf:ilk entity="ilk-confidential">Confidential</ximf:ilk>
<ximf:ilk entity="ilk-highly-confidential">Highly Confidential</ximf:ilk>
<ximf:ilk entity="ilk-minimum">Minimum</ximf:ilk>
<ximf:ilk entity="ilk-medium">Medium</ximf:ilk>
<ximf:ilk entity="ilk-maximum">Maximum</ximf:ilk>
<ximf:ilk entity="ilk-critical">Critical</ximf:ilk>
</ximf:locale>
</ximf:dictionary>
</ximf:instance>
</div>

=== Fichier ihm-amoco ===
* Le fichier ihm-amoco.xml contient des renseignements sur l'agencement du formulaire : un onglet "pane_security" contient deux sous-catégories "group-classification" et "group-info".
** La sous-catégorie "group-classification" contient les champs "header-classification" et "header-privacy-mark" décrits dans le fichier headers-amoco.xml.
** La sous-catégorie "group-info" contient les champs "header-originator-reference" et "header-reply-before" décrits dans le fichier headers-amoco.xml.
* Le champ "header-classification" et "header-privacy-mark" pourront être ajouté dans l'affichage des e-mails dans le client associé.

<div style="font-size: 8px;">
<?xml version="1.0" encoding="UTF-8"?>
<ximf:instance
name="Amoco"
version="1.0"
ximfVersion="2.0"
xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://eads.org/ximf/ ximf.xsd">
<ximf:ihm xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ximf:panel id="pane_security" ilk="ilk-classification-panel">
<ximf:groupbox id="group-classification" ilk="ilk-security-panel">
<ximf:headerRef>header-classification</ximf:headerRef>
<ximf:headerRef>header-privacy-mark</ximf:headerRef>
</ximf:groupbox>
<ximf:groupbox id="group-info" ilk="ilk-info-box">
<ximf:headerRef>header-originator-reference</ximf:headerRef>
<ximf:headerRef>header-reply-before</ximf:headerRef>
</ximf:groupbox>
</ximf:panel>
<ximf:treeRcv>
<ximf:headerRef>header-classification</ximf:headerRef>
<ximf:headerRef>header-privacy-mark</ximf:headerRef>
</ximf:treeRcv>
</ximf:ihm>
</ximf:instance>
</div>

=== Fichier headers-amoco ===
Le fichier headers-amoco.xml contient des renseignements sur les types de champs de l'instance XIMF et la façon dont les entêtes envoyées devront être formatées.
* Le header portant l'identifiant "header-classification" est une liste déroulante qui comporte trois choix. Cet élément comporte un attribut "technicalHeaderName" ce qui signifie que la valeur réellement envoyé dans les entêtes XIMF n'est pas celle qui est affichée à l'utilisateur.
* Le header portant l'identifiant "header-privacy-mark" est une liste déroulante qui comporte quatre choix.
* Le header portant l'identifiant "header-reply-before" est une date, lorsque le champs est sélectionné, un calendrier apparaît pour permettre la sélection de la date et de l'heure voulue.
* Le header portant l'identifiant "header-originator-reference" est un simple champ texte qui devra être rempli manuellement.

<u>Note :</u> Il est possible de spécifier des headers qui ne seront pas affichés dans le formulaire XIMF (e,g OID Amoco).

<div style="font-size: 8px;">
<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="ximftoxul.xsl"?>
<ximf:instance
name="Amoco"
version="1.0"
ximfVersion="2.0"
xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://eads.org/ximf/ ximf.xsd">


<ximf:header id="header-policy-identifier" headerName="X-XIMF-Security-Policy-Identifier" >
<ximf:string content="1.2.840.113549.1.9.16.7.1"/>
</ximf:header>
<ximf:header id="header-classification"
headerName="X-XIMF-Security-Classification"
technicalHeaderName="X-XIMF-Security-Classification-Identifier"
type="string"
technicalType="oid"
ilk="ilk-classification"
isMandatory="true">
<ximf:set id="value-amoco-classification" separator=";" technicalSeparator=".">
<ximf:string ilk="ilk-general" content="amoco-general" technicalContent="6" />
<ximf:string ilk="ilk-confidential" content="amoco-confidential" technicalContent="7" />
<ximf:string ilk="ilk-highly-confidential" content="amoco-highly-confidential" technicalContent="8" />
</ximf:set>
</ximf:header>
<ximf:header id="header-privacy-mark" headerName="X-XIMF-Privacy-Mark" ilk="ilk-privacy-mark" isMandatory="true">
<ximf:set id="value-privacy-mark">
<ximf:string ilk="ilk-minimum" content="amoco-minimum" />
<ximf:string ilk="ilk-medium" content="amoco-medium" />
<ximf:string ilk="ilk-maximum" content="amoco-maximum" />
<ximf:string ilk="ilk-critical" content="amoco-critical" />
</ximf:set>
</ximf:header>
<ximf:header
id="header-reply-before"
headerName="X-XIMF-Reply-Before"
ilk="ilk-reply-before"
isMandatory="false"
type="date">
<ximf:string id="value-reply-before" editable="true" />
</ximf:header>
<ximf:header
id="header-originator-reference"
headerName="X-XIMF-Originator-Reference"
ilk="ilk-originator-reference"
isMandatory="false"
type="string">
<ximf:string id="value-originator-reference" maxItem="5" editable="true" separator=";"/>
</ximf:header>
</ximf:instance>
</div>

=== Fichier rules-amoco ===
Le fichier rules-amoco.xml contient une règle d'association entre les deux listes déroulantes.
* Lorsque la valeur "amoco-general" est sélectionnée dans la première liste, les valeurs possibles pour la deuxième liste sont : "amoco-minimum" et "amoco-medium".
* Lorsque la valeur "amoco-confidential" est sélectionnée dans la première liste, les valeurs possibles pour la deuxième liste sont : "amoco-minimum", "amoco-medium" et "amoco-maximum".
* Lorsque la valeur "amoco-highly-confidential" est sélectionnée dans la première liste, les valeurs possibles pour la deuxième liste sont : "amoco-minimum", "amoco-medium", "amoco-maximum" et "amoco-critical".

<div style="font-size:8px;">
<?xml version="1.0" encoding="UTF-8"?>
<ximf:instance
name="Amoco"
version="1.0"
ximfVersion="2.0"
xmlns:ximf="http://eads.org/ximf/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://eads.org/ximf/ ximf.xsd">
<ximf:rule id="association-rule" description="Règle d'associations de valeurs" >
<ximf:association>
<ximf:aliasHeader headerName="X-XIMF-Privacy-Mark" headerRef="X-XIMF-Security-Classification">
<ximf:aliasValue valueName="amoco-minimum,amoco-medium" valueRef="amoco-general" />
<ximf:aliasValue valueName="amoco-minimum,amoco-medium,amoco-maximum" valueRef="amoco-confidential" />
<ximf:aliasValue
valueName="amoco-minimum,amoco-medium,amoco-maximum,amoco-critical"
valueRef="amoco-highly-confidential" />
</ximf:aliasHeader>
</ximf:association>
</ximf:rule>
</ximf:instance>
</div>

XIMF guide developpeur/fr

2011-02-24T10:43:14Z

Anthonyjuge : /* Exemples d'instances XIMF */

== Guide développeur ==

Possible de définir son instance avec des champs d'entête personnalisés mais également formulaires.

== Structure de l'instance ==

..

== Glossaire des balises XIMF ==

Une [[XIMF_XML_tags/fr| description détaillée des balises XIMF]] est disponible.

== Exemples d'instances XIMF ==

Instance simple : [[Instance_Example1 | Example1]] (un seul champ : type de correspondance)

Instance simple : [[Instance_Amoco | Amoco]] (plusieurs champs aux types variés : nom de l'affaire, label, date limite ...)

Instance simple : lien vers l'instance simple Company (associée au RFC security label example)

instance intégrant les possibilités avancées de XIMF.

== Création d'un add-on XIMF ==

Génération d'un add-on au format XPI. lien vers documentation Mozilla pour les XPI