Home > Models

Additional Properties


Access Properties

The attribute osd:access defines how the data of a particular schema node is read and written. This attribute must have one of the following values: " RW ", " R- ", " CC " or " -- " (see below).

Note: This attribute can be extended on 8 characters; this extension is reserved for 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 method Adaptation.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 any child node 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 an aggregated list, it is then a terminal value and is considered as RW

- Otherwise, it is 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.

Information

The element osd:information allows to specify additional information. This information can then be used by the integration code, for any specific purpose, by means of the method SchemaNode.getInformation() .

Example:

<xs:element name ="misc" type ="xs:string">
        <xs:annotation>
          <xs:appinfo>
            <osd:information>
             This is the text information of miscellaneous element.
            </osd:information>
          </xs:appinfo>
        </xs:annotation>
</xs:element>

Categories

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

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

Restriction

Category specification does not apply on table record node, except for category Hidden.

Home > Models