Home > Models

Access Properties and Categories

Access Properties and Categories allow you to define restrictions on your data:

  • Access Properties define how data in your model can be adapted using EBX.Manager tool
  • Categories allow to restrict data visualization in EBX.Manager to groups of data

Access Properties (osd:access)

The attribute osd:access defines adaptation properties. This attribute must have the following values: "RW", "R-", "CC" or"--" (see below).

Note: This attribute can be extended on 8 characters ; this extension is reserved for an internal usage.

For each node (XML Schema type), three adaptation types are possible:

  1. Adaptation terminal node
    This node is displayed with an associated value in EBX.Manager. Access with the method Adaptation.get() uses the adaptation search algorithm.
  2. Adaptation non terminal node
    This node is a complex type that is displayed in EBX.Manager only if it has one child node that is an adaptation terminal node. It has no value. Access with the method Adaptation.get() returns null.
  3. Non adaptable node
    This node is not an adaptation terminal node and has no adaptation terminal node child. This node is not displayed in EBX.Manager. Access with the methodAdaptation.get() returns its default value if defined on null.

RW

Adaptation terminal node : value can be read and written in EBX.Manager

R-

Adaptation terminal node : value can be only read in EBX.Manager

CC

Cut: This is not an adaptation terminal node and no child is an adaptation terminal node. This "instruction" has priority on every child nodes whatever the value of their access attribute.

--

If the node is a simple type, it is not adaptable. If the node is a complex type, it is not an adaptation terminal node and does not define any child node.

Default

If the access attribute is not defined:
- If the node is a computed value, it is considered as R-
- If the node is a simple type and its value is not computed, it is considered as RW
- If the node is a multi-occurrenced complex type, it is then a terminal value and is considered as RW
- If the node is a non multi-occurrenced complex type, it is then not an adaptation terminal node and it does not define anything about its child nodes.

Example :

<xs:element name ="proxyIpAddress" type ="xs:string" osd:access ="RW"/>

In this example, the element is adaptable because it is an adaptation terminal node.

Categories

Categories allow to define "filters" on the elements of an adaptation model. Those filters allow:

  • to restrict the display of Master Data in EBX.Manager
  • to activate specific Master Data edition features in EBX.Manager (CSS Style sheets, Web template...)

Creation of a category is achieved using the attribute osd:category in a node of the XML schema.

Filters on Master Data

In the example below, we add to the node rebate the attribute osd:category in order to create a category named mycategory.

<xs:element name ="rebate" osd:category ="mycategory"/>
      <xs:complexType>
        <xs:sequence>
          <xs:element name ="label" type ="xs:string"/>
          <xs:element name ="beginDate" type ="xs:date"/>
          <xs:element name ="endDate" type ="xs:date"/>
          <xs:element name ="rate" type ="xs:decimal"/>
        </xs:sequence>
      </xs:complexType>
</xs:element>

In EBX.Manager, it is possible to activate this filter with a drop-down menu (above the Master Data tree)

CSS Stylesheets

EBX.Platform provides a category dedicated to CSS stylesheets: osd:category="CSS"

By adding this attribute to a node, all dependent Master Data will be interpreted as CSS style classes, and EBX.Manager will display a dedicated editor.

CSS style classes are defined as simple types xs:string.

<xs:element name="stylescss" osd:category="CSS">
     <xs:annotation>
          <xs:documentation>
              <osd:label>CSS Stylesheet </osd:label>
              <osd:description>CSS Stylesheet </osd:description>
          </xs:documentation>
     </xs:annotation>
     <xs:complexType>
          <xs:sequence>
              <xs:element name="headerfont">
                <xs:annotation>
                     <xs:documentation xml:lang="fr-FR">
                       <osd:label>headerfont</osd:label>
                       <osd:description>Font of the header </osd:description>
                      </xs:documentation>
                </xs:annotation>
                <xs:complexType>
                     <xs:sequence>
                     <xs:element name="color" type="xs:string"/>
                     <xs:element name="font-family" type="xs:string"/>
                     <xs:element name="font-size" type="xs:string"/>
                     <xs:element name="font-weight" type="xs:string"/>
                   </xs:sequence>
                </xs:complexType>
              </xs:element>
        </xs:sequence>
   </xs:complexType>
</xs:element>

In EBX.Manager, the CSS style nodes have specific graphical editors:

Predefined categories

Two categories with localized labels are predefined:

  • Hidden (by default, node is hidden in EBX.Manager)
  • Constraint

Propriétés d'accès et catégories

Les propriétés d'accès et les catégories permettent de définir des restrictions sur les données d'un modèle d'adaptation :

  • Les propriétés d'accès définissent comment les données d'un modèle peuvent être adaptées à l'aide de EBX.Manager
  • Les catégories permettent de restreindre la visualisation des données dans EBX.Manager à des groupes de données.

Propriétés d'accès (osd:access)

L’attribut osd:access définit les caractéristiques d’adaptation. Cet attribut doit prendre une des valeurs suivantes : "RW", "R-", "CC" ou "--" (voir ci-dessous).

Note : cet attribut peut être étendu sur 8 caractères ; cette extension est réservée à un usage interne.

Pour chaque nœud (type XML Schema), trois types d’adaptabilité sont possibles :

  • Nœud terminal d’adaptation
    Ce nœud apparaît avec une valeur associée dans l’arbre de paramétrage de l’outil EBX.Manager. L’accès via la méthode Adaptation.get() utilise l’algorithme de recherche dans les adaptations.
  • Nœud d’adaptation non terminal
    Ce nœud est un type complexe qui apparaît dans l’arbre de paramétrage de l’outil EBX.Manager parce qu’il possède au moins un descendant qui est un nœud terminal d’adaptation, cependant il n’a pas de valeur d’adaptation associée. L’accès via la méthode Adaptation.get() retourne null.
  • Nœud non adaptable
    Ce n’est pas un nœud terminal d’adaptation et aucun descendant n’est un nœud terminal d’adaptation. En conséquence, ce nœud n’apparaît pas dans l’arbre de paramétrage de l’outil EBX.Manager. L’accès via la méthode Adaptation.get() retournera la valeur par défaut du type si elle est définie, null sinon.

Il est à noter qu’un type complexe peut être un nœud terminal d’adaptation, auquel cas un éditeur dédié des instances devra être associé à ce type.

RW

Noeud terminal d'adaptation: la valeur peut être lue et mise à jour dans EBX.Manager.

R-

Noeud terminal d'adaptation: la valeur peut être lue mais n'est pas modifiable dans EBX.Manager.

CC

Coupure: n'est pas un noeud terminal d'adaptation et aucun descendant n'est un noeud terminal d'adaptation. Cette « instruction » a la priorité sur tous les noeuds descendants quelle soit la valeur éventuelle de leur attribut access

--

Si le noeud est de type simple, il est non adaptable. Si le noeud est un type complexe, il ne s'agit pas d'un noeud terminal d'adaptation et ne prescrit rien quant aux noeuds descendants.

Default

Si l'attribut access n'est pas défini :
- Si le noeud a une valeur calculée, il est alors considéré comme R-
- Si le noeud est de type simple, il est alors considéré comme RW
- Si le noeud est de type complexe multi-occurrencé, il est alors un noeud terminal et est considéré comme RW
- Si le noeud est de type complexe non multi-occurrencé, il ne s'agit pas d'un noeud terminal d'adaptation et il ne prescrit rien quant à ses noeuds descendants.

Exemple :

<xs:element name ="proxyIpAddress" type ="xs:string" osd:access ="RW"/>

Dans l'exemple ci-dessus, l'élément est adaptable car il correspond à un noeud terminal d'adaptation.

Catégories

Les catégories permettent de définir des "filtres" sur des éléments d'un modèle d'adaptation. Ces filtres permettent :

  • de limiter la visualisation de certaines Master Data dans EBX.Manager
  • d'activer des fonctions de paramétrage spécfiques dans EBX.Manager (Styles CSS, modèles Web)

La création d'une catégorie s'effectue à l'aide de l'atribut osd:category dans un noeud du schéma XML.

Filtres sur des données

Dans l'exemple ci-dessous, nous ajoutons au noeud rebate l'attribut osd:category pour créer une catégorie dénommée macategorie.

<xs:element name ="rebate" osd:category ="mycategory"/>
      <xs:complexType>
        <xs:sequence>
          <xs:element name ="label" type ="xs:string"/>
          <xs:element name ="beginDate" type ="xs:date"/>
          <xs:element name ="endDate" type ="xs:date"/>
          <xs:element name ="rate" type ="xs:decimal"/>
        </xs:sequence>
      </xs:complexType>
</xs:element>

Dans EBX.Manager, il est possible d'activer ce filtre à l'aide du menu déroulant en haut à droite des Master Data.

Styles CSS

EBX.Platform fournit une catégorie dédiée aux feuilles de styles CSS : osd:category="CSS"

En ajoutant cet attribut à un noeud du modèle, les paramètres dépendant seront intéprêtés comme des classes de styles CSS, et EBX.Manager founira des éditeurs graphiques dédiés.

Les classes de style CSS se définissent comme des types simples xs:string.

Exemple:

<xs:element name="stylescss" osd:category="CSS">
     <xs:annotation>
          <xs:documentation>
              <osd:label>CSS Stylesheet </osd:label>
              <osd:description>CSS Stylesheet </osd:description>
          </xs:documentation>
     </xs:annotation>
     <xs:complexType>
          <xs:sequence>
              <xs:element name="headerfont">
                <xs:annotation>
                     <xs:documentation xml:lang="fr-FR">
                       <osd:label>headerfont</osd:label>
                       <osd:description>Font of the header </osd:description>
                      </xs:documentation>
                </xs:annotation>
                <xs:complexType>
                     <xs:sequence>
                     <xs:element name="color" type="xs:string"/>
                     <xs:element name="font-family" type="xs:string"/>
                     <xs:element name="font-size" type="xs:string"/>
                     <xs:element name="font-weight" type="xs:string"/>
                   </xs:sequence>
                </xs:complexType>
              </xs:element>
        </xs:sequence>
   </xs:complexType>
</xs:element>

Dans EBX.Manager, les noeuds de style CSS ont des éditeurs graphiques spécfiques :

Catégories prédéfinies

Deux catégories avec libellés localisés sont prédéfinies :

  • Hidden (noeud caché par défaut dans EBX.Manager)
  • Constraint

 

Home > Models