Home > Models

Libellés et messages

EBX.Platform permet d'enrichir vos modèles d'adaptation à l'aide de libellés, descriptions et messages d'erreurs affichés dans l'outil EBX.Manager .


Libellés et descriptions

Un libellé et une description peuvent être renseignés pour chaque nœud du modèle de données, que le nœud soit complexe ou simple.

Dans EBX.Manager, chaque noeud d'adaptation est identifié dans l'arbre par son libellé (osd:label). Si aucun libellé n’est défini, le nom de l’élément est affiché.

Deux notations sont possibles :

La description peut aussi avoir un lien hypertexte, que ce soit un lien HTML standard href vers un document externe, ou un lien EBX.Manager vers un autre noeud de l'adaptation.

Exemple:

<xs:element name="misc1" type="xs:string" >
        <xs:annotation>
          <xs:documentation>
            Miscellaneous 1. This is the description of miscellaneous element #1.
            Click &lt;a href="http://www.orchestranetworks.com" target="_blank"&gt;here&lt;/a&gt;
            to learn more about EBX.Platform.
          </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="misc2" type="xs:string" >
        <xs:annotation>
          <xs:documentation>
            <osd:label>
            Miscellaneous 2
            </osd:label>
            <osd:description>
              This is the miscellaneous element #2 and here is a 
              <osd:link path="../misc1"> link to another node in the 
              adaptation</osd:link>.
            </osd:description>
          </xs:documentation>
        </xs:annotation>
</xs:element>

Si un noeud pointe sur un type nommé, alors le libellé du noeud remplace le libellé du type nommé. Le même mécanisme s’applique à la description du nœud.

Libellés d'énumération

Un libellé simple, non régionalisé, peut être renseigné pour chaque élément d’une énumération, au moyen de l’attribut osd:label .

Exemple :

<xs:element name="Service" maxOccurs="unbounded">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:enumeration value="1" osd:label="Blue"/>
            <xs:enumeration value="2" osd:label="Red"/>
            <xs:enumeration value="3" osd:label="White"/>
          </xs:restriction>
        </xs:simpleType>
</xs:element>

Sinon, l'utilisation de l'élément xs:documentation permet de régionaliser complètement les libellés.

Exemple :

<xs:element name="access" minOccurs="0">
    <xs:simpleType>
        <xs:restriction base="xs:string">
            <xs:enumeration
                value="readOnly">
                <xs:annotation>
                    <xs:documentation xml:lang="en-US">
                        read only
                    </xs:documentation>
                    <xs:documentation xml:lang="fr-FR">
                        lecture seule
                    </xs:documentation>
                </xs:annotation>
            </xs:enumeration>
            <xs:enumeration
                value="readWrite">
                <xs:annotation>
                    <xs:documentation xml:lang="en-US">
                        read/write
                    </xs:documentation>
                    <xs:documentation xml:lang="fr-FR">
                        lecture écriture
                    </xs:documentation>
                </xs:annotation>
            </xs:enumeration>
            <xs:enumeration
                value="hidden">
                <xs:annotation>
                    <xs:documentation xml:lang="en-US">
                        hidden
                    </xs:documentation>
                    <xs:documentation xml:lang="fr-FR">
                        masqué
                    </xs:documentation>
                </xs:annotation>
            </xs:enumeration>
        </xs:restriction>
    </xs:simpleType>
</xs:element>

Message d'erreur obligatoire (osd:mandatoryErrorMessage)

Si le noeud spécifie l’attribut minOccurs="1" (comportement par défaut), alors un message d’erreur obligatoire est affiché si l’utilisateur final ne renseigne pas le champ. Ce message d’erreur obligatoire peut être spécifique à chaque nœud qui utilise l'élément osd:mandatoryErrorMessage . 

Exemple :

<xs:element name="birthDate" type="xs:date">
        <xs:annotation>
          <xs:documentation>
            <osd:mandatoryErrorMessage>
            Please give your birth date.
            </osd:mandatoryErrorMessage>
          </xs:documentation>
        </xs:annotation>
</xs:element>

Le message d’erreur obligatoire peut être localisé :

<xs:documentation>
    <osd:mandatoryErrorMessage xml:lang="en-US">
        Name is mandatory
    </osd:mandatoryErrorMessage>
    <osd:mandatoryErrorMessage xml:lang="fr-FR">
        Nom est obligatoire
    </osd:mandatoryErrorMessage>
</xs:documentation>

Message d'erreur de conversion

Pour chaque type simple XML Schema prédéfini, on peut définir un message d’erreur spécifique si la conversion du paramètre d’entrée en instance de classe Java échoue.

Exemple :

<xs:element name="email" type="xs:string">
        <xs:annotation>
          <xs:appinfo>
            <fmt:string>
              <fmt:ConversionErrorMessage xml:lang="en-US">
                Please enter a valid e-mail address.
              </fmt:ConversionErrorMessage>
              <fmt:ConversionErrorMessage xml:lang="fr-FR">
                Saisissez un e-mail valide.
              </fmt:ConversionErrorMessage>
            </fmt:string>
          </xs:appinfo>
        </xs:annotation>
</xs:element>

Message d'erreur associé à une facette

Facette XML Schema (osd:defaultErrorMessage)

Le message d’erreur est indiqué par l’élément osd:defaultErrorMessage dans annotation/documentation sous la définition de la facette.

Exemple :

<xs:element name="zipCode">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <!--facet is not localized, but error message is localized-->
            <xs:minInclusive value="01000">
              <xs:annotation>
                <xs:documentation>
                  <osd:defaultErrorMessage xml:lang="en-US">
                    Postal code not valid.
                  </osd:defaultErrorMessage>
                  <osd:defaultErrorMessage xml:lang="fr-FR">
                    Le code postal n'est pas valide.
                  </osd:defaultErrorMessage>
                </xs:documentation>
              </xs:annotation>
            </xs:minInclusive>
          </xs:restriction>
        </xs:simpleType>
</xs:element>

Facette XML Schema énumération (osd:enumerationErrorMessage)

Le message d’erreur est indiqué par l’élément osd:enumerationErrorMessage dans annotation/documentation sous la définition de l’élément.

Exemple :

<xs:element name="Gender">
        <xs:annotation>
          <xs:documentation>
            <osd:enumerationErrorMessage>
            Please indicate a valid gender.
            </osd:enumerationErrorMessage>
          </xs:documentation>
        </xs:annotation>
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:enumeration value="0" osd:label="male"/>
            <xs:enumeration value="1" osd:label="female"/>
          </xs:restriction>
        </xs:simpleType>
</xs:element>

Facette EBX.Platform (osd:defaultErrorMessage)

Le message d’erreur est indiqué par l’élément osd:defaultErrorMessage sous la définition de la facette (qui est définie dans annotation/appInfo/otherFacets).

Exemple:

<xs:element name="price" type="xs:decimal">
        <xs:annotation>
          <xs:appinfo>
            <osd:otherFacets>
              <osd:minInclusive path="../priceMin">
              <osd:defaultErrorMessage xml:lang="en-US">
                The amount
                '{1}' is too low.
              </osd:defaultErrorMessage>
              <osd:defaultErrorMessage xml:lang="fr-FR">
                Le montant
                '{1}' est trop bas.
              </osd:defaultErrorMessage>
              </osd:minInclusive>
            </osd:otherFacets>
          </xs:appinfo>
        </xs:annotation>
</xs:element>

Home > Models