Home > Models

Labels and Error Messages

EBX.Platform allows you to enrich your Master Data models with labels and error messages displayed in EBX.Manager tool.

Label and description (osd:label, osd:description)

A label and a description can be added to each node in an adaptation model.

In EBX.Manager, each adaptation node is displayed with its label . If no label is defined, the name of the element is used instead.

Notations :

Two notations are available:

  • full notation: label and description are defined respectively by the elements <osd:label> and <osd:description>.
  • simple notation: the label is extracted from the text content up to the first dot ('.') and/or this extraction is not longer than 60 characters ; the description is the rest of the text.

Link notations :

The description may have an hyperlink, either a standard html href to an external document, or an EBX.Manager link to another node in the adaptation.

  • href notation, and more generally any html notation must be escaped.
  • EBX.Manager link notation is not escaped and it must specify the path of the target, for example :
    <osd:link path="../misc1">link to another node in the adaptation</osd:link>

Example:

<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>

If a node points to a named type, then the label of the node replaces the label of the named type.

The same mechanism applies for description of the node (osd:description).

Enumeration label (osd:label)

A label can be added to each enumeration element. This property is described by adding the attribute osd:label in the enumeration element definition.

Example :

<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>

Required error message (osd:mandatoryErrorMessage)

If the node specifies the attribute minOccurs=”1” (default behavior), then a required error message is displayed if the user does not fill the field. This error message can be specific to each node by using the element osd:mandatoryErrorMessage.

Example :

<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>

Conversion error message

For each predefined XML Schema element, it is possible to define a specific error message if the user entry has an incorrect format.

Example :

<xs:element name ="email" type ="xs:string">
        <xs:annotation>
          <xs:appinfo>
            <fmt:string>
              <fmt:ConversionErrorMessage>
                Please enter a valid e-mail address
              </fmt:ConversionErrorMessage>
            </fmt:string>
          </xs:appinfo>
        </xs:annotation>
</xs:element>

Error message associated to a facet
 

XML Schema facet (osd:defaultErrorMessage)

The error message is described by the element <osd:defaultErrorMessage> in annotation/documentation under the definition of the facet.

Example :

<xs:element name ="zipCode">
        <xs:simpleType>
          <xs:restriction base ="xs:string">
            <!�facet is not localized, error message is also not localized-->
            <xs:minInclusive value ="01000" osd:index ="1">
              <xs:annotation>
                <xs:documentation>
                  <osd:defaultErrorMessage>
                    Postal code not valid
                  </osd:defaultErrorMessage>
                </xs:documentation>
              </xs:annotation>
            </xs:minInclusive>
          </xs:restriction>
        </xs:simpleType>
</xs:element>

XML Schema enumeration facet (osd:enumerationErrorMessage)

The error message is described by the element<osd:enumerationErrorMessage>in annotation/documentation under the definition of the element.

Example :

<xs:element name ="Gender">
        <xs:annotation>
          <xs:documentation>
            <osd:enumerationErrorMessage>
            Please indicate your 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>

EBX.Platform Facet (osd:defaultErrorMessage)

The error message is described by the element <osd:defaultErrorMessage> under the definition of the facet (which is defined in annotation/appInfo/otherFacets).

Example:

<xs:element name ="price" type ="xs:decimal">
        <xs:annotation>
          <xs:appinfo>
            <osd:otherFacets>
              <osd:minInclusive path ="../priceMin"/>
              <osd:defaultErrorMessage >
                The amount
                {1}' is too low.
              </osd:defaultErrorMessage>
              </osd:minInclusive>
            </osd:otherFacets>
          </xs:appinfo>
        </xs:annotation>
</xs:element>

Libellés et messages d'erreur

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 (osd:label, osd:description)

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é.

Notations :

Deux notations sont possibles :

  • notation longue : le libellé et la description sont respectivement définis par les éléments <osd:label> et <osd:description>.
  • notation simple : le libellé est extrait du texte de la documentation jusqu'au premier point ('.') et/ou cette extraction n'a pas plus de 60 caractères ; la description est le texte restant.

Notations des liens :

La description peut 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.

  • La notation href et de manière générale tout balise HTML, doit être échappée.
  • la notation d'un lien EBX.Manager n'est pas échappée et elle doit spécifier le chemin du noeud cible, par exemple :
    <osd:link path="../misc1">link to another node in the adaptation</osd:link>

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é d'énumération (osd:label)

Un libellé peut être renseigné pour chaque élément d’une énumération. Cette propriété est décrite par l’ajout de l’attribut osd:label dans la définition de l’élément de l’énumération.

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>

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>

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>
                Please enter a valid e-mail address
              </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, error message is also not localized-->
            <xs:minInclusive value ="01000" osd:index ="1">
              <xs:annotation>
                <xs:documentation>
                  <osd:defaultErrorMessage>
                    Postal code not valid
                  </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 your 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 >
                The amount
                {1}' is too low.
              </osd:defaultErrorMessage>
              </osd:minInclusive>
            </osd:otherFacets>
          </xs:appinfo>
        </xs:annotation>
</xs:element>

 

Home > Models