Property

From wiki.eclass.eu
Jump to: navigation, search

For the description how to request a new property, please see: Property_(Create_Change_Request).


eCl@ss is a system for classification and product description. For eCl@ss as a system to describe products, the most fundamental structural element is the property. A property describes a characteristic of a product. With the help of classification classes products are devided into certain categories of similar products, the product groups. These product groups can be unambiguously described by properties (e.g. material, color, article number). The sum of all properties of a subgroup is called an application class. A property can have relations to values which determine the most useful characteristics of the property (e.g. property: color, value: red). The sum of all values of a property is called a value list. Every property has a unique identifier (IRDI), a preferred name, a definition and a datatype - among other attributes that are described below.

Contents

[edit] Element structure (Property)

The following part will describe how the structural element "property" is structured and which attributes it consists of. All attributes are named in CamelCase writing. Attributes can be mandatory or optional, can be created automatically or manually by the user and underly certain rules. All of them are limited to a certain amount of characters.

A property is in a relation to other structural elements.


[edit] Identifier (Property)

The official and internationally unique eCl@ss identifier, i.e. primary key, is the IRDI (International Registration Data Identifier), a globally unambiguous identifier that comprises Supplier+TypeOfSE+Identifier+VersionNumber. The separate export of Supplier, ID, VersionNumber and the Identifier (ID+ VersionNumber) is therefore redundant. Starting with eCl@ss Release 8.0 this redundant information will no longer be additionally exported, because it is already contained in the IRDI which is the only valid primary key in eCl@ss.

The identifier for properties is the IrdiPR. It is mandatory, automatically created and limited to 20 characters. TheTypeOfSE of a property is 02.

[edit] Preferred Name (Property)

The text attribute named PreferredName is the official name of the property and is a mandatory text field. The following rules apply to the PreferredName:

  • 80 character limit
  • Must not contain a trademark, company or brand name
  • It should be possible to use the preferred name within a continuous text , i.e.
    • Adjective before noun (German, English)
    • Lower case for adjectives
    • Avoid combinations of several terms, keywords/synonyms are denoted separately
  • Give preference where possible to the basic grammatical form (singular, infinitive)
  • The following special characters must be avoided: semicolons (;), inverted commas (")
  • Formular symbols are not allowed in the PreferredName, but must be cited in the attribute FormularSymbol
  • In the case of BOOLEAN properties: the name has to be interpretable as a question that is to answered with either yes or no if adding a question mark. E.g. "suitable for...", "...present", "...possible" etc.

[edit] Definition (Property)

The property's definition is a mandatory text field. It shall describe the property as detailed as possible. The rules to create a property definition are described below.

  • 1023 character limit
  • shall be able to replace the preferred name in a continuous text without having to change it, i.e. the preferred name should not be repeated in the definition
  • formal rules must be considered:
    • start without a definite or indefinite article
    • start with a lower case letter (unless it is a German noun)
    • do not end with a full stop or any mark

Definitions should be complete and explain the meaning of the property so that the user knows which values are relevant for the property. A definition must not be in the form of a request or contain a request. Phrasing such as "must", "is for", "it is needed" etc. must not be used. Definitions must not contain any units of measure (e.g. mm, °C etc.). For generally phrased denotations (e.g. length), create generally valid definitions, for more specific denotations (e.g. length of the screw), create correspondingly limited definitions. Additional explanations for the definitions are specified in the attribute 'note'. Further explanations about the use of properties that are not related to definitions are specified in the attribute 'remark'.

[edit] Data type (Property)

The property's data type is a mandatory attribute and defines what kind of information a property transports. The following data types are possible:

Data Type Definition Examples
BOOLEAN Allowed values: (YES | NO) Yes
STRING A finite sequence of symbols that are chosen from a set or alphabet […] a sequence of characters (http://en.wikipedia.org/wiki/String_(computer_science)). Cannot be translated into other languages. 0173-1#01-ADG629#001 ; DN 700 ; 10 Mbps
STRING_TRANSLATABLE A finite sequence of symbols that are chosen from a set or alphabet […] a sequence of characters (http://en.wikipedia.org/wiki/String_(computer_science). Can be translated into other languages. Red ; Green ; Aluminum
INTEGER_COUNT data type which represents some finite subset of the mathematical integers. These are also known as integral data types. Used only for counting. (http://en.wikipedia.org/wiki/Integer_(computer_science). 1 ; 10 ; 111
INTEGER_MEASURE data type which represents some finite subset of the mathematical integers. These are also known as integral data types. Used for measuring in a specific unit of measure. (http://en.wikipedia.org/wiki/Integer_(computer_science). 1 ; 10 ; 111
INTEGER_CURRENCY data type which represents some finite subset of the mathematical integers. These are also known as integral data types. Used for measuring in a specific currency. (http://en.wikipedia.org/wiki/Integer_(computer_science). 1 ; 10 ; 111
REAL_COUNT a rational number expressed in decimal representation (http://en.wikipedia.org/wiki/Real_number). Used only for counting. 1,5 ; 102,35
REAL_MEASURE a rational number expressed in decimal representation (http://en.wikipedia.org/wiki/Real_number). Used for measuring in a specific unit of measure. 1,5 ; 102,35
REAL_CURRENCY a rational number expressed in decimal representation (http://en.wikipedia.org/wiki/Real_number). Used for measuring in a specific currency. 1,5 ; 102,35
RATIONAL to represent rational numbers like 1/3 and -11/17 without rounding (http://en.wikipedia.org/wiki/Rational_data_type). 1/3, 1 2/3
RATIONAL_MEASURE to represent rational numbers like 1/3 and -11/17 without rounding (http://en.wikipedia.org/wiki/Rational_data_type). Used for measuring in a specific unit of measure. 1/3, 1 2/3
TIME Format hh:mm according ISO 8601:2004 12:45
TIMESTAMP Format yyyy-mm-dd hh:mm according ISO 8601:2004 1979-01-15T12:45:00Z
DATE Format yyyy-mm-dd according ISO 8601:2004 1979-01-15
URL According to ISO 13584-24:2003 http://www.eclass-contentdevelopmentplatform.com
Level Type (only Advanced) Includes the minimal, maximal, typical and nominal value (min, max, typ, nom) min, max, typ, nom
Axis Type (only Advanced) Is a placement type and defines points in a geometry schema (axis1_placement_type, axis2_placement_2d_type, axis2_placement_3d_type), according to ISO 13584-42:2010, referring to ISO 10303-42. axis1_placement_type, axis2_placement_2d_type, axis2_placement_3d_type

Properties which have value lists can only be of the datatype STRING because a value has translations of its own. Properties without value lists were set to STRING(translatable) as default in 7.0 with the exception of “number of…”-properties and properties like “GTIN”, “Supplier name”, “Supplier number” etc.

[edit] Unit (Property)

Properties of DataTypes INTEGER_MEASURE, REAL_MEASURE or RATIONAL_MEASURE measure something in the measuring unit. Units that measure the same phenomenon can be compared and converted into each other. A quantity collects a set of units between which a conversion is defined and intended.

[edit] Reference (Property)

In the field 'reference', only documents are to be mentioned, in which a definition of the preferred name exists explicitly as a definition. However, if only the theme of the preferred name is discussed, i.e. the norm does not contain a definition, the title of the norm is to be mentioned in the attribute 'remark'. In the field 'reference', preference should be given to international, European or national norms. How to enter a reference: See ’The guideline for the creation of classes and properties in the DIN property dictionary’ (according to DIN 4002-4, DIN 820-2), e.g.:

  • DIN EN ISO 11145:2006 07
  • DIN 820-2:2004 10, 3.1
  • ISO 1234:2006

If no norm is available, a URL is better than no reference at all. Unfortunately, the risk that a URL will become outdated is rather high.

[edit] IEC Category

Detailed information is given in the DIN property dictionary under "IEC Property Classification". The IEC classification list is equivalent to the DIN EN 61360-1. The IEC Category can be chosen from a dropdown menu in the ContentDevelopmentPlatform when creating a new property.

List of IEC categories: IEC_Categories.pdf

[edit] ISO Language Code

see ISOLanguageCode

[edit] ISO Country Code

see ISOCountryCode

[edit] Note (Property)

Note on definition, optional, created by user, limited to 1023 characters. Notes are only designated for the additional explanations of definitions and must not contain any definitions. In the field notes, normal sentences are used starting with a capital and ending with a full stop.

[edit] Remark (Property)

Remark on the usage of the element, optional, created by user, limited to 1023 characters. Remarks are designated for comments in free text that in particular serve as an attached explanatory text or general/individual hint towards the use of the property. Remarks must not contain definitions or have an influence on the meaning of the definition or contradict its meaning; they must not represent an extension of the definition - that is the function of the 'note'. In the field remarks, normal sentences are used starting with a capital and ending with a full stop.

[edit] Formular Symbol (Property)

The preferred formular symbol.

[edit] Release notes (Property) (until eCl@ss-Release 9.1)

The description of a property in the BASIC release notes is as follows (update: release 7.1):

ReleaseNotesBasicProperty.JPG

[edit] Release notes (Property) (since eCl@ss-Release 10.0.1)

Starting with eCl@ss-Release 10.0.1, the necessity of the elements for field lengths and format is seen as redundant. Therefore, in comparison to the releases before, the rows DigitsBeforeComma, DigitsAfterComma and NumberOfCharacters have been removed and are no longer available. More information can be found here.

The description of a property in the BASIC release notes is as follows (update: release 10.0.1):

ReleaseNotesBasicProperty 10 0 1.JPEG

[edit] Change Request

How to request a change on a property in the eCl@ss ContentDevelopmentPortal?

Please see here: Property (Create Change Request)

Rules for the creation of a change request are described here: General rules for Change Requests


[edit] Related Information

Personal tools